<!DOCTYPE html>
<html>
<head>
<meta charset="utf8" />
<title>OpenAI API</title>
<!-- needed for adaptive design -->
<meta name="viewport" content="width=device-width, initial-scale=1">
<style>
body {
padding: 0;
margin: 0;
}
</style>
<script>/*! For license information please see redoc.standalone.js.LICENSE.txt */
!function(e,t){"object"==typeof exports&&"object"==typeof module?module.exports=t(require("null")):"function"==typeof define&&define.amd?define(["null"],t):"object"==typeof exports?exports.Redoc=t(require("null")):e.Redoc=t(e.null)}(this,(function(e){return function(){var t={5499:function(e,t,n){"use strict";Object.defineProperty(t,"__esModule",{value:!0}),t.CodeGen=t.Name=t.nil=t.stringify=t.str=t._=t.KeywordCxt=void 0;const r=n(3325),o=n(6479),i=n(5522),a=n(1603),s=["/properties"],l="http://json-schema.org/draft-07/schema";class c extends r.default{_addVocabularies(){super._addVocabularies(),o.default.forEach((e=>this.addVocabulary(e))),this.opts.discriminator&&this.addKeyword(i.default)}_addDefaultMetaSchema(){if(super._addDefaultMetaSchema(),!this.opts.meta)return;const e=this.opts.$data?this.$dataMetaSchema(a,s):a;this.addMetaSchema(e,l,!1),this.refs["http://json-schema.org/schema"]=l}defaultMeta(){return this.opts.defaultMeta=super.defaultMeta()||(this.getSchema(l)?l:void 0)}}e.exports=t=c,Object.defineProperty(t,"__esModule",{value:!0}),t.default=c;var u=n(1321);Object.defineProperty(t,"KeywordCxt",{enumerable:!0,get:function(){return u.KeywordCxt}});var p=n(4475);Object.defineProperty(t,"_",{enumerable:!0,get:function(){return p._}}),Object.defineProperty(t,"str",{enumerable:!0,get:function(){return p.str}}),Object.defineProperty(t,"stringify",{enumerable:!0,get:function(){return p.stringify}}),Object.defineProperty(t,"nil",{enumerable:!0,get:function(){return p.nil}}),Object.defineProperty(t,"Name",{enumerable:!0,get:function(){return p.Name}}),Object.defineProperty(t,"CodeGen",{enumerable:!0,get:function(){return p.CodeGen}})},4667:function(e,t){"use strict";Object.defineProperty(t,"__esModule",{value:!0}),t.regexpCode=t.getProperty=t.safeStringify=t.stringify=t.strConcat=t.addCodeArg=t.str=t._=t.nil=t._Code=t.Name=t.IDENTIFIER=t._CodeOrName=void 0;class n{}t._CodeOrName=n,t.IDENTIFIER=/^[a-z$_][a-z$_0-9]*$/i;class r extends n{constructor(e){if(super(),!t.IDENTIFIER.test(e))throw new Error("CodeGen: name must be a valid identifier");this.str=e}toString(){return this.str}emptyStr(){return!1}get names(){return{[this.str]:1}}}t.Name=r;class o extends n{constructor(e){super(),this._items="string"==typeof e?[e]:e}toString(){return this.str}emptyStr(){if(this._items.length>1)return!1;const e=this._items[0];return""===e||'""'===e}get str(){var e;return null!==(e=this._str)&&void 0!==e?e:this._str=this._items.reduce(((e,t)=>`${e}${t}`),"")}get names(){var e;return null!==(e=this._names)&&void 0!==e?e:this._names=this._items.reduce(((e,t)=>(t instanceof r&&(e[t.str]=(e[t.str]||0)+1),e)),{})}}function i(e,...t){const n=[e[0]];let r=0;for(;r<t.length;)l(n,t[r]),n.push(e[++r]);return new o(n)}t._Code=o,t.nil=new o(""),t._=i;const a=new o("+");function s(e,...t){const n=[u(e[0])];let r=0;for(;r<t.length;)n.push(a),l(n,t[r]),n.push(a,u(e[++r]));return function(e){let t=1;for(;t<e.length-1;){if(e[t]===a){const n=c(e[t-1],e[t+1]);if(void 0!==n){e.splice(t-1,3,n);continue}e[t++]="+"}t++}}(n),new o(n)}function l(e,t){var n;t instanceof o?e.push(...t._items):t instanceof r?e.push(t):e.push("number"==typeof(n=t)||"boolean"==typeof n||null===n?n:u(Array.isArray(n)?n.join(","):n))}function c(e,t){if('""'===t)return e;if('""'===e)return t;if("string"==typeof e){if(t instanceof r||'"'!==e[e.length-1])return;return"string"!=typeof t?`${e.slice(0,-1)}${t}"`:'"'===t[0]?e.slice(0,-1)+t.slice(1):void 0}return"string"!=typeof t||'"'!==t[0]||e instanceof r?void 0:`"${e}${t.slice(1)}`}function u(e){return JSON.stringify(e).replace(/\u2028/g,"\\u2028").replace(/\u2029/g,"\\u2029")}t.str=s,t.addCodeArg=l,t.strConcat=function(e,t){return t.emptyStr()?e:e.emptyStr()?t:s`${e}${t}`},t.stringify=function(e){return new o(u(e))},t.safeStringify=u,t.getProperty=function(e){return"string"==typeof e&&t.IDENTIFIER.test(e)?new o(`.${e}`):i`[${e}]`},t.regexpCode=function(e){return new o(e.toString())}},4475:function(e,t,n){"use strict";Object.defineProperty(t,"__esModule",{value:!0}),t.or=t.and=t.not=t.CodeGen=t.operators=t.varKinds=t.ValueScopeName=t.ValueScope=t.Scope=t.Name=t.regexpCode=t.stringify=t.getProperty=t.nil=t.strConcat=t.str=t._=void 0;const r=n(4667),o=n(7791);var i=n(4667);Object.defineProperty(t,"_",{enumerable:!0,get:function(){return i._}}),Object.defineProperty(t,"str",{enumerable:!0,get:function(){return i.str}}),Object.defineProperty(t,"strConcat",{enumerable:!0,get:function(){return i.strConcat}}),Object.defineProperty(t,"nil",{enumerable:!0,get:function(){return i.nil}}),Object.defineProperty(t,"getProperty",{enumerable:!0,get:function(){return i.getProperty}}),Object.defineProperty(t,"stringify",{enumerable:!0,get:function(){return i.stringify}}),Object.defineProperty(t,"regexpCode",{enumerable:!0,get:function(){return i.regexpCode}}),Object.defineProperty(t,"Name",{enumerable:!0,get:function(){return i.Name}});var a=n(7791);Object.defineProperty(t,"Scope",{enumerable:!0,get:function(){return a.Scope}}),Object.defineProperty(t,"ValueScope",{enumerable:!0,get:function(){return a.ValueScope}}),Object.defineProperty(t,"ValueScopeName",{enumerable:!0,get:function(){return a.ValueScopeName}}),Object.defineProperty(t,"varKinds",{enumerable:!0,get:function(){return a.varKinds}}),t.operators={GT:new r._Code(">"),GTE:new r._Code(">="),LT:new r._Code("<"),LTE:new r._Code("<="),EQ:new r._Code("==="),NEQ:new r._Code("!=="),NOT:new r._Code("!"),OR:new r._Code("||"),AND:new r._Code("&&"),ADD:new r._Code("+")};class s{optimizeNodes(){return this}optimizeNames(e,t){return this}}class l extends s{constructor(e,t,n){super(),this.varKind=e,this.name=t,this.rhs=n}render({es5:e,_n:t}){const n=e?o.varKinds.var:this.varKind,r=void 0===this.rhs?"":` = ${this.rhs}`;return`${n} ${this.name}${r};`+t}optimizeNames(e,t){if(e[this.name.str])return this.rhs&&(this.rhs=R(this.rhs,e,t)),this}get names(){return this.rhs instanceof r._CodeOrName?this.rhs.names:{}}}class c extends s{constructor(e,t,n){super(),this.lhs=e,this.rhs=t,this.sideEffects=n}render({_n:e}){return`${this.lhs} = ${this.rhs};`+e}optimizeNames(e,t){if(!(this.lhs instanceof r.Name)||e[this.lhs.str]||this.sideEffects)return this.rhs=R(this.rhs,e,t),this}get names(){return C(this.lhs instanceof r.Name?{}:{...this.lhs.names},this.rhs)}}class u extends c{constructor(e,t,n,r){super(e,n,r),this.op=t}render({_n:e}){return`${this.lhs} ${this.op}= ${this.rhs};`+e}}class p extends s{constructor(e){super(),this.label=e,this.names={}}render({_n:e}){return`${this.label}:`+e}}class d extends s{constructor(e){super(),this.label=e,this.names={}}render({_n:e}){return`break${this.label?` ${this.label}`:""};`+e}}class f extends s{constructor(e){super(),this.error=e}render({_n:e}){return`throw ${this.error};`+e}get names(){return this.error.names}}class h extends s{constructor(e){super(),this.code=e}render({_n:e}){return`${this.code};`+e}optimizeNodes(){return`${this.code}`?this:void 0}optimizeNames(e,t){return this.code=R(this.code,e,t),this}get names(){return this.code instanceof r._CodeOrName?this.code.names:{}}}class m extends s{constructor(e=[]){super(),this.nodes=e}render(e){return this.nodes.reduce(((t,n)=>t+n.render(e)),"")}optimizeNodes(){const{nodes:e}=this;let t=e.length;for(;t--;){const n=e[t].optimizeNodes();Array.isArray(n)?e.splice(t,1,...n):n?e[t]=n:e.splice(t,1)}return e.length>0?this:void 0}optimizeNames(e,t){const{nodes:n}=this;let r=n.length;for(;r--;){const o=n[r];o.optimizeNames(e,t)||(j(e,o.names),n.splice(r,1))}return n.length>0?this:void 0}get names(){return this.nodes.reduce(((e,t)=>$(e,t.names)),{})}}class g extends m{render(e){return"{"+e._n+super.render(e)+"}"+e._n}}class y extends m{}class v extends g{}v.kind="else";class b extends g{constructor(e,t){super(t),this.condition=e}render(e){let t=`if(${this.condition})`+super.render(e);return this.else&&(t+="else "+this.else.render(e)),t}optimizeNodes(){super.optimizeNodes();const e=this.condition;if(!0===e)return this.nodes;let t=this.else;if(t){const e=t.optimizeNodes();t=this.else=Array.isArray(e)?new v(e):e}return t?!1===e?t instanceof b?t:t.nodes:this.nodes.length?this:new b(T(e),t instanceof b?[t]:t.nodes):!1!==e&&this.nodes.length?this:void 0}optimizeNames(e,t){var n;if(this.else=null===(n=this.else)||void 0===n?void 0:n.optimizeNames(e,t),super.optimizeNames(e,t)||this.else)return this.condition=R(this.condition,e,t),this}get names(){const e=super.names;return C(e,this.condition),this.else&&$(e,this.else.names),e}}b.kind="if";class w extends g{}w.kind="for";class x extends w{constructor(e){super(),this.iteration=e}render(e){return`for(${this.iteration})`+super.render(e)}optimizeNames(e,t){if(super.optimizeNames(e,t))return this.iteration=R(this.iteration,e,t),this}get names(){return $(super.names,this.iteration.names)}}class k extends w{constructor(e,t,n,r){super(),this.varKind=e,this.name=t,this.from=n,this.to=r}render(e){const t=e.es5?o.varKinds.var:this.varKind,{name:n,from:r,to:i}=this;return`for(${t} ${n}=${r}; ${n}<${i}; ${n}++)`+super.render(e)}get names(){const e=C(super.names,this.from);return C(e,this.to)}}class _ extends w{constructor(e,t,n,r){super(),this.loop=e,this.varKind=t,this.name=n,this.iterable=r}render(e){return`for(${this.varKind} ${this.name} ${this.loop} ${this.iterable})`+super.render(e)}optimizeNames(e,t){if(super.optimizeNames(e,t))return this.iterable=R(this.iterable,e,t),this}get names(){return $(super.names,this.iterable.names)}}class O extends g{constructor(e,t,n){super(),this.name=e,this.args=t,this.async=n}render(e){return`${this.async?"async ":""}function ${this.name}(${this.args})`+super.render(e)}}O.kind="func";class S extends m{render(e){return"return "+super.render(e)}}S.kind="return";class E extends g{render(e){let t="try"+super.render(e);return this.catch&&(t+=this.catch.render(e)),this.finally&&(t+=this.finally.render(e)),t}optimizeNodes(){var e,t;return super.optimizeNodes(),null===(e=this.catch)||void 0===e||e.optimizeNodes(),null===(t=this.finally)||void 0===t||t.optimizeNodes(),this}optimizeNames(e,t){var n,r;return super.optimizeNames(e,t),null===(n=this.catch)||void 0===n||n.optimizeNames(e,t),null===(r=this.finally)||void 0===r||r.optimizeNames(e,t),this}get names(){const e=super.names;return this.catch&&$(e,this.catch.names),this.finally&&$(e,this.finally.names),e}}class P extends g{constructor(e){super(),this.error=e}render(e){return`catch(${this.error})`+super.render(e)}}P.kind="catch";class A extends g{render(e){return"finally"+super.render(e)}}function $(e,t){for(const n in t)e[n]=(e[n]||0)+(t[n]||0);return e}function C(e,t){return t instanceof r._CodeOrName?$(e,t.names):e}function R(e,t,n){return e instanceof r.Name?i(e):(o=e)instanceof r._Code&&o._items.some((e=>e instanceof r.Name&&1===t[e.str]&&void 0!==n[e.str]))?new r._Code(e._items.reduce(((e,t)=>(t instanceof r.Name&&(t=i(t)),t instanceof r._Code?e.push(...t._items):e.push(t),e)),[])):e;var o;function i(e){const r=n[e.str];return void 0===r||1!==t[e.str]?e:(delete t[e.str],r)}}function j(e,t){for(const n in t)e[n]=(e[n]||0)-(t[n]||0)}function T(e){return"boolean"==typeof e||"number"==typeof e||null===e?!e:r._`!${L(e)}`}A.kind="finally",t.CodeGen=class{constructor(e,t={}){this._values={},this._blockStarts=[],this._constants={},this.opts={...t,_n:t.lines?"\n":""},this._extScope=e,this._scope=new o.Scope({parent:e}),this._nodes=[new y]}toString(){return this._root.render(this.opts)}name(e){return this._scope.name(e)}scopeName(e){return this._extScope.name(e)}scopeValue(e,t){const n=this._extScope.value(e,t);return(this._values[n.prefix]||(this._values[n.prefix]=new Set)).add(n),n}getScopeValue(e,t){return this._extScope.getValue(e,t)}scopeRefs(e){return this._extScope.scopeRefs(e,this._values)}scopeCode(){return this._extScope.scopeCode(this._values)}_def(e,t,n,r){const o=this._scope.toName(t);return void 0!==n&&r&&(this._constants[o.str]=n),this._leafNode(new l(e,o,n)),o}const(e,t,n){return this._def(o.varKinds.const,e,t,n)}let(e,t,n){return this._def(o.varKinds.let,e,t,n)}var(e,t,n){return this._def(o.varKinds.var,e,t,n)}assign(e,t,n){return this._leafNode(new c(e,t,n))}add(e,n){return this._leafNode(new u(e,t.operators.ADD,n))}code(e){return"function"==typeof e?e():e!==r.nil&&this._leafNode(new h(e)),this}object(...e){const t=["{"];for(const[n,o]of e)t.length>1&&t.push(","),t.push(n),(n!==o||this.opts.es5)&&(t.push(":"),r.addCodeArg(t,o));return t.push("}"),new r._Code(t)}if(e,t,n){if(this._blockNode(new b(e)),t&&n)this.code(t).else().code(n).endIf();else if(t)this.code(t).endIf();else if(n)throw new Error('CodeGen: "else" body without "then" body');return this}elseIf(e){return this._elseNode(new b(e))}else(){return this._elseNode(new v)}endIf(){return this._endBlockNode(b,v)}_for(e,t){return this._blockNode(e),t&&this.code(t).endFor(),this}for(e,t){return this._for(new x(e),t)}forRange(e,t,n,r,i=(this.opts.es5?o.varKinds.var:o.varKinds.let)){const a=this._scope.toName(e);return this._for(new k(i,a,t,n),(()=>r(a)))}forOf(e,t,n,i=o.varKinds.const){const a=this._scope.toName(e);if(this.opts.es5){const e=t instanceof r.Name?t:this.var("_arr",t);return this.forRange("_i",0,r._`${e}.length`,(t=>{this.var(a,r._`${e}[${t}]`),n(a)}))}return this._for(new _("of",i,a,t),(()=>n(a)))}forIn(e,t,n,i=(this.opts.es5?o.varKinds.var:o.varKinds.const)){if(this.opts.ownProperties)return this.forOf(e,r._`Object.keys(${t})`,n);const a=this._scope.toName(e);return this._for(new _("in",i,a,t),(()=>n(a)))}endFor(){return this._endBlockNode(w)}label(e){return this._leafNode(new p(e))}break(e){return this._leafNode(new d(e))}return(e){const t=new S;if(this._blockNode(t),this.code(e),1!==t.nodes.length)throw new Error('CodeGen: "return" should have one node');return this._endBlockNode(S)}try(e,t,n){if(!t&&!n)throw new Error('CodeGen: "try" without "catch" and "finally"');const r=new E;if(this._blockNode(r),this.code(e),t){const e=this.name("e");this._currNode=r.catch=new P(e),t(e)}return n&&(this._currNode=r.finally=new A,this.code(n)),this._endBlockNode(P,A)}throw(e){return this._leafNode(new f(e))}block(e,t){return this._blockStarts.push(this._nodes.length),e&&this.code(e).endBlock(t),this}endBlock(e){const t=this._blockStarts.pop();if(void 0===t)throw new Error("CodeGen: not in self-balancing block");const n=this._nodes.length-t;if(n<0||void 0!==e&&n!==e)throw new Error(`CodeGen: wrong number of nodes: ${n} vs ${e} expected`);return this._nodes.length=t,this}func(e,t=r.nil,n,o){return this._blockNode(new O(e,t,n)),o&&this.code(o).endFunc(),this}endFunc(){return this._endBlockNode(O)}optimize(e=1){for(;e-- >0;)this._root.optimizeNodes(),this._root.optimizeNames(this._root.names,this._constants)}_leafNode(e){return this._currNode.nodes.push(e),this}_blockNode(e){this._currNode.nodes.push(e),this._nodes.push(e)}_endBlockNode(e,t){const n=this._currNode;if(n instanceof e||t&&n instanceof t)return this._nodes.pop(),this;throw new Error(`CodeGen: not in block "${t?`${e.kind}/${t.kind}`:e.kind}"`)}_elseNode(e){const t=this._currNode;if(!(t instanceof b))throw new Error('CodeGen: "else" without "if"');return this._currNode=t.else=e,this}get _root(){return this._nodes[0]}get _currNode(){const e=this._nodes;return e[e.length-1]}set _currNode(e){const t=this._nodes;t[t.length-1]=e}},t.not=T;const I=D(t.operators.AND);t.and=function(...e){return e.reduce(I)};const N=D(t.operators.OR);function D(e){return(t,n)=>t===r.nil?n:n===r.nil?t:r._`${L(t)} ${e} ${L(n)}`}function L(e){return e instanceof r.Name?e:r._`(${e})`}t.or=function(...e){return e.reduce(N)}},7791:function(e,t,n){"use strict";Object.defineProperty(t,"__esModule",{value:!0}),t.ValueScope=t.ValueScopeName=t.Scope=t.varKinds=t.UsedValueState=void 0;const r=n(4667);class o extends Error{constructor(e){super(`CodeGen: "code" for ${e} not defined`),this.value=e.value}}var i;!function(e){e[e.Started=0]="Started",e[e.Completed=1]="Completed"}(i=t.UsedValueState||(t.UsedValueState={})),t.varKinds={const:new r.Name("const"),let:new r.Name("let"),var:new r.Name("var")};class a{constructor({prefixes:e,parent:t}={}){this._names={},this._prefixes=e,this._parent=t}toName(e){return e instanceof r.Name?e:this.name(e)}name(e){return new r.Name(this._newName(e))}_newName(e){return`${e}${(this._names[e]||this._nameGroup(e)).index++}`}_nameGroup(e){var t,n;if((null===(n=null===(t=this._parent)||void 0===t?void 0:t._prefixes)||void 0===n?void 0:n.has(e))||this._prefixes&&!this._prefixes.has(e))throw new Error(`CodeGen: prefix "${e}" is not allowed in this scope`);return this._names[e]={prefix:e,index:0}}}t.Scope=a;class s extends r.Name{constructor(e,t){super(t),this.prefix=e}setValue(e,{property:t,itemIndex:n}){this.value=e,this.scopePath=r._`.${new r.Name(t)}[${n}]`}}t.ValueScopeName=s;const l=r._`\n`;t.ValueScope=class extends a{constructor(e){super(e),this._values={},this._scope=e.scope,this.opts={...e,_n:e.lines?l:r.nil}}get(){return this._scope}name(e){return new s(e,this._newName(e))}value(e,t){var n;if(void 0===t.ref)throw new Error("CodeGen: ref must be passed in value");const r=this.toName(e),{prefix:o}=r,i=null!==(n=t.key)&&void 0!==n?n:t.ref;let a=this._values[o];if(a){const e=a.get(i);if(e)return e}else a=this._values[o]=new Map;a.set(i,r);const s=this._scope[o]||(this._scope[o]=[]),l=s.length;return s[l]=t.ref,r.setValue(t,{property:o,itemIndex:l}),r}getValue(e,t){const n=this._values[e];if(n)return n.get(t)}scopeRefs(e,t=this._values){return this._reduceValues(t,(t=>{if(void 0===t.scopePath)throw new Error(`CodeGen: name "${t}" has no value`);return r._`${e}${t.scopePath}`}))}scopeCode(e=this._values,t,n){return this._reduceValues(e,(e=>{if(void 0===e.value)throw new Error(`CodeGen: name "${e}" has no value`);return e.value.code}),t,n)}_reduceValues(e,n,a={},s){let l=r.nil;for(const c in e){const u=e[c];if(!u)continue;const p=a[c]=a[c]||new Map;u.forEach((e=>{if(p.has(e))return;p.set(e,i.Started);let a=n(e);if(a){const n=this.opts.es5?t.varKinds.var:t.varKinds.const;l=r._`${l}${n} ${e} = ${a};${this.opts._n}`}else{if(!(a=null==s?void 0:s(e)))throw new o(e);l=r._`${l}${a}${this.opts._n}`}p.set(e,i.Completed)}))}return l}}},1885:function(e,t,n){"use strict";Object.defineProperty(t,"__esModule",{value:!0}),t.extendErrors=t.resetErrorsCount=t.reportExtraError=t.reportError=t.keyword$DataError=t.keywordError=void 0;const r=n(4475),o=n(6124),i=n(5018);function a(e,t){const n=e.const("err",t);e.if(r._`${i.default.vErrors} === null`,(()=>e.assign(i.default.vErrors,r._`[${n}]`)),r._`${i.default.vErrors}.push(${n})`),e.code(r._`${i.default.errors}++`)}function s(e,t){const{gen:n,validateName:o,schemaEnv:i}=e;i.$async?n.throw(r._`new ${e.ValidationError}(${t})`):(n.assign(r._`${o}.errors`,t),n.return(!1))}t.keywordError={message:({keyword:e})=>r.str`should pass "${e}" keyword validation`},t.keyword$DataError={message:({keyword:e,schemaType:t})=>t?r.str`"${e}" keyword must be ${t} ($data)`:r.str`"${e}" keyword is invalid ($data)`},t.reportError=function(e,n=t.keywordError,o,i){const{it:l}=e,{gen:u,compositeRule:p,allErrors:d}=l,f=c(e,n,o);(null!=i?i:p||d)?a(u,f):s(l,r._`[${f}]`)},t.reportExtraError=function(e,n=t.keywordError,r){const{it:o}=e,{gen:l,compositeRule:u,allErrors:p}=o;a(l,c(e,n,r)),u||p||s(o,i.default.vErrors)},t.resetErrorsCount=function(e,t){e.assign(i.default.errors,t),e.if(r._`${i.default.vErrors} !== null`,(()=>e.if(t,(()=>e.assign(r._`${i.default.vErrors}.length`,t)),(()=>e.assign(i.default.vErrors,null)))))},t.extendErrors=function({gen:e,keyword:t,schemaValue:n,data:o,errsCount:a,it:s}){if(void 0===a)throw new Error("ajv implementation error");const l=e.name("err");e.forRange("i",a,i.default.errors,(a=>{e.const(l,r._`${i.default.vErrors}[${a}]`),e.if(r._`${l}.instancePath === undefined`,(()=>e.assign(r._`${l}.instancePath`,r.strConcat(i.default.instancePath,s.errorPath)))),e.assign(r._`${l}.schemaPath`,r.str`${s.errSchemaPath}/${t}`),s.opts.verbose&&(e.assign(r._`${l}.schema`,n),e.assign(r._`${l}.data`,o))}))};const l={keyword:new r.Name("keyword"),schemaPath:new r.Name("schemaPath"),params:new r.Name("params"),propertyName:new r.Name("propertyName"),message:new r.Name("message"),schema:new r.Name("schema"),parentSchema:new r.Name("parentSchema")};function c(e,t,n){const{createErrors:o}=e.it;return!1===o?r._`{}`:function(e,t,n={}){const{gen:o,it:a}=e,s=[u(a,n),p(e,n)];return function(e,{params:t,message:n},o){const{keyword:a,data:s,schemaValue:c,it:u}=e,{opts:p,propertyName:d,topSchemaRef:f,schemaPath:h}=u;o.push([l.keyword,a],[l.params,"function"==typeof t?t(e):t||r._`{}`]),p.messages&&o.push([l.message,"function"==typeof n?n(e):n]),p.verbose&&o.push([l.schema,c],[l.parentSchema,r._`${f}${h}`],[i.default.data,s]),d&&o.push([l.propertyName,d])}(e,t,s),o.object(...s)}(e,t,n)}function u({errorPath:e},{instancePath:t}){const n=t?r.str`${e}${o.getErrorPath(t,o.Type.Str)}`:e;return[i.default.instancePath,r.strConcat(i.default.instancePath,n)]}function p({keyword:e,it:{errSchemaPath:t}},{schemaPath:n,parentSchema:i}){let a=i?t:r.str`${t}/${e}`;return n&&(a=r.str`${a}${o.getErrorPath(n,o.Type.Str)}`),[l.schemaPath,a]}},7805:function(e,t,n){"use strict";Object.defineProperty(t,"__esModule",{value:!0}),t.resolveSchema=t.getCompilingSchema=t.resolveRef=t.compileSchema=t.SchemaEnv=void 0;const r=n(4475),o=n(8451),i=n(5018),a=n(9826),s=n(6124),l=n(1321),c=n(540);class u{constructor(e){var t;let n;this.refs={},this.dynamicAnchors={},"object"==typeof e.schema&&(n=e.schema),this.schema=e.schema,this.schemaId=e.schemaId,this.root=e.root||this,this.baseId=null!==(t=e.baseId)&&void 0!==t?t:a.normalizeId(null==n?void 0:n[e.schemaId||"$id"]),this.schemaPath=e.schemaPath,this.localRefs=e.localRefs,this.meta=e.meta,this.$async=null==n?void 0:n.$async,this.refs={}}}function p(e){const t=f.call(this,e);if(t)return t;const n=a.getFullPath(e.root.baseId),{es5:s,lines:c}=this.opts.code,{ownProperties:u}=this.opts,p=new r.CodeGen(this.scope,{es5:s,lines:c,ownProperties:u});let d;e.$async&&(d=p.scopeValue("Error",{ref:o.default,code:r._`require("ajv/dist/runtime/validation_error").default`}));const h=p.scopeName("validate");e.validateName=h;const m={gen:p,allErrors:this.opts.allErrors,data:i.default.data,parentData:i.default.parentData,parentDataProperty:i.default.parentDataProperty,dataNames:[i.default.data],dataPathArr:[r.nil],dataLevel:0,dataTypes:[],definedProperties:new Set,topSchemaRef:p.scopeValue("schema",!0===this.opts.code.source?{ref:e.schema,code:r.stringify(e.schema)}:{ref:e.schema}),validateName:h,ValidationError:d,schema:e.schema,schemaEnv:e,rootId:n,baseId:e.baseId||n,schemaPath:r.nil,errSchemaPath:e.schemaPath||(this.opts.jtd?"":"#"),errorPath:r._`""`,opts:this.opts,self:this};let g;try{this._compilations.add(e),l.validateFunctionCode(m),p.optimize(this.opts.code.optimize);const t=p.toString();g=`const visitedNodesForRef = new WeakMap(); ${p.scopeRefs(i.default.scope)}return ${t}`,this.opts.code.process&&(g=this.opts.code.process(g,e));const n=new Function(`${i.default.self}`,`${i.default.scope}`,g)(this,this.scope.get());if(this.scope.value(h,{ref:n}),n.errors=null,n.schema=e.schema,n.schemaEnv=e,e.$async&&(n.$async=!0),!0===this.opts.code.source&&(n.source={validateName:h,validateCode:t,scopeValues:p._values}),this.opts.unevaluated){const{props:e,items:t}=m;n.evaluated={props:e instanceof r.Name?void 0:e,items:t instanceof r.Name?void 0:t,dynamicProps:e instanceof r.Name,dynamicItems:t instanceof r.Name},n.source&&(n.source.evaluated=r.stringify(n.evaluated))}return e.validate=n,e}catch(t){throw delete e.validate,delete e.validateName,g&&this.logger.error("Error compiling schema, function code:",g),t}finally{this._compilations.delete(e)}}function d(e){return a.inlineRef(e.schema,this.opts.inlineRefs)?e.schema:e.validate?e:p.call(this,e)}function f(e){for(const r of this._compilations)if(n=e,(t=r).schema===n.schema&&t.root===n.root&&t.baseId===n.baseId)return r;var t,n}function h(e,t){let n;for(;"string"==typeof(n=this.refs[t]);)t=n;return n||this.schemas[t]||m.call(this,e,t)}function m(e,t){const n=c.parse(t),r=a._getFullPath(n);let o=a.getFullPath(e.baseId);if(Object.keys(e.schema).length>0&&r===o)return y.call(this,n,e);const i=a.normalizeId(r),s=this.refs[i]||this.schemas[i];if("string"==typeof s){const t=m.call(this,e,s);if("object"!=typeof(null==t?void 0:t.schema))return;return y.call(this,n,t)}if("object"==typeof(null==s?void 0:s.schema)){if(s.validate||p.call(this,s),i===a.normalizeId(t)){const{schema:t}=s,{schemaId:n}=this.opts,r=t[n];return r&&(o=a.resolveUrl(o,r)),new u({schema:t,schemaId:n,root:e,baseId:o})}return y.call(this,n,s)}}t.SchemaEnv=u,t.compileSchema=p,t.resolveRef=function(e,t,n){var r;const o=a.resolveUrl(t,n),i=e.refs[o];if(i)return i;let s=h.call(this,e,o);if(void 0===s){const n=null===(r=e.localRefs)||void 0===r?void 0:r[o],{schemaId:i}=this.opts;n&&(s=new u({schema:n,schemaId:i,root:e,baseId:t}))}if(void 0===s&&this.opts.loadSchemaSync){const r=this.opts.loadSchemaSync(t,n,o);!r||this.refs[o]||this.schemas[o]||(this.addSchema(r,o,void 0),s=h.call(this,e,o))}return void 0!==s?e.refs[o]=d.call(this,s):void 0},t.getCompilingSchema=f,t.resolveSchema=m;const g=new Set(["properties","patternProperties","enum","dependencies","definitions"]);function y(e,{baseId:t,schema:n,root:r}){var o;if("/"!==(null===(o=e.fragment)||void 0===o?void 0:o[0]))return;for(const r of e.fragment.slice(1).split("/")){if("boolean"==typeof n)return;if(void 0===(n=n[s.unescapeFragment(r)]))return;const e="object"==typeof n&&n[this.opts.schemaId];!g.has(r)&&e&&(t=a.resolveUrl(t,e))}let i;if("boolean"!=typeof n&&n.$ref&&!s.schemaHasRulesButRef(n,this.RULES)){const e=a.resolveUrl(t,n.$ref);i=m.call(this,r,e)}const{schemaId:l}=this.opts;return i=i||new u({schema:n,schemaId:l,root:r,baseId:t}),i.schema!==i.root.schema?i:void 0}},5018:function(e,t,n){"use strict";Object.defineProperty(t,"__esModule",{value:!0});const r=n(4475),o={data:new r.Name("data"),valCxt:new r.Name("valCxt"),instancePath:new r.Name("instancePath"),parentData:new r.Name("parentData"),parentDataProperty:new r.Name("parentDataProperty"),rootData:new r.Name("rootData"),dynamicAnchors:new r.Name("dynamicAnchors"),vErrors:new r.Name("vErrors"),errors:new r.Name("errors"),this:new r.Name("this"),self:new r.Name("self"),scope:new r.Name("scope"),json:new r.Name("json"),jsonPos:new r.Name("jsonPos"),jsonLen:new r.Name("jsonLen"),jsonPart:new r.Name("jsonPart")};t.default=o},4143:function(e,t,n){"use strict";Object.defineProperty(t,"__esModule",{value:!0});const r=n(9826);class o extends Error{constructor(e,t,n){super(n||`can't resolve reference ${t} from id ${e}`),this.missingRef=r.resolveUrl(e,t),this.missingSchema=r.normalizeId(r.getFullPath(this.missingRef))}}t.default=o},9826:function(e,t,n){"use strict";Object.defineProperty(t,"__esModule",{value:!0}),t.getSchemaRefs=t.resolveUrl=t.normalizeId=t._getFullPath=t.getFullPath=t.inlineRef=void 0;const r=n(6124),o=n(4063),i=n(4029),a=n(540),s=new Set(["type","format","pattern","maxLength","minLength","maxProperties","minProperties","maxItems","minItems","maximum","minimum","uniqueItems","multipleOf","required","enum","const"]);t.inlineRef=function(e,t=!0){return"boolean"==typeof e||(!0===t?!c(e):!!t&&u(e)<=t)};const l=new Set(["$ref","$recursiveRef","$recursiveAnchor","$dynamicRef","$dynamicAnchor"]);function c(e){for(const t in e){if(l.has(t))return!0;const n=e[t];if(Array.isArray(n)&&n.some(c))return!0;if("object"==typeof n&&c(n))return!0}return!1}function u(e){let t=0;for(const n in e){if("$ref"===n)return 1/0;if(t++,!s.has(n)&&("object"==typeof e[n]&&r.eachItem(e[n],(e=>t+=u(e))),t===1/0))return 1/0}return t}function p(e="",t){return!1!==t&&(e=h(e)),d(a.parse(e))}function d(e){return a.serialize(e).split("#")[0]+"#"}t.getFullPath=p,t._getFullPath=d;const f=/#\/?$/;function h(e){return e?e.replace(f,""):""}t.normalizeId=h,t.resolveUrl=function(e,t){return t=h(t),a.resolve(e,t)};const m=/^[a-z_][-a-z0-9._]*$/i;t.getSchemaRefs=function(e){if("boolean"==typeof e)return{};const{schemaId:t}=this.opts,n=h(e[t]),r={"":n},s=p(n,!1),l={},c=new Set;return i(e,{allKeys:!0},((e,n,o,i)=>{if(void 0===i)return;const p=s+n;let f=r[i];function g(t){if(t=h(f?a.resolve(f,t):t),c.has(t))throw d(t);c.add(t);let n=this.refs[t];return"string"==typeof n&&(n=this.refs[n]),"object"==typeof n?u(e,n.schema,t):t!==h(p)&&("#"===t[0]?(u(e,l[t],t),l[t]=e):this.refs[t]=p),t}function y(e){if("string"==typeof e){if(!m.test(e))throw new Error(`invalid anchor "${e}"`);g.call(this,`#${e}`)}}"string"==typeof e[t]&&(f=g.call(this,e[t])),y.call(this,e.$anchor),y.call(this,e.$dynamicAnchor),r[n]=f})),l;function u(e,t,n){if(void 0!==t&&!o(e,t))throw d(n)}function d(e){return new Error(`reference "${e}" resolves to more than one schema`)}}},3664:function(e,t){"use strict";Object.defineProperty(t,"__esModule",{value:!0}),t.getRules=t.isJSONType=void 0;const n=new Set(["string","number","integer","boolean","null","object","array"]);t.isJSONType=function(e){return"string"==typeof e&&n.has(e)},t.getRules=function(){const e={number:{type:"number",rules:[]},string:{type:"string",rules:[]},array:{type:"array",rules:[]},object:{type:"object",rules:[]}};return{types:{...e,integer:!0,boolean:!0,null:!0},rules:[{rules:[]},e.number,e.string,e.array,e.object],post:{rules:[]},all:{},keywords:{}}}},6124:function(e,t,n){"use strict";Object.defineProperty(t,"__esModule",{value:!0}),t.checkStrictMode=t.getErrorPath=t.Type=t.useFunc=t.setEvaluated=t.evaluatedPropsToName=t.mergeEvaluated=t.eachItem=t.unescapeJsonPointer=t.escapeJsonPointer=t.escapeFragment=t.unescapeFragment=t.schemaRefOrVal=t.schemaHasRulesButRef=t.schemaHasRules=t.checkUnknownRules=t.alwaysValidSchema=t.toHash=void 0;const r=n(4475),o=n(4667);function i(e,t=e.schema){const{opts:n,self:r}=e;if(!n.strictSchema)return;if("boolean"==typeof t)return;const o=r.RULES.keywords;for(const n in t)o[n]||h(e,`unknown keyword: "${n}"`)}function a(e,t){if("boolean"==typeof e)return!e;for(const n in e)if(t[n])return!0;return!1}function s(e){return"number"==typeof e?`${e}`:e.replace(/~/g,"~0").replace(/\//g,"~1")}function l(e){return e.replace(/~1/g,"/").replace(/~0/g,"~")}function c({mergeNames:e,mergeToName:t,mergeValues:n,resultToName:o}){return(i,a,s,l)=>{const c=void 0===s?a:s instanceof r.Name?(a instanceof r.Name?e(i,a,s):t(i,a,s),s):a instanceof r.Name?(t(i,s,a),a):n(a,s);return l!==r.Name||c instanceof r.Name?c:o(i,c)}}function u(e,t){if(!0===t)return e.var("props",!0);const n=e.var("props",r._`{}`);return void 0!==t&&p(e,n,t),n}function p(e,t,n){Object.keys(n).forEach((n=>e.assign(r._`${t}${r.getProperty(n)}`,!0)))}t.toHash=function(e){const t={};for(const n of e)t[n]=!0;return t},t.alwaysValidSchema=function(e,t){return"boolean"==typeof t?t:0===Object.keys(t).length||(i(e,t),!a(t,e.self.RULES.all))},t.checkUnknownRules=i,t.schemaHasRules=a,t.schemaHasRulesButRef=function(e,t){if("boolean"==typeof e)return!e;for(const n in e)if("$ref"!==n&&t.all[n])return!0;return!1},t.schemaRefOrVal=function({topSchemaRef:e,schemaPath:t},n,o,i){if(!i){if("number"==typeof n||"boolean"==typeof n)return n;if("string"==typeof n)return r._`${n}`}return r._`${e}${t}${r.getProperty(o)}`},t.unescapeFragment=function(e){return l(decodeURIComponent(e))},t.escapeFragment=function(e){return encodeURIComponent(s(e))},t.escapeJsonPointer=s,t.unescapeJsonPointer=l,t.eachItem=function(e,t){if(Array.isArray(e))for(const n of e)t(n);else t(e)},t.mergeEvaluated={props:c({mergeNames:(e,t,n)=>e.if(r._`${n} !== true && ${t} !== undefined`,(()=>{e.if(r._`${t} === true`,(()=>e.assign(n,!0)),(()=>e.assign(n,r._`${n} || {}`).code(r._`Object.assign(${n}, ${t})`)))})),mergeToName:(e,t,n)=>e.if(r._`${n} !== true`,(()=>{!0===t?e.assign(n,!0):(e.assign(n,r._`${n} || {}`),p(e,n,t))})),mergeValues:(e,t)=>!0===e||{...e,...t},resultToName:u}),items:c({mergeNames:(e,t,n)=>e.if(r._`${n} !== true && ${t} !== undefined`,(()=>e.assign(n,r._`${t} === true ? true : ${n} > ${t} ? ${n} : ${t}`))),mergeToName:(e,t,n)=>e.if(r._`${n} !== true`,(()=>e.assign(n,!0===t||r._`${n} > ${t} ? ${n} : ${t}`))),mergeValues:(e,t)=>!0===e||Math.max(e,t),resultToName:(e,t)=>e.var("items",t)})},t.evaluatedPropsToName=u,t.setEvaluated=p;const d={};var f;function h(e,t,n=e.opts.strictSchema){if(n){if(t=`strict mode: ${t}`,!0===n)throw new Error(t);e.self.logger.warn(t)}}t.useFunc=function(e,t){return e.scopeValue("func",{ref:t,code:d[t.code]||(d[t.code]=new o._Code(t.code))})},function(e){e[e.Num=0]="Num",e[e.Str=1]="Str"}(f=t.Type||(t.Type={})),t.getErrorPath=function(e,t,n){if(e instanceof r.Name){const o=t===f.Num;return n?o?r._`"[" + ${e} + "]"`:r._`"['" + ${e} + "']"`:o?r._`"/" + ${e}`:r._`"/" + ${e}.replace(/~/g, "~0").replace(/\\//g, "~1")`}return n?r.getProperty(e).toString():"/"+s(e)},t.checkStrictMode=h},4566:function(e,t){"use strict";function n(e,t){return t.rules.some((t=>r(e,t)))}function r(e,t){var n;return void 0!==e[t.keyword]||(null===(n=t.definition.implements)||void 0===n?void 0:n.some((t=>void 0!==e[t])))}Object.defineProperty(t,"__esModule",{value:!0}),t.shouldUseRule=t.shouldUseGroup=t.schemaHasRulesForType=void 0,t.schemaHasRulesForType=function({schema:e,self:t},r){const o=t.RULES.types[r];return o&&!0!==o&&n(e,o)},t.shouldUseGroup=n,t.shouldUseRule=r},7627:function(e,t,n){"use strict";Object.defineProperty(t,"__esModule",{value:!0}),t.boolOrEmptySchema=t.topBoolOrEmptySchema=void 0;const r=n(1885),o=n(4475),i=n(5018),a={message:"boolean schema is false"};function s(e,t){const{gen:n,data:o}=e,i={gen:n,keyword:"false schema",data:o,schema:!1,schemaCode:!1,schemaValue:!1,params:{},it:e};r.reportError(i,a,void 0,t)}t.topBoolOrEmptySchema=function(e){const{gen:t,schema:n,validateName:r}=e;!1===n?s(e,!1):"object"==typeof n&&!0===n.$async?t.return(i.default.data):(t.assign(o._`${r}.errors`,null),t.return(!0))},t.boolOrEmptySchema=function(e,t){const{gen:n,schema:r}=e;!1===r?(n.var(t,!1),s(e)):n.var(t,!0)}},7927:function(e,t,n){"use strict";Object.defineProperty(t,"__esModule",{value:!0}),t.reportTypeError=t.checkDataTypes=t.checkDataType=t.coerceAndCheckDataType=t.getJSONTypes=t.getSchemaTypes=t.DataType=void 0;const r=n(3664),o=n(4566),i=n(1885),a=n(4475),s=n(6124);var l;function c(e){const t=Array.isArray(e)?e:e?[e]:[];if(t.every(r.isJSONType))return t;throw new Error("type must be JSONType or JSONType[]: "+t.join(","))}!function(e){e[e.Correct=0]="Correct",e[e.Wrong=1]="Wrong"}(l=t.DataType||(t.DataType={})),t.getSchemaTypes=function(e){const t=c(e.type);if(t.includes("null")){if(!1===e.nullable)throw new Error("type: null contradicts nullable: false")}else{if(!t.length&&void 0!==e.nullable)throw new Error('"nullable" cannot be used without "type"');!0===e.nullable&&t.push("null")}return t},t.getJSONTypes=c,t.coerceAndCheckDataType=function(e,t){const{gen:n,data:r,opts:i}=e,s=function(e,t){return t?e.filter((e=>u.has(e)||"array"===t&&"array"===e)):[]}(t,i.coerceTypes),c=t.length>0&&!(0===s.length&&1===t.length&&o.schemaHasRulesForType(e,t[0]));if(c){const o=d(t,r,i.strictNumbers,l.Wrong);n.if(o,(()=>{s.length?function(e,t,n){const{gen:r,data:o,opts:i}=e,s=r.let("dataType",a._`typeof ${o}`),l=r.let("coerced",a._`undefined`);"array"===i.coerceTypes&&r.if(a._`${s} == 'object' && Array.isArray(${o}) && ${o}.length == 1`,(()=>r.assign(o,a._`${o}[0]`).assign(s,a._`typeof ${o}`).if(d(t,o,i.strictNumbers),(()=>r.assign(l,o))))),r.if(a._`${l} !== undefined`);for(const e of n)(u.has(e)||"array"===e&&"array"===i.coerceTypes)&&c(e);function c(e){switch(e){case"string":return void r.elseIf(a._`${s} == "number" || ${s} == "boolean"`).assign(l,a._`"" + ${o}`).elseIf(a._`${o} === null`).assign(l,a._`""`);case"number":return void r.elseIf(a._`${s} == "boolean" || ${o} === null
|| (${s} == "string" && ${o} && ${o} == +${o})`).assign(l,a._`+${o}`);case"integer":return void r.elseIf(a._`${s} === "boolean" || ${o} === null
|| (${s} === "string" && ${o} && ${o} == +${o} && !(${o} % 1))`).assign(l,a._`+${o}`);case"boolean":return void r.elseIf(a._`${o} === "false" || ${o} === 0 || ${o} === null`).assign(l,!1).elseIf(a._`${o} === "true" || ${o} === 1`).assign(l,!0);case"null":return r.elseIf(a._`${o} === "" || ${o} === 0 || ${o} === false`),void r.assign(l,null);case"array":r.elseIf(a._`${s} === "string" || ${s} === "number"
|| ${s} === "boolean" || ${o} === null`).assign(l,a._`[${o}]`)}}r.else(),h(e),r.endIf(),r.if(a._`${l} !== undefined`,(()=>{r.assign(o,l),function({gen:e,parentData:t,parentDataProperty:n},r){e.if(a._`${t} !== undefined`,(()=>e.assign(a._`${t}[${n}]`,r)))}(e,l)}))}(e,t,s):h(e)}))}return c};const u=new Set(["string","number","integer","boolean","null"]);function p(e,t,n,r=l.Correct){const o=r===l.Correct?a.operators.EQ:a.operators.NEQ;let i;switch(e){case"null":return a._`${t} ${o} null`;case"array":i=a._`Array.isArray(${t})`;break;case"object":i=a._`${t} && typeof ${t} == "object" && !Array.isArray(${t})`;break;case"integer":i=s(a._`!(${t} % 1) && !isNaN(${t})`);break;case"number":i=s();break;default:return a._`typeof ${t} ${o} ${e}`}return r===l.Correct?i:a.not(i);function s(e=a.nil){return a.and(a._`typeof ${t} == "number"`,e,n?a._`isFinite(${t})`:a.nil)}}function d(e,t,n,r){if(1===e.length)return p(e[0],t,n,r);let o;const i=s.toHash(e);if(i.array&&i.object){const e=a._`typeof ${t} != "object"`;o=i.null?e:a._`!${t} || ${e}`,delete i.null,delete i.array,delete i.object}else o=a.nil;i.number&&delete i.integer;for(const e in i)o=a.and(o,p(e,t,n,r));return o}t.checkDataType=p,t.checkDataTypes=d;const f={message:({schema:e})=>`must be ${e}`,params:({schema:e,schemaValue:t})=>"string"==typeof e?a._`{type: ${e}}`:a._`{type: ${t}}`};function h(e){const t=function(e){const{gen:t,data:n,schema:r}=e,o=s.schemaRefOrVal(e,r,"type");return{gen:t,keyword:"type",data:n,schema:r.type,schemaCode:o,schemaValue:o,parentSchema:r,params:{},it:e}}(e);i.reportError(t,f)}t.reportTypeError=h},2537:function(e,t,n){"use strict";Object.defineProperty(t,"__esModule",{value:!0}),t.assignDefaults=void 0;const r=n(4475),o=n(6124);function i(e,t,n){const{gen:i,compositeRule:a,data:s,opts:l}=e;if(void 0===n)return;const c=r._`${s}${r.getProperty(t)}`;if(a)return void o.checkStrictMode(e,`default is ignored for: ${c}`);let u=r._`${c} === undefined`;"empty"===l.useDefaults&&(u=r._`${u} || ${c} === null || ${c} === ""`),i.if(u,r._`${c} = ${r.stringify(n)}`)}t.assignDefaults=function(e,t){const{properties:n,items:r}=e.schema;if("object"===t&&n)for(const t in n)i(e,t,n[t].default);else"array"===t&&Array.isArray(r)&&r.forEach(((t,n)=>i(e,n,t.default)))}},1321:function(e,t,n){"use strict";Object.defineProperty(t,"__esModule",{value:!0}),t.getData=t.KeywordCxt=t.validateFunctionCode=void 0;const r=n(7627),o=n(7927),i=n(4566),a=n(7927),s=n(2537),l=n(6488),c=n(4688),u=n(4475),p=n(5018),d=n(9826),f=n(6124),h=n(1885);function m({gen:e,validateName:t,schema:n,schemaEnv:r,opts:o},i){o.code.es5?e.func(t,u._`${p.default.data}, ${p.default.valCxt}`,r.$async,(()=>{e.code(u._`"use strict"; ${g(n,o)}`),function(e,t){e.if(p.default.valCxt,(()=>{e.var(p.default.instancePath,u._`${p.default.valCxt}.${p.default.instancePath}`),e.var(p.default.parentData,u._`${p.default.valCxt}.${p.default.parentData}`),e.var(p.default.parentDataProperty,u._`${p.default.valCxt}.${p.default.parentDataProperty}`),e.var(p.default.rootData,u._`${p.default.valCxt}.${p.default.rootData}`),t.dynamicRef&&e.var(p.default.dynamicAnchors,u._`${p.default.valCxt}.${p.default.dynamicAnchors}`)}),(()=>{e.var(p.default.instancePath,u._`""`),e.var(p.default.parentData,u._`undefined`),e.var(p.default.parentDataProperty,u._`undefined`),e.var(p.default.rootData,p.default.data),t.dynamicRef&&e.var(p.default.dynamicAnchors,u._`{}`)}))}(e,o),e.code(i)})):e.func(t,u._`${p.default.data}, ${function(e){return u._`{${p.default.instancePath}="", ${p.default.parentData}, ${p.default.parentDataProperty}, ${p.default.rootData}=${p.default.data}${e.dynamicRef?u._`, ${p.default.dynamicAnchors}={}`:u.nil}}={}`}(o)}`,r.$async,(()=>e.code(g(n,o)).code(i)))}function g(e,t){const n="object"==typeof e&&e[t.schemaId];return n&&(t.code.source||t.code.process)?u._`/*# sourceURL=${n} */`:u.nil}function y({schema:e,self:t}){if("boolean"==typeof e)return!e;for(const n in e)if(t.RULES.all[n])return!0;return!1}function v(e){return"boolean"!=typeof e.schema}function b(e){f.checkUnknownRules(e),function(e){const{schema:t,errSchemaPath:n,opts:r,self:o}=e;t.$ref&&r.ignoreKeywordsWithRef&&f.schemaHasRulesButRef(t,o.RULES)&&o.logger.warn(`$ref: keywords ignored in schema at path "${n}"`)}(e)}function w(e,t){if(e.opts.jtd)return k(e,[],!1,t);const n=o.getSchemaTypes(e.schema);k(e,n,!o.coerceAndCheckDataType(e,n),t)}function x({gen:e,schemaEnv:t,schema:n,errSchemaPath:r,opts:o}){const i=n.$comment;if(!0===o.$comment)e.code(u._`${p.default.self}.logger.log(${i})`);else if("function"==typeof o.$comment){const n=u.str`${r}/$comment`,o=e.scopeValue("root",{ref:t.root});e.code(u._`${p.default.self}.opts.$comment(${i}, ${n}, ${o}.schema)`)}}function k(e,t,n,r){const{gen:o,schema:s,data:l,allErrors:c,opts:d,self:h}=e,{RULES:m}=h;function g(f){i.shouldUseGroup(s,f)&&(f.type?(o.if(a.checkDataType(f.type,l,d.strictNumbers)),_(e,f),1===t.length&&t[0]===f.type&&n&&(o.else(),a.reportTypeError(e)),o.endIf()):_(e,f),c||o.if(u._`${p.default.errors} === ${r||0}`))}!s.$ref||!d.ignoreKeywordsWithRef&&f.schemaHasRulesButRef(s,m)?(d.jtd||function(e,t){!e.schemaEnv.meta&&e.opts.strictTypes&&(function(e,t){t.length&&(e.dataTypes.length?(t.forEach((t=>{O(e.dataTypes,t)||S(e,`type "${t}" not allowed by context "${e.dataTypes.join(",")}"`)})),e.dataTypes=e.dataTypes.filter((e=>O(t,e)))):e.dataTypes=t)}(e,t),e.opts.allowUnionTypes||function(e,t){t.length>1&&(2!==t.length||!t.includes("null"))&&S(e,"use allowUnionTypes to allow union type keyword")}(e,t),function(e,t){const n=e.self.RULES.all;for(const r in n){const o=n[r];if("object"==typeof o&&i.shouldUseRule(e.schema,o)){const{type:n}=o.definition;n.length&&!n.some((e=>{return r=e,(n=t).includes(r)||"number"===r&&n.includes("integer");var n,r}))&&S(e,`missing type "${n.join(",")}" for keyword "${r}"`)}}}(e,e.dataTypes))}(e,t),o.block((()=>{for(const e of m.rules)g(e);g(m.post)}))):o.block((()=>P(e,"$ref",m.all.$ref.definition)))}function _(e,t){const{gen:n,schema:r,opts:{useDefaults:o}}=e;o&&s.assignDefaults(e,t.type),n.block((()=>{for(const n of t.rules)i.shouldUseRule(r,n)&&P(e,n.keyword,n.definition,t.type)}))}function O(e,t){return e.includes(t)||"integer"===t&&e.includes("number")}function S(e,t){t+=` at "${e.schemaEnv.baseId+e.errSchemaPath}" (strictTypes)`,f.checkStrictMode(e,t,e.opts.strictTypes)}t.validateFunctionCode=function(e){v(e)&&(b(e),y(e))?function(e){const{schema:t,opts:n,gen:r}=e;m(e,(()=>{n.$comment&&t.$comment&&x(e),function(e){const{schema:t,opts:n}=e;void 0!==t.default&&n.useDefaults&&n.strictSchema&&f.checkStrictMode(e,"default is ignored in the schema root")}(e),r.let(p.default.vErrors,null),r.let(p.default.errors,0),n.unevaluated&&function(e){const{gen:t,validateName:n}=e;e.evaluated=t.const("evaluated",u._`${n}.evaluated`),t.if(u._`${e.evaluated}.dynamicProps`,(()=>t.assign(u._`${e.evaluated}.props`,u._`undefined`))),t.if(u._`${e.evaluated}.dynamicItems`,(()=>t.assign(u._`${e.evaluated}.items`,u._`undefined`)))}(e),w(e),function(e){const{gen:t,schemaEnv:n,validateName:r,ValidationError:o,opts:i}=e;n.$async?t.if(u._`${p.default.errors} === 0`,(()=>t.return(p.default.data)),(()=>t.throw(u._`new ${o}(${p.default.vErrors})`))):(t.assign(u._`${r}.errors`,p.default.vErrors),i.unevaluated&&function({gen:e,evaluated:t,props:n,items:r}){n instanceof u.Name&&e.assign(u._`${t}.props`,n),r instanceof u.Name&&e.assign(u._`${t}.items`,r)}(e),t.return(u._`${p.default.errors} === 0`))}(e)}))}(e):m(e,(()=>r.topBoolOrEmptySchema(e)))};class E{constructor(e,t,n){if(l.validateKeywordUsage(e,t,n),this.gen=e.gen,this.allErrors=e.allErrors,this.keyword=n,this.data=e.data,this.schema=e.schema[n],this.$data=t.$data&&e.opts.$data&&this.schema&&this.schema.$data,this.schemaValue=f.schemaRefOrVal(e,this.schema,n,this.$data),this.schemaType=t.schemaType,this.parentSchema=e.schema,this.params={},this.it=e,this.def=t,this.$data)this.schemaCode=e.gen.const("vSchema",C(this.$data,e));else if(this.schemaCode=this.schemaValue,!l.validSchemaType(this.schema,t.schemaType,t.allowUndefined))throw new Error(`${n} value must be ${JSON.stringify(t.schemaType)}`);("code"in t?t.trackErrors:!1!==t.errors)&&(this.errsCount=e.gen.const("_errs",p.default.errors))}result(e,t,n){this.gen.if(u.not(e)),n?n():this.error(),t?(this.gen.else(),t(),this.allErrors&&this.gen.endIf()):this.allErrors?this.gen.endIf():this.gen.else()}pass(e,t){this.result(e,void 0,t)}fail(e){if(void 0===e)return this.error(),void(this.allErrors||this.gen.if(!1));this.gen.if(e),this.error(),this.allErrors?this.gen.endIf():this.gen.else()}fail$data(e){if(!this.$data)return this.fail(e);const{schemaCode:t}=this;this.fail(u._`${t} !== undefined && (${u.or(this.invalid$data(),e)})`)}error(e,t,n){if(t)return this.setParams(t),this._error(e,n),void this.setParams({});this._error(e,n)}_error(e,t){(e?h.reportExtraError:h.reportError)(this,this.def.error,t)}$dataError(){h.reportError(this,this.def.$dataError||h.keyword$DataError)}reset(){if(void 0===this.errsCount)throw new Error('add "trackErrors" to keyword definition');h.resetErrorsCount(this.gen,this.errsCount)}ok(e){this.allErrors||this.gen.if(e)}setParams(e,t){t?Object.assign(this.params,e):this.params=e}block$data(e,t,n=u.nil){this.gen.block((()=>{this.check$data(e,n),t()}))}check$data(e=u.nil,t=u.nil){if(!this.$data)return;const{gen:n,schemaCode:r,schemaType:o,def:i}=this;n.if(u.or(u._`${r} === undefined`,t)),e!==u.nil&&n.assign(e,!0),(o.length||i.validateSchema)&&(n.elseIf(this.invalid$data()),this.$dataError(),e!==u.nil&&n.assign(e,!1)),n.else()}invalid$data(){const{gen:e,schemaCode:t,schemaType:n,def:r,it:o}=this;return u.or(function(){if(n.length){if(!(t instanceof u.Name))throw new Error("ajv implementation error");const e=Array.isArray(n)?n:[n];return u._`${a.checkDataTypes(e,t,o.opts.strictNumbers,a.DataType.Wrong)}`}return u.nil}(),function(){if(r.validateSchema){const n=e.scopeValue("validate$data",{ref:r.validateSchema});return u._`!${n}(${t})`}return u.nil}())}subschema(e,t){const n=c.getSubschema(this.it,e);c.extendSubschemaData(n,this.it,e),c.extendSubschemaMode(n,e);const o={...this.it,...n,items:void 0,props:void 0};return function(e,t){v(e)&&(b(e),y(e))?function(e,t){const{schema:n,gen:r,opts:o}=e;o.$comment&&n.$comment&&x(e),function(e){const t=e.schema[e.opts.schemaId];t&&(e.baseId=d.resolveUrl(e.baseId,t))}(e),function(e){if(e.schema.$async&&!e.schemaEnv.$async)throw new Error("async schema in sync schema")}(e);const i=r.const("_errs",p.default.errors);w(e,i),r.var(t,u._`${i} === ${p.default.errors}`)}(e,t):r.boolOrEmptySchema(e,t)}(o,t),o}mergeEvaluated(e,t){const{it:n,gen:r}=this;n.opts.unevaluated&&(!0!==n.props&&void 0!==e.props&&(n.props=f.mergeEvaluated.props(r,e.props,n.props,t)),!0!==n.items&&void 0!==e.items&&(n.items=f.mergeEvaluated.items(r,e.items,n.items,t)))}mergeValidEvaluated(e,t){const{it:n,gen:r}=this;if(n.opts.unevaluated&&(!0!==n.props||!0!==n.items))return r.if(t,(()=>this.mergeEvaluated(e,u.Name))),!0}}function P(e,t,n,r){const o=new E(e,n,t);"code"in n?n.code(o,r):o.$data&&n.validate?l.funcKeywordCode(o,n):"macro"in n?l.macroKeywordCode(o,n):(n.compile||n.validate)&&l.funcKeywordCode(o,n)}t.KeywordCxt=E;const A=/^\/(?:[^~]|~0|~1)*$/,$=/^([0-9]+)(#|\/(?:[^~]|~0|~1)*)?$/;function C(e,{dataLevel:t,dataNames:n,dataPathArr:r}){let o,i;if(""===e)return p.default.rootData;if("/"===e[0]){if(!A.test(e))throw new Error(`Invalid JSON-pointer: ${e}`);o=e,i=p.default.rootData}else{const a=$.exec(e);if(!a)throw new Error(`Invalid JSON-pointer: ${e}`);const s=+a[1];if(o=a[2],"#"===o){if(s>=t)throw new Error(l("property/index",s));return r[t-s]}if(s>t)throw new Error(l("data",s));if(i=n[t-s],!o)return i}let a=i;const s=o.split("/");for(const e of s)e&&(i=u._`${i}${u.getProperty(f.unescapeJsonPointer(e))}`,a=u._`${a} && ${i}`);return a;function l(e,n){return`Cannot access ${e} ${n} levels up, current level is ${t}`}}t.getData=C},6488:function(e,t,n){"use strict";Object.defineProperty(t,"__esModule",{value:!0}),t.validateKeywordUsage=t.validSchemaType=t.funcKeywordCode=t.macroKeywordCode=void 0;const r=n(4475),o=n(5018),i=n(8619),a=n(1885);function s(e){const{gen:t,data:n,it:o}=e;t.if(o.parentData,(()=>t.assign(n,r._`${o.parentData}[${o.parentDataProperty}]`)))}function l(e,t,n){if(void 0===n)throw new Error(`keyword "${t}" failed to compile`);return e.scopeValue("keyword","function"==typeof n?{ref:n}:{ref:n,code:r.stringify(n)})}t.macroKeywordCode=function(e,t){const{gen:n,keyword:o,schema:i,parentSchema:a,it:s}=e,c=t.macro.call(s.self,i,a,s),u=l(n,o,c);!1!==s.opts.validateSchema&&s.self.validateSchema(c,!0);const p=n.name("valid");e.subschema({schema:c,schemaPath:r.nil,errSchemaPath:`${s.errSchemaPath}/${o}`,topSchemaRef:u,compositeRule:!0},p),e.pass(p,(()=>e.error(!0)))},t.funcKeywordCode=function(e,t){var n;const{gen:c,keyword:u,schema:p,parentSchema:d,$data:f,it:h}=e;!function({schemaEnv:e},t){if(t.async&&!e.$async)throw new Error("async keyword in sync schema")}(h,t);const m=!f&&t.compile?t.compile.call(h.self,p,d,h):t.validate,g=l(c,u,m),y=c.let("valid");function v(n=(t.async?r._`await `:r.nil)){const a=h.opts.passContext?o.default.this:o.default.self,s=!("compile"in t&&!f||!1===t.schema);c.assign(y,r._`${n}${i.callValidateCode(e,g,a,s)}`,t.modifying)}function b(e){var n;c.if(r.not(null!==(n=t.valid)&&void 0!==n?n:y),e)}e.block$data(y,(function(){if(!1===t.errors)v(),t.modifying&&s(e),b((()=>e.error()));else{const n=t.async?function(){const e=c.let("ruleErrs",null);return c.try((()=>v(r._`await `)),(t=>c.assign(y,!1).if(r._`${t} instanceof ${h.ValidationError}`,(()=>c.assign(e,r._`${t}.errors`)),(()=>c.throw(t))))),e}():function(){const e=r._`${g}.errors`;return c.assign(e,null),v(r.nil),e}();t.modifying&&s(e),b((()=>function(e,t){const{gen:n}=e;n.if(r._`Array.isArray(${t})`,(()=>{n.assign(o.default.vErrors,r._`${o.default.vErrors} === null ? ${t} : ${o.default.vErrors}.concat(${t})`).assign(o.default.errors,r._`${o.default.vErrors}.length`),a.extendErrors(e)}),(()=>e.error()))}(e,n)))}})),e.ok(null!==(n=t.valid)&&void 0!==n?n:y)},t.validSchemaType=function(e,t,n=!1){return!t.length||t.some((t=>"array"===t?Array.isArray(e):"object"===t?e&&"object"==typeof e&&!Array.isArray(e):typeof e==t||n&&void 0===e))},t.validateKeywordUsage=function({schema:e,opts:t,self:n,errSchemaPath:r},o,i){if(Array.isArray(o.keyword)?!o.keyword.includes(i):o.keyword!==i)throw new Error("ajv implementation error");const a=o.dependencies;if(null==a?void 0:a.some((t=>!Object.prototype.hasOwnProperty.call(e,t))))throw new Error(`parent schema must have dependencies of ${i}: ${a.join(",")}`);if(o.validateSchema&&!o.validateSchema(e[i])){const e=`keyword "${i}" value is invalid at path "${r}": `+n.errorsText(o.validateSchema.errors);if("log"!==t.validateSchema)throw new Error(e);n.logger.error(e)}}},4688:function(e,t,n){"use strict";Object.defineProperty(t,"__esModule",{value:!0}),t.extendSubschemaMode=t.extendSubschemaData=t.getSubschema=void 0;const r=n(4475),o=n(6124);t.getSubschema=function(e,{keyword:t,schemaProp:n,schema:i,schemaPath:a,errSchemaPath:s,topSchemaRef:l}){if(void 0!==t&&void 0!==i)throw new Error('both "keyword" and "schema" passed, only one allowed');if(void 0!==t){const i=e.schema[t];return void 0===n?{schema:i,schemaPath:r._`${e.schemaPath}${r.getProperty(t)}`,errSchemaPath:`${e.errSchemaPath}/${t}`}:{schema:i[n],schemaPath:r._`${e.schemaPath}${r.getProperty(t)}${r.getProperty(n)}`,errSchemaPath:`${e.errSchemaPath}/${t}/${o.escapeFragment(n)}`}}if(void 0!==i){if(void 0===a||void 0===s||void 0===l)throw new Error('"schemaPath", "errSchemaPath" and "topSchemaRef" are required with "schema"');return{schema:i,schemaPath:a,topSchemaRef:l,errSchemaPath:s}}throw new Error('either "keyword" or "schema" must be passed')},t.extendSubschemaData=function(e,t,{dataProp:n,dataPropType:i,data:a,dataTypes:s,propertyName:l}){if(void 0!==a&&void 0!==n)throw new Error('both "data" and "dataProp" passed, only one allowed');const{gen:c}=t;if(void 0!==n){const{errorPath:a,dataPathArr:s,opts:l}=t;u(c.let("data",r._`${t.data}${r.getProperty(n)}`,!0)),e.errorPath=r.str`${a}${o.getErrorPath(n,i,l.jsPropertySyntax)}`,e.parentDataProperty=r._`${n}`,e.dataPathArr=[...s,e.parentDataProperty]}function u(n){e.data=n,e.dataLevel=t.dataLevel+1,e.dataTypes=[],t.definedProperties=new Set,e.parentData=t.data,e.dataNames=[...t.dataNames,n]}void 0!==a&&(u(a instanceof r.Name?a:c.let("data",a,!0)),void 0!==l&&(e.propertyName=l)),s&&(e.dataTypes=s)},t.extendSubschemaMode=function(e,{jtdDiscriminator:t,jtdMetadata:n,compositeRule:r,createErrors:o,allErrors:i}){void 0!==r&&(e.compositeRule=r),void 0!==o&&(e.createErrors=o),void 0!==i&&(e.allErrors=i),e.jtdDiscriminator=t,e.jtdMetadata=n}},3325:function(e,t,n){"use strict";Object.defineProperty(t,"__esModule",{value:!0}),t.CodeGen=t.Name=t.nil=t.stringify=t.str=t._=t.KeywordCxt=void 0;var r=n(1321);Object.defineProperty(t,"KeywordCxt",{enumerable:!0,get:function(){return r.KeywordCxt}});var o=n(4475);Object.defineProperty(t,"_",{enumerable:!0,get:function(){return o._}}),Object.defineProperty(t,"str",{enumerable:!0,get:function(){return o.str}}),Object.defineProperty(t,"stringify",{enumerable:!0,get:function(){return o.stringify}}),Object.defineProperty(t,"nil",{enumerable:!0,get:function(){return o.nil}}),Object.defineProperty(t,"Name",{enumerable:!0,get:function(){return o.Name}}),Object.defineProperty(t,"CodeGen",{enumerable:!0,get:function(){return o.CodeGen}});const i=n(8451),a=n(4143),s=n(3664),l=n(7805),c=n(4475),u=n(9826),p=n(7927),d=n(6124),f=n(425),h=["removeAdditional","useDefaults","coerceTypes"],m=new Set(["validate","serialize","parse","wrapper","root","schema","keyword","pattern","formats","validate$data","func","obj","Error"]),g={errorDataPath:"",format:"`validateFormats: false` can be used instead.",nullable:'"nullable" keyword is supported by default.',jsonPointers:"Deprecated jsPropertySyntax can be used instead.",extendRefs:"Deprecated ignoreKeywordsWithRef can be used instead.",missingRefs:"Pass empty schema with $id that should be ignored to ajv.addSchema.",processCode:"Use option `code: {process: (code, schemaEnv: object) => string}`",sourceCode:"Use option `code: {source: true}`",strictDefaults:"It is default now, see option `strict`.",strictKeywords:"It is default now, see option `strict`.",uniqueItems:'"uniqueItems" keyword is always validated.',unknownFormats:"Disable strict mode or pass `true` to `ajv.addFormat` (or `formats` option).",cache:"Map is used as cache, schema object as key.",serialize:"Map is used as cache, schema object as key.",ajvErrors:"It is default now."},y={ignoreKeywordsWithRef:"",jsPropertySyntax:"",unicode:'"minLength"/"maxLength" account for unicode characters by default.'};function v(e){var t,n,r,o,i,a,s,l,c,u,p,d,f,h,m,g,y,v,b,w,x,k;const _=e.strict,O=null===(t=e.code)||void 0===t?void 0:t.optimize,S=!0===O||void 0===O?1:O||0;return{strictSchema:null===(r=null!==(n=e.strictSchema)&&void 0!==n?n:_)||void 0===r||r,strictNumbers:null===(i=null!==(o=e.strictNumbers)&&void 0!==o?o:_)||void 0===i||i,strictTypes:null!==(s=null!==(a=e.strictTypes)&&void 0!==a?a:_)&&void 0!==s?s:"log",strictTuples:null!==(c=null!==(l=e.strictTuples)&&void 0!==l?l:_)&&void 0!==c?c:"log",strictRequired:null!==(p=null!==(u=e.strictRequired)&&void 0!==u?u:_)&&void 0!==p&&p,code:e.code?{...e.code,optimize:S}:{optimize:S},loopRequired:null!==(d=e.loopRequired)&&void 0!==d?d:200,loopEnum:null!==(f=e.loopEnum)&&void 0!==f?f:200,meta:null===(h=e.meta)||void 0===h||h,messages:null===(m=e.messages)||void 0===m||m,inlineRefs:null===(g=e.inlineRefs)||void 0===g||g,schemaId:null!==(y=e.schemaId)&&void 0!==y?y:"$id",addUsedSchema:null===(v=e.addUsedSchema)||void 0===v||v,validateSchema:null===(b=e.validateSchema)||void 0===b||b,validateFormats:null===(w=e.validateFormats)||void 0===w||w,unicodeRegExp:null===(x=e.unicodeRegExp)||void 0===x||x,int32range:null===(k=e.int32range)||void 0===k||k}}class b{constructor(e={}){this.schemas={},this.refs={},this.formats={},this._compilations=new Set,this._loading={},this._cache=new Map,e=this.opts={...e,...v(e)};const{es5:t,lines:n}=this.opts.code;this.scope=new c.ValueScope({scope:{},prefixes:m,es5:t,lines:n}),this.logger=function(e){if(!1===e)return E;if(void 0===e)return console;if(e.log&&e.warn&&e.error)return e;throw new Error("logger must implement log, warn and error methods")}(e.logger);const r=e.validateFormats;e.validateFormats=!1,this.RULES=s.getRules(),w.call(this,g,e,"NOT SUPPORTED"),w.call(this,y,e,"DEPRECATED","warn"),this._metaOpts=S.call(this),e.formats&&_.call(this),this._addVocabularies(),this._addDefaultMetaSchema(),e.keywords&&O.call(this,e.keywords),"object"==typeof e.meta&&this.addMetaSchema(e.meta),k.call(this),e.validateFormats=r}_addVocabularies(){this.addKeyword("$async")}_addDefaultMetaSchema(){const{$data:e,meta:t,schemaId:n}=this.opts;let r=f;"id"===n&&(r={...f},r.id=r.$id,delete r.$id),t&&e&&this.addMetaSchema(r,r[n],!1)}defaultMeta(){const{meta:e,schemaId:t}=this.opts;return this.opts.defaultMeta="object"==typeof e?e[t]||e:void 0}validate(e,t){let n;if("string"==typeof e){if(n=this.getSchema(e),!n)throw new Error(`no schema with key or ref "${e}"`)}else n=this.compile(e);const r=n(t);return"$async"in n||(this.errors=n.errors),r}compile(e,t){const n=this._addSchema(e,t);return n.validate||this._compileSchemaEnv(n)}compileAsync(e,t){if("function"!=typeof this.opts.loadSchema)throw new Error("options.loadSchema should be a function");const{loadSchema:n}=this.opts;return r.call(this,e,t);async function r(e,t){await o.call(this,e.$schema);const n=this._addSchema(e,t);return n.validate||i.call(this,n)}async function o(e){e&&!this.getSchema(e)&&await r.call(this,{$ref:e},!0)}async function i(e){try{return this._compileSchemaEnv(e)}catch(t){if(!(t instanceof a.default))throw t;return s.call(this,t),await l.call(this,t.missingSchema),i.call(this,e)}}function s({missingSchema:e,missingRef:t}){if(this.refs[e])throw new Error(`AnySchema ${e} is loaded but ${t} cannot be resolved`)}async function l(e){const n=await c.call(this,e);this.refs[e]||await o.call(this,n.$schema),this.refs[e]||this.addSchema(n,e,t)}async function c(e){const t=this._loading[e];if(t)return t;try{return await(this._loading[e]=n(e))}finally{delete this._loading[e]}}}addSchema(e,t,n,r=this.opts.validateSchema){if(Array.isArray(e)){for(const t of e)this.addSchema(t,void 0,n,r);return this}let o;if("object"==typeof e){const{schemaId:t}=this.opts;if(o=e[t],void 0!==o&&"string"!=typeof o)throw new Error(`schema ${t} must be string`)}return t=u.normalizeId(t||o),this._checkUnique(t),this.schemas[t]=this._addSchema(e,n,t,r,!0),this}addMetaSchema(e,t,n=this.opts.validateSchema){return this.addSchema(e,t,!0,n),this}validateSchema(e,t){if("boolean"==typeof e)return!0;let n;if(n=e.$schema,void 0!==n&&"string"!=typeof n)throw new Error("$schema must be a string");if(n=n||this.opts.defaultMeta||this.defaultMeta(),!n)return this.logger.warn("meta-schema not available"),this.errors=null,!0;const r=this.validate(n,e);if(!r&&t){const e="schema is invalid: "+this.errorsText();if("log"!==this.opts.validateSchema)throw new Error(e);this.logger.error(e)}return r}getSchema(e){let t;for(;"string"==typeof(t=x.call(this,e));)e=t;if(void 0===t){const{schemaId:n}=this.opts,r=new l.SchemaEnv({schema:{},schemaId:n});if(t=l.resolveSchema.call(this,r,e),!t)return;this.refs[e]=t}return t.validate||this._compileSchemaEnv(t)}removeSchema(e){if(e instanceof RegExp)return this._removeAllSchemas(this.schemas,e),this._removeAllSchemas(this.refs,e),this;switch(typeof e){case"undefined":return this._removeAllSchemas(this.schemas),this._removeAllSchemas(this.refs),this._cache.clear(),this;case"string":{const t=x.call(this,e);return"object"==typeof t&&this._cache.delete(t.schema),delete this.schemas[e],delete this.refs[e],this}case"object":{const t=e;this._cache.delete(t);let n=e[this.opts.schemaId];return n&&(n=u.normalizeId(n),delete this.schemas[n],delete this.refs[n]),this}default:throw new Error("ajv.removeSchema: invalid parameter")}}addVocabulary(e){for(const t of e)this.addKeyword(t);return this}addKeyword(e,t){let n;if("string"==typeof e)n=e,"object"==typeof t&&(this.logger.warn("these parameters are deprecated, see docs for addKeyword"),t.keyword=n);else{if("object"!=typeof e||void 0!==t)throw new Error("invalid addKeywords parameters");if(n=(t=e).keyword,Array.isArray(n)&&!n.length)throw new Error("addKeywords: keyword must be string or non-empty array")}if(A.call(this,n,t),!t)return d.eachItem(n,(e=>$.call(this,e))),this;R.call(this,t);const r={...t,type:p.getJSONTypes(t.type),schemaType:p.getJSONTypes(t.schemaType)};return d.eachItem(n,0===r.type.length?e=>$.call(this,e,r):e=>r.type.forEach((t=>$.call(this,e,r,t)))),this}getKeyword(e){const t=this.RULES.all[e];return"object"==typeof t?t.definition:!!t}removeKeyword(e){const{RULES:t}=this;delete t.keywords[e],delete t.all[e];for(const n of t.rules){const t=n.rules.findIndex((t=>t.keyword===e));t>=0&&n.rules.splice(t,1)}return this}addFormat(e,t){return"string"==typeof t&&(t=new RegExp(t)),this.formats[e]=t,this}errorsText(e=this.errors,{separator:t=", ",dataVar:n="data"}={}){return e&&0!==e.length?e.map((e=>`${n}${e.instancePath} ${e.message}`)).reduce(((e,n)=>e+t+n)):"No errors"}$dataMetaSchema(e,t){const n=this.RULES.all;e=JSON.parse(JSON.stringify(e));for(const r of t){const t=r.split("/").slice(1);let o=e;for(const e of t)o=o[e];for(const e in n){const t=n[e];if("object"!=typeof t)continue;const{$data:r}=t.definition,i=o[e];r&&i&&(o[e]=T(i))}}return e}_removeAllSchemas(e,t){for(const n in e){const r=e[n];t&&!t.test(n)||("string"==typeof r?delete e[n]:r&&!r.meta&&(this._cache.delete(r.schema),delete e[n]))}}_addSchema(e,t,n,r=this.opts.validateSchema,o=this.opts.addUsedSchema){let i;const{schemaId:a}=this.opts;if("object"==typeof e)i=e[a];else{if(this.opts.jtd)throw new Error("schema must be object");if("boolean"!=typeof e)throw new Error("schema must be object or boolean")}let s=this._cache.get(e);if(void 0!==s)return s;const c=u.getSchemaRefs.call(this,e);return n=u.normalizeId(i||n),s=new l.SchemaEnv({schema:e,schemaId:a,meta:t,baseId:n,localRefs:c}),this._cache.set(s.schema,s),o&&!n.startsWith("#")&&(n&&this._checkUnique(n),this.refs[n]=s),r&&this.validateSchema(e,!0),s}_checkUnique(e){if(this.schemas[e]||this.refs[e])throw new Error(`schema with key or id "${e}" already exists`)}_compileSchemaEnv(e){if(e.meta?this._compileMetaSchema(e):l.compileSchema.call(this,e),!e.validate)throw new Error("ajv implementation error");return e.validate}_compileMetaSchema(e){const t=this.opts;this.opts=this._metaOpts;try{l.compileSchema.call(this,e)}finally{this.opts=t}}}function w(e,t,n,r="error"){for(const o in e){const i=o;i in t&&this.logger[r](`${n}: option ${o}. ${e[i]}`)}}function x(e){return e=u.normalizeId(e),this.schemas[e]||this.refs[e]}function k(){const e=this.opts.schemas;if(e)if(Array.isArray(e))this.addSchema(e);else for(const t in e)this.addSchema(e[t],t)}function _(){for(const e in this.opts.formats){const t=this.opts.formats[e];t&&this.addFormat(e,t)}}function O(e){if(Array.isArray(e))this.addVocabulary(e);else{this.logger.warn("keywords option as map is deprecated, pass array");for(const t in e){const n=e[t];n.keyword||(n.keyword=t),this.addKeyword(n)}}}function S(){const e={...this.opts};for(const t of h)delete e[t];return e}t.default=b,b.ValidationError=i.default,b.MissingRefError=a.default;const E={log(){},warn(){},error(){}},P=/^[a-z_$][a-z0-9_$:-]*$/i;function A(e,t){const{RULES:n}=this;if(d.eachItem(e,(e=>{if(n.keywords[e])throw new Error(`Keyword ${e} is already defined`);if(!P.test(e))throw new Error(`Keyword ${e} has invalid name`)})),t&&t.$data&&!("code"in t)&&!("validate"in t))throw new Error('$data keyword must have "code" or "validate" function')}function $(e,t,n){var r;const o=null==t?void 0:t.post;if(n&&o)throw new Error('keyword with "post" flag cannot have "type"');const{RULES:i}=this;let a=o?i.post:i.rules.find((({type:e})=>e===n));if(a||(a={type:n,rules:[]},i.rules.push(a)),i.keywords[e]=!0,!t)return;const s={keyword:e,definition:{...t,type:p.getJSONTypes(t.type),schemaType:p.getJSONTypes(t.schemaType)}};t.before?C.call(this,a,s,t.before):a.rules.push(s),i.all[e]=s,null===(r=t.implements)||void 0===r||r.forEach((e=>this.addKeyword(e)))}function C(e,t,n){const r=e.rules.findIndex((e=>e.keyword===n));r>=0?e.rules.splice(r,0,t):(e.rules.push(t),this.logger.warn(`rule ${n} is not defined`))}function R(e){let{metaSchema:t}=e;void 0!==t&&(e.$data&&this.opts.$data&&(t=T(t)),e.validateSchema=this.compile(t,!0))}const j={$ref:"https://raw.githubusercontent.com/ajv-validator/ajv/master/lib/refs/data.json#"};function T(e){return{anyOf:[e,j]}}},412:function(e,t,n){"use strict";Object.defineProperty(t,"__esModule",{value:!0});const r=n(4063);r.code='require("ajv/dist/runtime/equal").default',t.default=r},5872:function(e,t){"use strict";function n(e){const t=e.length;let n,r=0,o=0;for(;o<t;)r++,n=e.charCodeAt(o++),n>=55296&&n<=56319&&o<t&&(n=e.charCodeAt(o),56320==(64512&n)&&o++);return r}Object.defineProperty(t,"__esModule",{value:!0}),t.default=n,n.code='require("ajv/dist/runtime/ucs2length").default'},8451:function(e,t){"use strict";Object.defineProperty(t,"__esModule",{value:!0});class n extends Error{constructor(e){super("validation failed"),this.errors=e,this.ajv=this.validation=!0}}t.default=n},3074:function(e,t,n){"use strict";Object.defineProperty(t,"__esModule",{value:!0}),t.validateAdditionalItems=void 0;const r=n(4475),o=n(6124),i={keyword:"additionalItems",type:"array",schemaType:["boolean","object"],before:"uniqueItems",error:{message:({params:{len:e}})=>r.str`must NOT have more than ${e} items`,params:({params:{len:e}})=>r._`{limit: ${e}}`},code(e){const{parentSchema:t,it:n}=e,{items:r}=t;Array.isArray(r)?a(e,r):o.checkStrictMode(n,'"additionalItems" is ignored when "items" is not an array of schemas')}};function a(e,t){const{gen:n,schema:i,data:a,keyword:s,it:l}=e;l.items=!0;const c=n.const("len",r._`${a}.length`);if(!1===i)e.setParams({len:t.length}),e.pass(r._`${c} <= ${t.length}`);else if("object"==typeof i&&!o.alwaysValidSchema(l,i)){const i=n.var("valid",r._`${c} <= ${t.length}`);n.if(r.not(i),(()=>function(i){n.forRange("i",t.length,c,(t=>{e.subschema({keyword:s,dataProp:t,dataPropType:o.Type.Num},i),l.allErrors||n.if(r.not(i),(()=>n.break()))}))}(i))),e.ok(i)}}t.validateAdditionalItems=a,t.default=i},1422:function(e,t,n){"use strict";Object.defineProperty(t,"__esModule",{value:!0});const r=n(8619),o=n(4475),i=n(5018),a=n(6124),s={keyword:"additionalProperties",type:["object"],schemaType:["boolean","object"],allowUndefined:!0,trackErrors:!0,error:{message:"must NOT have additional properties",params:({params:e})=>o._`{additionalProperty: ${e.additionalProperty}}`},code(e){const{gen:t,parentSchema:n,data:s,errsCount:l,it:c}=e,{schema:u=c.opts.defaultAdditionalProperties}=e;if(!l)throw new Error("ajv implementation error");const{allErrors:p,opts:d}=c;if(c.props=!0,"all"!==d.removeAdditional&&a.alwaysValidSchema(c,u))return;const f=r.allSchemaProperties(n.properties),h=r.allSchemaProperties(n.patternProperties);function m(e){t.code(o._`delete ${s}[${e}]`)}function g(n){if("all"===d.removeAdditional||d.removeAdditional&&!1===u)m(n);else{if(!1===u)return e.setParams({additionalProperty:n}),e.error(),void(p||t.break());if("object"==typeof u&&!a.alwaysValidSchema(c,u)){const r=t.name("valid");"failing"===d.removeAdditional?(y(n,r,!1),t.if(o.not(r),(()=>{e.reset(),m(n)}))):(y(n,r),p||t.if(o.not(r),(()=>t.break())))}}}function y(t,n,r){const o={keyword:"additionalProperties",dataProp:t,dataPropType:a.Type.Str};!1===r&&Object.assign(o,{compositeRule:!0,createErrors:!1,allErrors:!1}),e.subschema(o,n)}t.forIn("key",s,(i=>{f.length||h.length?t.if(function(i){let s;if(f.length>8){const e=a.schemaRefOrVal(c,n.properties,"properties");s=r.isOwnProperty(t,e,i)}else s=f.length?o.or(...f.map((e=>o._`${i} === ${e}`))):o.nil;return h.length&&(s=o.or(s,...h.map((t=>o._`${r.usePattern(e,t)}.test(${i})`)))),o.not(s)}(i),(()=>g(i))):g(i)})),e.ok(o._`${l} === ${i.default.errors}`)}};t.default=s},5716:function(e,t,n){"use strict";Object.defineProperty(t,"__esModule",{value:!0});const r=n(6124),o={keyword:"allOf",schemaType:"array",code(e){const{gen:t,schema:n,it:o}=e;if(!Array.isArray(n))throw new Error("ajv implementation error");const i=t.name("valid");n.forEach(((t,n)=>{if(r.alwaysValidSchema(o,t))return;const a=e.subschema({keyword:"allOf",schemaProp:n},i);e.ok(i),e.mergeEvaluated(a)}))}};t.default=o},1668:function(e,t,n){"use strict";Object.defineProperty(t,"__esModule",{value:!0});const r={keyword:"anyOf",schemaType:"array",trackErrors:!0,code:n(8619).validateUnion,error:{message:"must match a schema in anyOf"}};t.default=r},9564:function(e,t,n){"use strict";Object.defineProperty(t,"__esModule",{value:!0});const r=n(4475),o=n(6124),i={keyword:"contains",type:"array",schemaType:["object","boolean"],before:"uniqueItems",trackErrors:!0,error:{message:({params:{min:e,max:t}})=>void 0===t?r.str`must contain at least ${e} valid item(s)`:r.str`must contain at least ${e} and no more than ${t} valid item(s)`,params:({params:{min:e,max:t}})=>void 0===t?r._`{minContains: ${e}}`:r._`{minContains: ${e}, maxContains: ${t}}`},code(e){const{gen:t,schema:n,parentSchema:i,data:a,it:s}=e;let l,c;const{minContains:u,maxContains:p}=i;s.opts.next?(l=void 0===u?1:u,c=p):l=1;const d=t.const("len",r._`${a}.length`);if(e.setParams({min:l,max:c}),void 0===c&&0===l)return void o.checkStrictMode(s,'"minContains" == 0 without "maxContains": "contains" keyword ignored');if(void 0!==c&&l>c)return o.checkStrictMode(s,'"minContains" > "maxContains" is always invalid'),void e.fail();if(o.alwaysValidSchema(s,n)){let t=r._`${d} >= ${l}`;return void 0!==c&&(t=r._`${t} && ${d} <= ${c}`),void e.pass(t)}s.items=!0;const f=t.name("valid");if(void 0===c&&1===l)h(f,(()=>t.if(f,(()=>t.break()))));else{t.let(f,!1);const e=t.name("_valid"),n=t.let("count",0);h(e,(()=>t.if(e,(()=>function(e){t.code(r._`${e}++`),void 0===c?t.if(r._`${e} >= ${l}`,(()=>t.assign(f,!0).break())):(t.if(r._`${e} > ${c}`,(()=>t.assign(f,!1).break())),1===l?t.assign(f,!0):t.if(r._`${e} >= ${l}`,(()=>t.assign(f,!0))))}(n)))))}function h(n,r){t.forRange("i",0,d,(t=>{e.subschema({keyword:"contains",dataProp:t,dataPropType:o.Type.Num,compositeRule:!0},n),r()}))}e.result(f,(()=>e.reset()))}};t.default=i},1117:function(e,t,n){"use strict";Object.defineProperty(t,"__esModule",{value:!0}),t.validateSchemaDeps=t.validatePropertyDeps=t.error=void 0;const r=n(4475),o=n(6124),i=n(8619);t.error={message:({params:{property:e,depsCount:t,deps:n}})=>{const o=1===t?"property":"properties";return r.str`must have ${o} ${n} when property ${e} is present`},params:({params:{property:e,depsCount:t,deps:n,missingProperty:o}})=>r._`{property: ${e},
missingProperty: ${o},
depsCount: ${t},
deps: ${n}}`};const a={keyword:"dependencies",type:"object",schemaType:"object",error:t.error,code(e){const[t,n]=function({schema:e}){const t={},n={};for(const r in e)"__proto__"!==r&&((Array.isArray(e[r])?t:n)[r]=e[r]);return[t,n]}(e);s(e,t),l(e,n)}};function s(e,t=e.schema){const{gen:n,data:o,it:a}=e;if(0===Object.keys(t).length)return;const s=n.let("missing");for(const l in t){const c=t[l];if(0===c.length)continue;const u=i.propertyInData(n,o,l,a.opts.ownProperties);e.setParams({property:l,depsCount:c.length,deps:c.join(", ")}),a.allErrors?n.if(u,(()=>{for(const t of c)i.checkReportMissingProp(e,t)})):(n.if(r._`${u} && (${i.checkMissingProp(e,c,s)})`),i.reportMissingProp(e,s),n.else())}}function l(e,t=e.schema){const{gen:n,data:r,keyword:a,it:s}=e,l=n.name("valid");for(const c in t)o.alwaysValidSchema(s,t[c])||(n.if(i.propertyInData(n,r,c,s.opts.ownProperties),(()=>{const t=e.subschema({keyword:a,schemaProp:c},l);e.mergeValidEvaluated(t,l)}),(()=>n.var(l,!0))),e.ok(l))}t.validatePropertyDeps=s,t.validateSchemaDeps=l,t.default=a},5184:function(e,t,n){"use strict";Object.defineProperty(t,"__esModule",{value:!0});const r=n(4475),o=n(6124),i={keyword:"if",schemaType:["object","boolean"],trackErrors:!0,error:{message:({params:e})=>r.str`must match "${e.ifClause}" schema`,params:({params:e})=>r._`{failingKeyword: ${e.ifClause}}`},code(e){const{gen:t,parentSchema:n,it:i}=e;void 0===n.then&&void 0===n.else&&o.checkStrictMode(i,'"if" without "then" and "else" is ignored');const s=a(i,"then"),l=a(i,"else");if(!s&&!l)return;const c=t.let("valid",!0),u=t.name("_valid");if(function(){const t=e.subschema({keyword:"if",compositeRule:!0,createErrors:!1,allErrors:!1},u);e.mergeEvaluated(t)}(),e.reset(),s&&l){const n=t.let("ifClause");e.setParams({ifClause:n}),t.if(u,p("then",n),p("else",n))}else s?t.if(u,p("then")):t.if(r.not(u),p("else"));function p(n,o){return()=>{const i=e.subschema({keyword:n},u);t.assign(c,u),e.mergeValidEvaluated(i,c),o?t.assign(o,r._`${n}`):e.setParams({ifClause:n})}}e.pass(c,(()=>e.error(!0)))}};function a(e,t){const n=e.schema[t];return void 0!==n&&!o.alwaysValidSchema(e,n)}t.default=i},9616:function(e,t,n){"use strict";Object.defineProperty(t,"__esModule",{value:!0});const r=n(3074),o=n(6988),i=n(6348),a=n(9822),s=n(9564),l=n(1117),c=n(4002),u=n(1422),p=n(9690),d=n(9883),f=n(8435),h=n(1668),m=n(9684),g=n(5716),y=n(5184),v=n(5642);t.default=function(e=!1){const t=[f.default,h.default,m.default,g.default,y.default,v.default,c.default,u.default,l.default,p.default,d.default];return e?t.push(o.default,a.default):t.push(r.default,i.default),t.push(s.default),t}},6348:function(e,t,n){"use strict";Object.defineProperty(t,"__esModule",{value:!0}),t.validateTuple=void 0;const r=n(4475),o=n(6124),i=n(8619),a={keyword:"items",type:"array",schemaType:["object","array","boolean"],before:"uniqueItems",code(e){const{schema:t,it:n}=e;if(Array.isArray(t))return s(e,"additionalItems",t);n.items=!0,o.alwaysValidSchema(n,t)||e.ok(i.validateArray(e))}};function s(e,t,n=e.schema){const{gen:i,parentSchema:a,data:s,keyword:l,it:c}=e;!function(e){const{opts:r,errSchemaPath:i}=c,a=n.length,s=a===e.minItems&&(a===e.maxItems||!1===e[t]);if(r.strictTuples&&!s){const e=`"${l}" is ${a}-tuple, but minItems or maxItems/${t} are not specified or different at path "${i}"`;o.checkStrictMode(c,e,r.strictTuples)}}(a),c.opts.unevaluated&&n.length&&!0!==c.items&&(c.items=o.mergeEvaluated.items(i,n.length,c.items));const u=i.name("valid"),p=i.const("len",r._`${s}.length`);n.forEach(((t,n)=>{o.alwaysValidSchema(c,t)||(i.if(r._`${p} > ${n}`,(()=>e.subschema({keyword:l,schemaProp:n,dataProp:n},u))),e.ok(u))}))}t.validateTuple=s,t.default=a},9822:function(e,t,n){"use strict";Object.defineProperty(t,"__esModule",{value:!0});const r=n(4475),o=n(6124),i=n(8619),a=n(3074),s={keyword:"items",type:"array",schemaType:["object","boolean"],before:"uniqueItems",error:{message:({params:{len:e}})=>r.str`must NOT have more than ${e} items`,params:({params:{len:e}})=>r._`{limit: ${e}}`},code(e){const{schema:t,parentSchema:n,it:r}=e,{prefixItems:s}=n;r.items=!0,o.alwaysValidSchema(r,t)||(s?a.validateAdditionalItems(e,s):e.ok(i.validateArray(e)))}};t.default=s},8435:function(e,t,n){"use strict";Object.defineProperty(t,"__esModule",{value:!0});const r=n(6124),o={keyword:"not",schemaType:["object","boolean"],trackErrors:!0,code(e){const{gen:t,schema:n,it:o}=e;if(r.alwaysValidSchema(o,n))return void e.fail();const i=t.name("valid");e.subschema({keyword:"not",compositeRule:!0,createErrors:!1,allErrors:!1},i),e.result(i,(()=>e.error()),(()=>e.reset()))},error:{message:"must NOT be valid"}};t.default=o},9684:function(e,t,n){"use strict";Object.defineProperty(t,"__esModule",{value:!0});const r=n(4475),o=n(6124),i={keyword:"oneOf",schemaType:"array",trackErrors:!0,error:{message:"must match exactly one schema in oneOf",params:({params:e})=>r._`{passingSchemas: ${e.passing}}`},code(e){const{gen:t,schema:n,parentSchema:i,it:a}=e;if(!Array.isArray(n))throw new Error("ajv implementation error");if(a.opts.discriminator&&i.discriminator)return;const s=n,l=t.let("valid",!1),c=t.let("passing",null),u=t.name("_valid");e.setParams({passing:c}),t.block((function(){s.forEach(((n,i)=>{let s;o.alwaysValidSchema(a,n)?t.var(u,!0):s=e.subschema({keyword:"oneOf",schemaProp:i,compositeRule:!0},u),i>0&&t.if(r._`${u} && ${l}`).assign(l,!1).assign(c,r._`[${c}, ${i}]`).else(),t.if(u,(()=>{t.assign(l,!0),t.assign(c,i),s&&e.mergeEvaluated(s,r.Name)}))}))})),e.result(l,(()=>e.reset()),(()=>e.error(!0)))}};t.default=i},9883:function(e,t,n){"use strict";Object.defineProperty(t,"__esModule",{value:!0});const r=n(8619),o=n(4475),i=n(6124),a=n(6124),s={keyword:"patternProperties",type:"object",schemaType:"object",code(e){const{gen:t,schema:n,data:s,parentSchema:l,it:c}=e,{opts:u}=c,p=r.allSchemaProperties(n),d=p.filter((e=>i.alwaysValidSchema(c,n[e])));if(0===p.length||d.length===p.length&&(!c.opts.unevaluated||!0===c.props))return;const f=u.strictSchema&&!u.allowMatchingProperties&&l.properties,h=t.name("valid");!0===c.props||c.props instanceof o.Name||(c.props=a.evaluatedPropsToName(t,c.props));const{props:m}=c;function g(e){for(const t in f)new RegExp(e).test(t)&&i.checkStrictMode(c,`property ${t} matches pattern ${e} (use allowMatchingProperties)`)}function y(n){t.forIn("key",s,(i=>{t.if(o._`${r.usePattern(e,n)}.test(${i})`,(()=>{const r=d.includes(n);r||e.subschema({keyword:"patternProperties",schemaProp:n,dataProp:i,dataPropType:a.Type.Str},h),c.opts.unevaluated&&!0!==m?t.assign(o._`${m}[${i}]`,!0):r||c.allErrors||t.if(o.not(h),(()=>t.break()))}))}))}!function(){for(const e of p)f&&g(e),c.allErrors?y(e):(t.var(h,!0),y(e),t.if(h))}()}};t.default=s},6988:function(e,t,n){"use strict";Object.defineProperty(t,"__esModule",{value:!0});const r=n(6348),o={keyword:"prefixItems",type:"array",schemaType:["array"],before:"uniqueItems",code:e=>r.validateTuple(e,"items")};t.default=o},9690:function(e,t,n){"use strict";Object.defineProperty(t,"__esModule",{value:!0});const r=n(1321),o=n(8619),i=n(6124),a=n(1422),s={keyword:"properties",type:"object",schemaType:"object",code(e){const{gen:t,schema:n,parentSchema:s,data:l,it:c}=e;("all"===c.opts.removeAdditional&&void 0===s.additionalProperties||!1===c.opts.defaultAdditionalProperties)&&a.default.code(new r.KeywordCxt(c,a.default,"additionalProperties"));const u=o.allSchemaProperties(n);for(const e of u)c.definedProperties.add(e);c.opts.unevaluated&&u.length&&!0!==c.props&&(c.props=i.mergeEvaluated.props(t,i.toHash(u),c.props));const p=u.filter((e=>!i.alwaysValidSchema(c,n[e])));if(0===p.length)return;const d=t.name("valid");for(const n of p)f(n)?h(n):(t.if(o.propertyInData(t,l,n,c.opts.ownProperties)),h(n),c.allErrors||t.else().var(d,!0),t.endIf()),e.it.definedProperties.add(n),e.ok(d);function f(e){return c.opts.useDefaults&&!c.compositeRule&&void 0!==n[e].default}function h(t){e.subschema({keyword:"properties",schemaProp:t,dataProp:t},d)}}};t.default=s},4002:function(e,t,n){"use strict";Object.defineProperty(t,"__esModule",{value:!0});const r=n(4475),o=n(6124),i={keyword:"propertyNames",type:"object",schemaType:["object","boolean"],error:{message:"property name must be valid",params:({params:e})=>r._`{propertyName: ${e.propertyName}}`},code(e){const{gen:t,schema:n,data:i,it:a}=e;if(o.alwaysValidSchema(a,n))return;const s=t.name("valid");t.forIn("key",i,(n=>{e.setParams({propertyName:n}),e.subschema({keyword:"propertyNames",data:n,dataTypes:["string"],propertyName:n,compositeRule:!0},s),t.if(r.not(s),(()=>{e.error(!0),a.allErrors||t.break()}))})),e.ok(s)}};t.default=i},5642:function(e,t,n){"use strict";Object.defineProperty(t,"__esModule",{value:!0});const r=n(6124),o={keyword:["then","else"],schemaType:["object","boolean"],code({keyword:e,parentSchema:t,it:n}){void 0===t.if&&r.checkStrictMode(n,`"${e}" without "if" is ignored`)}};t.default=o},8619:function(e,t,n){"use strict";Object.defineProperty(t,"__esModule",{value:!0}),t.validateUnion=t.validateArray=t.usePattern=t.callValidateCode=t.schemaProperties=t.allSchemaProperties=t.noPropertyInData=t.propertyInData=t.isOwnProperty=t.hasPropFunc=t.reportMissingProp=t.checkMissingProp=t.checkReportMissingProp=void 0;const r=n(4475),o=n(6124),i=n(5018);function a(e){return e.scopeValue("func",{ref:Object.prototype.hasOwnProperty,code:r._`Object.prototype.hasOwnProperty`})}function s(e,t,n){return r._`${a(e)}.call(${t}, ${n})`}function l(e,t,n,o){const i=r._`${t}${r.getProperty(n)} === undefined`;return o?r.or(i,r.not(s(e,t,n))):i}function c(e){return e?Object.keys(e).filter((e=>"__proto__"!==e)):[]}t.checkReportMissingProp=function(e,t){const{gen:n,data:o,it:i}=e;n.if(l(n,o,t,i.opts.ownProperties),(()=>{e.setParams({missingProperty:r._`${t}`},!0),e.error()}))},t.checkMissingProp=function({gen:e,data:t,it:{opts:n}},o,i){return r.or(...o.map((o=>r.and(l(e,t,o,n.ownProperties),r._`${i} = ${o}`))))},t.reportMissingProp=function(e,t){e.setParams({missingProperty:t},!0),e.error()},t.hasPropFunc=a,t.isOwnProperty=s,t.propertyInData=function(e,t,n,o){const i=r._`${t}${r.getProperty(n)} !== undefined`;return o?r._`${i} && ${s(e,t,n)}`:i},t.noPropertyInData=l,t.allSchemaProperties=c,t.schemaProperties=function(e,t){return c(t).filter((n=>!o.alwaysValidSchema(e,t[n])))},t.callValidateCode=function({schemaCode:e,data:t,it:{gen:n,topSchemaRef:o,schemaPath:a,errorPath:s},it:l},c,u,p){const d=p?r._`${e}, ${t}, ${o}${a}`:t,f=[[i.default.instancePath,r.strConcat(i.default.instancePath,s)],[i.default.parentData,l.parentData],[i.default.parentDataProperty,l.parentDataProperty],[i.default.rootData,i.default.rootData]];l.opts.dynamicRef&&f.push([i.default.dynamicAnchors,i.default.dynamicAnchors]);const h=r._`${d}, ${n.object(...f)}`;return u!==r.nil?r._`${c}.call(${u}, ${h})`:r._`${c}(${h})`},t.usePattern=function({gen:e,it:{opts:t}},n){const o=t.unicodeRegExp?"u":"";return e.scopeValue("pattern",{key:n,ref:new RegExp(n,o),code:r._`new RegExp(${n}, ${o})`})},t.validateArray=function(e){const{gen:t,data:n,keyword:i,it:a}=e,s=t.name("valid");if(a.allErrors){const e=t.let("valid",!0);return l((()=>t.assign(e,!1))),e}return t.var(s,!0),l((()=>t.break())),s;function l(a){const l=t.const("len",r._`${n}.length`);t.forRange("i",0,l,(n=>{e.subschema({keyword:i,dataProp:n,dataPropType:o.Type.Num},s),t.if(r.not(s),a)}))}},t.validateUnion=function(e){const{gen:t,schema:n,keyword:i,it:a}=e;if(!Array.isArray(n))throw new Error("ajv implementation error");if(n.some((e=>o.alwaysValidSchema(a,e)))&&!a.opts.unevaluated)return;const s=t.let("valid",!1),l=t.name("_valid");t.block((()=>n.forEach(((n,o)=>{const a=e.subschema({keyword:i,schemaProp:o,compositeRule:!0},l);t.assign(s,r._`${s} || ${l}`),e.mergeValidEvaluated(a,l)||t.if(r.not(s))})))),e.result(s,(()=>e.reset()),(()=>e.error(!0)))}},5060:function(e,t){"use strict";Object.defineProperty(t,"__esModule",{value:!0});const n={keyword:"id",code(){throw new Error('NOT SUPPORTED: keyword "id", use "$id" for schema ID')}};t.default=n},8223:function(e,t,n){"use strict";Object.defineProperty(t,"__esModule",{value:!0});const r=n(5060),o=n(4028),i=["$schema","$id","$defs","$vocabulary",{keyword:"$comment"},"definitions",r.default,o.default];t.default=i},4028:function(e,t,n){"use strict";Object.defineProperty(t,"__esModule",{value:!0}),t.callRef=t.getValidate=void 0;const r=n(4143),o=n(8619),i=n(4475),a=n(5018),s=n(7805),l=n(6124),c={keyword:"$ref",schemaType:"string",code(e){const{gen:t,schema:n,it:o}=e,{baseId:a,schemaEnv:l,validateName:c,opts:d,self:f}=o,{root:h}=l;if(("#"===n||"#/"===n)&&a===h.baseId)return function(){if(l===h)return p(e,c,l,l.$async);const n=t.scopeValue("root",{ref:h});return p(e,i._`${n}.validate`,h,h.$async)}();const m=s.resolveRef.call(f,h,a,n);if(void 0===m)throw new r.default(a,n);return m instanceof s.SchemaEnv?function(t){const n=u(e,t);p(e,n,t,t.$async)}(m):function(r){const o=t.scopeValue("schema",!0===d.code.source?{ref:r,code:i.stringify(r)}:{ref:r}),a=t.name("valid"),s=e.subschema({schema:r,dataTypes:[],schemaPath:i.nil,topSchemaRef:o,errSchemaPath:n},a);e.mergeEvaluated(s),e.ok(a)}(m)}};function u(e,t){const{gen:n}=e;return t.validate?n.scopeValue("validate",{ref:t.validate}):i._`${n.scopeValue("wrapper",{ref:t})}.validate`}function p(e,t,n,r){const{gen:s,it:c}=e,{allErrors:u,schemaEnv:p,opts:d}=c,f=d.passContext?a.default.this:i.nil;function h(e){const t=i._`${e}.errors`;s.assign(a.default.vErrors,i._`${a.default.vErrors} === null ? ${t} : ${a.default.vErrors}.concat(${t})`),s.assign(a.default.errors,i._`${a.default.vErrors}.length`)}function m(e){var t;if(!c.opts.unevaluated)return;const r=null===(t=null==n?void 0:n.validate)||void 0===t?void 0:t.evaluated;if(!0!==c.props)if(r&&!r.dynamicProps)void 0!==r.props&&(c.props=l.mergeEvaluated.props(s,r.props,c.props));else{const t=s.var("props",i._`${e}.evaluated.props`);c.props=l.mergeEvaluated.props(s,t,c.props,i.Name)}if(!0!==c.items)if(r&&!r.dynamicItems)void 0!==r.items&&(c.items=l.mergeEvaluated.items(s,r.items,c.items));else{const t=s.var("items",i._`${e}.evaluated.items`);c.items=l.mergeEvaluated.items(s,t,c.items,i.Name)}}r?function(){if(!p.$async)throw new Error("async schema referenced by sync schema");const n=s.let("valid");s.try((()=>{s.code(i._`await ${o.callValidateCode(e,t,f)}`),m(t),u||s.assign(n,!0)}),(e=>{s.if(i._`!(${e} instanceof ${c.ValidationError})`,(()=>s.throw(e))),h(e),u||s.assign(n,!1)})),e.ok(n)}():function(){const n=s.name("visitedNodes");s.code(i._`const ${n} = visitedNodesForRef.get(${t}) || new Set()`),s.if(i._`!${n}.has(${e.data})`,(()=>{s.code(i._`visitedNodesForRef.set(${t}, ${n})`),s.code(i._`const dataNode = ${e.data}`),s.code(i._`${n}.add(dataNode)`);const r=e.result(o.callValidateCode(e,t,f),(()=>m(t)),(()=>h(t)));return s.code(i._`${n}.delete(dataNode)`),r}))}()}t.getValidate=u,t.callRef=p,t.default=c},5522:function(e,t,n){"use strict";Object.defineProperty(t,"__esModule",{value:!0});const r=n(4475),o=n(6545),i={keyword:"discriminator",type:"object",schemaType:"object",error:{message:({params:{discrError:e,tagName:t}})=>e===o.DiscrError.Tag?`tag "${t}" must be string`:`value of tag "${t}" must be in oneOf`,params:({params:{discrError:e,tag:t,tagName:n}})=>r._`{error: ${e}, tag: ${n}, tagValue: ${t}}`},code(e){const{gen:t,data:n,schema:i,parentSchema:a,it:s}=e,{oneOf:l}=a;if(!s.opts.discriminator)throw new Error("discriminator: requires discriminator option");const c=i.propertyName;if("string"!=typeof c)throw new Error("discriminator: requires propertyName");if(!l)throw new Error("discriminator: requires oneOf keyword");const u=t.let("valid",!1),p=t.const("tag",r._`${n}${r.getProperty(c)}`);function d(n){const o=t.name("valid"),i=e.subschema({keyword:"oneOf",schemaProp:n},o);return e.mergeEvaluated(i,r.Name),o}function f(e){return e.hasOwnProperty("$ref")}t.if(r._`typeof ${p} == "string"`,(()=>function(){const n=function(){var e;const t={},n=o(a);let r=!0;for(let t=0;t<l.length;t++){const a=l[t];let p;if(f(a)){if(i.mapping){const{mapping:e}=i;let n;if(Object.keys(e).forEach((function(t){e[t]===a.$ref&&(n=t)})),!n)throw new Error(`${a.$ref} should have corresponding entry in mapping`);u(n,t)}}else{if(p=null===(e=a.properties)||void 0===e?void 0:e[c],"object"!=typeof p)throw new Error(`discriminator: oneOf schemas must have "properties/${c}"`);r=r&&(n||o(a)),s(p,t)}}if(!r)throw new Error(`discriminator: "${c}" must be required`);return t;function o({required:e}){return Array.isArray(e)&&e.includes(c)}function s(e,t){if(e.const)u(e.const,t);else{if(!e.enum)throw new Error(`discriminator: "properties/${c}" must have "const" or "enum"`);for(const n of e.enum)u(n,t)}}function u(e,n){if("string"!=typeof e||e in t)throw new Error(`discriminator: "${c}" values must be unique strings`);t[e]=n}}();t.if(!1);for(const e in n)t.elseIf(r._`${p} === ${e}`),t.assign(u,d(n[e]));t.else(),e.error(!1,{discrError:o.DiscrError.Mapping,tag:p,tagName:c}),t.endIf()}()),(()=>e.error(!1,{discrError:o.DiscrError.Tag,tag:p,tagName:c}))),e.ok(u)}};t.default=i},6545:function(e,t){"use strict";var n;Object.defineProperty(t,"__esModule",{value:!0}),t.DiscrError=void 0,(n=t.DiscrError||(t.DiscrError={})).Tag="tag",n.Mapping="mapping"},6479:function(e,t,n){"use strict";Object.defineProperty(t,"__esModule",{value:!0});const r=n(8223),o=n(3799),i=n(9616),a=n(3815),s=n(4826),l=[r.default,o.default,i.default(),a.default,s.metadataVocabulary,s.contentVocabulary];t.default=l},157:function(e,t,n){"use strict";Object.defineProperty(t,"__esModule",{value:!0});const r=n(4475),o={keyword:"format",type:["number","string"],schemaType:"string",$data:!0,error:{message:({schemaCode:e})=>r.str`must match format "${e}"`,params:({schemaCode:e})=>r._`{format: ${e}}`},code(e,t){const{gen:n,data:o,$data:i,schema:a,schemaCode:s,it:l}=e,{opts:c,errSchemaPath:u,schemaEnv:p,self:d}=l;c.validateFormats&&(i?function(){const i=n.scopeValue("formats",{ref:d.formats,code:c.code.formats}),a=n.const("fDef",r._`${i}[${s}]`),l=n.let("fType"),u=n.let("format");n.if(r._`typeof ${a} == "object" && !(${a} instanceof RegExp)`,(()=>n.assign(l,r._`${a}.type || "string"`).assign(u,r._`${a}.validate`)),(()=>n.assign(l,r._`"string"`).assign(u,a))),e.fail$data(r.or(!1===c.strictSchema?r.nil:r._`${s} && !${u}`,function(){const e=p.$async?r._`(${a}.async ? await ${u}(${o}) : ${u}(${o}))`:r._`${u}(${o})`,n=r._`(typeof ${u} == "function" ? ${e} : ${u}.test(${o}))`;return r._`${u} && ${u} !== true && ${l} === ${t} && !${n}`}()))}():function(){const i=d.formats[a];if(!i)return void function(){if(!1!==c.strictSchema)throw new Error(e());function e(){return`unknown format "${a}" ignored in schema at path "${u}"`}d.logger.warn(e())}();if(!0===i)return;const[s,l,f]=function(e){const t=e instanceof RegExp?r.regexpCode(e):c.code.formats?r._`${c.code.formats}${r.getProperty(a)}`:void 0,o=n.scopeValue("formats",{key:a,ref:e,code:t});return"object"!=typeof e||e instanceof RegExp?["string",e,o]:[e.type||"string",e.validate,r._`${o}.validate`]}(i);s===t&&e.pass(function(){if("object"==typeof i&&!(i instanceof RegExp)&&i.async){if(!p.$async)throw new Error("async format in sync schema");return r._`await ${f}(${o})`}return"function"==typeof l?r._`${f}(${o})`:r._`${f}.test(${o})`}())}())}};t.default=o},3815:function(e,t,n){"use strict";Object.defineProperty(t,"__esModule",{value:!0});const r=[n(157).default];t.default=r},4826:function(e,t){"use strict";Object.defineProperty(t,"__esModule",{value:!0}),t.contentVocabulary=t.metadataVocabulary=void 0,t.metadataVocabulary=["title","description","default","deprecated","readOnly","writeOnly","examples"],t.contentVocabulary=["contentMediaType","contentEncoding","contentSchema"]},7535:function(e,t,n){"use strict";Object.defineProperty(t,"__esModule",{value:!0});const r=n(4475),o=n(6124),i=n(412),a={keyword:"const",$data:!0,error:{message:"must be equal to constant",params:({schemaCode:e})=>r._`{allowedValue: ${e}}`},code(e){const{gen:t,data:n,$data:a,schemaCode:s,schema:l}=e;a||l&&"object"==typeof l?e.fail$data(r._`!${o.useFunc(t,i.default)}(${n}, ${s})`):e.fail(r._`${l} !== ${n}`)}};t.default=a},4147:function(e,t,n){"use strict";Object.defineProperty(t,"__esModule",{value:!0});const r=n(4475),o=n(6124),i=n(412),a={keyword:"enum",schemaType:"array",$data:!0,error:{message:"must be equal to one of the allowed values",params:({schemaCode:e})=>r._`{allowedValues: ${e}}`},code(e){const{gen:t,data:n,$data:a,schema:s,schemaCode:l,it:c}=e;if(!a&&0===s.length)throw new Error("enum must have non-empty array");const u=s.length>=c.opts.loopEnum,p=o.useFunc(t,i.default);let d;if(u||a)d=t.let("valid"),e.block$data(d,(function(){t.assign(d,!1),t.forOf("v",l,(e=>t.if(r._`${p}(${n}, ${e})`,(()=>t.assign(d,!0).break()))))}));else{if(!Array.isArray(s))throw new Error("ajv implementation error");const e=t.const("vSchema",l);d=r.or(...s.map(((t,o)=>function(e,t){const o=s[t];return"object"==typeof o&&null!==o?r._`${p}(${n}, ${e}[${t}])`:r._`${n} === ${o}`}(e,o))))}e.pass(d)}};t.default=a},3799:function(e,t,n){"use strict";Object.defineProperty(t,"__esModule",{value:!0});const r=n(9640),o=n(7692),i=n(3765),a=n(8582),s=n(6711),l=n(7835),c=n(8950),u=n(7326),p=n(7535),d=n(4147),f=[r.default,o.default,i.default,a.default,s.default,l.default,c.default,u.default,{keyword:"type",schemaType:["string","array"]},{keyword:"nullable",schemaType:"boolean"},p.default,d.default];t.default=f},8950:function(e,t,n){"use strict";Object.defineProperty(t,"__esModule",{value:!0});const r=n(4475),o={keyword:["maxItems","minItems"],type:"array",schemaType:"number",$data:!0,error:{message({keyword:e,schemaCode:t}){const n="maxItems"===e?"more":"fewer";return r.str`must NOT have ${n} than ${t} items`},params:({schemaCode:e})=>r._`{limit: ${e}}`},code(e){const{keyword:t,data:n,schemaCode:o}=e,i="maxItems"===t?r.operators.GT:r.operators.LT;e.fail$data(r._`${n}.length ${i} ${o}`)}};t.default=o},3765:function(e,t,n){"use strict";Object.defineProperty(t,"__esModule",{value:!0});const r=n(4475),o=n(6124),i=n(5872),a={keyword:["maxLength","minLength"],type:"string",schemaType:"number",$data:!0,error:{message({keyword:e,schemaCode:t}){const n="maxLength"===e?"more":"fewer";return r.str`must NOT have ${n} than ${t} characters`},params:({schemaCode:e})=>r._`{limit: ${e}}`},code(e){const{keyword:t,data:n,schemaCode:a,it:s}=e,l="maxLength"===t?r.operators.GT:r.operators.LT,c=!1===s.opts.unicode?r._`${n}.length`:r._`${o.useFunc(e.gen,i.default)}(${n})`;e.fail$data(r._`${c} ${l} ${a}`)}};t.default=a},9640:function(e,t,n){"use strict";Object.defineProperty(t,"__esModule",{value:!0});const r=n(4475),o=r.operators,i={maximum:{okStr:"<=",ok:o.LTE,fail:o.GT},minimum:{okStr:">=",ok:o.GTE,fail:o.LT},exclusiveMaximum:{okStr:"<",ok:o.LT,fail:o.GTE},exclusiveMinimum:{okStr:">",ok:o.GT,fail:o.LTE}},a={message:({keyword:e,schemaCode:t})=>r.str`must be ${i[e].okStr} ${t}`,params:({keyword:e,schemaCode:t})=>r._`{comparison: ${i[e].okStr}, limit: ${t}}`},s={keyword:Object.keys(i),type:"number",schemaType:"number",$data:!0,error:a,code(e){const{keyword:t,data:n,schemaCode:o}=e;e.fail$data(r._`${n} ${i[t].fail} ${o} || isNaN(${n})`)}};t.default=s},6711:function(e,t,n){"use strict";Object.defineProperty(t,"__esModule",{value:!0});const r=n(4475),o={keyword:["maxProperties","minProperties"],type:"object",schemaType:"number",$data:!0,error:{message({keyword:e,schemaCode:t}){const n="maxProperties"===e?"more":"fewer";return r.str`must NOT have ${n} than ${t} items`},params:({schemaCode:e})=>r._`{limit: ${e}}`},code(e){const{keyword:t,data:n,schemaCode:o}=e,i="maxProperties"===t?r.operators.GT:r.operators.LT;e.fail$data(r._`Object.keys(${n}).length ${i} ${o}`)}};t.default=o},7692:function(e,t,n){"use strict";Object.defineProperty(t,"__esModule",{value:!0});const r=n(4475),o={keyword:"multipleOf",type:"number",schemaType:"number",$data:!0,error:{message:({schemaCode:e})=>r.str`must be multiple of ${e}`,params:({schemaCode:e})=>r._`{multipleOf: ${e}}`},code(e){const{gen:t,data:n,schemaCode:o,it:i}=e,a=i.opts.multipleOfPrecision,s=t.let("res"),l=a?r._`Math.abs(Math.round(${s}) - ${s}) > 1e-${a}`:r._`${s} !== parseInt(${s})`;e.fail$data(r._`(${o} === 0 || (${s} = ${n}/${o}, ${l}))`)}};t.default=o},8582:function(e,t,n){"use strict";Object.defineProperty(t,"__esModule",{value:!0});const r=n(8619),o=n(4475),i={keyword:"pattern",type:"string",schemaType:"string",$data:!0,error:{message:({schemaCode:e})=>o.str`must match pattern "${e}"`,params:({schemaCode:e})=>o._`{pattern: ${e}}`},code(e){const{data:t,$data:n,schema:i,schemaCode:a,it:s}=e,l=s.opts.unicodeRegExp?"u":"",c=n?o._`(new RegExp(${a}, ${l}))`:r.usePattern(e,i);e.fail$data(o._`!${c}.test(${t})`)}};t.default=i},7835:function(e,t,n){"use strict";Object.defineProperty(t,"__esModule",{value:!0});const r=n(8619),o=n(4475),i=n(6124),a={keyword:"required",type:"object",schemaType:"array",$data:!0,error:{message:({params:{missingProperty:e}})=>o.str`must have required property '${e}'`,params:({params:{missingProperty:e}})=>o._`{missingProperty: ${e}}`},code(e){const{gen:t,schema:n,schemaCode:a,data:s,$data:l,it:c}=e,{opts:u}=c;if(!l&&0===n.length)return;const p=n.length>=u.loopRequired;if(c.allErrors?function(){if(p||l)e.block$data(o.nil,d);else for(const t of n)r.checkReportMissingProp(e,t)}():function(){const i=t.let("missing");if(p||l){const n=t.let("valid",!0);e.block$data(n,(()=>function(n,i){e.setParams({missingProperty:n}),t.forOf(n,a,(()=>{t.assign(i,r.propertyInData(t,s,n,u.ownProperties)),t.if(o.not(i),(()=>{e.error(),t.break()}))}),o.nil)}(i,n))),e.ok(n)}else t.if(r.checkMissingProp(e,n,i)),r.reportMissingProp(e,i),t.else()}(),u.strictRequired){const t=e.parentSchema.properties,{definedProperties:r}=e.it;for(const e of n)if(void 0===(null==t?void 0:t[e])&&!r.has(e)){const t=`required property "${e}" is not defined at "${c.schemaEnv.baseId+c.errSchemaPath}" (strictRequired)`;i.checkStrictMode(c,t,c.opts.strictRequired)}}function d(){t.forOf("prop",a,(n=>{e.setParams({missingProperty:n}),t.if(r.noPropertyInData(t,s,n,u.ownProperties),(()=>e.error()))}))}}};t.default=a},7326:function(e,t,n){"use strict";Object.defineProperty(t,"__esModule",{value:!0});const r=n(7927),o=n(4475),i=n(6124),a=n(412),s={keyword:"uniqueItems",type:"array",schemaType:"boolean",$data:!0,error:{message:({params:{i:e,j:t}})=>o.str`must NOT have duplicate items (items ## ${t} and ${e} are identical)`,params:({params:{i:e,j:t}})=>o._`{i: ${e}, j: ${t}}`},code(e){const{gen:t,data:n,$data:s,schema:l,parentSchema:c,schemaCode:u,it:p}=e;if(!s&&!l)return;const d=t.let("valid"),f=c.items?r.getSchemaTypes(c.items):[];function h(i,a){const s=t.name("item"),l=r.checkDataTypes(f,s,p.opts.strictNumbers,r.DataType.Wrong),c=t.const("indices",o._`{}`);t.for(o._`;${i}--;`,(()=>{t.let(s,o._`${n}[${i}]`),t.if(l,o._`continue`),f.length>1&&t.if(o._`typeof ${s} == "string"`,o._`${s} += "_"`),t.if(o._`typeof ${c}[${s}] == "number"`,(()=>{t.assign(a,o._`${c}[${s}]`),e.error(),t.assign(d,!1).break()})).code(o._`${c}[${s}] = ${i}`)}))}function m(r,s){const l=i.useFunc(t,a.default),c=t.name("outer");t.label(c).for(o._`;${r}--;`,(()=>t.for(o._`${s} = ${r}; ${s}--;`,(()=>t.if(o._`${l}(${n}[${r}], ${n}[${s}])`,(()=>{e.error(),t.assign(d,!1).break(c)}))))))}e.block$data(d,(function(){const r=t.let("i",o._`${n}.length`),i=t.let("j");e.setParams({i:r,j:i}),t.assign(d,!0),t.if(o._`${r} > 1`,(()=>(f.length>0&&!f.some((e=>"object"===e||"array"===e))?h:m)(r,i)))}),o._`${u} === false`),e.ok(d)}};t.default=s},4029:function(e){"use strict";var t=e.exports=function(e,t,r){"function"==typeof t&&(r=t,t={}),n(t,"function"==typeof(r=t.cb||r)?r:r.pre||function(){},r.post||function(){},e,"",e)};function n(e,r,o,i,a,s,l,c,u,p){if(i&&"object"==typeof i&&!Array.isArray(i)){for(var d in r(i,a,s,l,c,u,p),i){var f=i[d];if(Array.isArray(f)){if(d in t.arrayKeywords)for(var h=0;h<f.length;h++)n(e,r,o,f[h],a+"/"+d+"/"+h,s,a,d,i,h)}else if(d in t.propsKeywords){if(f&&"object"==typeof f)for(var m in f)n(e,r,o,f[m],a+"/"+d+"/"+m.replace(/~/g,"~0").replace(/\//g,"~1"),s,a,d,i,m)}else(d in t.keywords||e.allKeys&&!(d in t.skipKeywords))&&n(e,r,o,f,a+"/"+d,s,a,d,i)}o(i,a,s,l,c,u,p)}}t.keywords={additionalItems:!0,items:!0,contains:!0,additionalProperties:!0,propertyNames:!0,not:!0,if:!0,then:!0,else:!0},t.arrayKeywords={items:!0,allOf:!0,anyOf:!0,oneOf:!0},t.propsKeywords={$defs:!0,definitions:!0,properties:!0,patternProperties:!0,dependencies:!0},t.skipKeywords={default:!0,enum:!0,const:!0,required:!0,maximum:!0,minimum:!0,exclusiveMaximum:!0,exclusiveMinimum:!0,multipleOf:!0,maxLength:!0,minLength:!0,pattern:!0,format:!0,maxItems:!0,minItems:!0,uniqueItems:!0,maxProperties:!0,minProperties:!0}},3675:function(e,t,n){"use strict";var r=this&&this.__awaiter||function(e,t,n,r){return new(n||(n=Promise))((function(o,i){function a(e){try{l(r.next(e))}catch(e){i(e)}}function s(e){try{l(r.throw(e))}catch(e){i(e)}}function l(e){var t;e.done?o(e.value):(t=e.value,t instanceof n?t:new n((function(e){e(t)}))).then(a,s)}l((r=r.apply(e,t||[])).next())}))};Object.defineProperty(t,"__esModule",{value:!0}),t.mapTypeToComponent=t.bundleDocument=t.bundle=t.OasVersion=void 0;const o=n(2307),i=n(4182),a=n(8065),s=n(5241),l=n(388),c=n(2608),u=n(5220),p=n(9443),d=n(1510),f=n(7468),h=n(5030),m=n(348),g=n(771),y=n(1094),v=n(4508),b=n(6350);var w;function x(e){return r(this,void 0,void 0,(function*(){const{document:t,config:n,customTypes:r,externalRefResolver:o,dereference:f=!1,skipRedoclyRegistryRefs:m=!1,removeUnusedComponents:g=!1,keepUrlRefs:y=!1}=e,x=d.detectOpenAPI(t.parsed),k=d.openAPIMajor(x),O=n.getRulesForOasVersion(k),S=u.normalizeTypes(n.extendTypes((null!=r?r:k===d.OasMajorVersion.Version3)?x===w.Version3_1?c.Oas3_1Types:s.Oas3Types:l.Oas2Types,x),n),E=h.initRules(O,n,"preprocessors",x),P=h.initRules(O,n,"decorators",x),A={problems:[],oasVersion:x,refTypes:new Map,visitorsData:{}};g&&P.push({severity:"error",ruleId:"remove-unused-components",visitor:k===d.OasMajorVersion.Version2?v.RemoveUnusedComponents({}):b.RemoveUnusedComponents({})});const $=yield i.resolveDocument({rootDocument:t,rootType:S.DefinitionRoot,externalRefResolver:o}),C=a.normalizeVisitors([...E,{severity:"error",ruleId:"bundler",visitor:_(k,f,m,t,$,y)},...P],S);return p.walkDocument({document:t,rootType:S.DefinitionRoot,normalizedVisitors:C,resolvedRefMap:$,ctx:A}),{bundle:t,problems:A.problems.map((e=>n.addProblemToIgnore(e))),fileDependencies:o.getFiles(),rootType:S.DefinitionRoot,refTypes:A.refTypes,visitorsData:A.visitorsData}}))}function k(e,t){switch(t){case d.OasMajorVersion.Version3:switch(e){case"Schema":return"schemas";case"Parameter":return"parameters";case"Response":return"responses";case"Example":return"examples";case"RequestBody":return"requestBodies";case"Header":return"headers";case"SecuritySchema":return"securitySchemes";case"Link":return"links";case"Callback":return"callbacks";default:return null}case d.OasMajorVersion.Version2:switch(e){case"Schema":return"definitions";case"Parameter":return"parameters";case"Response":return"responses";default:return null}}}function _(e,t,n,r,a,s){let l;const c={ref:{leave(o,l,c){if(!c.location||void 0===c.node)return void m.reportUnresolvedRef(c,l.report,l.location);if(c.location.source===r.source&&c.location.source===l.location.source&&"scalar"!==l.type.name&&!t)return;if(n&&y.isRedoclyRegistryURL(o.$ref))return;if(s&&f.isAbsoluteUrl(o.$ref))return;const d=k(l.type.name,e);d?t?(p(d,c,l),u(o,c,l)):(o.$ref=p(d,c,l),function(e,t,n){const o=i.makeRefId(n.location.source.absoluteRef,e.$ref);a.set(o,{document:r,isRemote:!1,node:t.node,nodePointer:e.$ref,resolved:!0})}(o,c,l)):u(o,c,l)}},DefinitionRoot:{enter(t){e===d.OasMajorVersion.Version3?l=t.components=t.components||{}:e===d.OasMajorVersion.Version2&&(l=t)}}};function u(e,t,n){g.isPlainObject(t.node)?(delete e.$ref,Object.assign(e,t.node)):n.parent[n.key]=t.node}function p(t,n,r){l[t]=l[t]||{};const o=function(e,t,n){const[r,o]=[e.location.source.absoluteRef,e.location.pointer],i=l[t];let a="";const s=o.slice(2).split("/").filter(Boolean);for(;s.length>0;)if(a=s.pop()+(a?`-${a}`:""),!i||!i[a]||h(i[a],e,n))return a;if(a=f.refBaseName(r)+(a?`_${a}`:""),!i[a]||h(i[a],e,n))return a;const c=a;let u=2;for(;i[a]&&!h(i[a],e,n);)a=`${c}-${u}`,u++;return i[a]||n.report({message:`Two schemas are referenced with the same name but different content. Renamed ${c} to ${a}.`,location:n.location,forceSeverity:"warn"}),a}(n,t,r);return l[t][o]=n.node,e===d.OasMajorVersion.Version3?`#/components/${t}/${o}`:`#/${t}/${o}`}function h(e,t,n){var r;return!(!f.isRef(e)||(null===(r=n.resolve(e).location)||void 0===r?void 0:r.absolutePointer)!==t.location.absolutePointer)||o(e,t.node)}return e===d.OasMajorVersion.Version3&&(c.DiscriminatorMapping={leave(n,r){for(const o of Object.keys(n)){const i=n[o],a=r.resolve({$ref:i});if(!a.location||void 0===a.node)return void m.reportUnresolvedRef(a,r.report,r.location.child(o));const s=k("Schema",e);t?p(s,a,r):n[o]=p(s,a,r)}}}),c}!function(e){e.Version2="oas2",e.Version3_0="oas3_0",e.Version3_1="oas3_1"}(w=t.OasVersion||(t.OasVersion={})),t.bundle=function(e){return r(this,void 0,void 0,(function*(){const{ref:t,doc:n,externalRefResolver:r=new i.BaseResolver(e.config.resolve),base:o=null}=e;if(!t&&!n)throw new Error("Document or reference is required.\n");const a=void 0!==n?n:yield r.resolveDocument(o,t,!0);if(a instanceof Error)throw a;return x(Object.assign(Object.assign({document:a},e),{config:e.config.lint,externalRefResolver:r}))}))},t.bundleDocument=x,t.mapTypeToComponent=k},6877:function(e,t){"use strict";Object.defineProperty(t,"__esModule",{value:!0}),t.default={rules:{"info-description":"error","info-contact":"error","info-license":"error","info-license-url":"error","tag-description":"error","tags-alphabetical":"error","parameter-description":"error","no-identical-paths":"error","no-ambiguous-paths":"error","no-path-trailing-slash":"error","path-segment-plural":"error","path-declaration-must-exist":"error","path-not-include-query":"error","path-parameters-defined":"error","operation-description":"error","operation-2xx-response":"error","operation-4xx-response":"error",assertions:"error","operation-operationId":"error","operation-summary":"error","operation-operationId-unique":"error","operation-operationId-url-safe":"error","operation-parameters-unique":"error","operation-tag-defined":"error","operation-security-defined":"error","operation-singular-tag":"error","no-unresolved-refs":"error","no-enum-type-mismatch":"error","boolean-parameter-prefixes":"error","paths-kebab-case":"error","no-http-verbs-in-paths":"error","path-excludes-patterns":{severity:"error",patterns:[]},"request-mime-type":"error",spec:"error","no-invalid-schema-examples":"error","no-invalid-parameter-examples":"error","scalar-property-missing-example":"error"},oas3_0Rules:{"no-invalid-media-type-examples":"error","no-server-example.com":"error","no-server-trailing-slash":"error","no-empty-servers":"error","no-example-value-and-externalValue":"error","no-unused-components":"error","no-undefined-server-variable":"error","no-servers-empty-enum":"error"},oas3_1Rules:{"no-server-example.com":"error","no-server-trailing-slash":"error","no-empty-servers":"error","no-example-value-and-externalValue":"error","no-unused-components":"error","no-undefined-server-variable":"error","no-servers-empty-enum":"error"}}},6242:function(e,t,n){"use strict";Object.defineProperty(t,"__esModule",{value:!0}),t.defaultPlugin=t.builtInConfigs=void 0;const r=n(8057),o=n(6877),i=n(9016),a=n(226),s=n(7523),l=n(226),c=n(7523),u=n(1753),p=n(7060);t.builtInConfigs={recommended:r.default,minimal:i.default,all:o.default,"redocly-registry":{decorators:{"registry-dependencies":"on"}}},t.defaultPlugin={id:"",rules:{oas3:a.rules,oas2:s.rules},preprocessors:{oas3:l.preprocessors,oas2:c.preprocessors},decorators:{oas3:u.decorators,oas2:p.decorators},configs:t.builtInConfigs}},7040:function(e,t,n){"use strict";var r=this&&this.__awaiter||function(e,t,n,r){return new(n||(n=Promise))((function(o,i){function a(e){try{l(r.next(e))}catch(e){i(e)}}function s(e){try{l(r.throw(e))}catch(e){i(e)}}function l(e){var t;e.done?o(e.value):(t=e.value,t instanceof n?t:new n((function(e){e(t)}))).then(a,s)}l((r=r.apply(e,t||[])).next())}))},o=this&&this.__rest||function(e,t){var n={};for(var r in e)Object.prototype.hasOwnProperty.call(e,r)&&t.indexOf(r)<0&&(n[r]=e[r]);if(null!=e&&"function"==typeof Object.getOwnPropertySymbols){var o=0;for(r=Object.getOwnPropertySymbols(e);o<r.length;o++)t.indexOf(r[o])<0&&Object.prototype.propertyIsEnumerable.call(e,r[o])&&(n[r[o]]=e[r[o]])}return n};Object.defineProperty(t,"__esModule",{value:!0}),t.resolvePreset=t.resolveLint=t.resolveApis=t.resolvePlugins=t.resolveConfig=void 0;const i=n(6470),a=n(6212),s=n(7468),l=n(4182),c=n(6242),u=n(2565),p=n(771),d=n(3777);function f(e,t=""){if(!e)return[];const n=require,r=new Map;return e.map((e=>{if(p.isString(e)&&s.isAbsoluteUrl(e))throw new Error(a.red("We don't support remote plugins yet."));const o=p.isString(e)?n(i.resolve(i.dirname(t),e)):e,l=o.id;if("string"!=typeof l)throw new Error(a.red(`Plugin must define \`id\` property in ${a.blue(e.toString())}.`));if(r.has(l)){const t=r.get(l);throw new Error(a.red(`Plugin "id" must be unique. Plugin ${a.blue(e.toString())} uses id "${a.blue(l)}" already seen in ${a.blue(t)}`))}r.set(l,e.toString());const c=Object.assign(Object.assign({id:l},o.configs?{configs:o.configs}:{}),o.typeExtension?{typeExtension:o.typeExtension}:{});if(o.rules){if(!o.rules.oas3&&!o.rules.oas2)throw new Error(`Plugin rules must have \`oas3\` or \`oas2\` rules "${e}.`);c.rules={},o.rules.oas3&&(c.rules.oas3=u.prefixRules(o.rules.oas3,l)),o.rules.oas2&&(c.rules.oas2=u.prefixRules(o.rules.oas2,l))}if(o.preprocessors){if(!o.preprocessors.oas3&&!o.preprocessors.oas2)throw new Error(`Plugin \`preprocessors\` must have \`oas3\` or \`oas2\` preprocessors "${e}.`);c.preprocessors={},o.preprocessors.oas3&&(c.preprocessors.oas3=u.prefixRules(o.preprocessors.oas3,l)),o.preprocessors.oas2&&(c.preprocessors.oas2=u.prefixRules(o.preprocessors.oas2,l))}if(o.decorators){if(!o.decorators.oas3&&!o.decorators.oas2)throw new Error(`Plugin \`decorators\` must have \`oas3\` or \`oas2\` decorators "${e}.`);c.decorators={},o.decorators.oas3&&(c.decorators.oas3=u.prefixRules(o.decorators.oas3,l)),o.decorators.oas2&&(c.decorators.oas2=u.prefixRules(o.decorators.oas2,l))}return c})).filter(p.notUndefined)}function h({rawConfig:e,configPath:t="",resolver:n}){var o,i;return r(this,void 0,void 0,(function*(){const{apis:r={},lint:a={}}=e;let s={};for(const[e,l]of Object.entries(r||{})){if(null===(i=null===(o=l.lint)||void 0===o?void 0:o.extends)||void 0===i?void 0:i.some(p.isNotString))throw new Error("Error configuration format not detected in extends value must contain strings");const r=v(a,l.lint),c=yield g({lintConfig:r,configPath:t,resolver:n});s[e]=Object.assign(Object.assign({},l),{lint:c})}return s}))}function m({lintConfig:e,configPath:t="",resolver:n=new l.BaseResolver},a=[],d=[]){var h,g,v;return r(this,void 0,void 0,(function*(){if(a.includes(t))throw new Error(`Circular dependency in config file: "${t}"`);const l=u.getUniquePlugins(f([...(null==e?void 0:e.plugins)||[],c.defaultPlugin],t)),b=null===(h=null==e?void 0:e.plugins)||void 0===h?void 0:h.filter(p.isString).map((e=>i.resolve(i.dirname(t),e))),w=s.isAbsoluteUrl(t)?t:t&&i.resolve(t),x=yield Promise.all((null===(g=null==e?void 0:e.extends)||void 0===g?void 0:g.map((e=>r(this,void 0,void 0,(function*(){if(!s.isAbsoluteUrl(e)&&!i.extname(e))return y(e,l);const o=s.isAbsoluteUrl(e)?e:s.isAbsoluteUrl(t)?new URL(e,t).href:i.resolve(i.dirname(t),e),c=yield function(e,t){return r(this,void 0,void 0,(function*(){try{const n=yield t.loadExternalRef(e),r=u.transformConfig(p.parseYaml(n.body));if(!r.lint)throw new Error(`Lint configuration format not detected: "${e}"`);return r.lint}catch(t){throw new Error(`Failed to load "${e}": ${t.message}`)}}))}(o,n);return yield m({lintConfig:c,configPath:o,resolver:n},[...a,w],d)})))))||[]),k=u.mergeExtends([...x,Object.assign(Object.assign({},e),{plugins:l,extends:void 0,extendPaths:[...a,w],pluginPaths:b})]),{plugins:_=[]}=k,O=o(k,["plugins"]);return Object.assign(Object.assign({},O),{extendPaths:null===(v=O.extendPaths)||void 0===v?void 0:v.filter((e=>e&&!s.isAbsoluteUrl(e))),plugins:u.getUniquePlugins(_),recommendedFallback:null==e?void 0:e.recommendedFallback,doNotResolveExamples:null==e?void 0:e.doNotResolveExamples})}))}function g(e,t=[],n=[]){return r(this,void 0,void 0,(function*(){const r=yield m(e,t,n);return Object.assign(Object.assign({},r),{rules:r.rules&&b(r.rules)})}))}function y(e,t){var n;const{pluginId:r,configName:o}=u.parsePresetName(e),i=t.find((e=>e.id===r));if(!i)throw new Error(`Invalid config ${a.red(e)}: plugin ${r} is not included.`);const s=null===(n=i.configs)||void 0===n?void 0:n[o];if(!s)throw new Error(r?`Invalid config ${a.red(e)}: plugin ${r} doesn't export config with name ${o}.`:`Invalid config ${a.red(e)}: there is no such built-in config.`);return s}function v(e,t){return Object.assign(Object.assign(Object.assign({},e),t),{rules:Object.assign(Object.assign({},null==e?void 0:e.rules),null==t?void 0:t.rules),oas2Rules:Object.assign(Object.assign({},null==e?void 0:e.oas2Rules),null==t?void 0:t.oas2Rules),oas3_0Rules:Object.assign(Object.assign({},null==e?void 0:e.oas3_0Rules),null==t?void 0:t.oas3_0Rules),oas3_1Rules:Object.assign(Object.assign({},null==e?void 0:e.oas3_1Rules),null==t?void 0:t.oas3_1Rules),preprocessors:Object.assign(Object.assign({},null==e?void 0:e.preprocessors),null==t?void 0:t.preprocessors),oas2Preprocessors:Object.assign(Object.assign({},null==e?void 0:e.oas2Preprocessors),null==t?void 0:t.oas2Preprocessors),oas3_0Preprocessors:Object.assign(Object.assign({},null==e?void 0:e.oas3_0Preprocessors),null==t?void 0:t.oas3_0Preprocessors),oas3_1Preprocessors:Object.assign(Object.assign({},null==e?void 0:e.oas3_1Preprocessors),null==t?void 0:t.oas3_1Preprocessors),decorators:Object.assign(Object.assign({},null==e?void 0:e.decorators),null==t?void 0:t.decorators),oas2Decorators:Object.assign(Object.assign({},null==e?void 0:e.oas2Decorators),null==t?void 0:t.oas2Decorators),oas3_0Decorators:Object.assign(Object.assign({},null==e?void 0:e.oas3_0Decorators),null==t?void 0:t.oas3_0Decorators),oas3_1Decorators:Object.assign(Object.assign({},null==e?void 0:e.oas3_1Decorators),null==t?void 0:t.oas3_1Decorators),recommendedFallback:!(null==t?void 0:t.extends)&&e.recommendedFallback})}function b(e){if(!e)return e;const t={},n=[];for(const[r,o]of Object.entries(e))if(r.startsWith("assert/")&&"object"==typeof o&&null!==o){const e=o;n.push(Object.assign(Object.assign({},e),{assertionId:r.replace("assert/","")}))}else t[r]=o;return n.length>0&&(t.assertions=n),t}t.resolveConfig=function(e,t){var n,o,i,a,s;return r(this,void 0,void 0,(function*(){if(null===(o=null===(n=e.lint)||void 0===n?void 0:n.extends)||void 0===o?void 0:o.some(p.isNotString))throw new Error("Error configuration format not detected in extends value must contain strings");const r=new l.BaseResolver(u.getResolveConfig(e.resolve)),c=null!==(a=null===(i=null==e?void 0:e.lint)||void 0===i?void 0:i.extends)&&void 0!==a?a:["recommended"],f=!(null===(s=null==e?void 0:e.lint)||void 0===s?void 0:s.extends),m=Object.assign(Object.assign({},null==e?void 0:e.lint),{extends:c,recommendedFallback:f}),y=yield h({rawConfig:Object.assign(Object.assign({},e),{lint:m}),configPath:t,resolver:r}),v=yield g({lintConfig:m,configPath:t,resolver:r});return new d.Config(Object.assign(Object.assign({},e),{apis:y,lint:v}),t)}))},t.resolvePlugins=f,t.resolveApis=h,t.resolveLint=g,t.resolvePreset=y},3777:function(e,t,n){"use strict";Object.defineProperty(t,"__esModule",{value:!0}),t.Config=t.LintConfig=t.AVAILABLE_REGIONS=t.DOMAINS=t.DEFAULT_REGION=t.IGNORE_FILE=t.env=void 0;const r=n(5101),o=n(6470),i=n(5273),a=n(771),s=n(1510),l=n(2565);t.env="undefined"!=typeof process&&{}||{},t.IGNORE_FILE=".redocly.lint-ignore.yaml",t.DEFAULT_REGION="us",t.DOMAINS=function(){const e={us:"redocly.com",eu:"eu.redocly.com"},n=t.env.REDOCLY_DOMAIN;return(null==n?void 0:n.endsWith(".redocly.host"))&&(e[n.split(".")[0]]=n),"redoc.online"===n&&(e[n]=n),e}(),t.AVAILABLE_REGIONS=Object.keys(t.DOMAINS);class c{constructor(e,n){this.rawConfig=e,this.configFile=n,this.ignore={},this._usedRules=new Set,this._usedVersions=new Set,this.plugins=e.plugins||[],this.doNotResolveExamples=!!e.doNotResolveExamples,this.recommendedFallback=e.recommendedFallback||!1,this.rules={[s.OasVersion.Version2]:Object.assign(Object.assign({},e.rules),e.oas2Rules),[s.OasVersion.Version3_0]:Object.assign(Object.assign({},e.rules),e.oas3_0Rules),[s.OasVersion.Version3_1]:Object.assign(Object.assign({},e.rules),e.oas3_1Rules)},this.preprocessors={[s.OasVersion.Version2]:Object.assign(Object.assign({},e.preprocessors),e.oas2Preprocessors),[s.OasVersion.Version3_0]:Object.assign(Object.assign({},e.preprocessors),e.oas3_0Preprocessors),[s.OasVersion.Version3_1]:Object.assign(Object.assign({},e.preprocessors),e.oas3_1Preprocessors)},this.decorators={[s.OasVersion.Version2]:Object.assign(Object.assign({},e.decorators),e.oas2Decorators),[s.OasVersion.Version3_0]:Object.assign(Object.assign({},e.decorators),e.oas3_0Decorators),[s.OasVersion.Version3_1]:Object.assign(Object.assign({},e.decorators),e.oas3_1Decorators)},this.extendPaths=e.extendPaths||[],this.pluginPaths=e.pluginPaths||[];const a=this.configFile?o.dirname(this.configFile):"undefined"!=typeof process&&process.cwd()||"",l=o.join(a,t.IGNORE_FILE);if(r.hasOwnProperty("existsSync")&&r.existsSync(l)){this.ignore=i.parseYaml(r.readFileSync(l,"utf-8"))||{};for(const e of Object.keys(this.ignore)){this.ignore[o.resolve(o.dirname(l),e)]=this.ignore[e];for(const t of Object.keys(this.ignore[e]))this.ignore[e][t]=new Set(this.ignore[e][t]);delete this.ignore[e]}}}saveIgnore(){const e=this.configFile?o.dirname(this.configFile):process.cwd(),n=o.join(e,t.IGNORE_FILE),s={};for(const t of Object.keys(this.ignore)){const n=s[a.slash(o.relative(e,t))]=this.ignore[t];for(const e of Object.keys(n))n[e]=Array.from(n[e])}r.writeFileSync(n,"# This file instructs Redocly's linter to ignore the rules contained for specific parts of your API.\n# See https://redoc.ly/docs/cli/ for more information.\n"+i.stringifyYaml(s))}addIgnore(e){const t=this.ignore,n=e.location[0];if(void 0===n.pointer)return;const r=t[n.source.absoluteRef]=t[n.source.absoluteRef]||{};(r[e.ruleId]=r[e.ruleId]||new Set).add(n.pointer)}addProblemToIgnore(e){const t=e.location[0];if(void 0===t.pointer)return e;const n=(this.ignore[t.source.absoluteRef]||{})[e.ruleId],r=n&&n.has(t.pointer);return r?Object.assign(Object.assign({},e),{ignored:r}):e}extendTypes(e,t){let n=e;for(const e of this.plugins)if(void 0!==e.typeExtension)switch(t){case s.OasVersion.Version3_0:case s.OasVersion.Version3_1:if(!e.typeExtension.oas3)continue;n=e.typeExtension.oas3(n,t);case s.OasVersion.Version2:if(!e.typeExtension.oas2)continue;n=e.typeExtension.oas2(n,t);default:throw new Error("Not implemented")}return n}getRuleSettings(e,t){this._usedRules.add(e),this._usedVersions.add(t);const n=this.rules[t][e]||"off";return"string"==typeof n?{severity:n}:Object.assign({severity:"error"},n)}getPreprocessorSettings(e,t){this._usedRules.add(e),this._usedVersions.add(t);const n=this.preprocessors[t][e]||"off";return"string"==typeof n?{severity:"on"===n?"error":n}:Object.assign({severity:"error"},n)}getDecoratorSettings(e,t){this._usedRules.add(e),this._usedVersions.add(t);const n=this.decorators[t][e]||"off";return"string"==typeof n?{severity:"on"===n?"error":n}:Object.assign({severity:"error"},n)}getUnusedRules(){const e=[],t=[],n=[];for(const r of Array.from(this._usedVersions))e.push(...Object.keys(this.rules[r]).filter((e=>!this._usedRules.has(e)))),t.push(...Object.keys(this.decorators[r]).filter((e=>!this._usedRules.has(e)))),n.push(...Object.keys(this.preprocessors[r]).filter((e=>!this._usedRules.has(e))));return{rules:e,preprocessors:n,decorators:t}}getRulesForOasVersion(e){switch(e){case s.OasMajorVersion.Version3:const e=[];return this.plugins.forEach((t=>{var n;return(null===(n=t.preprocessors)||void 0===n?void 0:n.oas3)&&e.push(t.preprocessors.oas3)})),this.plugins.forEach((t=>{var n;return(null===(n=t.rules)||void 0===n?void 0:n.oas3)&&e.push(t.rules.oas3)})),this.plugins.forEach((t=>{var n;return(null===(n=t.decorators)||void 0===n?void 0:n.oas3)&&e.push(t.decorators.oas3)})),e;case s.OasMajorVersion.Version2:const t=[];return this.plugins.forEach((e=>{var n;return(null===(n=e.preprocessors)||void 0===n?void 0:n.oas2)&&t.push(e.preprocessors.oas2)})),this.plugins.forEach((e=>{var n;return(null===(n=e.rules)||void 0===n?void 0:n.oas2)&&t.push(e.rules.oas2)})),this.plugins.forEach((e=>{var n;return(null===(n=e.decorators)||void 0===n?void 0:n.oas2)&&t.push(e.decorators.oas2)})),t}}skipRules(e){for(const t of e||[])for(const e of Object.values(s.OasVersion))this.rules[e][t]&&(this.rules[e][t]="off")}skipPreprocessors(e){for(const t of e||[])for(const e of Object.values(s.OasVersion))this.preprocessors[e][t]&&(this.preprocessors[e][t]="off")}skipDecorators(e){for(const t of e||[])for(const e of Object.values(s.OasVersion))this.decorators[e][t]&&(this.decorators[e][t]="off")}}t.LintConfig=c,t.Config=class{constructor(e,t){this.rawConfig=e,this.configFile=t,this.apis=e.apis||{},this.lint=new c(e.lint||{},t),this["features.openapi"]=e["features.openapi"]||{},this["features.mockServer"]=e["features.mockServer"]||{},this.resolve=l.getResolveConfig(null==e?void 0:e.resolve),this.region=e.region,this.organization=e.organization}}},8698:function(e,t,n){"use strict";var r=this&&this.__createBinding||(Object.create?function(e,t,n,r){void 0===r&&(r=n),Object.defineProperty(e,r,{enumerable:!0,get:function(){return t[n]}})}:function(e,t,n,r){void 0===r&&(r=n),e[r]=t[n]}),o=this&&this.__exportStar||function(e,t){for(var n in e)"default"===n||Object.prototype.hasOwnProperty.call(t,n)||r(t,e,n)};Object.defineProperty(t,"__esModule",{value:!0}),o(n(3777),t),o(n(3865),t),o(n(5030),t),o(n(6242),t),o(n(9129),t),o(n(2565),t),o(n(7040),t)},9129:function(e,t,n){"use strict";var r=this&&this.__awaiter||function(e,t,n,r){return new(n||(n=Promise))((function(o,i){function a(e){try{l(r.next(e))}catch(e){i(e)}}function s(e){try{l(r.throw(e))}catch(e){i(e)}}function l(e){var t;e.done?o(e.value):(t=e.value,t instanceof n?t:new n((function(e){e(t)}))).then(a,s)}l((r=r.apply(e,t||[])).next())}))};Object.defineProperty(t,"__esModule",{value:!0}),t.getConfig=t.findConfig=t.CONFIG_FILE_NAMES=t.loadConfig=void 0;const o=n(5101),i=n(6470),a=n(1094),s=n(771),l=n(3777),c=n(2565),u=n(7040);function p(e){if(!o.hasOwnProperty("existsSync"))return;const n=t.CONFIG_FILE_NAMES.map((t=>e?i.resolve(e,t):t)).filter(o.existsSync);if(n.length>1)throw new Error(`\n Multiple configuration files are not allowed. \n Found the following files: ${n.join(", ")}. \n Please use 'redocly.yaml' instead.\n `);return n[0]}function d(e=p()){return r(this,void 0,void 0,(function*(){if(!e)return{};try{const t=(yield s.loadYaml(e))||{};return c.transformConfig(t)}catch(t){throw new Error(`Error parsing config file at '${e}': ${t.message}`)}}))}t.loadConfig=function(e=p(),t,n){return r(this,void 0,void 0,(function*(){const o=yield d(e);return"function"==typeof n&&(yield n(o)),yield function({rawConfig:e,customExtends:t,configPath:n}){var o;return r(this,void 0,void 0,(function*(){void 0!==t?(e.lint=e.lint||{},e.lint.extends=t):s.isEmptyObject(e);const r=new a.RedoclyClient,i=yield r.getTokens();if(i.length){e.resolve||(e.resolve={}),e.resolve.http||(e.resolve.http={}),e.resolve.http.headers=[...null!==(o=e.resolve.http.headers)&&void 0!==o?o:[]];for(const t of i){const n=l.DOMAINS[t.region];e.resolve.http.headers.push({matches:`https://api.${n}/registry/**`,name:"Authorization",envVariable:void 0,value:t.token},..."us"===t.region?[{matches:"https://api.redoc.ly/registry/**",name:"Authorization",envVariable:void 0,value:t.token}]:[])}}return u.resolveConfig(e,n)}))}({rawConfig:o,customExtends:t,configPath:e})}))},t.CONFIG_FILE_NAMES=["redocly.yaml","redocly.yml",".redocly.yaml",".redocly.yml"],t.findConfig=p,t.getConfig=d},9016:function(e,t){"use strict";Object.defineProperty(t,"__esModule",{value:!0}),t.default={rules:{"info-description":"warn","info-contact":"off","info-license":"off","info-license-url":"off","tag-description":"warn","tags-alphabetical":"off","parameter-description":"off","no-path-trailing-slash":"warn","no-identical-paths":"warn","no-ambiguous-paths":"warn","path-declaration-must-exist":"warn","path-not-include-query":"warn","path-parameters-defined":"warn","operation-description":"off","operation-2xx-response":"warn","operation-4xx-response":"off",assertions:"warn","operation-operationId":"warn","operation-summary":"warn","operation-operationId-unique":"warn","operation-parameters-unique":"warn","operation-tag-defined":"off","operation-security-defined":"warn","operation-operationId-url-safe":"warn","operation-singular-tag":"off","no-unresolved-refs":"error","no-enum-type-mismatch":"warn","boolean-parameter-prefixes":"off","paths-kebab-case":"off",spec:"error"},oas3_0Rules:{"no-invalid-media-type-examples":{severity:"warn",disallowAdditionalProperties:!0},"no-server-example.com":"warn","no-server-trailing-slash":"error","no-empty-servers":"warn","no-example-value-and-externalValue":"warn","no-unused-components":"warn","no-undefined-server-variable":"warn","no-servers-empty-enum":"error"},oas3_1Rules:{"no-server-example.com":"warn","no-server-trailing-slash":"error","no-empty-servers":"warn","no-example-value-and-externalValue":"warn","no-unused-components":"warn","no-undefined-server-variable":"warn","no-servers-empty-enum":"error"}}},8057:function(e,t){"use strict";Object.defineProperty(t,"__esModule",{value:!0}),t.default={rules:{"info-description":"warn","info-contact":"off","info-license":"warn","info-license-url":"warn","tag-description":"warn","tags-alphabetical":"off","parameter-description":"off","no-path-trailing-slash":"error","no-identical-paths":"error","no-ambiguous-paths":"warn","path-declaration-must-exist":"error","path-not-include-query":"error","path-parameters-defined":"error","operation-description":"off","operation-2xx-response":"warn",assertions:"warn","operation-4xx-response":"warn","operation-operationId":"warn","operation-summary":"error","operation-operationId-unique":"error","operation-operationId-url-safe":"error","operation-parameters-unique":"error","operation-tag-defined":"off","operation-security-defined":"error","operation-singular-tag":"off","no-unresolved-refs":"error","no-enum-type-mismatch":"error","boolean-parameter-prefixes":"off","paths-kebab-case":"off",spec:"error"},oas3_0Rules:{"no-invalid-media-type-examples":{severity:"warn",disallowAdditionalProperties:!0},"no-server-example.com":"warn","no-server-trailing-slash":"error","no-empty-servers":"error","no-example-value-and-externalValue":"error","no-unused-components":"warn","no-undefined-server-variable":"error","no-servers-empty-enum":"error"},oas3_1Rules:{"no-server-example.com":"warn","no-server-trailing-slash":"error","no-empty-servers":"error","no-example-value-and-externalValue":"error","no-unused-components":"warn","no-undefined-server-variable":"error","no-servers-empty-enum":"error"}}},5030:function(e,t,n){"use strict";Object.defineProperty(t,"__esModule",{value:!0}),t.initRules=void 0;const r=n(771);t.initRules=function(e,t,n,o){return e.flatMap((e=>Object.keys(e).map((r=>{const i=e[r],a="rules"===n?t.getRuleSettings(r,o):"preprocessors"===n?t.getPreprocessorSettings(r,o):t.getDecoratorSettings(r,o);if("off"===a.severity)return;const s=i(a);return Array.isArray(s)?s.map((e=>({severity:a.severity,ruleId:r,visitor:e}))):{severity:a.severity,ruleId:r,visitor:s}})))).flatMap((e=>e)).filter(r.notUndefined)}},3865:function(e,t){"use strict";Object.defineProperty(t,"__esModule",{value:!0})},2565:function(e,t,n){"use strict";var r=this&&this.__rest||function(e,t){var n={};for(var r in e)Object.prototype.hasOwnProperty.call(e,r)&&t.indexOf(r)<0&&(n[r]=e[r]);if(null!=e&&"function"==typeof Object.getOwnPropertySymbols){var o=0;for(r=Object.getOwnPropertySymbols(e);o<r.length;o++)t.indexOf(r[o])<0&&Object.prototype.propertyIsEnumerable.call(e,r[o])&&(n[r[o]]=e[r[o]])}return n};Object.defineProperty(t,"__esModule",{value:!0}),t.getUniquePlugins=t.getResolveConfig=t.transformConfig=t.getMergedConfig=t.mergeExtends=t.prefixRules=t.transformApiDefinitionsToApis=t.parsePresetName=void 0;const o=n(6212),i=n(771),a=n(3777);function s(e={}){let t={};for(const[n,r]of Object.entries(e))t[n]={root:r};return t}t.parsePresetName=function(e){if(e.indexOf("/")>-1){const[t,n]=e.split("/");return{pluginId:t,configName:n}}return{pluginId:"",configName:e}},t.transformApiDefinitionsToApis=s,t.prefixRules=function(e,t){if(!t)return e;const n={};for(const r of Object.keys(e))n[`${t}/${r}`]=e[r];return n},t.mergeExtends=function(e){const t={rules:{},oas2Rules:{},oas3_0Rules:{},oas3_1Rules:{},preprocessors:{},oas2Preprocessors:{},oas3_0Preprocessors:{},oas3_1Preprocessors:{},decorators:{},oas2Decorators:{},oas3_0Decorators:{},oas3_1Decorators:{},plugins:[],pluginPaths:[],extendPaths:[]};for(let n of e){if(n.extends)throw new Error(`\`extends\` is not supported in shared configs yet: ${JSON.stringify(n,null,2)}.`);Object.assign(t.rules,n.rules),Object.assign(t.oas2Rules,n.oas2Rules),i.assignExisting(t.oas2Rules,n.rules||{}),Object.assign(t.oas3_0Rules,n.oas3_0Rules),i.assignExisting(t.oas3_0Rules,n.rules||{}),Object.assign(t.oas3_1Rules,n.oas3_1Rules),i.assignExisting(t.oas3_1Rules,n.rules||{}),Object.assign(t.preprocessors,n.preprocessors),Object.assign(t.oas2Preprocessors,n.oas2Preprocessors),i.assignExisting(t.oas2Preprocessors,n.preprocessors||{}),Object.assign(t.oas3_0Preprocessors,n.oas3_0Preprocessors),i.assignExisting(t.oas3_0Preprocessors,n.preprocessors||{}),Object.assign(t.oas3_1Preprocessors,n.oas3_1Preprocessors),i.assignExisting(t.oas3_1Preprocessors,n.preprocessors||{}),Object.assign(t.decorators,n.decorators),Object.assign(t.oas2Decorators,n.oas2Decorators),i.assignExisting(t.oas2Decorators,n.decorators||{}),Object.assign(t.oas3_0Decorators,n.oas3_0Decorators),i.assignExisting(t.oas3_0Decorators,n.decorators||{}),Object.assign(t.oas3_1Decorators,n.oas3_1Decorators),i.assignExisting(t.oas3_1Decorators,n.decorators||{}),t.plugins.push(...n.plugins||[]),t.pluginPaths.push(...n.pluginPaths||[]),t.extendPaths.push(...new Set(n.extendPaths))}return t},t.getMergedConfig=function(e,t){var n,r,o,i,s,l;const c=[...Object.values(e.apis).map((e=>{var t;return null===(t=null==e?void 0:e.lint)||void 0===t?void 0:t.extendPaths})),null===(r=null===(n=e.rawConfig)||void 0===n?void 0:n.lint)||void 0===r?void 0:r.extendPaths].flat().filter(Boolean),u=[...Object.values(e.apis).map((e=>{var t;return null===(t=null==e?void 0:e.lint)||void 0===t?void 0:t.pluginPaths})),null===(i=null===(o=e.rawConfig)||void 0===o?void 0:o.lint)||void 0===i?void 0:i.pluginPaths].flat().filter(Boolean);return t?new a.Config(Object.assign(Object.assign({},e.rawConfig),{lint:Object.assign(Object.assign({},e.apis[t]?e.apis[t].lint:e.rawConfig.lint),{extendPaths:c,pluginPaths:u}),"features.openapi":Object.assign(Object.assign({},e["features.openapi"]),null===(s=e.apis[t])||void 0===s?void 0:s["features.openapi"]),"features.mockServer":Object.assign(Object.assign({},e["features.mockServer"]),null===(l=e.apis[t])||void 0===l?void 0:l["features.mockServer"])}),e.configFile):e},t.transformConfig=function(e){if(e.apis&&e.apiDefinitions)throw new Error("Do not use 'apiDefinitions' field. Use 'apis' instead.\n");if(e["features.openapi"]&&e.referenceDocs)throw new Error("Do not use 'referenceDocs' field. Use 'features.openapi' instead.\n");const t=e,{apiDefinitions:n,referenceDocs:i}=t,a=r(t,["apiDefinitions","referenceDocs"]);return n&&process.stderr.write(`The ${o.yellow("apiDefinitions")} field is deprecated. Use ${o.green("apis")} instead. Read more about this change: https://redocly.com/docs/api-registry/guides/migration-guide-config-file/#changed-properties\n`),i&&process.stderr.write(`The ${o.yellow("referenceDocs")} field is deprecated. Use ${o.green("features.openapi")} instead. Read more about this change: https://redocly.com/docs/api-registry/guides/migration-guide-config-file/#changed-properties\n`),Object.assign({"features.openapi":i,apis:s(n)},a)},t.getResolveConfig=function(e){var t,n;return{http:{headers:null!==(n=null===(t=null==e?void 0:e.http)||void 0===t?void 0:t.headers)&&void 0!==n?n:[],customFetch:void 0}}},t.getUniquePlugins=function(e){const t=new Set,n=[];for(const r of e)t.has(r.id)?r.id&&process.stderr.write(`Duplicate plugin id "${o.yellow(r.id)}".\n`):(n.push(r),t.add(r.id));return n}},1988:function(e,t,n){"use strict";Object.defineProperty(t,"__esModule",{value:!0}),t.checkIfMatchByStrategy=t.filter=void 0;const r=n(7468),o=n(771);function i(e){return Array.isArray(e)?e:[e]}t.filter=function(e,t,n){const{parent:i,key:a}=t;let s=!1;if(Array.isArray(e))for(let o=0;o<e.length;o++)r.isRef(e[o])&&n(t.resolve(e[o]).node)&&(e.splice(o,1),s=!0,o--),n(e[o])&&(e.splice(o,1),s=!0,o--);else if(o.isPlainObject(e))for(const o of Object.keys(e))r.isRef(e[o])&&n(t.resolve(e[o]).node)&&(delete e[o],s=!0),n(e[o])&&(delete e[o],s=!0);s&&(o.isEmptyObject(e)||o.isEmptyArray(e))&&delete i[a]},t.checkIfMatchByStrategy=function(e,t,n){return void 0!==e&&void 0!==t&&(Array.isArray(t)||Array.isArray(e)?(t=i(t),e=i(e),"any"===n?t.some((t=>e.includes(t))):"all"===n&&t.every((t=>e.includes(t)))):e===t)}},9244:function(e,t,n){"use strict";Object.defineProperty(t,"__esModule",{value:!0}),t.FilterIn=void 0;const r=n(1988);t.FilterIn=({property:e,value:t,matchStrategy:n})=>{const o=n||"any",i=n=>(null==n?void 0:n[e])&&!r.checkIfMatchByStrategy(null==n?void 0:n[e],t,o);return{any:{enter:(e,t)=>{r.filter(e,t,i)}}}}},8623:function(e,t,n){"use strict";Object.defineProperty(t,"__esModule",{value:!0}),t.FilterOut=void 0;const r=n(1988);t.FilterOut=({property:e,value:t,matchStrategy:n})=>{const o=n||"any",i=n=>r.checkIfMatchByStrategy(null==n?void 0:n[e],t,o);return{any:{enter:(e,t)=>{r.filter(e,t,i)}}}}},4555:function(e,t,n){"use strict";Object.defineProperty(t,"__esModule",{value:!0}),t.InfoDescriptionOverride=void 0;const r=n(771);t.InfoDescriptionOverride=({filePath:e})=>({Info:{leave(t,{report:n,location:o}){if(!e)throw new Error('Parameter "filePath" is not provided for "info-description-override" rule');try{t.description=r.readFileAsStringSync(e)}catch(e){n({message:`Failed to read markdown override file for "info.description".\n${e.message}`,location:o.child("description")})}}}})},7802:function(e,t,n){"use strict";Object.defineProperty(t,"__esModule",{value:!0}),t.OperationDescriptionOverride=void 0;const r=n(771);t.OperationDescriptionOverride=({operationIds:e})=>({Operation:{leave(t,{report:n,location:o}){if(!t.operationId)return;if(!e)throw new Error('Parameter "operationIds" is not provided for "operation-description-override" rule');const i=t.operationId;if(e[i])try{t.description=r.readFileAsStringSync(e[i])}catch(e){n({message:`Failed to read markdown override file for operation "${i}".\n${e.message}`,location:o.child("operationId").key()})}}}})},2287:function(e,t,n){"use strict";Object.defineProperty(t,"__esModule",{value:!0}),t.RegistryDependencies=void 0;const r=n(1094);t.RegistryDependencies=()=>{let e=new Set;return{DefinitionRoot:{leave(t,n){n.getVisitorData().links=Array.from(e)}},ref(t){if(t.$ref){const n=t.$ref.split("#/")[0];r.isRedoclyRegistryURL(n)&&e.add(n)}}}}},5830:function(e,t,n){"use strict";Object.defineProperty(t,"__esModule",{value:!0}),t.RemoveXInternal=void 0;const r=n(771),o=n(7468);t.RemoveXInternal=({internalFlagProperty:e})=>{const t=e||"x-internal";return{any:{enter:(e,n)=>{!function(e,n){var i,a,s,l;const{parent:c,key:u}=n;let p=!1;if(Array.isArray(e))for(let r=0;r<e.length;r++)o.isRef(e[r])&&(null===(i=n.resolve(e[r]).node)||void 0===i?void 0:i[t])&&(e.splice(r,1),p=!0,r--),(null===(a=e[r])||void 0===a?void 0:a[t])&&(e.splice(r,1),p=!0,r--);else if(r.isPlainObject(e))for(const r of Object.keys(e))o.isRef(e[r])&&(null===(s=n.resolve(e[r]).node)||void 0===s?void 0:s[t])&&(delete e[r],p=!0),(null===(l=e[r])||void 0===l?void 0:l[t])&&(delete e[r],p=!0);p&&(r.isEmptyObject(e)||r.isEmptyArray(e))&&delete c[u]}(e,n)}}}}},423:function(e,t,n){"use strict";Object.defineProperty(t,"__esModule",{value:!0}),t.TagDescriptionOverride=void 0;const r=n(771);t.TagDescriptionOverride=({tagNames:e})=>({Tag:{leave(t,{report:n}){if(!e)throw new Error('Parameter "tagNames" is not provided for "tag-description-override" rule');if(e[t.name])try{t.description=r.readFileAsStringSync(e[t.name])}catch(e){n({message:`Failed to read markdown override file for tag "${t.name}".\n${e.message}`})}}}})},7060:function(e,t,n){"use strict";Object.defineProperty(t,"__esModule",{value:!0}),t.decorators=void 0;const r=n(2287),o=n(7802),i=n(423),a=n(4555),s=n(5830),l=n(9244),c=n(8623);t.decorators={"registry-dependencies":r.RegistryDependencies,"operation-description-override":o.OperationDescriptionOverride,"tag-description-override":i.TagDescriptionOverride,"info-description-override":a.InfoDescriptionOverride,"remove-x-internal":s.RemoveXInternal,"filter-in":l.FilterIn,"filter-out":c.FilterOut}},1753:function(e,t,n){"use strict";Object.defineProperty(t,"__esModule",{value:!0}),t.decorators=void 0;const r=n(2287),o=n(7802),i=n(423),a=n(4555),s=n(5830),l=n(9244),c=n(8623);t.decorators={"registry-dependencies":r.RegistryDependencies,"operation-description-override":o.OperationDescriptionOverride,"tag-description-override":i.TagDescriptionOverride,"info-description-override":a.InfoDescriptionOverride,"remove-x-internal":s.RemoveXInternal,"filter-in":l.FilterIn,"filter-out":c.FilterOut}},5273:function(e,t,n){"use strict";Object.defineProperty(t,"__esModule",{value:!0}),t.stringifyYaml=t.parseYaml=void 0;const r=n(3320),o=r.JSON_SCHEMA.extend({implicit:[r.types.merge],explicit:[r.types.binary,r.types.omap,r.types.pairs,r.types.set]});t.parseYaml=(e,t)=>r.load(e,Object.assign({schema:o},t)),t.stringifyYaml=(e,t)=>r.dump(e,t)},1510:function(e,t){"use strict";var n,r;Object.defineProperty(t,"__esModule",{value:!0}),t.openAPIMajor=t.detectOpenAPI=t.OasMajorVersion=t.OasVersion=void 0,function(e){e.Version2="oas2",e.Version3_0="oas3_0",e.Version3_1="oas3_1"}(n=t.OasVersion||(t.OasVersion={})),function(e){e.Version2="oas2",e.Version3="oas3"}(r=t.OasMajorVersion||(t.OasMajorVersion={})),t.detectOpenAPI=function(e){if("object"!=typeof e)throw new Error("Document must be JSON object, got "+typeof e);if(!e.openapi&&!e.swagger)throw new Error("This doesn’t look like an OpenAPI document.\n");if(e.openapi&&"string"!=typeof e.openapi)throw new Error(`Invalid OpenAPI version: should be a string but got "${typeof e.openapi}"`);if(e.openapi&&e.openapi.startsWith("3.0"))return n.Version3_0;if(e.openapi&&e.openapi.startsWith("3.1"))return n.Version3_1;if(e.swagger&&"2.0"===e.swagger)return n.Version2;throw new Error(`Unsupported OpenAPI Version: ${e.openapi||e.swagger}`)},t.openAPIMajor=function(e){return e===n.Version2?r.Version2:r.Version3}},1094:function(e,t,n){"use strict";var r=this&&this.__awaiter||function(e,t,n,r){return new(n||(n=Promise))((function(o,i){function a(e){try{l(r.next(e))}catch(e){i(e)}}function s(e){try{l(r.throw(e))}catch(e){i(e)}}function l(e){var t;e.done?o(e.value):(t=e.value,t instanceof n?t:new n((function(e){e(t)}))).then(a,s)}l((r=r.apply(e,t||[])).next())}))};Object.defineProperty(t,"__esModule",{value:!0}),t.isRedoclyRegistryURL=t.RedoclyClient=void 0;const o=n(2116),i=n(6470),a=n(6918),s=n(8836),l=n(1390),c=n(3777),u=n(771),p=".redocly-config.json";t.RedoclyClient=class{constructor(e){this.accessTokens={},this.region=this.loadRegion(e),this.loadTokens(),this.domain=e?c.DOMAINS[e]:c.env.REDOCLY_DOMAIN||c.DOMAINS[c.DEFAULT_REGION],c.env.REDOCLY_DOMAIN=this.domain,this.registryApi=new l.RegistryApi(this.accessTokens,this.region)}loadRegion(e){if(e&&!c.DOMAINS[e])throw new Error(`Invalid argument: region in config file.\nGiven: ${s.green(e)}, choices: "us", "eu".`);return c.env.REDOCLY_DOMAIN?c.AVAILABLE_REGIONS.find((e=>c.DOMAINS[e]===c.env.REDOCLY_DOMAIN))||c.DEFAULT_REGION:e||c.DEFAULT_REGION}getRegion(){return this.region}hasTokens(){return u.isNotEmptyObject(this.accessTokens)}hasToken(){return!!this.accessTokens[this.region]}getAuthorizationHeader(){return r(this,void 0,void 0,(function*(){return this.accessTokens[this.region]}))}setAccessTokens(e){this.accessTokens=e}loadTokens(){const e=i.resolve(a.homedir(),p),t=this.readCredentialsFile(e);u.isNotEmptyObject(t)&&this.setAccessTokens(Object.assign(Object.assign({},t),t.token&&!t[this.region]&&{[this.region]:t.token})),c.env.REDOCLY_AUTHORIZATION&&this.setAccessTokens(Object.assign(Object.assign({},this.accessTokens),{[this.region]:c.env.REDOCLY_AUTHORIZATION}))}getAllTokens(){return Object.entries(this.accessTokens).filter((([e])=>c.AVAILABLE_REGIONS.includes(e))).map((([e,t])=>({region:e,token:t})))}getValidTokens(){return r(this,void 0,void 0,(function*(){const e=this.getAllTokens(),t=yield Promise.allSettled(e.map((({token:e,region:t})=>this.verifyToken(e,t))));return e.filter(((e,n)=>"fulfilled"===t[n].status)).map((({token:e,region:t})=>({token:e,region:t,valid:!0})))}))}getTokens(){return r(this,void 0,void 0,(function*(){return this.hasTokens()?yield this.getValidTokens():[]}))}isAuthorizedWithRedoclyByRegion(){return r(this,void 0,void 0,(function*(){if(!this.hasTokens())return!1;const e=this.accessTokens[this.region];if(!e)return!1;try{return yield this.verifyToken(e,this.region),!0}catch(e){return!1}}))}isAuthorizedWithRedocly(){return r(this,void 0,void 0,(function*(){return this.hasTokens()&&u.isNotEmptyObject(yield this.getValidTokens())}))}readCredentialsFile(e){return o.existsSync(e)?JSON.parse(o.readFileSync(e,"utf-8")):{}}verifyToken(e,t,n=!1){return r(this,void 0,void 0,(function*(){return this.registryApi.authStatus(e,t,n)}))}login(e,t=!1){return r(this,void 0,void 0,(function*(){const n=i.resolve(a.homedir(),p);try{yield this.verifyToken(e,this.region,t)}catch(e){throw new Error("Authorization failed. Please check if you entered a valid API key.")}const r=Object.assign(Object.assign({},this.readCredentialsFile(n)),{[this.region]:e,token:e});this.accessTokens=r,this.registryApi.setAccessTokens(r),o.writeFileSync(n,JSON.stringify(r,null,2))}))}logout(){const e=i.resolve(a.homedir(),p);o.existsSync(e)&&o.unlinkSync(e)}},t.isRedoclyRegistryURL=function(e){const t=c.env.REDOCLY_DOMAIN||c.DOMAINS[c.DEFAULT_REGION],n="redocly.com"===t?"redoc.ly":t;return!(!e.startsWith(`https://api.${t}/registry/`)&&!e.startsWith(`https://api.${n}/registry/`))}},1390:function(e,t,n){"use strict";var r=this&&this.__awaiter||function(e,t,n,r){return new(n||(n=Promise))((function(o,i){function a(e){try{l(r.next(e))}catch(e){i(e)}}function s(e){try{l(r.throw(e))}catch(e){i(e)}}function l(e){var t;e.done?o(e.value):(t=e.value,t instanceof n?t:new n((function(e){e(t)}))).then(a,s)}l((r=r.apply(e,t||[])).next())}))};Object.defineProperty(t,"__esModule",{value:!0}),t.RegistryApi=void 0;const o=n(8150),i=n(3777),a=n(771),s=n(3244).i8;t.RegistryApi=class{constructor(e,t){this.accessTokens=e,this.region=t}get accessToken(){return a.isNotEmptyObject(this.accessTokens)&&this.accessTokens[this.region]}getBaseUrl(e=i.DEFAULT_REGION){return`https://api.${i.DOMAINS[e]}/registry`}setAccessTokens(e){return this.accessTokens=e,this}request(e="",t={},n){return r(this,void 0,void 0,(function*(){const r=Object.assign({},t.headers||{},{"x-redocly-cli-version":s});if(!r.hasOwnProperty("authorization"))throw new Error("Unauthorized");const i=yield o.default(`${this.getBaseUrl(n)}${e}`,Object.assign({},t,{headers:r}));if(401===i.status)throw new Error("Unauthorized");if(404===i.status){const e=yield i.json();throw new Error(e.code)}return i}))}authStatus(e,t,n=!1){return r(this,void 0,void 0,(function*(){try{const n=yield this.request("",{headers:{authorization:e}},t);return yield n.json()}catch(e){throw n&&console.log(e),e}}))}prepareFileUpload({organizationId:e,name:t,version:n,filesHash:o,filename:i,isUpsert:a}){return r(this,void 0,void 0,(function*(){const r=yield this.request(`/${e}/${t}/${n}/prepare-file-upload`,{method:"POST",headers:{"content-type":"application/json",authorization:this.accessToken},body:JSON.stringify({filesHash:o,filename:i,isUpsert:a})},this.region);if(r.ok)return r.json();throw new Error("Could not prepare file upload")}))}pushApi({organizationId:e,name:t,version:n,rootFilePath:o,filePaths:i,branch:a,isUpsert:s,isPublic:l,batchId:c,batchSize:u}){return r(this,void 0,void 0,(function*(){if(!(yield this.request(`/${e}/${t}/${n}`,{method:"PUT",headers:{"content-type":"application/json",authorization:this.accessToken},body:JSON.stringify({rootFilePath:o,filePaths:i,branch:a,isUpsert:s,isPublic:l,batchId:c,batchSize:u})},this.region)).ok)throw new Error("Could not push api")}))}}},7468:function(e,t){"use strict";function n(e,t){return""===e&&(e="#/"),"/"===e[e.length-1]?e+t:e+"/"+t}Object.defineProperty(t,"__esModule",{value:!0}),t.isMappingRef=t.isAbsoluteUrl=t.refBaseName=t.pointerBaseName=t.parsePointer=t.parseRef=t.escapePointer=t.unescapePointer=t.Location=t.isRef=t.joinPointer=void 0,t.joinPointer=n,t.isRef=function(e){return e&&"string"==typeof e.$ref};class r{constructor(e,t){this.source=e,this.pointer=t}child(e){return new r(this.source,n(this.pointer,(Array.isArray(e)?e:[e]).map(i).join("/")))}key(){return Object.assign(Object.assign({},this),{reportOnKey:!0})}get absolutePointer(){return this.source.absoluteRef+("#/"===this.pointer?"":this.pointer)}}function o(e){return decodeURIComponent(e.replace(/~1/g,"/").replace(/~0/g,"~"))}function i(e){return"number"==typeof e?e:e.replace(/~/g,"~0").replace(/\//g,"~1")}t.Location=r,t.unescapePointer=o,t.escapePointer=i,t.parseRef=function(e){const[t,n]=e.split("#/");return{uri:t||null,pointer:n?n.split("/").map(o).filter(Boolean):[]}},t.parsePointer=function(e){return e.substr(2).split("/").map(o)},t.pointerBaseName=function(e){const t=e.split("/");return t[t.length-1]},t.refBaseName=function(e){const t=e.split(/[\/\\]/);return t[t.length-1].replace(/\.[^.]+$/,"")},t.isAbsoluteUrl=function(e){return e.startsWith("http://")||e.startsWith("https://")},t.isMappingRef=function(e){return e.startsWith("#")||e.startsWith("https://")||e.startsWith("http://")||e.startsWith("./")||e.startsWith("../")||e.indexOf("/")>-1}},4182:function(e,t,n){"use strict";var r=this&&this.__awaiter||function(e,t,n,r){return new(n||(n=Promise))((function(o,i){function a(e){try{l(r.next(e))}catch(e){i(e)}}function s(e){try{l(r.throw(e))}catch(e){i(e)}}function l(e){var t;e.done?o(e.value):(t=e.value,t instanceof n?t:new n((function(e){e(t)}))).then(a,s)}l((r=r.apply(e,t||[])).next())}))};Object.defineProperty(t,"__esModule",{value:!0}),t.resolveDocument=t.BaseResolver=t.makeDocumentFromString=t.makeRefId=t.YamlParseError=t.ResolveError=t.Source=void 0;const o=n(3197),i=n(6470),a=n(7468),s=n(5220),l=n(771);class c{constructor(e,t,n){this.absoluteRef=e,this.body=t,this.mimeType=n}getAst(e){var t;return void 0===this._ast&&(this._ast=null!==(t=e(this.body,{filename:this.absoluteRef}))&&void 0!==t?t:void 0,this._ast&&0===this._ast.kind&&""===this._ast.value&&1!==this._ast.startPosition&&(this._ast.startPosition=1,this._ast.endPosition=1)),this._ast}getLines(){return void 0===this._lines&&(this._lines=this.body.split(/\r\n|[\n\r]/g)),this._lines}}t.Source=c;class u extends Error{constructor(e){super(e.message),this.originalError=e,Object.setPrototypeOf(this,u.prototype)}}t.ResolveError=u;const p=/\((\d+):(\d+)\)$/;class d extends Error{constructor(e,t){super(e.message.split("\n")[0]),this.originalError=e,this.source=t,Object.setPrototypeOf(this,d.prototype);const[,n,r]=this.message.match(p)||[];this.line=parseInt(n,10),this.col=parseInt(r,10)}}function f(e,t){return e+"::"+t}function h(e,t){return{prev:e,node:t}}t.YamlParseError=d,t.makeRefId=f,t.makeDocumentFromString=function(e,t){const n=new c(t,e);try{return{source:n,parsed:l.parseYaml(e,{filename:t})}}catch(e){throw new d(e,n)}},t.BaseResolver=class{constructor(e={http:{headers:[]}}){this.config=e,this.cache=new Map}getFiles(){return new Set(Array.from(this.cache.keys()))}resolveExternalRef(e,t){return a.isAbsoluteUrl(t)?t:e&&a.isAbsoluteUrl(e)?new URL(t,e).href:i.resolve(e?i.dirname(e):process.cwd(),t)}loadExternalRef(e){return r(this,void 0,void 0,(function*(){try{if(a.isAbsoluteUrl(e)){const{body:t,mimeType:n}=yield l.readFileFromUrl(e,this.config.http);return new c(e,t,n)}return new c(e,yield o.promises.readFile(e,"utf-8"))}catch(e){throw new u(e)}}))}parseDocument(e,t=!1){var n;const r=e.absoluteRef.substr(e.absoluteRef.lastIndexOf("."));if(![".json",".json",".yml",".yaml"].includes(r)&&!(null===(n=e.mimeType)||void 0===n?void 0:n.match(/(json|yaml|openapi)/))&&!t)return{source:e,parsed:e.body};try{return{source:e,parsed:l.parseYaml(e.body,{filename:e.absoluteRef})}}catch(t){throw new d(t,e)}}resolveDocument(e,t,n=!1){return r(this,void 0,void 0,(function*(){const r=this.resolveExternalRef(e,t),o=this.cache.get(r);if(o)return o;const i=this.loadExternalRef(r).then((e=>this.parseDocument(e,n)));return this.cache.set(r,i),i}))}};const m={name:"unknown",properties:{}},g={name:"scalar",properties:{}};t.resolveDocument=function(e){return r(this,void 0,void 0,(function*(){const{rootDocument:t,externalRefResolver:n,rootType:o}=e,i=new Map,l=new Set,c=[];let u;!function e(t,o,u,p){function d(e,t,o){return r(this,void 0,void 0,(function*(){if(function(e,t){for(;e;){if(e.node===t)return!0;e=e.prev}return!1}(o.prev,t))throw new Error("Self-referencing circular pointer");const{uri:r,pointer:s}=a.parseRef(t.$ref),l=null!==r;let c;try{c=l?yield n.resolveDocument(e.source.absoluteRef,r):e}catch(n){const r={resolved:!1,isRemote:l,document:void 0,error:n},o=f(e.source.absoluteRef,t.$ref);return i.set(o,r),r}let u={resolved:!0,document:c,isRemote:l,node:e.parsed,nodePointer:"#/"},p=c.parsed;const m=s;for(let e of m){if("object"!=typeof p){p=void 0;break}if(void 0!==p[e])p=p[e],u.nodePointer=a.joinPointer(u.nodePointer,a.escapePointer(e));else{if(!a.isRef(p)){p=void 0;break}if(u=yield d(c,p,h(o,p)),c=u.document||c,"object"!=typeof u.node){p=void 0;break}p=u.node[e],u.nodePointer=a.joinPointer(u.nodePointer,a.escapePointer(e))}}u.node=p,u.document=c;const g=f(e.source.absoluteRef,t.$ref);return u.document&&a.isRef(p)&&(u=yield d(u.document,p,h(o,p))),i.set(g,u),Object.assign({},u)}))}!function t(n,r,i){if("object"!=typeof n||null===n)return;const u=`${r.name}::${i}`;if(!l.has(u))if(l.add(u),Array.isArray(n)){const e=r.items;if(r!==m&&void 0===e)return;for(let r=0;r<n.length;r++)t(n[r],e||m,a.joinPointer(i,r))}else{for(const e of Object.keys(n)){let o=n[e],l=r.properties[e];void 0===l&&(l=r.additionalProperties),"function"==typeof l&&(l=l(o,e)),void 0===l&&(l=m),!s.isNamedType(l)&&(null==l?void 0:l.directResolveAs)&&(l=l.directResolveAs,o={$ref:o}),l&&void 0===l.name&&!1!==l.resolvable&&(l=g),s.isNamedType(l)&&"object"==typeof o&&t(o,l,a.joinPointer(i,a.escapePointer(e)))}if(a.isRef(n)){const t=d(o,n,{prev:null,node:n}).then((t=>{t.resolved&&e(t.node,t.document,t.nodePointer,r)}));c.push(t)}}}(t,p,o.source.absoluteRef+u)}(t.parsed,t,"#/",o);do{u=yield Promise.all(c)}while(c.length!==u.length);return i}))}},7275:function(e,t,n){"use strict";Object.defineProperty(t,"__esModule",{value:!0}),t.validateJsonSchema=t.releaseAjvInstance=void 0;const r=n(5499),o=n(7468);let i=null;t.releaseAjvInstance=function(){i=null},t.validateJsonSchema=function(e,t,n,a,s,l){const c=function(e,t,n,o){const a=function(e,t){return i||(i=new r.default({schemaId:"$id",meta:!0,allErrors:!0,strictSchema:!1,inlineRefs:!1,validateSchema:!1,discriminator:!0,allowUnionTypes:!0,validateFormats:!1,defaultAdditionalProperties:!t,loadSchemaSync(t,n){const r=e({$ref:n},t.split("#")[0]);return!(!r||!r.location)&&Object.assign({$id:r.location.absolutePointer},r.node)},logger:!1})),i}(n,o);return a.getSchema(t.absolutePointer)||a.addSchema(Object.assign({$id:t.absolutePointer},e),t.absolutePointer),a.getSchema(t.absolutePointer)}(t,n,s,l);return c?{valid:!!c(e,{instancePath:a,parentData:{fake:{}},parentDataProperty:"fake",rootData:{},dynamicAnchors:{}}),errors:(c.errors||[]).map((function(e){let t=e.message,n="enum"===e.keyword?e.params.allowedValues:void 0;n&&(t+=` ${n.map((e=>`"${e}"`)).join(", ")}`),"type"===e.keyword&&(t=`type ${t}`);const r=e.instancePath.substring(a.length+1),i=r.substring(r.lastIndexOf("/")+1);if(i&&(t=`\`${i}\` property ${t}`),"additionalProperties"===e.keyword){const n=e.params.additionalProperty;t=`${t} \`${n}\``,e.instancePath+="/"+o.escapePointer(n)}return Object.assign(Object.assign({},e),{message:t,suggest:n})}))}:{valid:!0,errors:[]}}},9740:function(e,t,n){"use strict";Object.defineProperty(t,"__esModule",{value:!0}),t.asserts=t.runOnValuesSet=t.runOnKeysSet=void 0;const r=n(771),o=n(5738);t.runOnKeysSet=new Set(["mutuallyExclusive","mutuallyRequired","enum","pattern","minLength","maxLength","casing","sortOrder","disallowed","required","requireAny","ref"]),t.runOnValuesSet=new Set(["pattern","enum","defined","undefined","nonEmpty","minLength","maxLength","casing","sortOrder","ref"]),t.asserts={pattern:(e,t,n)=>{if(void 0===e)return{isValid:!0};const i=r.isString(e)?[e]:e,a=o.regexFromString(t);for(let t of i)if(!(null==a?void 0:a.test(t)))return{isValid:!1,location:r.isString(e)?n:n.key()};return{isValid:!0}},enum:(e,t,n)=>{if(void 0===e)return{isValid:!0};const o=r.isString(e)?[e]:e;for(let i of o)if(!t.includes(i))return{isValid:!1,location:r.isString(e)?n:n.child(i).key()};return{isValid:!0}},defined:(e,t=!0,n)=>{const r=void 0!==e;return{isValid:t?r:!r,location:n}},required:(e,t,n)=>{for(const r of t)if(!e.includes(r))return{isValid:!1,location:n.key()};return{isValid:!0}},disallowed:(e,t,n)=>{if(void 0===e)return{isValid:!0};const o=r.isString(e)?[e]:e;for(let i of o)if(t.includes(i))return{isValid:!1,location:r.isString(e)?n:n.child(i).key()};return{isValid:!0}},undefined:(e,t=!0,n)=>{const r=void 0===e;return{isValid:t?r:!r,location:n}},nonEmpty:(e,t=!0,n)=>{const r=null==e||""===e;return{isValid:t?!r:r,location:n}},minLength:(e,t,n)=>void 0===e?{isValid:!0}:{isValid:e.length>=t,location:n},maxLength:(e,t,n)=>void 0===e?{isValid:!0}:{isValid:e.length<=t,location:n},casing:(e,t,n)=>{if(void 0===e)return{isValid:!0};const o=r.isString(e)?[e]:e;for(let i of o){let o=!1;switch(t){case"camelCase":o=!!i.match(/^[a-z][a-zA-Z0-9]+$/g);break;case"kebab-case":o=!!i.match(/^([a-z][a-z0-9]*)(-[a-z0-9]+)*$/g);break;case"snake_case":o=!!i.match(/^([a-z][a-z0-9]*)(_[a-z0-9]+)*$/g);break;case"PascalCase":o=!!i.match(/^[A-Z][a-zA-Z0-9]+$/g);break;case"MACRO_CASE":o=!!i.match(/^([A-Z][A-Z0-9]*)(_[A-Z0-9]+)*$/g);break;case"COBOL-CASE":o=!!i.match(/^([A-Z][A-Z0-9]*)(-[A-Z0-9]+)*$/g);break;case"flatcase":o=!!i.match(/^[a-z][a-z0-9]+$/g)}if(!o)return{isValid:!1,location:r.isString(e)?n:n.child(i).key()}}return{isValid:!0}},sortOrder:(e,t,n)=>void 0===e?{isValid:!0}:{isValid:o.isOrdered(e,t),location:n},mutuallyExclusive:(e,t,n)=>({isValid:o.getIntersectionLength(e,t)<2,location:n.key()}),mutuallyRequired:(e,t,n)=>({isValid:!(o.getIntersectionLength(e,t)>0)||o.getIntersectionLength(e,t)===t.length,location:n.key()}),requireAny:(e,t,n)=>({isValid:o.getIntersectionLength(e,t)>=1,location:n.key()}),ref:(e,t,n,r)=>{if(void 0===r)return{isValid:!0};const i=r.hasOwnProperty("$ref");if("boolean"==typeof t)return{isValid:t?i:!i,location:i?n:n.key()};const a=o.regexFromString(t);return{isValid:i&&(null==a?void 0:a.test(r.$ref)),location:i?n:n.key()}}}},4015:function(e,t,n){"use strict";Object.defineProperty(t,"__esModule",{value:!0}),t.Assertions=void 0;const r=n(9740),o=n(5738);t.Assertions=e=>{let t=[];const n=Object.values(e).filter((e=>"object"==typeof e&&null!==e));for(const[e,i]of n.entries()){const n=i.assertionId&&`${i.assertionId} assertion`||`assertion #${e+1}`;if(!i.subject)throw new Error(`${n}: 'subject' is required`);const a=Array.isArray(i.subject)?i.subject:[i.subject],s=Object.keys(r.asserts).filter((e=>void 0!==i[e])).map((e=>({assertId:n,name:e,conditions:i[e],message:i.message,severity:i.severity||"error",suggest:i.suggest||[],runsOnKeys:r.runOnKeysSet.has(e),runsOnValues:r.runOnValuesSet.has(e)}))),l=s.find((e=>e.runsOnKeys&&!e.runsOnValues)),c=s.find((e=>e.runsOnValues&&!e.runsOnKeys));if(c&&!i.property)throw new Error(`${c.name} can't be used on all keys. Please provide a single property.`);if(l&&i.property)throw new Error(`${l.name} can't be used on a single property. Please use 'property'.`);for(const e of a){const n=o.buildSubjectVisitor(i.property,s,i.context),r=o.buildVisitorObject(e,i.context,n);t.push(r)}}return t}},5738:function(e,t,n){"use strict";Object.defineProperty(t,"__esModule",{value:!0}),t.regexFromString=t.isOrdered=t.getIntersectionLength=t.buildSubjectVisitor=t.buildVisitorObject=void 0;const r=n(7468),o=n(9740);function i({values:e,rawValues:t,assert:n,location:r,report:i}){const a=o.asserts[n.name](e,n.conditions,r,t);a.isValid||i({message:n.message||`The ${n.assertId} doesn't meet required conditions`,location:a.location||r,forceSeverity:n.severity,suggest:n.suggest,ruleId:n.assertId})}t.buildVisitorObject=function(e,t,n){if(!t)return{[e]:n};let r={};const o=r;for(let n=0;n<t.length;n++){const o=t[n];if(t.length===n+1&&o.type===e)continue;const i=o.matchParentKeys,a=o.excludeParentKeys;if(i&&a)throw new Error("Both 'matchParentKeys' and 'excludeParentKeys' can't be under one context item");r[o.type]=i||a?{skip:(e,t)=>i?!i.includes(t):a?a.includes(t):void 0}:{},r=r[o.type]}return r[e]=n,o},t.buildSubjectVisitor=function(e,t,n){return(o,{report:a,location:s,rawLocation:l,key:c,type:u,resolve:p,rawNode:d})=>{var f;if(n){const e=n[n.length-1];if(e.type===u.name){const t=e.matchParentKeys,n=e.excludeParentKeys;if(t&&!t.includes(c))return;if(n&&n.includes(c))return}}e&&(e=Array.isArray(e)?e:[e]);for(const n of t){const t="ref"===n.name?l:s;if(e)for(const s of e)i({values:r.isRef(o[s])?null===(f=p(o[s]))||void 0===f?void 0:f.node:o[s],rawValues:d[s],assert:n,location:t.child(s),report:a});else{const e="ref"===n.name?d:Object.keys(o);i({values:Object.keys(o),rawValues:e,assert:n,location:t,report:a})}}}},t.getIntersectionLength=function(e,t){const n=new Set(t);let r=0;for(const t of e)n.has(t)&&r++;return r},t.isOrdered=function(e,t){const n=t.direction||t,r=t.property;for(let t=1;t<e.length;t++){let o=e[t],i=e[t-1];if(r){if(!e[t][r]||!e[t-1][r])return!1;o=e[t][r],i=e[t-1][r]}if(!("asc"===n?o>=i:o<=i))return!1}return!0},t.regexFromString=function(e){const t=e.match(/^\/(.*)\/(.*)|(.*)/);return t&&new RegExp(t[1]||t[3],t[2])}},8265:function(e,t,n){"use strict";Object.defineProperty(t,"__esModule",{value:!0}),t.InfoContact=void 0;const r=n(780);t.InfoContact=()=>({Info(e,{report:t,location:n}){e.contact||t({message:r.missingRequiredField("Info","contact"),location:n.child("contact").key()})}})},8675:function(e,t,n){"use strict";Object.defineProperty(t,"__esModule",{value:!0}),t.InfoDescription=void 0;const r=n(780);t.InfoDescription=()=>({Info(e,t){r.validateDefinedAndNonEmpty("description",e,t)}})},9622:function(e,t,n){"use strict";Object.defineProperty(t,"__esModule",{value:!0}),t.InfoLicense=void 0;const r=n(780);t.InfoLicense=()=>({Info(e,{report:t}){e.license||t({message:r.missingRequiredField("Info","license"),location:{reportOnKey:!0}})}})},476:function(e,t,n){"use strict";Object.defineProperty(t,"__esModule",{value:!0}),t.InfoLicenseUrl=void 0;const r=n(780);t.InfoLicenseUrl=()=>({License(e,t){r.validateDefinedAndNonEmpty("url",e,t)}})},3467:function(e,t){"use strict";function n(e,t){const n=e.split("/"),r=t.split("/");if(n.length!==r.length)return!1;let o=0,i=0,a=!0;for(let e=0;e<n.length;e++){const t=n[e].match(/^{.+?}$/),s=r[e].match(/^{.+?}$/);t||s?(t&&o++,s&&i++):n[e]!==r[e]&&(a=!1)}return a&&o===i}Object.defineProperty(t,"__esModule",{value:!0}),t.NoAmbiguousPaths=void 0,t.NoAmbiguousPaths=()=>({PathMap(e,{report:t,location:r}){const o=[];for(const i of Object.keys(e)){const e=o.find((e=>n(e,i)));e&&t({message:`Paths should resolve unambiguously. Found two ambiguous paths: \`${e}\` and \`${i}\`.`,location:r.child([i]).key()}),o.push(i)}}})},2319:function(e,t,n){"use strict";Object.defineProperty(t,"__esModule",{value:!0}),t.NoEnumTypeMismatch=void 0;const r=n(780);t.NoEnumTypeMismatch=()=>({Schema(e,{report:t,location:n}){if(!e.enum||Array.isArray(e.enum)){if(e.enum&&e.type&&!Array.isArray(e.type)){const o=e.enum.filter((t=>!r.matchesJsonSchemaType(t,e.type,e.nullable)));for(const i of o)t({message:`All values of \`enum\` field must be of the same type as the \`type\` field: expected "${e.type}" but received "${r.oasTypeOf(i)}".`,location:n.child(["enum",e.enum.indexOf(i)])})}if(e.enum&&e.type&&Array.isArray(e.type)){const o={};for(const t of e.enum){o[t]=[];for(const n of e.type)r.matchesJsonSchemaType(t,n,e.nullable)||o[t].push(n);o[t].length!==e.type.length&&delete o[t]}for(const r of Object.keys(o))t({message:`Enum value \`${r}\` must be of one type. Allowed types: \`${e.type}\`.`,location:n.child(["enum",e.enum.indexOf(r)])})}}}})},525:function(e,t,n){"use strict";Object.defineProperty(t,"__esModule",{value:!0}),t.NoHttpVerbsInPaths=void 0;const r=n(771),o=["get","head","post","put","patch","delete","options","trace"];t.NoHttpVerbsInPaths=({splitIntoWords:e})=>({PathItem(t,{key:n,report:i,location:a}){const s=n.toString();if(!s.startsWith("/"))return;const l=s.split("/");for(const t of l){if(!t||r.isPathParameter(t))continue;const n=n=>e?r.splitCamelCaseIntoWords(t).has(n):t.toLocaleLowerCase().includes(n);for(const e of o)n(e)&&i({message:`path \`${s}\` should not contain http verb ${e}`,location:a.key()})}}})},4628:function(e,t){"use strict";Object.defineProperty(t,"__esModule",{value:!0}),t.NoIdenticalPaths=void 0,t.NoIdenticalPaths=()=>({PathMap(e,{report:t,location:n}){const r=new Map;for(const o of Object.keys(e)){const e=o.replace(/{.+?}/g,"{VARIABLE}"),i=r.get(e);i?t({message:`The path already exists which differs only by path parameter name(s): \`${i}\` and \`${o}\`.`,location:n.child([o]).key()}):r.set(e,o)}}})},1562:function(e,t,n){"use strict";Object.defineProperty(t,"__esModule",{value:!0}),t.NoInvalidParameterExamples=void 0;const r=n(780);t.NoInvalidParameterExamples=e=>{var t;const n=null===(t=e.disallowAdditionalProperties)||void 0===t||t;return{Parameter:{leave(e,t){if(e.example&&r.validateExample(e.example,e.schema,t.location.child("example"),t,n),e.examples)for(const[n,o]of Object.entries(e.examples))"value"in o&&r.validateExample(o.value,e.schema,t.location.child(["examples",n]),t,!1)}}}}},78:function(e,t,n){"use strict";Object.defineProperty(t,"__esModule",{value:!0}),t.NoInvalidSchemaExamples=void 0;const r=n(780);t.NoInvalidSchemaExamples=e=>{var t;const n=null===(t=e.disallowAdditionalProperties)||void 0===t||t;return{Schema:{leave(e,t){if(e.examples)for(const o of e.examples)r.validateExample(o,e,t.location.child(["examples",e.examples.indexOf(o)]),t,n);e.example&&r.validateExample(e.example,e,t.location.child("example"),t,!1)}}}}},700:function(e,t){"use strict";Object.defineProperty(t,"__esModule",{value:!0}),t.NoPathTrailingSlash=void 0,t.NoPathTrailingSlash=()=>({PathItem(e,{report:t,key:n,location:r}){n.endsWith("/")&&"/"!==n&&t({message:`\`${n}\` should not have a trailing slash.`,location:r.key()})}})},5946:function(e,t){"use strict";Object.defineProperty(t,"__esModule",{value:!0}),t.Operation2xxResponse=void 0,t.Operation2xxResponse=()=>({ResponsesMap(e,{report:t}){Object.keys(e).some((e=>"default"===e||/2[Xx0-9]{2}/.test(e)))||t({message:"Operation must have at least one `2xx` response.",location:{reportOnKey:!0}})}})},5281:function(e,t){"use strict";Object.defineProperty(t,"__esModule",{value:!0}),t.Operation4xxResponse=void 0,t.Operation4xxResponse=()=>({ResponsesMap(e,{report:t}){Object.keys(e).some((e=>/4[Xx0-9]{2}/.test(e)))||t({message:"Operation must have at least one `4xx` response.",location:{reportOnKey:!0}})}})},3408:function(e,t,n){"use strict";Object.defineProperty(t,"__esModule",{value:!0}),t.OperationDescription=void 0;const r=n(780);t.OperationDescription=()=>({Operation(e,t){r.validateDefinedAndNonEmpty("description",e,t)}})},8742:function(e,t){"use strict";Object.defineProperty(t,"__esModule",{value:!0}),t.OperationIdUnique=void 0,t.OperationIdUnique=()=>{const e=new Set;return{Operation(t,{report:n,location:r}){t.operationId&&(e.has(t.operationId)&&n({message:"Every operation must have a unique `operationId`.",location:r.child([t.operationId])}),e.add(t.operationId))}}}},5064:function(e,t){"use strict";Object.defineProperty(t,"__esModule",{value:!0}),t.OperationIdUrlSafe=void 0;const n=/^[A-Za-z0-9-._~:/?#\[\]@!\$&'()*+,;=]*$/;t.OperationIdUrlSafe=()=>({Operation(e,{report:t,location:r}){e.operationId&&!n.test(e.operationId)&&t({message:"Operation `operationId` should not have URL invalid characters.",location:r.child(["operationId"])})}})},8786:function(e,t,n){"use strict";Object.defineProperty(t,"__esModule",{value:!0}),t.OperationOperationId=void 0;const r=n(780);t.OperationOperationId=()=>({DefinitionRoot:{PathItem:{Operation(e,t){r.validateDefinedAndNonEmpty("operationId",e,t)}}}})},4112:function(e,t){"use strict";Object.defineProperty(t,"__esModule",{value:!0}),t.OperationParametersUnique=void 0,t.OperationParametersUnique=()=>{let e,t;return{PathItem:{enter(){e=new Set},Parameter(t,{report:n,key:r,parentLocations:o}){const i=`${t.in}___${t.name}`;e.has(i)&&n({message:`Paths must have unique \`name\` + \`in\` parameters.\nRepeats of \`in:${t.in}\` + \`name:${t.name}\`.`,location:o.PathItem.child(["parameters",r])}),e.add(`${t.in}___${t.name}`)},Operation:{enter(){t=new Set},Parameter(e,{report:n,key:r,parentLocations:o}){const i=`${e.in}___${e.name}`;t.has(i)&&n({message:`Operations must have unique \`name\` + \`in\` parameters. Repeats of \`in:${e.in}\` + \`name:${e.name}\`.`,location:o.Operation.child(["parameters",r])}),t.add(i)}}}}}},7892:function(e,t){"use strict";Object.defineProperty(t,"__esModule",{value:!0}),t.OperationSecurityDefined=void 0,t.OperationSecurityDefined=()=>{let e=new Map;return{DefinitionRoot:{leave(t,{report:n}){for(const[t,r]of e.entries())if(!r.defined)for(const e of r.from)n({message:`There is no \`${t}\` security scheme defined.`,location:e.key()})}},SecurityScheme(t,{key:n}){e.set(n.toString(),{defined:!0,from:[]})},SecurityRequirement(t,{location:n}){for(const r of Object.keys(t)){const t=e.get(r),o=n.child([r]);t?t.from.push(o):e.set(r,{from:[o]})}}}}},8613:function(e,t){"use strict";Object.defineProperty(t,"__esModule",{value:!0}),t.OperationSingularTag=void 0,t.OperationSingularTag=()=>({Operation(e,{report:t,location:n}){e.tags&&e.tags.length>1&&t({message:"Operation `tags` object should have only one tag.",location:n.child(["tags"]).key()})}})},9578:function(e,t,n){"use strict";Object.defineProperty(t,"__esModule",{value:!0}),t.OperationSummary=void 0;const r=n(780);t.OperationSummary=()=>({Operation(e,t){r.validateDefinedAndNonEmpty("summary",e,t)}})},5097:function(e,t){"use strict";Object.defineProperty(t,"__esModule",{value:!0}),t.OperationTagDefined=void 0,t.OperationTagDefined=()=>{let e;return{DefinitionRoot(t){var n;e=new Set((null!==(n=t.tags)&&void 0!==n?n:[]).map((e=>e.name)))},Operation(t,{report:n,location:r}){if(t.tags)for(let o=0;o<t.tags.length;o++)e.has(t.tags[o])||n({message:"Operation tags should be defined in global tags.",location:r.child(["tags",o])})}}}},3529:function(e,t){"use strict";Object.defineProperty(t,"__esModule",{value:!0}),t.ParameterDescription=void 0,t.ParameterDescription=()=>({Parameter(e,{report:t,location:n}){void 0===e.description?t({message:"Parameter object description must be present.",location:{reportOnKey:!0}}):e.description||t({message:"Parameter object description must be non-empty string.",location:n.child(["description"])})}})},7890:function(e,t){"use strict";Object.defineProperty(t,"__esModule",{value:!0}),t.PathDeclarationMustExist=void 0,t.PathDeclarationMustExist=()=>({PathItem(e,{report:t,key:n}){-1!==n.indexOf("{}")&&t({message:"Path parameter declarations must be non-empty. `{}` is invalid.",location:{reportOnKey:!0}})}})},3689:function(e,t){"use strict";Object.defineProperty(t,"__esModule",{value:!0}),t.PathExcludesPatterns=void 0,t.PathExcludesPatterns=({patterns:e})=>({PathItem(t,{report:n,key:r,location:o}){if(!e)throw new Error('Parameter "patterns" is not provided for "path-excludes-patterns" rule');const i=r.toString();if(i.startsWith("/")){const t=e.filter((e=>i.match(e)));for(const e of t)n({message:`path \`${i}\` should not match regex pattern: \`${e}\``,location:o.key()})}}})},2332:function(e,t){"use strict";Object.defineProperty(t,"__esModule",{value:!0}),t.PathHttpVerbsOrder=void 0;const n=["get","head","post","put","patch","delete","options","trace"];t.PathHttpVerbsOrder=e=>{const t=e&&e.order||n;if(!Array.isArray(t))throw new Error("path-http-verbs-order `order` option must be an array");return{PathItem(e,{report:n,location:r}){const o=Object.keys(e).filter((e=>t.includes(e)));for(let e=0;e<o.length-1;e++){const i=t.indexOf(o[e]);t.indexOf(o[e+1])<i&&n({message:"Operation http verbs must be ordered.",location:Object.assign({reportOnKey:!0},r.child(o[e+1]))})}}}}},5023:function(e,t){"use strict";Object.defineProperty(t,"__esModule",{value:!0}),t.PathNotIncludeQuery=void 0,t.PathNotIncludeQuery=()=>({PathMap:{PathItem(e,{report:t,key:n}){n.toString().includes("?")&&t({message:"Don't put query string items in the path, they belong in parameters with `in: query`.",location:{reportOnKey:!0}})}}})},7421:function(e,t){"use strict";Object.defineProperty(t,"__esModule",{value:!0}),t.PathParamsDefined=void 0;const n=/\{([a-zA-Z0-9_.-]+)\}+/g;t.PathParamsDefined=()=>{let e,t,r;return{PathItem:{enter(o,{key:i}){t=new Set,r=i,e=new Set(Array.from(i.toString().matchAll(n)).map((e=>e[1])))},Parameter(n,{report:o,location:i}){"path"===n.in&&n.name&&(t.add(n.name),e.has(n.name)||o({message:`Path parameter \`${n.name}\` is not used in the path \`${r}\`.`,location:i.child(["name"])}))},Operation:{leave(n,{report:o,location:i}){for(const n of Array.from(e.keys()))t.has(n)||o({message:`The operation does not define the path parameter \`{${n}}\` expected by path \`${r}\`.`,location:i.child(["parameters"]).key()})},Parameter(n,{report:o,location:i}){"path"===n.in&&n.name&&(t.add(n.name),e.has(n.name)||o({message:`Path parameter \`${n.name}\` is not used in the path \`${r}\`.`,location:i.child(["name"])}))}}}}}},3807:function(e,t,n){"use strict";Object.defineProperty(t,"__esModule",{value:!0}),t.PathSegmentPlural=void 0;const r=n(771);t.PathSegmentPlural=e=>{const{ignoreLastPathSegment:t,exceptions:n}=e;return{PathItem:{leave(e,{report:o,key:i,location:a}){const s=i.toString();if(s.startsWith("/")){const e=s.split("/");e.shift(),t&&e.length>1&&e.pop();for(const t of e)n&&n.includes(t)||!r.isPathParameter(t)&&r.isSingular(t)&&o({message:`path segment \`${t}\` should be plural.`,location:a.key()})}}}}}},9527:function(e,t){"use strict";Object.defineProperty(t,"__esModule",{value:!0}),t.PathsKebabCase=void 0,t.PathsKebabCase=()=>({PathItem(e,{report:t,key:n}){n.substr(1).split("/").filter((e=>""!==e)).every((e=>/^{.+}$/.test(e)||/^[a-z0-9-.]+$/.test(e)))||t({message:`\`${n}\` does not use kebab-case.`,location:{reportOnKey:!0}})}})},5839:function(e,t,n){"use strict";Object.defineProperty(t,"__esModule",{value:!0}),t.ResponseContainsHeader=void 0;const r=n(771);t.ResponseContainsHeader=e=>{const t=e.names||{};return{Operation:{Response:{enter:(e,{report:n,location:o,key:i})=>{var a;const s=t[i]||t[r.getMatchingStatusCodeRange(i)]||t[r.getMatchingStatusCodeRange(i).toLowerCase()]||[];for(const t of s)(null===(a=e.headers)||void 0===a?void 0:a[t])||n({message:`Response object must contain a "${t}" header.`,location:o.child("headers").key()})}}}}}},5669:function(e,t,n){"use strict";Object.defineProperty(t,"__esModule",{value:!0}),t.ScalarPropertyMissingExample=void 0;const r=n(1510),o=["string","integer","number","boolean","null"];t.ScalarPropertyMissingExample=()=>({SchemaProperties(e,{report:t,location:n,oasVersion:i,resolve:a}){for(const l of Object.keys(e)){const c=a(e[l]).node;c&&((s=c).type&&!(s.allOf||s.anyOf||s.oneOf)&&"binary"!==s.format&&(Array.isArray(s.type)?s.type.every((e=>o.includes(e))):o.includes(s.type)))&&void 0===c.example&&void 0===c.examples&&t({message:`Scalar property should have "example"${i===r.OasVersion.Version3_1?' or "examples"':""} defined.`,location:n.child(l).key()})}var s}})},6471:function(e,t,n){"use strict";Object.defineProperty(t,"__esModule",{value:!0}),t.OasSpec=void 0;const r=n(5220),o=n(780),i=n(7468),a=n(771);t.OasSpec=()=>({any(e,{report:t,type:n,location:s,key:l,resolve:c,ignoreNextVisitorsOnNode:u}){var p,d,f,h;const m=o.oasTypeOf(e);if(n.items)return void("array"!==m&&(t({message:`Expected type \`${n.name}\` (array) but got \`${m}\``}),u()));if("object"!==m)return t({message:`Expected type \`${n.name}\` (object) but got \`${m}\``}),void u();const g="function"==typeof n.required?n.required(e,l):n.required;for(let n of g||[])e.hasOwnProperty(n)||t({message:`The field \`${n}\` must be present on this level.`,location:[{reportOnKey:!0}]});const y=null===(p=n.allowed)||void 0===p?void 0:p.call(n,e);if(y&&a.isPlainObject(e))for(const r in e)y.includes(r)||n.extensionsPrefix&&r.startsWith(n.extensionsPrefix)||!Object.keys(n.properties).includes(r)||t({message:`The field \`${r}\` is not allowed here.`,location:s.child([r]).key()});const v=n.requiredOneOf||null;if(v){let r=!1;for(let t of v||[])e.hasOwnProperty(t)&&(r=!0);r||t({message:`Must contain at least one of the following fields: ${null===(d=n.requiredOneOf)||void 0===d?void 0:d.join(", ")}.`,location:[{reportOnKey:!0}]})}for(const a of Object.keys(e)){const l=s.child([a]);let u=e[a],p=n.properties[a];if(void 0===p&&(p=n.additionalProperties),"function"==typeof p&&(p=p(u,a)),r.isNamedType(p))continue;const d=p,m=o.oasTypeOf(u);if(void 0!==d){if(null!==d){if(!1!==d.resolvable&&i.isRef(u)&&(u=c(u).node),d.enum)d.enum.includes(u)||t({location:l,message:`\`${a}\` can be one of the following only: ${d.enum.map((e=>`"${e}"`)).join(", ")}.`,suggest:o.getSuggest(u,d.enum)});else if(d.type&&!o.matchesJsonSchemaType(u,d.type,!1))t({message:`Expected type \`${d.type}\` but got \`${m}\`.`,location:l});else if("array"===m&&(null===(f=d.items)||void 0===f?void 0:f.type)){const e=null===(h=d.items)||void 0===h?void 0:h.type;for(let n=0;n<u.length;n++){const r=u[n];o.matchesJsonSchemaType(r,e,!1)||t({message:`Expected type \`${e}\` but got \`${o.oasTypeOf(r)}\`.`,location:l.child([n])})}}"number"==typeof d.minimum&&d.minimum>e[a]&&t({message:`The value of the ${a} field must be greater than or equal to ${d.minimum}`,location:s.child([a])})}}else{if(a.startsWith("x-"))continue;t({message:`Property \`${a}\` is not expected here.`,suggest:o.getSuggest(a,Object.keys(n.properties)),location:l.key()})}}}})},7281:function(e,t,n){"use strict";Object.defineProperty(t,"__esModule",{value:!0}),t.TagDescription=void 0;const r=n(780);t.TagDescription=()=>({Tag(e,t){r.validateDefinedAndNonEmpty("description",e,t)}})},6855:function(e,t){"use strict";Object.defineProperty(t,"__esModule",{value:!0}),t.TagsAlphabetical=void 0,t.TagsAlphabetical=()=>({DefinitionRoot(e,{report:t,location:n}){if(e.tags)for(let r=0;r<e.tags.length-1;r++)e.tags[r].name>e.tags[r+1].name&&t({message:"The `tags` array should be in alphabetical order.",location:n.child(["tags",r])})}})},348:function(e,t,n){"use strict";Object.defineProperty(t,"__esModule",{value:!0}),t.reportUnresolvedRef=t.NoUnresolvedRefs=void 0;const r=n(4182);function o(e,t,n){var o;const i=e.error;i instanceof r.YamlParseError&&t({message:"Failed to parse: "+i.message,location:{source:i.source,pointer:void 0,start:{col:i.col,line:i.line}}});const a=null===(o=e.error)||void 0===o?void 0:o.message;t({location:n,message:"Can't resolve $ref"+(a?": "+a:"")})}t.NoUnresolvedRefs=()=>({ref:{leave(e,{report:t,location:n},r){void 0===r.node&&o(r,t,n)}},DiscriminatorMapping(e,{report:t,resolve:n,location:r}){for(const i of Object.keys(e)){const a=n({$ref:e[i]});if(void 0!==a.node)return;o(a,t,r.child(i))}}}),t.reportUnresolvedRef=o},9566:function(e,t){"use strict";Object.defineProperty(t,"__esModule",{value:!0}),t.BooleanParameterPrefixes=void 0,t.BooleanParameterPrefixes=e=>{const t=e.prefixes||["is","has"],n=new RegExp(`^(${t.join("|")})[A-Z-_]`),r=t.map((e=>`\`${e}\``)),o=1===r.length?r[0]:r.slice(0,-1).join(", ")+" or "+r[t.length-1];return{Parameter(e,{report:t,location:r}){"boolean"!==e.type||n.test(e.name)||t({message:`Boolean parameter \`${e.name}\` should have ${o} prefix.`,location:r.child("name")})}}}},7523:function(e,t,n){"use strict";Object.defineProperty(t,"__esModule",{value:!0}),t.preprocessors=t.rules=void 0;const r=n(6471),o=n(78),i=n(1562),a=n(8675),s=n(8265),l=n(9622),c=n(476),u=n(9566),p=n(7281),d=n(6855),f=n(9527),h=n(2319),m=n(700),g=n(5946),y=n(5281),v=n(4015),b=n(8742),w=n(4112),x=n(7421),k=n(5097),_=n(7890),O=n(5064),S=n(3408),E=n(5023),P=n(3529),A=n(8613),$=n(7892),C=n(348),R=n(2332),j=n(4628),T=n(8786),I=n(9578),N=n(3467),D=n(525),L=n(3689),M=n(7028),F=n(1750),z=n(3807),U=n(5839),V=n(7899),B=n(5669);t.rules={spec:r.OasSpec,"no-invalid-schema-examples":o.NoInvalidSchemaExamples,"no-invalid-parameter-examples":i.NoInvalidParameterExamples,"info-description":a.InfoDescription,"info-contact":s.InfoContact,"info-license":l.InfoLicense,"info-license-url":c.InfoLicenseUrl,"tag-description":p.TagDescription,"tags-alphabetical":d.TagsAlphabetical,"paths-kebab-case":f.PathsKebabCase,"no-enum-type-mismatch":h.NoEnumTypeMismatch,"boolean-parameter-prefixes":u.BooleanParameterPrefixes,"no-path-trailing-slash":m.NoPathTrailingSlash,"operation-2xx-response":g.Operation2xxResponse,"operation-4xx-response":y.Operation4xxResponse,assertions:v.Assertions,"operation-operationId-unique":b.OperationIdUnique,"operation-parameters-unique":w.OperationParametersUnique,"path-parameters-defined":x.PathParamsDefined,"operation-tag-defined":k.OperationTagDefined,"path-declaration-must-exist":_.PathDeclarationMustExist,"operation-operationId-url-safe":O.OperationIdUrlSafe,"operation-operationId":T.OperationOperationId,"operation-summary":I.OperationSummary,"operation-description":S.OperationDescription,"path-not-include-query":E.PathNotIncludeQuery,"path-params-defined":x.PathParamsDefined,"parameter-description":P.ParameterDescription,"operation-singular-tag":A.OperationSingularTag,"operation-security-defined":$.OperationSecurityDefined,"no-unresolved-refs":C.NoUnresolvedRefs,"no-identical-paths":j.NoIdenticalPaths,"no-ambiguous-paths":N.NoAmbiguousPaths,"path-http-verbs-order":R.PathHttpVerbsOrder,"no-http-verbs-in-paths":D.NoHttpVerbsInPaths,"path-excludes-patterns":L.PathExcludesPatterns,"request-mime-type":M.RequestMimeType,"response-mime-type":F.ResponseMimeType,"path-segment-plural":z.PathSegmentPlural,"response-contains-header":U.ResponseContainsHeader,"response-contains-property":V.ResponseContainsProperty,"scalar-property-missing-example":B.ScalarPropertyMissingExample},t.preprocessors={}},4508:function(e,t,n){"use strict";Object.defineProperty(t,"__esModule",{value:!0}),t.RemoveUnusedComponents=void 0;const r=n(771);t.RemoveUnusedComponents=()=>{let e=new Map;function t(t,n,r){var o;e.set(t.absolutePointer,{used:(null===(o=e.get(t.absolutePointer))||void 0===o?void 0:o.used)||!1,componentType:n,name:r})}return{ref:{leave(t,{type:n,resolve:r,key:o}){if(["Schema","Parameter","Response","SecurityScheme"].includes(n.name)){const n=r(t);if(!n.location)return;e.set(n.location.absolutePointer,{used:!0,name:o.toString()})}}},DefinitionRoot:{leave(t,n){const o=n.getVisitorData();o.removedCount=0;let i=new Set;e.forEach((e=>{const{used:n,name:r,componentType:a}=e;!n&&a&&(i.add(a),delete t[a][r],o.removedCount++)}));for(const e of i)r.isEmptyObject(t[e])&&delete t[e]}},NamedSchemas:{Schema(e,{location:n,key:r}){e.allOf||t(n,"definitions",r.toString())}},NamedParameters:{Parameter(e,{location:n,key:r}){t(n,"parameters",r.toString())}},NamedResponses:{Response(e,{location:n,key:r}){t(n,"responses",r.toString())}},NamedSecuritySchemes:{SecurityScheme(e,{location:n,key:r}){t(n,"securityDefinitions",r.toString())}}}}},7028:function(e,t,n){"use strict";Object.defineProperty(t,"__esModule",{value:!0}),t.RequestMimeType=void 0;const r=n(771);t.RequestMimeType=({allowedValues:e})=>({DefinitionRoot(t,n){r.validateMimeType({type:"consumes",value:t},n,e)},Operation:{leave(t,n){r.validateMimeType({type:"consumes",value:t},n,e)}}})},7899:function(e,t,n){"use strict";Object.defineProperty(t,"__esModule",{value:!0}),t.ResponseContainsProperty=void 0;const r=n(771);t.ResponseContainsProperty=e=>{const t=e.names||{};let n;return{Operation:{Response:{skip:(e,t)=>"204"==`${t}`,enter:(e,t)=>{n=t.key},Schema(e,{report:o,location:i}){var a;if("object"!==e.type)return;const s=t[n]||t[r.getMatchingStatusCodeRange(n)]||t[r.getMatchingStatusCodeRange(n).toLowerCase()]||[];for(const t of s)(null===(a=e.properties)||void 0===a?void 0:a[t])||o({message:`Response object must contain a top-level "${t}" property.`,location:i.child("properties").key()})}}}}}},1750:function(e,t,n){"use strict";Object.defineProperty(t,"__esModule",{value:!0}),t.ResponseMimeType=void 0;const r=n(771);t.ResponseMimeType=({allowedValues:e})=>({DefinitionRoot(t,n){r.validateMimeType({type:"produces",value:t},n,e)},Operation:{leave(t,n){r.validateMimeType({type:"produces",value:t},n,e)}}})},962:function(e,t){"use strict";Object.defineProperty(t,"__esModule",{value:!0}),t.BooleanParameterPrefixes=void 0,t.BooleanParameterPrefixes=e=>{const t=e.prefixes||["is","has"],n=new RegExp(`^(${t.join("|")})[A-Z-_]`),r=t.map((e=>`\`${e}\``)),o=1===r.length?r[0]:r.slice(0,-1).join(", ")+" or "+r[t.length-1];return{Parameter:{Schema(e,{report:t,parentLocations:r},i){"boolean"!==e.type||n.test(i.Parameter.name)||t({message:`Boolean parameter \`${i.Parameter.name}\` should have ${o} prefix.`,location:r.Parameter.child(["name"])})}}}}},226:function(e,t,n){"use strict";Object.defineProperty(t,"__esModule",{value:!0}),t.preprocessors=t.rules=void 0;const r=n(6471),o=n(5946),i=n(5281),a=n(4015),s=n(8742),l=n(4112),c=n(7421),u=n(5097),p=n(1265),d=n(2319),f=n(700),h=n(7890),m=n(5064),g=n(6855),y=n(5486),v=n(2947),b=n(8675),w=n(7281),x=n(8265),k=n(9622),_=n(3408),O=n(897),S=n(5023),E=n(3529),P=n(8613),A=n(476),$=n(7892),C=n(348),R=n(962),j=n(9527),T=n(2332),I=n(7020),N=n(9336),D=n(4628),L=n(6208),M=n(8786),F=n(9578),z=n(3467),U=n(472),V=n(525),B=n(3736),q=n(503),W=n(3807),H=n(3689),Y=n(78),K=n(1562),G=n(5839),Q=n(7557),X=n(5669);t.rules={spec:r.OasSpec,"info-description":b.InfoDescription,"info-contact":x.InfoContact,"info-license":k.InfoLicense,"info-license-url":A.InfoLicenseUrl,"operation-2xx-response":o.Operation2xxResponse,"operation-4xx-response":i.Operation4xxResponse,assertions:a.Assertions,"operation-operationId-unique":s.OperationIdUnique,"operation-parameters-unique":l.OperationParametersUnique,"path-parameters-defined":c.PathParamsDefined,"operation-tag-defined":u.OperationTagDefined,"no-example-value-and-externalValue":p.NoExampleValueAndExternalValue,"no-enum-type-mismatch":d.NoEnumTypeMismatch,"no-path-trailing-slash":f.NoPathTrailingSlash,"no-empty-servers":I.NoEmptyServers,"path-declaration-must-exist":h.PathDeclarationMustExist,"operation-operationId-url-safe":m.OperationIdUrlSafe,"operation-operationId":M.OperationOperationId,"operation-summary":F.OperationSummary,"tags-alphabetical":g.TagsAlphabetical,"no-server-example.com":y.NoServerExample,"no-server-trailing-slash":v.NoServerTrailingSlash,"tag-description":w.TagDescription,"operation-description":_.OperationDescription,"no-unused-components":O.NoUnusedComponents,"path-not-include-query":S.PathNotIncludeQuery,"path-params-defined":c.PathParamsDefined,"parameter-description":E.ParameterDescription,"operation-singular-tag":P.OperationSingularTag,"operation-security-defined":$.OperationSecurityDefined,"no-unresolved-refs":C.NoUnresolvedRefs,"paths-kebab-case":j.PathsKebabCase,"boolean-parameter-prefixes":R.BooleanParameterPrefixes,"path-http-verbs-order":T.PathHttpVerbsOrder,"no-invalid-media-type-examples":N.ValidContentExamples,"no-identical-paths":D.NoIdenticalPaths,"no-ambiguous-paths":z.NoAmbiguousPaths,"no-undefined-server-variable":L.NoUndefinedServerVariable,"no-servers-empty-enum":U.NoEmptyEnumServers,"no-http-verbs-in-paths":V.NoHttpVerbsInPaths,"path-excludes-patterns":H.PathExcludesPatterns,"request-mime-type":B.RequestMimeType,"response-mime-type":q.ResponseMimeType,"path-segment-plural":W.PathSegmentPlural,"no-invalid-schema-examples":Y.NoInvalidSchemaExamples,"no-invalid-parameter-examples":K.NoInvalidParameterExamples,"response-contains-header":G.ResponseContainsHeader,"response-contains-property":Q.ResponseContainsProperty,"scalar-property-missing-example":X.ScalarPropertyMissingExample},t.preprocessors={}},7020:function(e,t){"use strict";Object.defineProperty(t,"__esModule",{value:!0}),t.NoEmptyServers=void 0,t.NoEmptyServers=()=>({DefinitionRoot(e,{report:t,location:n}){e.hasOwnProperty("servers")?Array.isArray(e.servers)&&0!==e.servers.length||t({message:"Servers must be a non-empty array.",location:n.child(["servers"]).key()}):t({message:"Servers must be present.",location:n.child(["openapi"]).key()})}})},1265:function(e,t){"use strict";Object.defineProperty(t,"__esModule",{value:!0}),t.NoExampleValueAndExternalValue=void 0,t.NoExampleValueAndExternalValue=()=>({Example(e,{report:t,location:n}){e.value&&e.externalValue&&t({message:"Example object can have either `value` or `externalValue` fields.",location:n.child(["value"]).key()})}})},9336:function(e,t,n){"use strict";Object.defineProperty(t,"__esModule",{value:!0}),t.ValidContentExamples=void 0;const r=n(7468),o=n(780);t.ValidContentExamples=e=>{var t;const n=null===(t=e.disallowAdditionalProperties)||void 0===t||t;return{MediaType:{leave(e,t){const{location:i,resolve:a}=t;if(e.schema)if(e.example)s(e.example,i.child("example"));else if(e.examples)for(const t of Object.keys(e.examples))s(e.examples[t],i.child(["examples",t,"value"]),!0);function s(i,s,l){if(r.isRef(i)){const e=a(i);if(!e.location)return;s=l?e.location.child("value"):e.location,i=e.node}o.validateExample(l?i.value:i,e.schema,s,t,n)}}}}}},5486:function(e,t){"use strict";Object.defineProperty(t,"__esModule",{value:!0}),t.NoServerExample=void 0,t.NoServerExample=()=>({Server(e,{report:t,location:n}){-1!==["example.com","localhost"].indexOf(e.url)&&t({message:"Server `url` should not point at example.com.",location:n.child(["url"])})}})},2947:function(e,t){"use strict";Object.defineProperty(t,"__esModule",{value:!0}),t.NoServerTrailingSlash=void 0,t.NoServerTrailingSlash=()=>({Server(e,{report:t,location:n}){e.url&&e.url.endsWith("/")&&"/"!==e.url&&t({message:"Server `url` should not have a trailing slash.",location:n.child(["url"])})}})},472:function(e,t){"use strict";var n;function r(e){var t;if(e.variables&&0===Object.keys(e.variables).length)return;const r=[];for(var o in e.variables){const i=e.variables[o];if(!i.enum)continue;if(Array.isArray(i.enum)&&0===(null===(t=i.enum)||void 0===t?void 0:t.length)&&r.push(n.empty),!i.default)continue;const a=e.variables[o].default;i.enum&&!i.enum.includes(a)&&r.push(n.invalidDefaultValue)}return r.length?r:void 0}Object.defineProperty(t,"__esModule",{value:!0}),t.NoEmptyEnumServers=void 0,function(e){e.empty="empty",e.invalidDefaultValue="invalidDefaultValue"}(n||(n={})),t.NoEmptyEnumServers=()=>({DefinitionRoot(e,{report:t,location:o}){if(!e.servers||0===e.servers.length)return;const i=[];if(Array.isArray(e.servers))for(const t of e.servers){const e=r(t);e&&i.push(...e)}else{const t=r(e.servers);if(!t)return;i.push(...t)}for(const e of i)e===n.empty&&t({message:"Server variable with `enum` must be a non-empty array.",location:o.child(["servers"]).key()}),e===n.invalidDefaultValue&&t({message:"Server variable define `enum` and `default`. `enum` must include default value",location:o.child(["servers"]).key()})}})},6208:function(e,t){"use strict";Object.defineProperty(t,"__esModule",{value:!0}),t.NoUndefinedServerVariable=void 0,t.NoUndefinedServerVariable=()=>({Server(e,{report:t,location:n}){var r;if(!e.url)return;const o=(null===(r=e.url.match(/{[^}]+}/g))||void 0===r?void 0:r.map((e=>e.slice(1,e.length-1))))||[],i=(null==e?void 0:e.variables)&&Object.keys(e.variables)||[];for(const e of o)i.includes(e)||t({message:`The \`${e}\` variable is not defined in the \`variables\` objects.`,location:n.child(["url"])});for(const e of i)o.includes(e)||t({message:`The \`${e}\` variable is not used in the server's \`url\` field.`,location:n.child(["variables",e]).key(),from:n.child("url")})}})},897:function(e,t){"use strict";Object.defineProperty(t,"__esModule",{value:!0}),t.NoUnusedComponents=void 0,t.NoUnusedComponents=()=>{let e=new Map;function t(t,n){var r;e.set(t.absolutePointer,{used:(null===(r=e.get(t.absolutePointer))||void 0===r?void 0:r.used)||!1,location:t,name:n})}return{ref(t,{type:n,resolve:r,key:o,location:i}){if(["Schema","Header","Parameter","Response","Example","RequestBody"].includes(n.name)){const n=r(t);if(!n.location)return;e.set(n.location.absolutePointer,{used:!0,name:o.toString(),location:i})}},DefinitionRoot:{leave(t,{report:n}){e.forEach((e=>{e.used||n({message:`Component: "${e.name}" is never used.`,location:e.location.key()})}))}},NamedSchemas:{Schema(e,{location:n,key:r}){e.allOf||t(n,r.toString())}},NamedParameters:{Parameter(e,{location:n,key:r}){t(n,r.toString())}},NamedResponses:{Response(e,{location:n,key:r}){t(n,r.toString())}},NamedExamples:{Example(e,{location:n,key:r}){t(n,r.toString())}},NamedRequestBodies:{RequestBody(e,{location:n,key:r}){t(n,r.toString())}},NamedHeaders:{Header(e,{location:n,key:r}){t(n,r.toString())}}}}},6350:function(e,t,n){"use strict";Object.defineProperty(t,"__esModule",{value:!0}),t.RemoveUnusedComponents=void 0;const r=n(771);t.RemoveUnusedComponents=()=>{let e=new Map;function t(t,n,r){var o;e.set(t.absolutePointer,{used:(null===(o=e.get(t.absolutePointer))||void 0===o?void 0:o.used)||!1,componentType:n,name:r})}return{ref:{leave(t,{type:n,resolve:r,key:o}){if(["Schema","Header","Parameter","Response","Example","RequestBody"].includes(n.name)){const n=r(t);if(!n.location)return;e.set(n.location.absolutePointer,{used:!0,name:o.toString()})}}},DefinitionRoot:{leave(t,n){const o=n.getVisitorData();o.removedCount=0,e.forEach((e=>{const{used:n,componentType:i,name:a}=e;if(!n&&i){let e=t.components[i];delete e[a],o.removedCount++,r.isEmptyObject(e)&&delete t.components[i]}})),r.isEmptyObject(t.components)&&delete t.components}},NamedSchemas:{Schema(e,{location:n,key:r}){e.allOf||t(n,"schemas",r.toString())}},NamedParameters:{Parameter(e,{location:n,key:r}){t(n,"parameters",r.toString())}},NamedResponses:{Response(e,{location:n,key:r}){t(n,"responses",r.toString())}},NamedExamples:{Example(e,{location:n,key:r}){t(n,"examples",r.toString())}},NamedRequestBodies:{RequestBody(e,{location:n,key:r}){t(n,"requestBodies",r.toString())}},NamedHeaders:{Header(e,{location:n,key:r}){t(n,"headers",r.toString())}}}}},3736:function(e,t,n){"use strict";Object.defineProperty(t,"__esModule",{value:!0}),t.RequestMimeType=void 0;const r=n(771);t.RequestMimeType=({allowedValues:e})=>({PathMap:{RequestBody:{leave(t,n){r.validateMimeTypeOAS3({type:"consumes",value:t},n,e)}},Callback:{RequestBody(){},Response:{leave(t,n){r.validateMimeTypeOAS3({type:"consumes",value:t},n,e)}}}},WebhooksMap:{Response:{leave(t,n){r.validateMimeTypeOAS3({type:"consumes",value:t},n,e)}}}})},7557:function(e,t,n){"use strict";Object.defineProperty(t,"__esModule",{value:!0}),t.ResponseContainsProperty=void 0;const r=n(771);t.ResponseContainsProperty=e=>{const t=e.names||{};let n;return{Operation:{Response:{skip:(e,t)=>"204"==`${t}`,enter:(e,t)=>{n=t.key},MediaType:{Schema(e,{report:o,location:i}){var a;if("object"!==e.type)return;const s=t[n]||t[r.getMatchingStatusCodeRange(n)]||t[r.getMatchingStatusCodeRange(n).toLowerCase()]||[];for(const t of s)(null===(a=e.properties)||void 0===a?void 0:a[t])||o({message:`Response object must contain a top-level "${t}" property.`,location:i.child("properties").key()})}}}}}}},503:function(e,t,n){"use strict";Object.defineProperty(t,"__esModule",{value:!0}),t.ResponseMimeType=void 0;const r=n(771);t.ResponseMimeType=({allowedValues:e})=>({PathMap:{Response:{leave(t,n){r.validateMimeTypeOAS3({type:"produces",value:t},n,e)}},Callback:{Response(){},RequestBody:{leave(t,n){r.validateMimeTypeOAS3({type:"produces",value:t},n,e)}}}},WebhooksMap:{RequestBody:{leave(t,n){r.validateMimeTypeOAS3({type:"produces",value:t},n,e)}}}})},780:function(e,t,n){"use strict";Object.defineProperty(t,"__esModule",{value:!0}),t.validateExample=t.getSuggest=t.validateDefinedAndNonEmpty=t.fieldNonEmpty=t.missingRequiredField=t.matchesJsonSchemaType=t.oasTypeOf=void 0;const r=n(9991),o=n(7468),i=n(7275);function a(e,t){return`${e} object should contain \`${t}\` field.`}function s(e,t){return`${e} object \`${t}\` must be non-empty string.`}t.oasTypeOf=function(e){return Array.isArray(e)?"array":null===e?"null":typeof e},t.matchesJsonSchemaType=function(e,t,n){if(n&&null===e)return null===e;switch(t){case"array":return Array.isArray(e);case"object":return"object"==typeof e&&null!==e&&!Array.isArray(e);case"null":return null===e;case"integer":return Number.isInteger(e);default:return typeof e===t}},t.missingRequiredField=a,t.fieldNonEmpty=s,t.validateDefinedAndNonEmpty=function(e,t,n){"object"==typeof t&&(void 0===t[e]?n.report({message:a(n.type.name,e),location:n.location.child([e]).key()}):t[e]||n.report({message:s(n.type.name,e),location:n.location.child([e]).key()}))},t.getSuggest=function(e,t){if("string"!=typeof e||!t.length)return[];const n=[];for(let o=0;o<t.length;o++){const i=r(e,t[o]);i<4&&n.push({distance:i,variant:t[o]})}return n.sort(((e,t)=>e.distance-t.distance)),n.map((e=>e.variant))},t.validateExample=function(e,t,n,{resolve:r,location:a,report:s},l){try{const{valid:c,errors:u}=i.validateJsonSchema(e,t,a.child("schema"),n.pointer,r,l);if(!c)for(let e of u)s({message:`Example value must conform to the schema: ${e.message}.`,location:Object.assign(Object.assign({},new o.Location(n.source,e.instancePath)),{reportOnKey:"additionalProperties"===e.keyword}),from:a,suggest:e.suggest})}catch(e){s({message:`Example validation errored: ${e.message}.`,location:a.child("schema"),from:a})}}},5220:function(e,t){"use strict";Object.defineProperty(t,"__esModule",{value:!0}),t.isNamedType=t.normalizeTypes=t.mapOf=t.listOf=void 0,t.listOf=function(e){return{name:`${e}List`,properties:{},items:e}},t.mapOf=function(e){return{name:`${e}Map`,properties:{},additionalProperties:()=>e}},t.normalizeTypes=function(e,t={}){const n={};for(const t of Object.keys(e))n[t]=Object.assign(Object.assign({},e[t]),{name:t});for(const e of Object.values(n))r(e);return n;function r(e){if(e.additionalProperties&&(e.additionalProperties=o(e.additionalProperties)),e.items&&(e.items=o(e.items)),e.properties){const n={};for(const[r,i]of Object.entries(e.properties))n[r]=o(i),t.doNotResolveExamples&&i&&i.isExample&&(n[r]=Object.assign(Object.assign({},i),{resolvable:!1}));e.properties=n}}function o(e){if("string"==typeof e){if(!n[e])throw new Error(`Unknown type name found: ${e}`);return n[e]}return"function"==typeof e?(t,n)=>o(e(t,n)):e&&e.name?(r(e=Object.assign({},e)),e):e&&e.directResolveAs?Object.assign(Object.assign({},e),{directResolveAs:o(e.directResolveAs)}):e}},t.isNamedType=function(e){return"string"==typeof(null==e?void 0:e.name)}},388:function(e,t,n){"use strict";Object.defineProperty(t,"__esModule",{value:!0}),t.Oas2Types=void 0;const r=n(5220),o=/^[0-9][0-9Xx]{2}$/,i={properties:{swagger:{type:"string"},info:"Info",host:{type:"string"},basePath:{type:"string"},schemes:{type:"array",items:{type:"string"}},consumes:{type:"array",items:{type:"string"}},produces:{type:"array",items:{type:"string"}},paths:"PathMap",definitions:"NamedSchemas",parameters:"NamedParameters",responses:"NamedResponses",securityDefinitions:"NamedSecuritySchemes",security:r.listOf("SecurityRequirement"),tags:r.listOf("Tag"),externalDocs:"ExternalDocs"},required:["swagger","paths","info"]},a={properties:{$ref:{type:"string"},parameters:r.listOf("Parameter"),get:"Operation",put:"Operation",post:"Operation",delete:"Operation",options:"Operation",head:"Operation",patch:"Operation"}},s={properties:{tags:{type:"array",items:{type:"string"}},summary:{type:"string"},description:{type:"string"},externalDocs:"ExternalDocs",operationId:{type:"string"},consumes:{type:"array",items:{type:"string"}},produces:{type:"array",items:{type:"string"}},parameters:r.listOf("Parameter"),responses:"ResponsesMap",schemes:{type:"array",items:{type:"string"}},deprecated:{type:"boolean"},security:r.listOf("SecurityRequirement"),"x-codeSamples":r.listOf("XCodeSample"),"x-code-samples":r.listOf("XCodeSample"),"x-hideTryItPanel":{type:"boolean"}},required:["responses"]},l={properties:{default:"Response"},additionalProperties:(e,t)=>o.test(t)?"Response":void 0},c={properties:{description:{type:"string"},schema:"Schema",headers:r.mapOf("Header"),examples:"Examples"},required:["description"]},u={properties:{format:{type:"string"},title:{type:"string"},description:{type:"string"},default:null,multipleOf:{type:"number"},maximum:{type:"number"},minimum:{type:"number"},exclusiveMaximum:{type:"boolean"},exclusiveMinimum:{type:"boolean"},maxLength:{type:"number"},minLength:{type:"number"},pattern:{type:"string"},maxItems:{type:"number"},minItems:{type:"number"},uniqueItems:{type:"boolean"},maxProperties:{type:"number"},minProperties:{type:"number"},required:{type:"array",items:{type:"string"}},enum:{type:"array"},type:{type:"string",enum:["object","array","string","number","integer","boolean","null"]},items:e=>Array.isArray(e)?r.listOf("Schema"):"Schema",allOf:r.listOf("Schema"),properties:"SchemaProperties",additionalProperties:e=>"boolean"==typeof e?{type:"boolean"}:"Schema",discriminator:{type:"string"},readOnly:{type:"boolean"},xml:"Xml",externalDocs:"ExternalDocs",example:{isExample:!0},"x-tags":{type:"array",items:{type:"string"}}}},p={properties:{type:{enum:["basic","apiKey","oauth2"]},description:{type:"string"},name:{type:"string"},in:{type:"string",enum:["query","header"]},flow:{enum:["implicit","password","application","accessCode"]},authorizationUrl:{type:"string"},tokenUrl:{type:"string"},scopes:{type:"object",additionalProperties:{type:"string"}}},required(e){switch(null==e?void 0:e.type){case"apiKey":return["type","name","in"];case"oauth2":switch(null==e?void 0:e.flow){case"implicit":return["type","flow","authorizationUrl","scopes"];case"accessCode":return["type","flow","authorizationUrl","tokenUrl","scopes"];case"application":case"password":return["type","flow","tokenUrl","scopes"];default:return["type","flow","scopes"]}default:return["type"]}},allowed(e){switch(null==e?void 0:e.type){case"basic":return["type","description"];case"apiKey":return["type","name","in","description"];case"oauth2":switch(null==e?void 0:e.flow){case"implicit":return["type","flow","authorizationUrl","description","scopes"];case"accessCode":return["type","flow","authorizationUrl","tokenUrl","description","scopes"];case"application":case"password":return["type","flow","tokenUrl","description","scopes"];default:return["type","flow","tokenUrl","authorizationUrl","description","scopes"]}default:return["type","description"]}},extensionsPrefix:"x-"};t.Oas2Types={DefinitionRoot:i,Tag:{properties:{name:{type:"string"},description:{type:"string"},externalDocs:"ExternalDocs"},required:["name"]},ExternalDocs:{properties:{description:{type:"string"},url:{type:"string"}},required:["url"]},SecurityRequirement:{properties:{},additionalProperties:{type:"array",items:{type:"string"}}},Info:{properties:{title:{type:"string"},description:{type:"string"},termsOfService:{type:"string"},contact:"Contact",license:"License",version:{type:"string"}},required:["title","version"]},Contact:{properties:{name:{type:"string"},url:{type:"string"},email:{type:"string"}}},License:{properties:{name:{type:"string"},url:{type:"string"}},required:["name"]},PathMap:{properties:{},additionalProperties:(e,t)=>t.startsWith("/")?"PathItem":void 0},PathItem:a,Parameter:{properties:{name:{type:"string"},in:{type:"string",enum:["query","header","path","formData","body"]},description:{type:"string"},required:{type:"boolean"},schema:"Schema",type:{type:"string",enum:["string","number","integer","boolean","array","file"]},format:{type:"string"},allowEmptyValue:{type:"boolean"},items:"ParameterItems",collectionFormat:{type:"string",enum:["csv","ssv","tsv","pipes","multi"]},default:null,maximum:{type:"integer"},exclusiveMaximum:{type:"boolean"},minimum:{type:"integer"},exclusiveMinimum:{type:"boolean"},maxLength:{type:"integer"},minLength:{type:"integer"},pattern:{type:"string"},maxItems:{type:"integer"},minItems:{type:"integer"},uniqueItems:{type:"boolean"},enum:{type:"array"},multipleOf:{type:"number"}},required:e=>e&&e.in?"body"===e.in?["name","in","schema"]:"array"===e.type?["name","in","type","items"]:["name","in","type"]:["name","in"]},ParameterItems:{properties:{type:{type:"string",enum:["string","number","integer","boolean","array"]},format:{type:"string"},items:"ParameterItems",collectionFormat:{type:"string",enum:["csv","ssv","tsv","pipes","multi"]},default:null,maximum:{type:"integer"},exclusiveMaximum:{type:"boolean"},minimum:{type:"integer"},exclusiveMinimum:{type:"boolean"},maxLength:{type:"integer"},minLength:{type:"integer"},pattern:{type:"string"},maxItems:{type:"integer"},minItems:{type:"integer"},uniqueItems:{type:"boolean"},enum:{type:"array"},multipleOf:{type:"number"}},required:e=>e&&"array"===e.type?["type","items"]:["type"]},Operation:s,Examples:{properties:{},additionalProperties:{isExample:!0}},Header:{properties:{description:{type:"string"},type:{type:"string",enum:["string","number","integer","boolean","array"]},format:{type:"string"},items:"ParameterItems",collectionFormat:{type:"string",enum:["csv","ssv","tsv","pipes","multi"]},default:null,maximum:{type:"integer"},exclusiveMaximum:{type:"boolean"},minimum:{type:"integer"},exclusiveMinimum:{type:"boolean"},maxLength:{type:"integer"},minLength:{type:"integer"},pattern:{type:"string"},maxItems:{type:"integer"},minItems:{type:"integer"},uniqueItems:{type:"boolean"},enum:{type:"array"},multipleOf:{type:"number"}},required:e=>e&&"array"===e.type?["type","items"]:["type"]},ResponsesMap:l,Response:c,Schema:u,Xml:{properties:{name:{type:"string"},namespace:{type:"string"},prefix:{type:"string"},attribute:{type:"boolean"},wrapped:{type:"boolean"}}},SchemaProperties:{properties:{},additionalProperties:"Schema"},NamedSchemas:r.mapOf("Schema"),NamedResponses:r.mapOf("Response"),NamedParameters:r.mapOf("Parameter"),NamedSecuritySchemes:r.mapOf("SecurityScheme"),SecurityScheme:p,XCodeSample:{properties:{lang:{type:"string"},label:{type:"string"},source:{type:"string"}}}}},5241:function(e,t,n){"use strict";Object.defineProperty(t,"__esModule",{value:!0}),t.Oas3Types=void 0;const r=n(5220),o=n(7468),i=/^[0-9][0-9Xx]{2}$/,a={properties:{openapi:null,info:"Info",servers:r.listOf("Server"),security:r.listOf("SecurityRequirement"),tags:r.listOf("Tag"),externalDocs:"ExternalDocs",paths:"PathMap",components:"Components","x-webhooks":"WebhooksMap"},required:["openapi","paths","info"]},s={properties:{url:{type:"string"},description:{type:"string"},variables:r.mapOf("ServerVariable")},required:["url"]},l={properties:{$ref:{type:"string"},servers:r.listOf("Server"),parameters:r.listOf("Parameter"),summary:{type:"string"},description:{type:"string"},get:"Operation",put:"Operation",post:"Operation",delete:"Operation",options:"Operation",head:"Operation",patch:"Operation",trace:"Operation"}},c={properties:{name:{type:"string"},in:{enum:["query","header","path","cookie"]},description:{type:"string"},required:{type:"boolean"},deprecated:{type:"boolean"},allowEmptyValue:{type:"boolean"},style:{enum:["form","simple","label","matrix","spaceDelimited","pipeDelimited","deepObject"]},explode:{type:"boolean"},allowReserved:{type:"boolean"},schema:"Schema",example:{isExample:!0},examples:r.mapOf("Example"),content:"MediaTypeMap"},required:["name","in"],requiredOneOf:["schema","content"]},u={properties:{tags:{type:"array",items:{type:"string"}},summary:{type:"string"},description:{type:"string"},externalDocs:"ExternalDocs",operationId:{type:"string"},parameters:r.listOf("Parameter"),security:r.listOf("SecurityRequirement"),servers:r.listOf("Server"),requestBody:"RequestBody",responses:"ResponsesMap",deprecated:{type:"boolean"},callbacks:r.mapOf("Callback"),"x-codeSamples":r.listOf("XCodeSample"),"x-code-samples":r.listOf("XCodeSample"),"x-hideTryItPanel":{type:"boolean"}},required:["responses"]},p={properties:{schema:"Schema",example:{isExample:!0},examples:r.mapOf("Example"),encoding:r.mapOf("Encoding")}},d={properties:{contentType:{type:"string"},headers:r.mapOf("Header"),style:{enum:["form","simple","label","matrix","spaceDelimited","pipeDelimited","deepObject"]},explode:{type:"boolean"},allowReserved:{type:"boolean"}}},f={properties:{description:{type:"string"},required:{type:"boolean"},deprecated:{type:"boolean"},allowEmptyValue:{type:"boolean"},style:{enum:["form","simple","label","matrix","spaceDelimited","pipeDelimited","deepObject"]},explode:{type:"boolean"},allowReserved:{type:"boolean"},schema:"Schema",example:{isExample:!0},examples:r.mapOf("Example"),content:"MediaTypeMap"}},h={properties:{default:"Response"},additionalProperties:(e,t)=>i.test(t)?"Response":void 0},m={properties:{description:{type:"string"},headers:r.mapOf("Header"),content:"MediaTypeMap",links:r.mapOf("Link")},required:["description"]},g={properties:{externalDocs:"ExternalDocs",discriminator:"Discriminator",title:{type:"string"},multipleOf:{type:"number",minimum:0},maximum:{type:"number"},minimum:{type:"number"},exclusiveMaximum:{type:"boolean"},exclusiveMinimum:{type:"boolean"},maxLength:{type:"integer",minimum:0},minLength:{type:"integer",minimum:0},pattern:{type:"string"},maxItems:{type:"integer",minimum:0},minItems:{type:"integer",minimum:0},uniqueItems:{type:"boolean"},maxProperties:{type:"integer",minimum:0},minProperties:{type:"integer",minimum:0},required:{type:"array",items:{type:"string"}},enum:{type:"array"},type:{enum:["object","array","string","number","integer","boolean","null"]},allOf:r.listOf("Schema"),anyOf:r.listOf("Schema"),oneOf:r.listOf("Schema"),not:"Schema",properties:"SchemaProperties",items:e=>Array.isArray(e)?r.listOf("Schema"):"Schema",additionalItems:e=>"boolean"==typeof e?{type:"boolean"}:"Schema",additionalProperties:e=>"boolean"==typeof e?{type:"boolean"}:"Schema",description:{type:"string"},format:{type:"string"},default:null,nullable:{type:"boolean"},readOnly:{type:"boolean"},writeOnly:{type:"boolean"},xml:"Xml",example:{isExample:!0},deprecated:{type:"boolean"},"x-tags":{type:"array",items:{type:"string"}}}},y={properties:{},additionalProperties:e=>o.isMappingRef(e)?{type:"string",directResolveAs:"Schema"}:{type:"string"}},v={properties:{type:{enum:["apiKey","http","oauth2","openIdConnect"]},description:{type:"string"},name:{type:"string"},in:{type:"string",enum:["query","header","cookie"]},scheme:{type:"string"},bearerFormat:{type:"string"},flows:"SecuritySchemeFlows",openIdConnectUrl:{type:"string"}},required(e){switch(null==e?void 0:e.type){case"apiKey":return["type","name","in"];case"http":return["type","scheme"];case"oauth2":return["type","flows"];case"openIdConnect":return["type","openIdConnectUrl"];default:return["type"]}},allowed(e){switch(null==e?void 0:e.type){case"apiKey":return["type","name","in","description"];case"http":return["type","scheme","bearerFormat","description"];case"oauth2":return["type","flows","description"];case"openIdConnect":return["type","openIdConnectUrl","description"];default:return["type","description"]}},extensionsPrefix:"x-"};t.Oas3Types={DefinitionRoot:a,Tag:{properties:{name:{type:"string"},description:{type:"string"},externalDocs:"ExternalDocs"},required:["name"]},ExternalDocs:{properties:{description:{type:"string"},url:{type:"string"}},required:["url"]},Server:s,ServerVariable:{properties:{enum:{type:"array",items:{type:"string"}},default:{type:"string"},description:null},required:["default"]},SecurityRequirement:{properties:{},additionalProperties:{type:"array",items:{type:"string"}}},Info:{properties:{title:{type:"string"},version:{type:"string"},description:{type:"string"},termsOfService:{type:"string"},contact:"Contact",license:"License"},required:["title","version"]},Contact:{properties:{name:{type:"string"},url:{type:"string"},email:{type:"string"}}},License:{properties:{name:{type:"string"},url:{type:"string"}},required:["name"]},PathMap:{properties:{},additionalProperties:(e,t)=>t.startsWith("/")?"PathItem":void 0},PathItem:l,Parameter:c,Operation:u,Callback:r.mapOf("PathItem"),RequestBody:{properties:{description:{type:"string"},required:{type:"boolean"},content:"MediaTypeMap"},required:["content"]},MediaTypeMap:{properties:{},additionalProperties:"MediaType"},MediaType:p,Example:{properties:{value:{isExample:!0},summary:{type:"string"},description:{type:"string"},externalValue:{type:"string"}}},Encoding:d,Header:f,ResponsesMap:h,Response:m,Link:{properties:{operationRef:{type:"string"},operationId:{type:"string"},parameters:null,requestBody:null,description:{type:"string"},server:"Server"}},Schema:g,Xml:{properties:{name:{type:"string"},namespace:{type:"string"},prefix:{type:"string"},attribute:{type:"boolean"},wrapped:{type:"boolean"}}},SchemaProperties:{properties:{},additionalProperties:"Schema"},DiscriminatorMapping:y,Discriminator:{properties:{propertyName:{type:"string"},mapping:"DiscriminatorMapping"},required:["propertyName"]},Components:{properties:{parameters:"NamedParameters",schemas:"NamedSchemas",responses:"NamedResponses",examples:"NamedExamples",requestBodies:"NamedRequestBodies",headers:"NamedHeaders",securitySchemes:"NamedSecuritySchemes",links:"NamedLinks",callbacks:"NamedCallbacks"}},NamedSchemas:r.mapOf("Schema"),NamedResponses:r.mapOf("Response"),NamedParameters:r.mapOf("Parameter"),NamedExamples:r.mapOf("Example"),NamedRequestBodies:r.mapOf("RequestBody"),NamedHeaders:r.mapOf("Header"),NamedSecuritySchemes:r.mapOf("SecurityScheme"),NamedLinks:r.mapOf("Link"),NamedCallbacks:r.mapOf("Callback"),ImplicitFlow:{properties:{refreshUrl:{type:"string"},scopes:{type:"object",additionalProperties:{type:"string"}},authorizationUrl:{type:"string"}},required:["authorizationUrl","scopes"]},PasswordFlow:{properties:{refreshUrl:{type:"string"},scopes:{type:"object",additionalProperties:{type:"string"}},tokenUrl:{type:"string"}},required:["tokenUrl","scopes"]},ClientCredentials:{properties:{refreshUrl:{type:"string"},scopes:{type:"object",additionalProperties:{type:"string"}},tokenUrl:{type:"string"}},required:["tokenUrl","scopes"]},AuthorizationCode:{properties:{refreshUrl:{type:"string"},authorizationUrl:{type:"string"},scopes:{type:"object",additionalProperties:{type:"string"}},tokenUrl:{type:"string"}},required:["authorizationUrl","tokenUrl","scopes"]},SecuritySchemeFlows:{properties:{implicit:"ImplicitFlow",password:"PasswordFlow",clientCredentials:"ClientCredentials",authorizationCode:"AuthorizationCode"}},SecurityScheme:v,XCodeSample:{properties:{lang:{type:"string"},label:{type:"string"},source:{type:"string"}}},WebhooksMap:{properties:{},additionalProperties:()=>"PathItem"}}},2608:function(e,t,n){"use strict";Object.defineProperty(t,"__esModule",{value:!0}),t.Oas3_1Types=void 0;const r=n(5220),o=n(5241),i={properties:{openapi:null,info:"Info",servers:r.listOf("Server"),security:r.listOf("SecurityRequirement"),tags:r.listOf("Tag"),externalDocs:"ExternalDocs",paths:"PathMap",webhooks:"WebhooksMap",components:"Components",jsonSchemaDialect:{type:"string"}},required:["openapi","info"],requiredOneOf:["paths","components","webhooks"]},a={properties:{tags:{type:"array",items:{type:"string"}},summary:{type:"string"},description:{type:"string"},externalDocs:"ExternalDocs",operationId:{type:"string"},parameters:r.listOf("Parameter"),security:r.listOf("SecurityRequirement"),servers:r.listOf("Server"),requestBody:"RequestBody",responses:"ResponsesMap",deprecated:{type:"boolean"},callbacks:r.mapOf("Callback"),"x-codeSamples":r.listOf("XCodeSample"),"x-code-samples":r.listOf("XCodeSample"),"x-hideTryItPanel":{type:"boolean"}}},s={properties:{$id:{type:"string"},id:{type:"string"},$schema:{type:"string"},definitions:"NamedSchemas",$defs:"NamedSchemas",$vocabulary:{type:"string"},externalDocs:"ExternalDocs",discriminator:"Discriminator",myArbitraryKeyword:{type:"boolean"},title:{type:"string"},multipleOf:{type:"number",minimum:0},maximum:{type:"number"},minimum:{type:"number"},exclusiveMaximum:{type:"number"},exclusiveMinimum:{type:"number"},maxLength:{type:"integer",minimum:0},minLength:{type:"integer",minimum:0},pattern:{type:"string"},maxItems:{type:"integer",minimum:0},minItems:{type:"integer",minimum:0},uniqueItems:{type:"boolean"},maxProperties:{type:"integer",minimum:0},minProperties:{type:"integer",minimum:0},required:{type:"array",items:{type:"string"}},enum:{type:"array"},type:e=>Array.isArray(e)?{type:"array",items:{enum:["object","array","string","number","integer","boolean","null"]}}:{enum:["object","array","string","number","integer","boolean","null"]},allOf:r.listOf("Schema"),anyOf:r.listOf("Schema"),oneOf:r.listOf("Schema"),not:"Schema",if:"Schema",then:"Schema",else:"Schema",dependentSchemas:r.listOf("Schema"),prefixItems:r.listOf("Schema"),contains:"Schema",minContains:{type:"integer",minimum:0},maxContains:{type:"integer",minimum:0},patternProperties:{type:"object"},propertyNames:"Schema",unevaluatedItems:"Schema",unevaluatedProperties:e=>"boolean"==typeof e?{type:"boolean"}:"Schema",summary:{type:"string"},properties:"SchemaProperties",items:e=>"boolean"==typeof e?{type:"boolean"}:"Schema",additionalProperties:e=>"boolean"==typeof e?{type:"boolean"}:"Schema",description:{type:"string"},format:{type:"string"},contentEncoding:{type:"string"},contentMediaType:{type:"string"},default:null,readOnly:{type:"boolean"},writeOnly:{type:"boolean"},xml:"Xml",examples:{type:"array"},example:{isExample:!0},deprecated:{type:"boolean"},const:null,$comment:{type:"string"},"x-tags":{type:"array",items:{type:"string"}}}},l={properties:{type:{enum:["apiKey","http","oauth2","openIdConnect","mutualTLS"]},description:{type:"string"},name:{type:"string"},in:{type:"string",enum:["query","header","cookie"]},scheme:{type:"string"},bearerFormat:{type:"string"},flows:"SecuritySchemeFlows",openIdConnectUrl:{type:"string"}},required(e){switch(null==e?void 0:e.type){case"apiKey":return["type","name","in"];case"http":return["type","scheme"];case"oauth2":return["type","flows"];case"openIdConnect":return["type","openIdConnectUrl"];default:return["type"]}},allowed(e){switch(null==e?void 0:e.type){case"apiKey":return["type","name","in","description"];case"http":return["type","scheme","bearerFormat","description"];case"oauth2":switch(null==e?void 0:e.flows){case"implicit":return["type","flows","authorizationUrl","refreshUrl","description","scopes"];case"password":case"clientCredentials":return["type","flows","tokenUrl","refreshUrl","description","scopes"];default:return["type","flows","authorizationUrl","refreshUrl","tokenUrl","description","scopes"]}case"openIdConnect":return["type","openIdConnectUrl","description"];default:return["type","description"]}},extensionsPrefix:"x-"};t.Oas3_1Types=Object.assign(Object.assign({},o.Oas3Types),{Info:{properties:{title:{type:"string"},version:{type:"string"},description:{type:"string"},termsOfService:{type:"string"},summary:{type:"string"},contact:"Contact",license:"License"},required:["title","version"]},DefinitionRoot:i,Schema:s,License:{properties:{name:{type:"string"},url:{type:"string"},identifier:{type:"string"}},required:["name"]},Components:{properties:{parameters:"NamedParameters",schemas:"NamedSchemas",responses:"NamedResponses",examples:"NamedExamples",requestBodies:"NamedRequestBodies",headers:"NamedHeaders",securitySchemes:"NamedSecuritySchemes",links:"NamedLinks",callbacks:"NamedCallbacks",pathItems:"NamedPathItems"}},NamedPathItems:r.mapOf("PathItem"),SecurityScheme:l,Operation:a})},771:function(e,t,n){"use strict";var r=this&&this.__awaiter||function(e,t,n,r){return new(n||(n=Promise))((function(o,i){function a(e){try{l(r.next(e))}catch(e){i(e)}}function s(e){try{l(r.throw(e))}catch(e){i(e)}}function l(e){var t;e.done?o(e.value):(t=e.value,t instanceof n?t:new n((function(e){e(t)}))).then(a,s)}l((r=r.apply(e,t||[])).next())}))};Object.defineProperty(t,"__esModule",{value:!0}),t.isCustomRuleId=t.getMatchingStatusCodeRange=t.assignExisting=t.isNotString=t.isString=t.isNotEmptyObject=t.slash=t.isPathParameter=t.readFileAsStringSync=t.isSingular=t.validateMimeTypeOAS3=t.validateMimeType=t.splitCamelCaseIntoWords=t.omitObjectProps=t.pickObjectProps=t.readFileFromUrl=t.isEmptyArray=t.isEmptyObject=t.isPlainObject=t.notUndefined=t.loadYaml=t.popStack=t.pushStack=t.stringifyYaml=t.parseYaml=void 0;const o=n(3197),i=n(4099),a=n(8150),s=n(3450),l=n(5273),c=n(8698);var u=n(5273);function p(e){return null!==e&&"object"==typeof e&&!Array.isArray(e)}function d(e,t){return t.match(/^https?:\/\//)||(e=e.replace(/^https?:\/\//,"")),i(e,t)}function f(e){return"string"==typeof e}Object.defineProperty(t,"parseYaml",{enumerable:!0,get:function(){return u.parseYaml}}),Object.defineProperty(t,"stringifyYaml",{enumerable:!0,get:function(){return u.stringifyYaml}}),t.pushStack=function(e,t){return{prev:e,value:t}},t.popStack=function(e){var t;return null!==(t=null==e?void 0:e.prev)&&void 0!==t?t:null},t.loadYaml=function(e){return r(this,void 0,void 0,(function*(){const t=yield o.promises.readFile(e,"utf-8");return l.parseYaml(t)}))},t.notUndefined=function(e){return void 0!==e},t.isPlainObject=p,t.isEmptyObject=function(e){return p(e)&&0===Object.keys(e).length},t.isEmptyArray=function(e){return Array.isArray(e)&&0===e.length},t.readFileFromUrl=function(e,t){return r(this,void 0,void 0,(function*(){const n={};for(const r of t.headers)d(e,r.matches)&&(n[r.name]=void 0!==r.envVariable?c.env[r.envVariable]||"":r.value);const r=yield(t.customFetch||a.default)(e,{headers:n});if(!r.ok)throw new Error(`Failed to load ${e}: ${r.status} ${r.statusText}`);return{body:yield r.text(),mimeType:r.headers.get("content-type")}}))},t.pickObjectProps=function(e,t){return Object.fromEntries(t.filter((t=>t in e)).map((t=>[t,e[t]])))},t.omitObjectProps=function(e,t){return Object.fromEntries(Object.entries(e).filter((([e])=>!t.includes(e))))},t.splitCamelCaseIntoWords=function(e){const t=e.split(/(?:[-._])|([A-Z][a-z]+)/).filter(Boolean).map((e=>e.toLocaleLowerCase())),n=e.split(/([A-Z]{2,})/).filter((e=>e&&e===e.toUpperCase())).map((e=>e.toLocaleLowerCase()));return new Set([...t,...n])},t.validateMimeType=function({type:e,value:t},{report:n,location:r},o){if(!o)throw new Error(`Parameter "allowedValues" is not provided for "${"consumes"===e?"request":"response"}-mime-type" rule`);if(t[e])for(const i of t[e])o.includes(i)||n({message:`Mime type "${i}" is not allowed`,location:r.child(t[e].indexOf(i)).key()})},t.validateMimeTypeOAS3=function({type:e,value:t},{report:n,location:r},o){if(!o)throw new Error(`Parameter "allowedValues" is not provided for "${"consumes"===e?"request":"response"}-mime-type" rule`);if(t.content)for(const e of Object.keys(t.content))o.includes(e)||n({message:`Mime type "${e}" is not allowed`,location:r.child("content").child(e).key()})},t.isSingular=function(e){return s.isSingular(e)},t.readFileAsStringSync=function(e){return o.readFileSync(e,"utf-8")},t.isPathParameter=function(e){return e.startsWith("{")&&e.endsWith("}")},t.slash=function(e){return/^\\\\\?\\/.test(e)?e:e.replace(/\\/g,"/")},t.isNotEmptyObject=function(e){return!!e&&Object.keys(e).length>0},t.isString=f,t.isNotString=function(e){return!f(e)},t.assignExisting=function(e,t){for(let n of Object.keys(t))e.hasOwnProperty(n)&&(e[n]=t[n])},t.getMatchingStatusCodeRange=e=>`${e}`.replace(/^(\d)\d\d$/,((e,t)=>`${t}XX`)),t.isCustomRuleId=function(e){return e.includes("/")}},8065:function(e,t){"use strict";Object.defineProperty(t,"__esModule",{value:!0}),t.normalizeVisitors=void 0,t.normalizeVisitors=function(e,t){const n={any:{enter:[],leave:[]}};for(const e of Object.keys(t))n[e]={enter:[],leave:[]};n.ref={enter:[],leave:[]};for(const{ruleId:t,severity:n,visitor:r}of e)o({ruleId:t,severity:n},r,null);for(const e of Object.keys(n))n[e].enter.sort(((e,t)=>t.depth-e.depth)),n[e].leave.sort(((e,t)=>e.depth-t.depth));return n;function r(e,t,o,i,a=[]){if(a.includes(t))return;a=[...a,t];const s=new Set;for(let n of Object.values(t.properties))n!==o?"object"==typeof n&&null!==n&&n.name&&s.add(n):l(e,a);t.additionalProperties&&"function"!=typeof t.additionalProperties&&(t.additionalProperties===o?l(e,a):void 0!==t.additionalProperties.name&&s.add(t.additionalProperties)),t.items&&(t.items===o?l(e,a):void 0!==t.items.name&&s.add(t.items));for(let t of Array.from(s.values()))r(e,t,o,i,a);function l(e,t){for(const r of t.slice(1))n[r.name]=n[r.name]||{enter:[],leave:[]},n[r.name].enter.push(Object.assign(Object.assign({},e),{visit:()=>{},depth:0,context:{isSkippedLevel:!0,seen:new Set,parent:i}}))}}function o(e,i,a,s=0){const l=Object.keys(t);if(0===s)l.push("any"),l.push("ref");else{if(i.any)throw new Error("any() is allowed only on top level");if(i.ref)throw new Error("ref() is allowed only on top level")}for(const c of l){const l=i[c],u=n[c];if(!l)continue;let p,d,f;const h="object"==typeof l;if("ref"===c&&h&&l.skip)throw new Error("ref() visitor does not support skip");"function"==typeof l?p=l:h&&(p=l.enter,d=l.leave,f=l.skip);const m={activatedOn:null,type:t[c],parent:a,isSkippedLevel:!1};if("object"==typeof l&&o(e,l,m,s+1),a&&r(e,a.type,t[c],a),p||h){if(p&&"function"!=typeof p)throw new Error("DEV: should be function");u.enter.push(Object.assign(Object.assign({},e),{visit:p||(()=>{}),skip:f,depth:s,context:m}))}if(d){if("function"!=typeof d)throw new Error("DEV: should be function");u.leave.push(Object.assign(Object.assign({},e),{visit:d,depth:s,context:m}))}}}}},9443:function(e,t,n){"use strict";Object.defineProperty(t,"__esModule",{value:!0}),t.walkDocument=void 0;const r=n(7468),o=n(4182),i=n(771),a=n(5220);function s(e){var t,n;const r={};for(;e.parent;)(null===(t=e.parent.activatedOn)||void 0===t?void 0:t.value.location)&&(r[e.parent.type.name]=null===(n=e.parent.activatedOn)||void 0===n?void 0:n.value.location),e=e.parent;return r}t.walkDocument=function(e){const{document:t,rootType:n,normalizedVisitors:l,resolvedRefMap:c,ctx:u}=e,p={},d=new Set;!function e(t,n,f,h,m){var g,y,v,b,w,x,k,_,O,S,E;const P=(e,t=$.source.absoluteRef)=>{if(!r.isRef(e))return{location:f,node:e};const n=o.makeRefId(t,e.$ref),i=c.get(n);if(!i)return{location:void 0,node:void 0};const{resolved:a,node:s,document:l,nodePointer:u,error:p}=i;return{location:a?new r.Location(l.source,u):p instanceof o.YamlParseError?new r.Location(p.source,""):void 0,node:s,error:p}},A=f;let $=f;const{node:C,location:R,error:j}=P(t),T=new Set;if(r.isRef(t)){const e=l.ref.enter;for(const{visit:r,ruleId:o,severity:i,context:a}of e)if(!d.has(t)){T.add(a);r(t,{report:N.bind(void 0,o,i),resolve:P,rawNode:t,rawLocation:A,location:f,type:n,parent:h,key:m,parentLocations:{},oasVersion:u.oasVersion,getVisitorData:D.bind(void 0,o)},{node:C,location:R,error:j}),(null==R?void 0:R.source.absoluteRef)&&u.refTypes&&u.refTypes.set(null==R?void 0:R.source.absoluteRef,n)}}if(void 0!==C&&R&&"scalar"!==n.name){$=R;const o=null===(y=null===(g=p[n.name])||void 0===g?void 0:g.has)||void 0===y?void 0:y.call(g,C);let s=!1;const c=l.any.enter.concat((null===(v=l[n.name])||void 0===v?void 0:v.enter)||[]),u=[];for(const{context:e,visit:r,skip:a,ruleId:l,severity:p}of c)if(e.isSkippedLevel)!e.parent.activatedOn||e.parent.activatedOn.value.nextLevelTypeActivated||e.seen.has(t)||(e.seen.add(t),s=!0,u.push(e));else if(e.parent&&e.parent.activatedOn&&(null===(b=e.activatedOn)||void 0===b?void 0:b.value.withParentNode)!==e.parent.activatedOn.value.node&&(null===(w=e.parent.activatedOn.value.nextLevelTypeActivated)||void 0===w?void 0:w.value)!==n||!e.parent&&!o){u.push(e);const o={node:C,location:R,nextLevelTypeActivated:null,withParentNode:null===(k=null===(x=e.parent)||void 0===x?void 0:x.activatedOn)||void 0===k?void 0:k.value.node,skipped:null!==(S=(null===(O=null===(_=e.parent)||void 0===_?void 0:_.activatedOn)||void 0===O?void 0:O.value.skipped)||(null==a?void 0:a(C,m)))&&void 0!==S&&S};e.activatedOn=i.pushStack(e.activatedOn,o);let c=e.parent;for(;c;)c.activatedOn.value.nextLevelTypeActivated=i.pushStack(c.activatedOn.value.nextLevelTypeActivated,n),c=c.parent;if(!o.skipped){s=!0,T.add(e);const{ignoreNextVisitorsOnNode:n}=I(r,C,t,e,l,p);if(n)break}}if(s||!o)if(p[n.name]=p[n.name]||new Set,p[n.name].add(C),Array.isArray(C)){const t=n.items;if(void 0!==t)for(let n=0;n<C.length;n++)e(C[n],t,R.child([n]),C,n)}else if("object"==typeof C&&null!==C){const o=Object.keys(n.properties);n.additionalProperties&&o.push(...Object.keys(C).filter((e=>!o.includes(e)))),r.isRef(t)&&o.push(...Object.keys(t).filter((e=>"$ref"!==e&&!o.includes(e))));for(const i of o){let o=C[i],s=R;void 0===o&&(o=t[i],s=f);let l=n.properties[i];void 0===l&&(l=n.additionalProperties),"function"==typeof l&&(l=l(o,i)),!a.isNamedType(l)&&(null==l?void 0:l.directResolveAs)&&(l=l.directResolveAs,o={$ref:o}),l&&void 0===l.name&&!1!==l.resolvable&&(l={name:"scalar",properties:{}}),a.isNamedType(l)&&("scalar"!==l.name||r.isRef(o))&&e(o,l,s.child([i]),C,i)}}const d=l.any.leave,h=((null===(E=l[n.name])||void 0===E?void 0:E.leave)||[]).concat(d);for(const e of u.reverse())if(e.isSkippedLevel)e.seen.delete(C);else if(e.activatedOn=i.popStack(e.activatedOn),e.parent){let t=e.parent;for(;t;)t.activatedOn.value.nextLevelTypeActivated=i.popStack(t.activatedOn.value.nextLevelTypeActivated),t=t.parent}for(const{context:e,visit:n,ruleId:r,severity:o}of h)!e.isSkippedLevel&&T.has(e)&&I(n,C,t,e,r,o)}if($=f,r.isRef(t)){const e=l.ref.leave;for(const{visit:r,ruleId:o,severity:i,context:a}of e)if(T.has(a)){r(t,{report:N.bind(void 0,o,i),resolve:P,rawNode:t,rawLocation:A,location:f,type:n,parent:h,key:m,parentLocations:{},oasVersion:u.oasVersion,getVisitorData:D.bind(void 0,o)},{node:C,location:R,error:j})}}function I(e,t,r,o,i,a){const l=N.bind(void 0,i,a);let c=!1;return e(t,{report:l,resolve:P,rawNode:r,location:$,rawLocation:A,type:n,parent:h,key:m,parentLocations:s(o),oasVersion:u.oasVersion,ignoreNextVisitorsOnNode:()=>{c=!0},getVisitorData:D.bind(void 0,i)},function(e){var t;const n={};for(;e.parent;)n[e.parent.type.name]=null===(t=e.parent.activatedOn)||void 0===t?void 0:t.value.node,e=e.parent;return n}(o),o),{ignoreNextVisitorsOnNode:c}}function N(e,t,n){const r=n.location?Array.isArray(n.location)?n.location:[n.location]:[Object.assign(Object.assign({},$),{reportOnKey:!1})];u.problems.push(Object.assign(Object.assign({ruleId:n.ruleId||e,severity:n.forceSeverity||t},n),{suggest:n.suggest||[],location:r.map((e=>Object.assign(Object.assign(Object.assign({},$),{reportOnKey:!1}),e)))}))}function D(e){return u.visitorsData[e]=u.visitorsData[e]||{},u.visitorsData[e]}}(t.parsed,n,new r.Location(t.source,"#/"),void 0,"")}},5019:function(e,t,n){var r=n(5623);e.exports=function(e){return e?("{}"===e.substr(0,2)&&(e="\\{\\}"+e.substr(2)),g(function(e){return e.split("\\\\").join(o).split("\\{").join(i).split("\\}").join(a).split("\\,").join(s).split("\\.").join(l)}(e),!0).map(u)):[]};var o="\0SLASH"+Math.random()+"\0",i="\0OPEN"+Math.random()+"\0",a="\0CLOSE"+Math.random()+"\0",s="\0COMMA"+Math.random()+"\0",l="\0PERIOD"+Math.random()+"\0";function c(e){return parseInt(e,10)==e?parseInt(e,10):e.charCodeAt(0)}function u(e){return e.split(o).join("\\").split(i).join("{").split(a).join("}").split(s).join(",").split(l).join(".")}function p(e){if(!e)return[""];var t=[],n=r("{","}",e);if(!n)return e.split(",");var o=n.pre,i=n.body,a=n.post,s=o.split(",");s[s.length-1]+="{"+i+"}";var l=p(a);return a.length&&(s[s.length-1]+=l.shift(),s.push.apply(s,l)),t.push.apply(t,s),t}function d(e){return"{"+e+"}"}function f(e){return/^-?0\d/.test(e)}function h(e,t){return e<=t}function m(e,t){return e>=t}function g(e,t){var n=[],o=r("{","}",e);if(!o)return[e];var i=o.pre,s=o.post.length?g(o.post,!1):[""];if(/\$$/.test(o.pre))for(var l=0;l<s.length;l++){var u=i+"{"+o.body+"}"+s[l];n.push(u)}else{var y,v,b=/^-?\d+\.\.-?\d+(?:\.\.-?\d+)?$/.test(o.body),w=/^[a-zA-Z]\.\.[a-zA-Z](?:\.\.-?\d+)?$/.test(o.body),x=b||w,k=o.body.indexOf(",")>=0;if(!x&&!k)return o.post.match(/,.*\}/)?g(e=o.pre+"{"+o.body+a+o.post):[e];if(x)y=o.body.split(/\.\./);else if(1===(y=p(o.body)).length&&1===(y=g(y[0],!1).map(d)).length)return s.map((function(e){return o.pre+y[0]+e}));if(x){var _=c(y[0]),O=c(y[1]),S=Math.max(y[0].length,y[1].length),E=3==y.length?Math.abs(c(y[2])):1,P=h;O<_&&(E*=-1,P=m);var A=y.some(f);v=[];for(var $=_;P($,O);$+=E){var C;if(w)"\\"===(C=String.fromCharCode($))&&(C="");else if(C=String($),A){var R=S-C.length;if(R>0){var j=new Array(R+1).join("0");C=$<0?"-"+j+C.slice(1):j+C}}v.push(C)}}else{v=[];for(var T=0;T<y.length;T++)v.push.apply(v,g(y[T],!1))}for(T=0;T<v.length;T++)for(l=0;l<s.length;l++)u=i+v[T]+s[l],(!t||x||u)&&n.push(u)}return n}},5751:function(e){const t="object"==typeof process&&process&&!1;e.exports=t?{sep:"\\"}:{sep:"/"}},4099:function(e,t,n){const r=e.exports=(e,t,n={})=>(g(t),!(!n.nocomment&&"#"===t.charAt(0))&&new v(t,n).match(e));e.exports=r;const o=n(5751);r.sep=o.sep;const i=Symbol("globstar **");r.GLOBSTAR=i;const a=n(5019),s={"!":{open:"(?:(?!(?:",close:"))[^/]*?)"},"?":{open:"(?:",close:")?"},"+":{open:"(?:",close:")+"},"*":{open:"(?:",close:")*"},"@":{open:"(?:",close:")"}},l="[^/]",c="[^/]*?",u=e=>e.split("").reduce(((e,t)=>(e[t]=!0,e)),{}),p=u("().*{}+?[]^$\\!"),d=u("[.("),f=/\/+/;r.filter=(e,t={})=>(n,o,i)=>r(n,e,t);const h=(e,t={})=>{const n={};return Object.keys(e).forEach((t=>n[t]=e[t])),Object.keys(t).forEach((e=>n[e]=t[e])),n};r.defaults=e=>{if(!e||"object"!=typeof e||!Object.keys(e).length)return r;const t=r,n=(n,r,o)=>t(n,r,h(e,o));return(n.Minimatch=class extends t.Minimatch{constructor(t,n){super(t,h(e,n))}}).defaults=n=>t.defaults(h(e,n)).Minimatch,n.filter=(n,r)=>t.filter(n,h(e,r)),n.defaults=n=>t.defaults(h(e,n)),n.makeRe=(n,r)=>t.makeRe(n,h(e,r)),n.braceExpand=(n,r)=>t.braceExpand(n,h(e,r)),n.match=(n,r,o)=>t.match(n,r,h(e,o)),n},r.braceExpand=(e,t)=>m(e,t);const m=(e,t={})=>(g(e),t.nobrace||!/\{(?:(?!\{).)*\}/.test(e)?[e]:a(e)),g=e=>{if("string"!=typeof e)throw new TypeError("invalid pattern");if(e.length>65536)throw new TypeError("pattern is too long")},y=Symbol("subparse");r.makeRe=(e,t)=>new v(e,t||{}).makeRe(),r.match=(e,t,n={})=>{const r=new v(t,n);return e=e.filter((e=>r.match(e))),r.options.nonull&&!e.length&&e.push(t),e};class v{constructor(e,t){g(e),t||(t={}),this.options=t,this.set=[],this.pattern=e,this.regexp=null,this.negate=!1,this.comment=!1,this.empty=!1,this.partial=!!t.partial,this.make()}debug(){}make(){const e=this.pattern,t=this.options;if(!t.nocomment&&"#"===e.charAt(0))return void(this.comment=!0);if(!e)return void(this.empty=!0);this.parseNegate();let n=this.globSet=this.braceExpand();t.debug&&(this.debug=(...e)=>console.error(...e)),this.debug(this.pattern,n),n=this.globParts=n.map((e=>e.split(f))),this.debug(this.pattern,n),n=n.map(((e,t,n)=>e.map(this.parse,this))),this.debug(this.pattern,n),n=n.filter((e=>-1===e.indexOf(!1))),this.debug(this.pattern,n),this.set=n}parseNegate(){if(this.options.nonegate)return;const e=this.pattern;let t=!1,n=0;for(let r=0;r<e.length&&"!"===e.charAt(r);r++)t=!t,n++;n&&(this.pattern=e.substr(n)),this.negate=t}matchOne(e,t,n){var r=this.options;this.debug("matchOne",{this:this,file:e,pattern:t}),this.debug("matchOne",e.length,t.length);for(var o=0,a=0,s=e.length,l=t.length;o<s&&a<l;o++,a++){this.debug("matchOne loop");var c,u=t[a],p=e[o];if(this.debug(t,u,p),!1===u)return!1;if(u===i){this.debug("GLOBSTAR",[t,u,p]);var d=o,f=a+1;if(f===l){for(this.debug("** at the end");o<s;o++)if("."===e[o]||".."===e[o]||!r.dot&&"."===e[o].charAt(0))return!1;return!0}for(;d<s;){var h=e[d];if(this.debug("\nglobstar while",e,d,t,f,h),this.matchOne(e.slice(d),t.slice(f),n))return this.debug("globstar found match!",d,s,h),!0;if("."===h||".."===h||!r.dot&&"."===h.charAt(0)){this.debug("dot detected!",e,d,t,f);break}this.debug("globstar swallow a segment, and continue"),d++}return!(!n||(this.debug("\n>>> no match, partial?",e,d,t,f),d!==s))}if("string"==typeof u?(c=p===u,this.debug("string match",u,p,c)):(c=p.match(u),this.debug("pattern match",u,p,c)),!c)return!1}if(o===s&&a===l)return!0;if(o===s)return n;if(a===l)return o===s-1&&""===e[o];throw new Error("wtf?")}braceExpand(){return m(this.pattern,this.options)}parse(e,t){g(e);const n=this.options;if("**"===e){if(!n.noglobstar)return i;e="*"}if(""===e)return"";let r="",o=!!n.nocase,a=!1;const u=[],f=[];let h,m,v,b,w=!1,x=-1,k=-1;const _="."===e.charAt(0)?"":n.dot?"(?!(?:^|\\/)\\.{1,2}(?:$|\\/))":"(?!\\.)",O=()=>{if(h){switch(h){case"*":r+=c,o=!0;break;case"?":r+=l,o=!0;break;default:r+="\\"+h}this.debug("clearStateChar %j %j",h,r),h=!1}};for(let t,i=0;i<e.length&&(t=e.charAt(i));i++)if(this.debug("%s\t%s %s %j",e,i,r,t),a){if("/"===t)return!1;p[t]&&(r+="\\"),r+=t,a=!1}else switch(t){case"/":return!1;case"\\":O(),a=!0;continue;case"?":case"*":case"+":case"@":case"!":if(this.debug("%s\t%s %s %j <-- stateChar",e,i,r,t),w){this.debug(" in class"),"!"===t&&i===k+1&&(t="^"),r+=t;continue}this.debug("call clearStateChar %j",h),O(),h=t,n.noext&&O();continue;case"(":if(w){r+="(";continue}if(!h){r+="\\(";continue}u.push({type:h,start:i-1,reStart:r.length,open:s[h].open,close:s[h].close}),r+="!"===h?"(?:(?!(?:":"(?:",this.debug("plType %j %j",h,r),h=!1;continue;case")":if(w||!u.length){r+="\\)";continue}O(),o=!0,v=u.pop(),r+=v.close,"!"===v.type&&f.push(v),v.reEnd=r.length;continue;case"|":if(w||!u.length){r+="\\|";continue}O(),r+="|";continue;case"[":if(O(),w){r+="\\"+t;continue}w=!0,k=i,x=r.length,r+=t;continue;case"]":if(i===k+1||!w){r+="\\"+t;continue}m=e.substring(k+1,i);try{RegExp("["+m+"]")}catch(e){b=this.parse(m,y),r=r.substr(0,x)+"\\["+b[0]+"\\]",o=o||b[1],w=!1;continue}o=!0,w=!1,r+=t;continue;default:O(),!p[t]||"^"===t&&w||(r+="\\"),r+=t}for(w&&(m=e.substr(k+1),b=this.parse(m,y),r=r.substr(0,x)+"\\["+b[0],o=o||b[1]),v=u.pop();v;v=u.pop()){let e;e=r.slice(v.reStart+v.open.length),this.debug("setting tail",r,v),e=e.replace(/((?:\\{2}){0,64})(\\?)\|/g,((e,t,n)=>(n||(n="\\"),t+t+n+"|"))),this.debug("tail=%j\n %s",e,e,v,r);const t="*"===v.type?c:"?"===v.type?l:"\\"+v.type;o=!0,r=r.slice(0,v.reStart)+t+"\\("+e}O(),a&&(r+="\\\\");const S=d[r.charAt(0)];for(let e=f.length-1;e>-1;e--){const n=f[e],o=r.slice(0,n.reStart),i=r.slice(n.reStart,n.reEnd-8);let a=r.slice(n.reEnd);const s=r.slice(n.reEnd-8,n.reEnd)+a,l=o.split("(").length-1;let c=a;for(let e=0;e<l;e++)c=c.replace(/\)[+*?]?/,"");a=c,r=o+i+a+(""===a&&t!==y?"$":"")+s}if(""!==r&&o&&(r="(?=.)"+r),S&&(r=_+r),t===y)return[r,o];if(!o)return e.replace(/\\(.)/g,"$1");const E=n.nocase?"i":"";try{return Object.assign(new RegExp("^"+r+"$",E),{_glob:e,_src:r})}catch(e){return new RegExp("$.")}}makeRe(){if(this.regexp||!1===this.regexp)return this.regexp;const e=this.set;if(!e.length)return this.regexp=!1,this.regexp;const t=this.options,n=t.noglobstar?c:t.dot?"(?:(?!(?:\\/|^)(?:\\.{1,2})($|\\/)).)*?":"(?:(?!(?:\\/|^)\\.).)*?",r=t.nocase?"i":"";let o=e.map((e=>(e=e.map((e=>"string"==typeof e?e.replace(/[-[\]{}()*+?.,\\^$|#\s]/g,"\\$&"):e===i?i:e._src)).reduce(((e,t)=>(e[e.length-1]===i&&t===i||e.push(t),e)),[]),e.forEach(((t,r)=>{t===i&&e[r-1]!==i&&(0===r?e.length>1?e[r+1]="(?:\\/|"+n+"\\/)?"+e[r+1]:e[r]=n:r===e.length-1?e[r-1]+="(?:\\/|"+n+")?":(e[r-1]+="(?:\\/|\\/"+n+"\\/)"+e[r+1],e[r+1]=i))})),e.filter((e=>e!==i)).join("/")))).join("|");o="^(?:"+o+")$",this.negate&&(o="^(?!"+o+").*$");try{this.regexp=new RegExp(o,r)}catch(e){this.regexp=!1}return this.regexp}match(e,t=this.partial){if(this.debug("match",e,this.pattern),this.comment)return!1;if(this.empty)return""===e;if("/"===e&&t)return!0;const n=this.options;"/"!==o.sep&&(e=e.split(o.sep).join("/")),e=e.split(f),this.debug(this.pattern,"split",e);const r=this.set;let i;this.debug(this.pattern,"set",r);for(let t=e.length-1;t>=0&&(i=e[t],!i);t--);for(let o=0;o<r.length;o++){const a=r[o];let s=e;if(n.matchBase&&1===a.length&&(s=[i]),this.matchOne(s,a,t))return!!n.flipNegate||!this.negate}return!n.flipNegate&&this.negate}static defaults(e){return r.defaults(e).Minimatch}}r.Minimatch=v},5623:function(e){"use strict";function t(e,t,o){e instanceof RegExp&&(e=n(e,o)),t instanceof RegExp&&(t=n(t,o));var i=r(e,t,o);return i&&{start:i[0],end:i[1],pre:o.slice(0,i[0]),body:o.slice(i[0]+e.length,i[1]),post:o.slice(i[1]+t.length)}}function n(e,t){var n=t.match(e);return n?n[0]:null}function r(e,t,n){var r,o,i,a,s,l=n.indexOf(e),c=n.indexOf(t,l+1),u=l;if(l>=0&&c>0){if(e===t)return[l,c];for(r=[],i=n.length;u>=0&&!s;)u==l?(r.push(u),l=n.indexOf(e,u+1)):1==r.length?s=[r.pop(),c]:((o=r.pop())<i&&(i=o,a=c),c=n.indexOf(t,u+1)),u=l<c&&l>=0?l:c;r.length&&(s=[i,a])}return s}e.exports=t,t.range=r},4480:function(e,t,n){"use strict";var r=n.g.process&&process.nextTick||n.g.setImmediate||function(e){setTimeout(e,0)};e.exports=function(e,t){return e?void t.then((function(t){r((function(){e(null,t)}))}),(function(t){r((function(){e(t)}))})):t}},4184:function(e,t){var n;!function(){"use strict";var r={}.hasOwnProperty;function o(){for(var e=[],t=0;t<arguments.length;t++){var n=arguments[t];if(n){var i=typeof n;if("string"===i||"number"===i)e.push(n);else if(Array.isArray(n)){if(n.length){var a=o.apply(null,n);a&&e.push(a)}}else if("object"===i)if(n.toString===Object.prototype.toString)for(var s in n)r.call(n,s)&&n[s]&&e.push(s);else e.push(n.toString())}}return e.join(" ")}e.exports?(o.default=o,e.exports=o):void 0===(n=function(){return o}.apply(t,[]))||(e.exports=n)}()},9266:function(e,t,n){n(2222),n(1539),n(2526),n(2443),n(1817),n(2401),n(8722),n(2165),n(9007),n(6066),n(3510),n(1840),n(6982),n(2159),n(6649),n(9341),n(543),n(3706),n(408),n(1299);var r=n(857);e.exports=r.Symbol},3099:function(e){e.exports=function(e){if("function"!=typeof e)throw TypeError(String(e)+" is not a function");return e}},9670:function(e,t,n){var r=n(111);e.exports=function(e){if(!r(e))throw TypeError(String(e)+" is not an object");return e}},1318:function(e,t,n){var r=n(5656),o=n(7466),i=n(1400),a=function(e){return function(t,n,a){var s,l=r(t),c=o(l.length),u=i(a,c);if(e&&n!=n){for(;c>u;)if((s=l[u++])!=s)return!0}else for(;c>u;u++)if((e||u in l)&&l[u]===n)return e||u||0;return!e&&-1}};e.exports={includes:a(!0),indexOf:a(!1)}},2092:function(e,t,n){var r=n(9974),o=n(8361),i=n(7908),a=n(7466),s=n(5417),l=[].push,c=function(e){var t=1==e,n=2==e,c=3==e,u=4==e,p=6==e,d=7==e,f=5==e||p;return function(h,m,g,y){for(var v,b,w=i(h),x=o(w),k=r(m,g,3),_=a(x.length),O=0,S=y||s,E=t?S(h,_):n||d?S(h,0):void 0;_>O;O++)if((f||O in x)&&(b=k(v=x[O],O,w),e))if(t)E[O]=b;else if(b)switch(e){case 3:return!0;case 5:return v;case 6:return O;case 2:l.call(E,v)}else switch(e){case 4:return!1;case 7:l.call(E,v)}return p?-1:c||u?u:E}};e.exports={forEach:c(0),map:c(1),filter:c(2),some:c(3),every:c(4),find:c(5),findIndex:c(6),filterOut:c(7)}},1194:function(e,t,n){var r=n(7293),o=n(5112),i=n(7392),a=o("species");e.exports=function(e){return i>=51||!r((function(){var t=[];return(t.constructor={})[a]=function(){return{foo:1}},1!==t[e](Boolean).foo}))}},5417:function(e,t,n){var r=n(111),o=n(3157),i=n(5112)("species");e.exports=function(e,t){var n;return o(e)&&("function"!=typeof(n=e.constructor)||n!==Array&&!o(n.prototype)?r(n)&&null===(n=n[i])&&(n=void 0):n=void 0),new(void 0===n?Array:n)(0===t?0:t)}},4326:function(e){var t={}.toString;e.exports=function(e){return t.call(e).slice(8,-1)}},648:function(e,t,n){var r=n(1694),o=n(4326),i=n(5112)("toStringTag"),a="Arguments"==o(function(){return arguments}());e.exports=r?o:function(e){var t,n,r;return void 0===e?"Undefined":null===e?"Null":"string"==typeof(n=function(e,t){try{return e[t]}catch(e){}}(t=Object(e),i))?n:a?o(t):"Object"==(r=o(t))&&"function"==typeof t.callee?"Arguments":r}},9920:function(e,t,n){var r=n(6656),o=n(3887),i=n(1236),a=n(3070);e.exports=function(e,t){for(var n=o(t),s=a.f,l=i.f,c=0;c<n.length;c++){var u=n[c];r(e,u)||s(e,u,l(t,u))}}},8880:function(e,t,n){var r=n(9781),o=n(3070),i=n(9114);e.exports=r?function(e,t,n){return o.f(e,t,i(1,n))}:function(e,t,n){return e[t]=n,e}},9114:function(e){e.exports=function(e,t){return{enumerable:!(1&e),configurable:!(2&e),writable:!(4&e),value:t}}},6135:function(e,t,n){"use strict";var r=n(7593),o=n(3070),i=n(9114);e.exports=function(e,t,n){var a=r(t);a in e?o.f(e,a,i(0,n)):e[a]=n}},7235:function(e,t,n){var r=n(857),o=n(6656),i=n(6061),a=n(3070).f;e.exports=function(e){var t=r.Symbol||(r.Symbol={});o(t,e)||a(t,e,{value:i.f(e)})}},9781:function(e,t,n){var r=n(7293);e.exports=!r((function(){return 7!=Object.defineProperty({},1,{get:function(){return 7}})[1]}))},317:function(e,t,n){var r=n(7854),o=n(111),i=r.document,a=o(i)&&o(i.createElement);e.exports=function(e){return a?i.createElement(e):{}}},8113:function(e,t,n){var r=n(5005);e.exports=r("navigator","userAgent")||""},7392:function(e,t,n){var r,o,i=n(7854),a=n(8113),s=i.process,l=s&&s.versions,c=l&&l.v8;c?o=(r=c.split("."))[0]<4?1:r[0]+r[1]:a&&(!(r=a.match(/Edge\/(\d+)/))||r[1]>=74)&&(r=a.match(/Chrome\/(\d+)/))&&(o=r[1]),e.exports=o&&+o},748:function(e){e.exports=["constructor","hasOwnProperty","isPrototypeOf","propertyIsEnumerable","toLocaleString","toString","valueOf"]},2109:function(e,t,n){var r=n(7854),o=n(1236).f,i=n(8880),a=n(1320),s=n(3505),l=n(9920),c=n(4705);e.exports=function(e,t){var n,u,p,d,f,h=e.target,m=e.global,g=e.stat;if(n=m?r:g?r[h]||s(h,{}):(r[h]||{}).prototype)for(u in t){if(d=t[u],p=e.noTargetGet?(f=o(n,u))&&f.value:n[u],!c(m?u:h+(g?".":"#")+u,e.forced)&&void 0!==p){if(typeof d==typeof p)continue;l(d,p)}(e.sham||p&&p.sham)&&i(d,"sham",!0),a(n,u,d,e)}}},7293:function(e){e.exports=function(e){try{return!!e()}catch(e){return!0}}},9974:function(e,t,n){var r=n(3099);e.exports=function(e,t,n){if(r(e),void 0===t)return e;switch(n){case 0:return function(){return e.call(t)};case 1:return function(n){return e.call(t,n)};case 2:return function(n,r){return e.call(t,n,r)};case 3:return function(n,r,o){return e.call(t,n,r,o)}}return function(){return e.apply(t,arguments)}}},5005:function(e,t,n){var r=n(857),o=n(7854),i=function(e){return"function"==typeof e?e:void 0};e.exports=function(e,t){return arguments.length<2?i(r[e])||i(o[e]):r[e]&&r[e][t]||o[e]&&o[e][t]}},7854:function(e,t,n){var r=function(e){return e&&e.Math==Math&&e};e.exports=r("object"==typeof globalThis&&globalThis)||r("object"==typeof window&&window)||r("object"==typeof self&&self)||r("object"==typeof n.g&&n.g)||function(){return this}()||Function("return this")()},6656:function(e,t,n){var r=n(7908),o={}.hasOwnProperty;e.exports=Object.hasOwn||function(e,t){return o.call(r(e),t)}},3501:function(e){e.exports={}},490:function(e,t,n){var r=n(5005);e.exports=r("document","documentElement")},4664:function(e,t,n){var r=n(9781),o=n(7293),i=n(317);e.exports=!r&&!o((function(){return 7!=Object.defineProperty(i("div"),"a",{get:function(){return 7}}).a}))},8361:function(e,t,n){var r=n(7293),o=n(4326),i="".split;e.exports=r((function(){return!Object("z").propertyIsEnumerable(0)}))?function(e){return"String"==o(e)?i.call(e,""):Object(e)}:Object},2788:function(e,t,n){var r=n(5465),o=Function.toString;"function"!=typeof r.inspectSource&&(r.inspectSource=function(e){return o.call(e)}),e.exports=r.inspectSource},9909:function(e,t,n){var r,o,i,a=n(8536),s=n(7854),l=n(111),c=n(8880),u=n(6656),p=n(5465),d=n(6200),f=n(3501),h="Object already initialized",m=s.WeakMap;if(a||p.state){var g=p.state||(p.state=new m),y=g.get,v=g.has,b=g.set;r=function(e,t){if(v.call(g,e))throw new TypeError(h);return t.facade=e,b.call(g,e,t),t},o=function(e){return y.call(g,e)||{}},i=function(e){return v.call(g,e)}}else{var w=d("state");f[w]=!0,r=function(e,t){if(u(e,w))throw new TypeError(h);return t.facade=e,c(e,w,t),t},o=function(e){return u(e,w)?e[w]:{}},i=function(e){return u(e,w)}}e.exports={set:r,get:o,has:i,enforce:function(e){return i(e)?o(e):r(e,{})},getterFor:function(e){return function(t){var n;if(!l(t)||(n=o(t)).type!==e)throw TypeError("Incompatible receiver, "+e+" required");return n}}}},3157:function(e,t,n){var r=n(4326);e.exports=Array.isArray||function(e){return"Array"==r(e)}},4705:function(e,t,n){var r=n(7293),o=/#|\.prototype\./,i=function(e,t){var n=s[a(e)];return n==c||n!=l&&("function"==typeof t?r(t):!!t)},a=i.normalize=function(e){return String(e).replace(o,".").toLowerCase()},s=i.data={},l=i.NATIVE="N",c=i.POLYFILL="P";e.exports=i},111:function(e){e.exports=function(e){return"object"==typeof e?null!==e:"function"==typeof e}},1913:function(e){e.exports=!1},133:function(e,t,n){var r=n(7392),o=n(7293);e.exports=!!Object.getOwnPropertySymbols&&!o((function(){var e=Symbol();return!String(e)||!(Object(e)instanceof Symbol)||!Symbol.sham&&r&&r<41}))},8536:function(e,t,n){var r=n(7854),o=n(2788),i=r.WeakMap;e.exports="function"==typeof i&&/native code/.test(o(i))},30:function(e,t,n){var r,o=n(9670),i=n(6048),a=n(748),s=n(3501),l=n(490),c=n(317),u=n(6200)("IE_PROTO"),p=function(){},d=function(e){return"<script>"+e+"<\/script>"},f=function(){try{r=document.domain&&new ActiveXObject("htmlfile")}catch(e){}var e,t;f=r?function(e){e.write(d("")),e.close();var t=e.parentWindow.Object;return e=null,t}(r):((t=c("iframe")).style.display="none",l.appendChild(t),t.src=String("javascript:"),(e=t.contentWindow.document).open(),e.write(d("document.F=Object")),e.close(),e.F);for(var n=a.length;n--;)delete f.prototype[a[n]];return f()};s[u]=!0,e.exports=Object.create||function(e,t){var n;return null!==e?(p.prototype=o(e),n=new p,p.prototype=null,n[u]=e):n=f(),void 0===t?n:i(n,t)}},6048:function(e,t,n){var r=n(9781),o=n(3070),i=n(9670),a=n(1956);e.exports=r?Object.defineProperties:function(e,t){i(e);for(var n,r=a(t),s=r.length,l=0;s>l;)o.f(e,n=r[l++],t[n]);return e}},3070:function(e,t,n){var r=n(9781),o=n(4664),i=n(9670),a=n(7593),s=Object.defineProperty;t.f=r?s:function(e,t,n){if(i(e),t=a(t,!0),i(n),o)try{return s(e,t,n)}catch(e){}if("get"in n||"set"in n)throw TypeError("Accessors not supported");return"value"in n&&(e[t]=n.value),e}},1236:function(e,t,n){var r=n(9781),o=n(5296),i=n(9114),a=n(5656),s=n(7593),l=n(6656),c=n(4664),u=Object.getOwnPropertyDescriptor;t.f=r?u:function(e,t){if(e=a(e),t=s(t,!0),c)try{return u(e,t)}catch(e){}if(l(e,t))return i(!o.f.call(e,t),e[t])}},1156:function(e,t,n){var r=n(5656),o=n(8006).f,i={}.toString,a="object"==typeof window&&window&&Object.getOwnPropertyNames?Object.getOwnPropertyNames(window):[];e.exports.f=function(e){return a&&"[object Window]"==i.call(e)?function(e){try{return o(e)}catch(e){return a.slice()}}(e):o(r(e))}},8006:function(e,t,n){var r=n(6324),o=n(748).concat("length","prototype");t.f=Object.getOwnPropertyNames||function(e){return r(e,o)}},5181:function(e,t){t.f=Object.getOwnPropertySymbols},6324:function(e,t,n){var r=n(6656),o=n(5656),i=n(1318).indexOf,a=n(3501);e.exports=function(e,t){var n,s=o(e),l=0,c=[];for(n in s)!r(a,n)&&r(s,n)&&c.push(n);for(;t.length>l;)r(s,n=t[l++])&&(~i(c,n)||c.push(n));return c}},1956:function(e,t,n){var r=n(6324),o=n(748);e.exports=Object.keys||function(e){return r(e,o)}},5296:function(e,t){"use strict";var n={}.propertyIsEnumerable,r=Object.getOwnPropertyDescriptor,o=r&&!n.call({1:2},1);t.f=o?function(e){var t=r(this,e);return!!t&&t.enumerable}:n},288:function(e,t,n){"use strict";var r=n(1694),o=n(648);e.exports=r?{}.toString:function(){return"[object "+o(this)+"]"}},3887:function(e,t,n){var r=n(5005),o=n(8006),i=n(5181),a=n(9670);e.exports=r("Reflect","ownKeys")||function(e){var t=o.f(a(e)),n=i.f;return n?t.concat(n(e)):t}},857:function(e,t,n){var r=n(7854);e.exports=r},1320:function(e,t,n){var r=n(7854),o=n(8880),i=n(6656),a=n(3505),s=n(2788),l=n(9909),c=l.get,u=l.enforce,p=String(String).split("String");(e.exports=function(e,t,n,s){var l,c=!!s&&!!s.unsafe,d=!!s&&!!s.enumerable,f=!!s&&!!s.noTargetGet;"function"==typeof n&&("string"!=typeof t||i(n,"name")||o(n,"name",t),(l=u(n)).source||(l.source=p.join("string"==typeof t?t:""))),e!==r?(c?!f&&e[t]&&(d=!0):delete e[t],d?e[t]=n:o(e,t,n)):d?e[t]=n:a(t,n)})(Function.prototype,"toString",(function(){return"function"==typeof this&&c(this).source||s(this)}))},4488:function(e){e.exports=function(e){if(null==e)throw TypeError("Can't call method on "+e);return e}},3505:function(e,t,n){var r=n(7854),o=n(8880);e.exports=function(e,t){try{o(r,e,t)}catch(n){r[e]=t}return t}},8003:function(e,t,n){var r=n(3070).f,o=n(6656),i=n(5112)("toStringTag");e.exports=function(e,t,n){e&&!o(e=n?e:e.prototype,i)&&r(e,i,{configurable:!0,value:t})}},6200:function(e,t,n){var r=n(2309),o=n(9711),i=r("keys");e.exports=function(e){return i[e]||(i[e]=o(e))}},5465:function(e,t,n){var r=n(7854),o=n(3505),i="__core-js_shared__",a=r[i]||o(i,{});e.exports=a},2309:function(e,t,n){var r=n(1913),o=n(5465);(e.exports=function(e,t){return o[e]||(o[e]=void 0!==t?t:{})})("versions",[]).push({version:"3.14.0",mode:r?"pure":"global",copyright:"© 2021 Denis Pushkarev (zloirock.ru)"})},1400:function(e,t,n){var r=n(9958),o=Math.max,i=Math.min;e.exports=function(e,t){var n=r(e);return n<0?o(n+t,0):i(n,t)}},5656:function(e,t,n){var r=n(8361),o=n(4488);e.exports=function(e){return r(o(e))}},9958:function(e){var t=Math.ceil,n=Math.floor;e.exports=function(e){return isNaN(e=+e)?0:(e>0?n:t)(e)}},7466:function(e,t,n){var r=n(9958),o=Math.min;e.exports=function(e){return e>0?o(r(e),9007199254740991):0}},7908:function(e,t,n){var r=n(4488);e.exports=function(e){return Object(r(e))}},7593:function(e,t,n){var r=n(111);e.exports=function(e,t){if(!r(e))return e;var n,o;if(t&&"function"==typeof(n=e.toString)&&!r(o=n.call(e)))return o;if("function"==typeof(n=e.valueOf)&&!r(o=n.call(e)))return o;if(!t&&"function"==typeof(n=e.toString)&&!r(o=n.call(e)))return o;throw TypeError("Can't convert object to primitive value")}},1694:function(e,t,n){var r={};r[n(5112)("toStringTag")]="z",e.exports="[object z]"===String(r)},9711:function(e){var t=0,n=Math.random();e.exports=function(e){return"Symbol("+String(void 0===e?"":e)+")_"+(++t+n).toString(36)}},3307:function(e,t,n){var r=n(133);e.exports=r&&!Symbol.sham&&"symbol"==typeof Symbol.iterator},6061:function(e,t,n){var r=n(5112);t.f=r},5112:function(e,t,n){var r=n(7854),o=n(2309),i=n(6656),a=n(9711),s=n(133),l=n(3307),c=o("wks"),u=r.Symbol,p=l?u:u&&u.withoutSetter||a;e.exports=function(e){return i(c,e)&&(s||"string"==typeof c[e])||(s&&i(u,e)?c[e]=u[e]:c[e]=p("Symbol."+e)),c[e]}},2222:function(e,t,n){"use strict";var r=n(2109),o=n(7293),i=n(3157),a=n(111),s=n(7908),l=n(7466),c=n(6135),u=n(5417),p=n(1194),d=n(5112),f=n(7392),h=d("isConcatSpreadable"),m=9007199254740991,g="Maximum allowed index exceeded",y=f>=51||!o((function(){var e=[];return e[h]=!1,e.concat()[0]!==e})),v=p("concat"),b=function(e){if(!a(e))return!1;var t=e[h];return void 0!==t?!!t:i(e)};r({target:"Array",proto:!0,forced:!y||!v},{concat:function(e){var t,n,r,o,i,a=s(this),p=u(a,0),d=0;for(t=-1,r=arguments.length;t<r;t++)if(b(i=-1===t?a:arguments[t])){if(d+(o=l(i.length))>m)throw TypeError(g);for(n=0;n<o;n++,d++)n in i&&c(p,d,i[n])}else{if(d>=m)throw TypeError(g);c(p,d++,i)}return p.length=d,p}})},3706:function(e,t,n){var r=n(7854);n(8003)(r.JSON,"JSON",!0)},408:function(e,t,n){n(8003)(Math,"Math",!0)},1539:function(e,t,n){var r=n(1694),o=n(1320),i=n(288);r||o(Object.prototype,"toString",i,{unsafe:!0})},1299:function(e,t,n){var r=n(2109),o=n(7854),i=n(8003);r({global:!0},{Reflect:{}}),i(o.Reflect,"Reflect",!0)},2443:function(e,t,n){n(7235)("asyncIterator")},1817:function(e,t,n){"use strict";var r=n(2109),o=n(9781),i=n(7854),a=n(6656),s=n(111),l=n(3070).f,c=n(9920),u=i.Symbol;if(o&&"function"==typeof u&&(!("description"in u.prototype)||void 0!==u().description)){var p={},d=function(){var e=arguments.length<1||void 0===arguments[0]?void 0:String(arguments[0]),t=this instanceof d?new u(e):void 0===e?u():u(e);return""===e&&(p[t]=!0),t};c(d,u);var f=d.prototype=u.prototype;f.constructor=d;var h=f.toString,m="Symbol(test)"==String(u("test")),g=/^Symbol\((.*)\)[^)]+$/;l(f,"description",{configurable:!0,get:function(){var e=s(this)?this.valueOf():this,t=h.call(e);if(a(p,e))return"";var n=m?t.slice(7,-1):t.replace(g,"$1");return""===n?void 0:n}}),r({global:!0,forced:!0},{Symbol:d})}},2401:function(e,t,n){n(7235)("hasInstance")},8722:function(e,t,n){n(7235)("isConcatSpreadable")},2165:function(e,t,n){n(7235)("iterator")},2526:function(e,t,n){"use strict";var r=n(2109),o=n(7854),i=n(5005),a=n(1913),s=n(9781),l=n(133),c=n(3307),u=n(7293),p=n(6656),d=n(3157),f=n(111),h=n(9670),m=n(7908),g=n(5656),y=n(7593),v=n(9114),b=n(30),w=n(1956),x=n(8006),k=n(1156),_=n(5181),O=n(1236),S=n(3070),E=n(5296),P=n(8880),A=n(1320),$=n(2309),C=n(6200),R=n(3501),j=n(9711),T=n(5112),I=n(6061),N=n(7235),D=n(8003),L=n(9909),M=n(2092).forEach,F=C("hidden"),z="Symbol",U=T("toPrimitive"),V=L.set,B=L.getterFor(z),q=Object.prototype,W=o.Symbol,H=i("JSON","stringify"),Y=O.f,K=S.f,G=k.f,Q=E.f,X=$("symbols"),J=$("op-symbols"),Z=$("string-to-symbol-registry"),ee=$("symbol-to-string-registry"),te=$("wks"),ne=o.QObject,re=!ne||!ne.prototype||!ne.prototype.findChild,oe=s&&u((function(){return 7!=b(K({},"a",{get:function(){return K(this,"a",{value:7}).a}})).a}))?function(e,t,n){var r=Y(q,t);r&&delete q[t],K(e,t,n),r&&e!==q&&K(q,t,r)}:K,ie=function(e,t){var n=X[e]=b(W.prototype);return V(n,{type:z,tag:e,description:t}),s||(n.description=t),n},ae=c?function(e){return"symbol"==typeof e}:function(e){return Object(e)instanceof W},se=function(e,t,n){e===q&&se(J,t,n),h(e);var r=y(t,!0);return h(n),p(X,r)?(n.enumerable?(p(e,F)&&e[F][r]&&(e[F][r]=!1),n=b(n,{enumerable:v(0,!1)})):(p(e,F)||K(e,F,v(1,{})),e[F][r]=!0),oe(e,r,n)):K(e,r,n)},le=function(e,t){h(e);var n=g(t),r=w(n).concat(de(n));return M(r,(function(t){s&&!ce.call(n,t)||se(e,t,n[t])})),e},ce=function(e){var t=y(e,!0),n=Q.call(this,t);return!(this===q&&p(X,t)&&!p(J,t))&&(!(n||!p(this,t)||!p(X,t)||p(this,F)&&this[F][t])||n)},ue=function(e,t){var n=g(e),r=y(t,!0);if(n!==q||!p(X,r)||p(J,r)){var o=Y(n,r);return!o||!p(X,r)||p(n,F)&&n[F][r]||(o.enumerable=!0),o}},pe=function(e){var t=G(g(e)),n=[];return M(t,(function(e){p(X,e)||p(R,e)||n.push(e)})),n},de=function(e){var t=e===q,n=G(t?J:g(e)),r=[];return M(n,(function(e){!p(X,e)||t&&!p(q,e)||r.push(X[e])})),r};l||(W=function(){if(this instanceof W)throw TypeError("Symbol is not a constructor");var e=arguments.length&&void 0!==arguments[0]?String(arguments[0]):void 0,t=j(e),n=function(e){this===q&&n.call(J,e),p(this,F)&&p(this[F],t)&&(this[F][t]=!1),oe(this,t,v(1,e))};return s&&re&&oe(q,t,{configurable:!0,set:n}),ie(t,e)},A(W.prototype,"toString",(function(){return B(this).tag})),A(W,"withoutSetter",(function(e){return ie(j(e),e)})),E.f=ce,S.f=se,O.f=ue,x.f=k.f=pe,_.f=de,I.f=function(e){return ie(T(e),e)},s&&(K(W.prototype,"description",{configurable:!0,get:function(){return B(this).description}}),a||A(q,"propertyIsEnumerable",ce,{unsafe:!0}))),r({global:!0,wrap:!0,forced:!l,sham:!l},{Symbol:W}),M(w(te),(function(e){N(e)})),r({target:z,stat:!0,forced:!l},{for:function(e){var t=String(e);if(p(Z,t))return Z[t];var n=W(t);return Z[t]=n,ee[n]=t,n},keyFor:function(e){if(!ae(e))throw TypeError(e+" is not a symbol");if(p(ee,e))return ee[e]},useSetter:function(){re=!0},useSimple:function(){re=!1}}),r({target:"Object",stat:!0,forced:!l,sham:!s},{create:function(e,t){return void 0===t?b(e):le(b(e),t)},defineProperty:se,defineProperties:le,getOwnPropertyDescriptor:ue}),r({target:"Object",stat:!0,forced:!l},{getOwnPropertyNames:pe,getOwnPropertySymbols:de}),r({target:"Object",stat:!0,forced:u((function(){_.f(1)}))},{getOwnPropertySymbols:function(e){return _.f(m(e))}}),H&&r({target:"JSON",stat:!0,forced:!l||u((function(){var e=W();return"[null]"!=H([e])||"{}"!=H({a:e})||"{}"!=H(Object(e))}))},{stringify:function(e,t,n){for(var r,o=[e],i=1;arguments.length>i;)o.push(arguments[i++]);if(r=t,(f(t)||void 0!==e)&&!ae(e))return d(t)||(t=function(e,t){if("function"==typeof r&&(t=r.call(this,e,t)),!ae(t))return t}),o[1]=t,H.apply(null,o)}}),W.prototype[U]||P(W.prototype,U,W.prototype.valueOf),D(W,z),R[F]=!0},6066:function(e,t,n){n(7235)("matchAll")},9007:function(e,t,n){n(7235)("match")},3510:function(e,t,n){n(7235)("replace")},1840:function(e,t,n){n(7235)("search")},6982:function(e,t,n){n(7235)("species")},2159:function(e,t,n){n(7235)("split")},6649:function(e,t,n){n(7235)("toPrimitive")},9341:function(e,t,n){n(7235)("toStringTag")},543:function(e,t,n){n(7235)("unscopables")},2295:function(e,t,n){"use strict";var r=n(5071),o=n.n(r),i=n(3645),a=n.n(i)()(o());a.push([e.id,".ps{overflow:hidden!important;overflow-anchor:none;-ms-overflow-style:none;touch-action:auto;-ms-touch-action:auto}.ps__rail-x{display:none;opacity:0;transition:background-color .2s linear,opacity .2s linear;-webkit-transition:background-color .2s linear,opacity .2s linear;height:15px;bottom:0;position:absolute}.ps__rail-y{display:none;opacity:0;transition:background-color .2s linear,opacity .2s linear;-webkit-transition:background-color .2s linear,opacity .2s linear;width:15px;right:0;position:absolute}.ps--active-x>.ps__rail-x,.ps--active-y>.ps__rail-y{display:block;background-color:transparent}.ps:hover>.ps__rail-x,.ps:hover>.ps__rail-y,.ps--focus>.ps__rail-x,.ps--focus>.ps__rail-y,.ps--scrolling-x>.ps__rail-x,.ps--scrolling-y>.ps__rail-y{opacity:.6}.ps .ps__rail-x:hover,.ps .ps__rail-y:hover,.ps .ps__rail-x:focus,.ps .ps__rail-y:focus,.ps .ps__rail-x.ps--clicking,.ps .ps__rail-y.ps--clicking{background-color:#eee;opacity:.9}.ps__thumb-x{background-color:#aaa;border-radius:6px;transition:background-color .2s linear,height .2s ease-in-out;-webkit-transition:background-color .2s linear,height .2s ease-in-out;height:6px;bottom:2px;position:absolute}.ps__thumb-y{background-color:#aaa;border-radius:6px;transition:background-color .2s linear,width .2s ease-in-out;-webkit-transition:background-color .2s linear,width .2s ease-in-out;width:6px;right:2px;position:absolute}.ps__rail-x:hover>.ps__thumb-x,.ps__rail-x:focus>.ps__thumb-x,.ps__rail-x.ps--clicking .ps__thumb-x{background-color:#999;height:11px}.ps__rail-y:hover>.ps__thumb-y,.ps__rail-y:focus>.ps__thumb-y,.ps__rail-y.ps--clicking .ps__thumb-y{background-color:#999;width:11px}@supports (-ms-overflow-style: none){.ps{overflow:auto!important}}@media screen and (-ms-high-contrast: active),(-ms-high-contrast: none){.ps{overflow:auto!important}}\n","",{version:3,sources:["webpack://./node_modules/perfect-scrollbar/css/perfect-scrollbar.css"],names:[],mappings:"AAGA,IACE,yBAAA,CACA,oBAAA,CACA,uBAAA,CACA,iBAAA,CACA,qBAAA,CAMF,YACE,YAAA,CACA,SAAA,CACA,yDAAA,CACA,iEAAA,CACA,WAAA,CAEA,QAAA,CAEA,iBAAA,CAGF,YACE,YAAA,CACA,SAAA,CACA,yDAAA,CACA,iEAAA,CACA,UAAA,CAEA,OAAA,CAEA,iBAAA,CAGF,oDAEE,aAAA,CACA,4BAAA,CAGF,oJAME,UAAA,CAGF,kJAME,qBAAA,CACA,UAAA,CAMF,aACE,qBAAA,CAnEF,iBAAA,CAqEE,6DAAA,CACA,qEAAA,CACA,UAAA,CAEA,UAAA,CAEA,iBAAA,CAGF,aACE,qBAAA,CA/EF,iBAAA,CAiFE,4DAAA,CACA,oEAAA,CACA,SAAA,CAEA,SAAA,CAEA,iBAAA,CAGF,oGAGE,qBAAA,CACA,WAAA,CAGF,oGAGE,qBAAA,CACA,UAAA,CAIF,qCACE,IACE,uBAAA,CAAA,CAIJ,wEACE,IACE,uBAAA,CAAA",sourcesContent:["/*\n * Container style\n */\n.ps {\n overflow: hidden !important;\n overflow-anchor: none;\n -ms-overflow-style: none;\n touch-action: auto;\n -ms-touch-action: auto;\n}\n\n/*\n * Scrollbar rail styles\n */\n.ps__rail-x {\n display: none;\n opacity: 0;\n transition: background-color .2s linear, opacity .2s linear;\n -webkit-transition: background-color .2s linear, opacity .2s linear;\n height: 15px;\n /* there must be 'bottom' or 'top' for ps__rail-x */\n bottom: 0px;\n /* please don't change 'position' */\n position: absolute;\n}\n\n.ps__rail-y {\n display: none;\n opacity: 0;\n transition: background-color .2s linear, opacity .2s linear;\n -webkit-transition: background-color .2s linear, opacity .2s linear;\n width: 15px;\n /* there must be 'right' or 'left' for ps__rail-y */\n right: 0;\n /* please don't change 'position' */\n position: absolute;\n}\n\n.ps--active-x > .ps__rail-x,\n.ps--active-y > .ps__rail-y {\n display: block;\n background-color: transparent;\n}\n\n.ps:hover > .ps__rail-x,\n.ps:hover > .ps__rail-y,\n.ps--focus > .ps__rail-x,\n.ps--focus > .ps__rail-y,\n.ps--scrolling-x > .ps__rail-x,\n.ps--scrolling-y > .ps__rail-y {\n opacity: 0.6;\n}\n\n.ps .ps__rail-x:hover,\n.ps .ps__rail-y:hover,\n.ps .ps__rail-x:focus,\n.ps .ps__rail-y:focus,\n.ps .ps__rail-x.ps--clicking,\n.ps .ps__rail-y.ps--clicking {\n background-color: #eee;\n opacity: 0.9;\n}\n\n/*\n * Scrollbar thumb styles\n */\n.ps__thumb-x {\n background-color: #aaa;\n border-radius: 6px;\n transition: background-color .2s linear, height .2s ease-in-out;\n -webkit-transition: background-color .2s linear, height .2s ease-in-out;\n height: 6px;\n /* there must be 'bottom' for ps__thumb-x */\n bottom: 2px;\n /* please don't change 'position' */\n position: absolute;\n}\n\n.ps__thumb-y {\n background-color: #aaa;\n border-radius: 6px;\n transition: background-color .2s linear, width .2s ease-in-out;\n -webkit-transition: background-color .2s linear, width .2s ease-in-out;\n width: 6px;\n /* there must be 'right' for ps__thumb-y */\n right: 2px;\n /* please don't change 'position' */\n position: absolute;\n}\n\n.ps__rail-x:hover > .ps__thumb-x,\n.ps__rail-x:focus > .ps__thumb-x,\n.ps__rail-x.ps--clicking .ps__thumb-x {\n background-color: #999;\n height: 11px;\n}\n\n.ps__rail-y:hover > .ps__thumb-y,\n.ps__rail-y:focus > .ps__thumb-y,\n.ps__rail-y.ps--clicking .ps__thumb-y {\n background-color: #999;\n width: 11px;\n}\n\n/* MS supports */\n@supports (-ms-overflow-style: none) {\n .ps {\n overflow: auto !important;\n }\n}\n\n@media screen and (-ms-high-contrast: active), (-ms-high-contrast: none) {\n .ps {\n overflow: auto !important;\n }\n}\n"],sourceRoot:""}]),t.Z=a},3645:function(e){"use strict";e.exports=function(e){var t=[];return t.toString=function(){return this.map((function(t){var n=e(t);return t[2]?"@media ".concat(t[2]," {").concat(n,"}"):n})).join("")},t.i=function(e,n,r){"string"==typeof e&&(e=[[null,e,""]]);var o={};if(r)for(var i=0;i<this.length;i++){var a=this[i][0];null!=a&&(o[a]=!0)}for(var s=0;s<e.length;s++){var l=[].concat(e[s]);r&&o[l[0]]||(n&&(l[2]?l[2]="".concat(n," and ").concat(l[2]):l[2]=n),t.push(l))}},t}},5071:function(e){"use strict";function t(e,t){(null==t||t>e.length)&&(t=e.length);for(var n=0,r=new Array(t);n<t;n++)r[n]=e[n];return r}e.exports=function(e){var n,r,o=(r=4,function(e){if(Array.isArray(e))return e}(n=e)||function(e,t){var n=e&&("undefined"!=typeof Symbol&&e[Symbol.iterator]||e["@@iterator"]);if(null!=n){var r,o,i=[],a=!0,s=!1;try{for(n=n.call(e);!(a=(r=n.next()).done)&&(i.push(r.value),!t||i.length!==t);a=!0);}catch(e){s=!0,o=e}finally{try{a||null==n.return||n.return()}finally{if(s)throw o}}return i}}(n,r)||function(e,n){if(e){if("string"==typeof e)return t(e,n);var r=Object.prototype.toString.call(e).slice(8,-1);return"Object"===r&&e.constructor&&(r=e.constructor.name),"Map"===r||"Set"===r?Array.from(e):"Arguments"===r||/^(?:Ui|I)nt(?:8|16|32)(?:Clamped)?Array$/.test(r)?t(e,n):void 0}}(n,r)||function(){throw new TypeError("Invalid attempt to destructure non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method.")}()),i=o[1],a=o[3];if("function"==typeof btoa){var s=btoa(unescape(encodeURIComponent(JSON.stringify(a)))),l="sourceMappingURL=data:application/json;charset=utf-8;base64,".concat(s),c="/*# ".concat(l," */"),u=a.sources.map((function(e){return"/*# sourceURL=".concat(a.sourceRoot||"").concat(e," */")}));return[i].concat(u).concat([c]).join("\n")}return[i].join("\n")}},1851:function(e,t){var n,r;n=function(e){"use strict";e.__esModule=!0;var t={},n=Object.prototype.hasOwnProperty,r=function(e){var r=arguments.length<=1||void 0===arguments[1]?t:arguments[1],o=r.cache||{};return function(){for(var t=arguments.length,i=Array(t),a=0;a<t;a++)i[a]=arguments[a];var s=String(i[0]);return!1===r.caseSensitive&&(s=s.toLowerCase()),n.call(o,s)?o[s]:o[s]=e.apply(this,i)}},o=function(e,t){if("function"==typeof t){var n=e;e=t,t=n}var r=t&&t.delay||t||0,o=void 0,i=void 0,a=void 0;return function(){for(var t=arguments.length,n=Array(t),s=0;s<t;s++)n[s]=arguments[s];o=n,i=this,a||(a=setTimeout((function(){e.apply(i,o),o=i=a=null}),r))}},i=function(e,t,n){var r=n.value;return{configurable:!0,get:function(){var e=r.bind(this);return Object.defineProperty(this,t,{value:e,configurable:!0,writable:!0}),e}}},a=c(r),s=c(o),l=c((function(e,t){return e.bind(t)}),(function(){return i}));function c(e,t){var n,r=(t=t||e.decorate||(n=e,function(e){return"function"==typeof e?n(e):function(t,r,o){o.value=n(o.value,e,t,r,o)}}))();return function(){for(var n=arguments.length,o=Array(n),i=0;i<n;i++)o[i]=arguments[i];var a=o.length;return(a<2?t:a>2?r:e).apply(void 0,o)}}e.memoize=a,e.debounce=s,e.bind=l,e.default={memoize:a,debounce:s,bind:l}},void 0===(r=n.apply(t,[t]))||(e.exports=r)},7856:function(e){e.exports=function(){"use strict";var e=Object.hasOwnProperty,t=Object.setPrototypeOf,n=Object.isFrozen,r=Object.getPrototypeOf,o=Object.getOwnPropertyDescriptor,i=Object.freeze,a=Object.seal,s=Object.create,l="undefined"!=typeof Reflect&&Reflect,c=l.apply,u=l.construct;c||(c=function(e,t,n){return e.apply(t,n)}),i||(i=function(e){return e}),a||(a=function(e){return e}),u||(u=function(e,t){return new(Function.prototype.bind.apply(e,[null].concat(function(e){if(Array.isArray(e)){for(var t=0,n=Array(e.length);t<e.length;t++)n[t]=e[t];return n}return Array.from(e)}(t))))});var p,d=k(Array.prototype.forEach),f=k(Array.prototype.pop),h=k(Array.prototype.push),m=k(String.prototype.toLowerCase),g=k(String.prototype.match),y=k(String.prototype.replace),v=k(String.prototype.indexOf),b=k(String.prototype.trim),w=k(RegExp.prototype.test),x=(p=TypeError,function(){for(var e=arguments.length,t=Array(e),n=0;n<e;n++)t[n]=arguments[n];return u(p,t)});function k(e){return function(t){for(var n=arguments.length,r=Array(n>1?n-1:0),o=1;o<n;o++)r[o-1]=arguments[o];return c(e,t,r)}}function _(e,r){t&&t(e,null);for(var o=r.length;o--;){var i=r[o];if("string"==typeof i){var a=m(i);a!==i&&(n(r)||(r[o]=a),i=a)}e[i]=!0}return e}function O(t){var n=s(null),r=void 0;for(r in t)c(e,t,[r])&&(n[r]=t[r]);return n}function S(e,t){for(;null!==e;){var n=o(e,t);if(n){if(n.get)return k(n.get);if("function"==typeof n.value)return k(n.value)}e=r(e)}return function(e){return console.warn("fallback value for",e),null}}var E=i(["a","abbr","acronym","address","area","article","aside","audio","b","bdi","bdo","big","blink","blockquote","body","br","button","canvas","caption","center","cite","code","col","colgroup","content","data","datalist","dd","decorator","del","details","dfn","dialog","dir","div","dl","dt","element","em","fieldset","figcaption","figure","font","footer","form","h1","h2","h3","h4","h5","h6","head","header","hgroup","hr","html","i","img","input","ins","kbd","label","legend","li","main","map","mark","marquee","menu","menuitem","meter","nav","nobr","ol","optgroup","option","output","p","picture","pre","progress","q","rp","rt","ruby","s","samp","section","select","shadow","small","source","spacer","span","strike","strong","style","sub","summary","sup","table","tbody","td","template","textarea","tfoot","th","thead","time","tr","track","tt","u","ul","var","video","wbr"]),P=i(["svg","a","altglyph","altglyphdef","altglyphitem","animatecolor","animatemotion","animatetransform","circle","clippath","defs","desc","ellipse","filter","font","g","glyph","glyphref","hkern","image","line","lineargradient","marker","mask","metadata","mpath","path","pattern","polygon","polyline","radialgradient","rect","stop","style","switch","symbol","text","textpath","title","tref","tspan","view","vkern"]),A=i(["feBlend","feColorMatrix","feComponentTransfer","feComposite","feConvolveMatrix","feDiffuseLighting","feDisplacementMap","feDistantLight","feFlood","feFuncA","feFuncB","feFuncG","feFuncR","feGaussianBlur","feMerge","feMergeNode","feMorphology","feOffset","fePointLight","feSpecularLighting","feSpotLight","feTile","feTurbulence"]),$=i(["animate","color-profile","cursor","discard","fedropshadow","feimage","font-face","font-face-format","font-face-name","font-face-src","font-face-uri","foreignobject","hatch","hatchpath","mesh","meshgradient","meshpatch","meshrow","missing-glyph","script","set","solidcolor","unknown","use"]),C=i(["math","menclose","merror","mfenced","mfrac","mglyph","mi","mlabeledtr","mmultiscripts","mn","mo","mover","mpadded","mphantom","mroot","mrow","ms","mspace","msqrt","mstyle","msub","msup","msubsup","mtable","mtd","mtext","mtr","munder","munderover"]),R=i(["maction","maligngroup","malignmark","mlongdiv","mscarries","mscarry","msgroup","mstack","msline","msrow","semantics","annotation","annotation-xml","mprescripts","none"]),j=i(["#text"]),T=i(["accept","action","align","alt","autocapitalize","autocomplete","autopictureinpicture","autoplay","background","bgcolor","border","capture","cellpadding","cellspacing","checked","cite","class","clear","color","cols","colspan","controls","controlslist","coords","crossorigin","datetime","decoding","default","dir","disabled","disablepictureinpicture","disableremoteplayback","download","draggable","enctype","enterkeyhint","face","for","headers","height","hidden","high","href","hreflang","id","inputmode","integrity","ismap","kind","label","lang","list","loading","loop","low","max","maxlength","media","method","min","minlength","multiple","muted","name","noshade","novalidate","nowrap","open","optimum","pattern","placeholder","playsinline","poster","preload","pubdate","radiogroup","readonly","rel","required","rev","reversed","role","rows","rowspan","spellcheck","scope","selected","shape","size","sizes","span","srclang","start","src","srcset","step","style","summary","tabindex","title","translate","type","usemap","valign","value","width","xmlns","slot"]),I=i(["accent-height","accumulate","additive","alignment-baseline","ascent","attributename","attributetype","azimuth","basefrequency","baseline-shift","begin","bias","by","class","clip","clippathunits","clip-path","clip-rule","color","color-interpolation","color-interpolation-filters","color-profile","color-rendering","cx","cy","d","dx","dy","diffuseconstant","direction","display","divisor","dur","edgemode","elevation","end","fill","fill-opacity","fill-rule","filter","filterunits","flood-color","flood-opacity","font-family","font-size","font-size-adjust","font-stretch","font-style","font-variant","font-weight","fx","fy","g1","g2","glyph-name","glyphref","gradientunits","gradienttransform","height","href","id","image-rendering","in","in2","k","k1","k2","k3","k4","kerning","keypoints","keysplines","keytimes","lang","lengthadjust","letter-spacing","kernelmatrix","kernelunitlength","lighting-color","local","marker-end","marker-mid","marker-start","markerheight","markerunits","markerwidth","maskcontentunits","maskunits","max","mask","media","method","mode","min","name","numoctaves","offset","operator","opacity","order","orient","orientation","origin","overflow","paint-order","path","pathlength","patterncontentunits","patterntransform","patternunits","points","preservealpha","preserveaspectratio","primitiveunits","r","rx","ry","radius","refx","refy","repeatcount","repeatdur","restart","result","rotate","scale","seed","shape-rendering","specularconstant","specularexponent","spreadmethod","startoffset","stddeviation","stitchtiles","stop-color","stop-opacity","stroke-dasharray","stroke-dashoffset","stroke-linecap","stroke-linejoin","stroke-miterlimit","stroke-opacity","stroke","stroke-width","style","surfacescale","systemlanguage","tabindex","targetx","targety","transform","text-anchor","text-decoration","text-rendering","textlength","type","u1","u2","unicode","values","viewbox","visibility","version","vert-adv-y","vert-origin-x","vert-origin-y","width","word-spacing","wrap","writing-mode","xchannelselector","ychannelselector","x","x1","x2","xmlns","y","y1","y2","z","zoomandpan"]),N=i(["accent","accentunder","align","bevelled","close","columnsalign","columnlines","columnspan","denomalign","depth","dir","display","displaystyle","encoding","fence","frame","height","href","id","largeop","length","linethickness","lspace","lquote","mathbackground","mathcolor","mathsize","mathvariant","maxsize","minsize","movablelimits","notation","numalign","open","rowalign","rowlines","rowspacing","rowspan","rspace","rquote","scriptlevel","scriptminsize","scriptsizemultiplier","selection","separator","separators","stretchy","subscriptshift","supscriptshift","symmetric","voffset","width","xmlns"]),D=i(["xlink:href","xml:id","xlink:title","xml:space","xmlns:xlink"]),L=a(/\{\{[\s\S]*|[\s\S]*\}\}/gm),M=a(/<%[\s\S]*|[\s\S]*%>/gm),F=a(/^data-[\-\w.\u00B7-\uFFFF]/),z=a(/^aria-[\-\w]+$/),U=a(/^(?:(?:(?:f|ht)tps?|mailto|tel|callto|cid|xmpp):|[^a-z]|[a-z+.\-]+(?:[^a-z+.\-:]|$))/i),V=a(/^(?:\w+script|data):/i),B=a(/[\u0000-\u0020\u00A0\u1680\u180E\u2000-\u2029\u205F\u3000]/g),q="function"==typeof Symbol&&"symbol"==typeof Symbol.iterator?function(e){return typeof e}:function(e){return e&&"function"==typeof Symbol&&e.constructor===Symbol&&e!==Symbol.prototype?"symbol":typeof e};function W(e){if(Array.isArray(e)){for(var t=0,n=Array(e.length);t<e.length;t++)n[t]=e[t];return n}return Array.from(e)}var H=function(){return"undefined"==typeof window?null:window},Y=function(e,t){if("object"!==(void 0===e?"undefined":q(e))||"function"!=typeof e.createPolicy)return null;var n=null,r="data-tt-policy-suffix";t.currentScript&&t.currentScript.hasAttribute(r)&&(n=t.currentScript.getAttribute(r));var o="dompurify"+(n?"#"+n:"");try{return e.createPolicy(o,{createHTML:function(e){return e}})}catch(e){return console.warn("TrustedTypes policy "+o+" could not be created."),null}};return function e(){var t=arguments.length>0&&void 0!==arguments[0]?arguments[0]:H(),n=function(t){return e(t)};if(n.version="2.2.9",n.removed=[],!t||!t.document||9!==t.document.nodeType)return n.isSupported=!1,n;var r=t.document,o=t.document,a=t.DocumentFragment,s=t.HTMLTemplateElement,l=t.Node,c=t.Element,u=t.NodeFilter,p=t.NamedNodeMap,k=void 0===p?t.NamedNodeMap||t.MozNamedAttrMap:p,K=t.Text,G=t.Comment,Q=t.DOMParser,X=t.trustedTypes,J=c.prototype,Z=S(J,"cloneNode"),ee=S(J,"nextSibling"),te=S(J,"childNodes"),ne=S(J,"parentNode");if("function"==typeof s){var re=o.createElement("template");re.content&&re.content.ownerDocument&&(o=re.content.ownerDocument)}var oe=Y(X,r),ie=oe&&De?oe.createHTML(""):"",ae=o,se=ae.implementation,le=ae.createNodeIterator,ce=ae.createDocumentFragment,ue=r.importNode,pe={};try{pe=O(o).documentMode?o.documentMode:{}}catch(e){}var de={};n.isSupported="function"==typeof ne&&se&&void 0!==se.createHTMLDocument&&9!==pe;var fe=L,he=M,me=F,ge=z,ye=V,ve=B,be=U,we=null,xe=_({},[].concat(W(E),W(P),W(A),W(C),W(j))),ke=null,_e=_({},[].concat(W(T),W(I),W(N),W(D))),Oe=null,Se=null,Ee=!0,Pe=!0,Ae=!1,$e=!1,Ce=!1,Re=!1,je=!1,Te=!1,Ie=!1,Ne=!0,De=!1,Le=!0,Me=!0,Fe=!1,ze={},Ue=_({},["annotation-xml","audio","colgroup","desc","foreignobject","head","iframe","math","mi","mn","mo","ms","mtext","noembed","noframes","noscript","plaintext","script","style","svg","template","thead","title","video","xmp"]),Ve=null,Be=_({},["audio","video","img","source","image","track"]),qe=null,We=_({},["alt","class","for","id","label","name","pattern","placeholder","summary","title","value","style","xmlns"]),He="http://www.w3.org/1998/Math/MathML",Ye="http://www.w3.org/2000/svg",Ke="http://www.w3.org/1999/xhtml",Ge=Ke,Qe=!1,Xe=null,Je=o.createElement("form"),Ze=function(e){Xe&&Xe===e||(e&&"object"===(void 0===e?"undefined":q(e))||(e={}),e=O(e),we="ALLOWED_TAGS"in e?_({},e.ALLOWED_TAGS):xe,ke="ALLOWED_ATTR"in e?_({},e.ALLOWED_ATTR):_e,qe="ADD_URI_SAFE_ATTR"in e?_(O(We),e.ADD_URI_SAFE_ATTR):We,Ve="ADD_DATA_URI_TAGS"in e?_(O(Be),e.ADD_DATA_URI_TAGS):Be,Oe="FORBID_TAGS"in e?_({},e.FORBID_TAGS):{},Se="FORBID_ATTR"in e?_({},e.FORBID_ATTR):{},ze="USE_PROFILES"in e&&e.USE_PROFILES,Ee=!1!==e.ALLOW_ARIA_ATTR,Pe=!1!==e.ALLOW_DATA_ATTR,Ae=e.ALLOW_UNKNOWN_PROTOCOLS||!1,$e=e.SAFE_FOR_TEMPLATES||!1,Ce=e.WHOLE_DOCUMENT||!1,Te=e.RETURN_DOM||!1,Ie=e.RETURN_DOM_FRAGMENT||!1,Ne=!1!==e.RETURN_DOM_IMPORT,De=e.RETURN_TRUSTED_TYPE||!1,je=e.FORCE_BODY||!1,Le=!1!==e.SANITIZE_DOM,Me=!1!==e.KEEP_CONTENT,Fe=e.IN_PLACE||!1,be=e.ALLOWED_URI_REGEXP||be,Ge=e.NAMESPACE||Ke,$e&&(Pe=!1),Ie&&(Te=!0),ze&&(we=_({},[].concat(W(j))),ke=[],!0===ze.html&&(_(we,E),_(ke,T)),!0===ze.svg&&(_(we,P),_(ke,I),_(ke,D)),!0===ze.svgFilters&&(_(we,A),_(ke,I),_(ke,D)),!0===ze.mathMl&&(_(we,C),_(ke,N),_(ke,D))),e.ADD_TAGS&&(we===xe&&(we=O(we)),_(we,e.ADD_TAGS)),e.ADD_ATTR&&(ke===_e&&(ke=O(ke)),_(ke,e.ADD_ATTR)),e.ADD_URI_SAFE_ATTR&&_(qe,e.ADD_URI_SAFE_ATTR),Me&&(we["#text"]=!0),Ce&&_(we,["html","head","body"]),we.table&&(_(we,["tbody"]),delete Oe.tbody),i&&i(e),Xe=e)},et=_({},["mi","mo","mn","ms","mtext"]),tt=_({},["foreignobject","desc","title","annotation-xml"]),nt=_({},P);_(nt,A),_(nt,$);var rt=_({},C);_(rt,R);var ot=function(e){var t=ne(e);t&&t.tagName||(t={namespaceURI:Ke,tagName:"template"});var n=m(e.tagName),r=m(t.tagName);if(e.namespaceURI===Ye)return t.namespaceURI===Ke?"svg"===n:t.namespaceURI===He?"svg"===n&&("annotation-xml"===r||et[r]):Boolean(nt[n]);if(e.namespaceURI===He)return t.namespaceURI===Ke?"math"===n:t.namespaceURI===Ye?"math"===n&&tt[r]:Boolean(rt[n]);if(e.namespaceURI===Ke){if(t.namespaceURI===Ye&&!tt[r])return!1;if(t.namespaceURI===He&&!et[r])return!1;var o=_({},["title","style","font","a","script"]);return!rt[n]&&(o[n]||!nt[n])}return!1},it=function(e){h(n.removed,{element:e});try{e.parentNode.removeChild(e)}catch(t){try{e.outerHTML=ie}catch(t){e.remove()}}},at=function(e,t){try{h(n.removed,{attribute:t.getAttributeNode(e),from:t})}catch(e){h(n.removed,{attribute:null,from:t})}if(t.removeAttribute(e),"is"===e&&!ke[e])if(Te||Ie)try{it(t)}catch(e){}else try{t.setAttribute(e,"")}catch(e){}},st=function(e){var t=void 0,n=void 0;if(je)e="<remove></remove>"+e;else{var r=g(e,/^[\r\n\t ]+/);n=r&&r[0]}var i=oe?oe.createHTML(e):e;if(Ge===Ke)try{t=(new Q).parseFromString(i,"text/html")}catch(e){}if(!t||!t.documentElement){t=se.createDocument(Ge,"template",null);try{t.documentElement.innerHTML=Qe?"":i}catch(e){}}var a=t.body||t.documentElement;return e&&n&&a.insertBefore(o.createTextNode(n),a.childNodes[0]||null),Ce?t.documentElement:a},lt=function(e){return le.call(e.ownerDocument||e,e,u.SHOW_ELEMENT|u.SHOW_COMMENT|u.SHOW_TEXT,null,!1)},ct=function(e){return!(e instanceof K||e instanceof G||"string"==typeof e.nodeName&&"string"==typeof e.textContent&&"function"==typeof e.removeChild&&e.attributes instanceof k&&"function"==typeof e.removeAttribute&&"function"==typeof e.setAttribute&&"string"==typeof e.namespaceURI&&"function"==typeof e.insertBefore)},ut=function(e){return"object"===(void 0===l?"undefined":q(l))?e instanceof l:e&&"object"===(void 0===e?"undefined":q(e))&&"number"==typeof e.nodeType&&"string"==typeof e.nodeName},pt=function(e,t,r){de[e]&&d(de[e],(function(e){e.call(n,t,r,Xe)}))},dt=function(e){var t=void 0;if(pt("beforeSanitizeElements",e,null),ct(e))return it(e),!0;if(g(e.nodeName,/[\u0080-\uFFFF]/))return it(e),!0;var r=m(e.nodeName);if(pt("uponSanitizeElement",e,{tagName:r,allowedTags:we}),!ut(e.firstElementChild)&&(!ut(e.content)||!ut(e.content.firstElementChild))&&w(/<[/\w]/g,e.innerHTML)&&w(/<[/\w]/g,e.textContent))return it(e),!0;if(!we[r]||Oe[r]){if(Me&&!Ue[r]){var o=ne(e)||e.parentNode,i=te(e)||e.childNodes;if(i&&o)for(var a=i.length-1;a>=0;--a)o.insertBefore(Z(i[a],!0),ee(e))}return it(e),!0}return e instanceof c&&!ot(e)?(it(e),!0):"noscript"!==r&&"noembed"!==r||!w(/<\/no(script|embed)/i,e.innerHTML)?($e&&3===e.nodeType&&(t=e.textContent,t=y(t,fe," "),t=y(t,he," "),e.textContent!==t&&(h(n.removed,{element:e.cloneNode()}),e.textContent=t)),pt("afterSanitizeElements",e,null),!1):(it(e),!0)},ft=function(e,t,n){if(Le&&("id"===t||"name"===t)&&(n in o||n in Je))return!1;if(Pe&&w(me,t));else if(Ee&&w(ge,t));else{if(!ke[t]||Se[t])return!1;if(qe[t]);else if(w(be,y(n,ve,"")));else if("src"!==t&&"xlink:href"!==t&&"href"!==t||"script"===e||0!==v(n,"data:")||!Ve[e])if(Ae&&!w(ye,y(n,ve,"")));else if(n)return!1}return!0},ht=function(e){var t=void 0,r=void 0,o=void 0,i=void 0;pt("beforeSanitizeAttributes",e,null);var a=e.attributes;if(a){var s={attrName:"",attrValue:"",keepAttr:!0,allowedAttributes:ke};for(i=a.length;i--;){var l=t=a[i],c=l.name,u=l.namespaceURI;if(r=b(t.value),o=m(c),s.attrName=o,s.attrValue=r,s.keepAttr=!0,s.forceKeepAttr=void 0,pt("uponSanitizeAttribute",e,s),r=s.attrValue,!s.forceKeepAttr&&(at(c,e),s.keepAttr))if(w(/\/>/i,r))at(c,e);else{$e&&(r=y(r,fe," "),r=y(r,he," "));var p=e.nodeName.toLowerCase();if(ft(p,o,r))try{u?e.setAttributeNS(u,c,r):e.setAttribute(c,r),f(n.removed)}catch(e){}}}pt("afterSanitizeAttributes",e,null)}},mt=function e(t){var n=void 0,r=lt(t);for(pt("beforeSanitizeShadowDOM",t,null);n=r.nextNode();)pt("uponSanitizeShadowNode",n,null),dt(n)||(n.content instanceof a&&e(n.content),ht(n));pt("afterSanitizeShadowDOM",t,null)};return n.sanitize=function(e,o){var i=void 0,s=void 0,c=void 0,u=void 0,p=void 0;if((Qe=!e)&&(e="\x3c!--\x3e"),"string"!=typeof e&&!ut(e)){if("function"!=typeof e.toString)throw x("toString is not a function");if("string"!=typeof(e=e.toString()))throw x("dirty is not a string, aborting")}if(!n.isSupported){if("object"===q(t.toStaticHTML)||"function"==typeof t.toStaticHTML){if("string"==typeof e)return t.toStaticHTML(e);if(ut(e))return t.toStaticHTML(e.outerHTML)}return e}if(Re||Ze(o),n.removed=[],"string"==typeof e&&(Fe=!1),Fe);else if(e instanceof l)1===(s=(i=st("\x3c!----\x3e")).ownerDocument.importNode(e,!0)).nodeType&&"BODY"===s.nodeName||"HTML"===s.nodeName?i=s:i.appendChild(s);else{if(!Te&&!$e&&!Ce&&-1===e.indexOf("<"))return oe&&De?oe.createHTML(e):e;if(!(i=st(e)))return Te?null:ie}i&&je&&it(i.firstChild);for(var d=lt(Fe?e:i);c=d.nextNode();)3===c.nodeType&&c===u||dt(c)||(c.content instanceof a&&mt(c.content),ht(c),u=c);if(u=null,Fe)return e;if(Te){if(Ie)for(p=ce.call(i.ownerDocument);i.firstChild;)p.appendChild(i.firstChild);else p=i;return Ne&&(p=ue.call(r,p,!0)),p}var f=Ce?i.outerHTML:i.innerHTML;return $e&&(f=y(f,fe," "),f=y(f,he," ")),oe&&De?oe.createHTML(f):f},n.setConfig=function(e){Ze(e),Re=!0},n.clearConfig=function(){Xe=null,Re=!1},n.isValidAttribute=function(e,t,n){Xe||Ze({});var r=m(e),o=m(t);return ft(r,o,n)},n.addHook=function(e,t){"function"==typeof t&&(de[e]=de[e]||[],h(de[e],t))},n.removeHook=function(e){de[e]&&f(de[e])},n.removeHooks=function(e){de[e]&&(de[e]=[])},n.removeAllHooks=function(){de={}},n}()}()},9045:function(e){e.exports={}},6729:function(e){"use strict";var t=Object.prototype.hasOwnProperty,n="~";function r(){}function o(e,t,n){this.fn=e,this.context=t,this.once=n||!1}function i(e,t,r,i,a){if("function"!=typeof r)throw new TypeError("The listener must be a function");var s=new o(r,i||e,a),l=n?n+t:t;return e._events[l]?e._events[l].fn?e._events[l]=[e._events[l],s]:e._events[l].push(s):(e._events[l]=s,e._eventsCount++),e}function a(e,t){0==--e._eventsCount?e._events=new r:delete e._events[t]}function s(){this._events=new r,this._eventsCount=0}Object.create&&(r.prototype=Object.create(null),(new r).__proto__||(n=!1)),s.prototype.eventNames=function(){var e,r,o=[];if(0===this._eventsCount)return o;for(r in e=this._events)t.call(e,r)&&o.push(n?r.slice(1):r);return Object.getOwnPropertySymbols?o.concat(Object.getOwnPropertySymbols(e)):o},s.prototype.listeners=function(e){var t=n?n+e:e,r=this._events[t];if(!r)return[];if(r.fn)return[r.fn];for(var o=0,i=r.length,a=new Array(i);o<i;o++)a[o]=r[o].fn;return a},s.prototype.listenerCount=function(e){var t=n?n+e:e,r=this._events[t];return r?r.fn?1:r.length:0},s.prototype.emit=function(e,t,r,o,i,a){var s=n?n+e:e;if(!this._events[s])return!1;var l,c,u=this._events[s],p=arguments.length;if(u.fn){switch(u.once&&this.removeListener(e,u.fn,void 0,!0),p){case 1:return u.fn.call(u.context),!0;case 2:return u.fn.call(u.context,t),!0;case 3:return u.fn.call(u.context,t,r),!0;case 4:return u.fn.call(u.context,t,r,o),!0;case 5:return u.fn.call(u.context,t,r,o,i),!0;case 6:return u.fn.call(u.context,t,r,o,i,a),!0}for(c=1,l=new Array(p-1);c<p;c++)l[c-1]=arguments[c];u.fn.apply(u.context,l)}else{var d,f=u.length;for(c=0;c<f;c++)switch(u[c].once&&this.removeListener(e,u[c].fn,void 0,!0),p){case 1:u[c].fn.call(u[c].context);break;case 2:u[c].fn.call(u[c].context,t);break;case 3:u[c].fn.call(u[c].context,t,r);break;case 4:u[c].fn.call(u[c].context,t,r,o);break;default:if(!l)for(d=1,l=new Array(p-1);d<p;d++)l[d-1]=arguments[d];u[c].fn.apply(u[c].context,l)}}return!0},s.prototype.on=function(e,t,n){return i(this,e,t,n,!1)},s.prototype.once=function(e,t,n){return i(this,e,t,n,!0)},s.prototype.removeListener=function(e,t,r,o){var i=n?n+e:e;if(!this._events[i])return this;if(!t)return a(this,i),this;var s=this._events[i];if(s.fn)s.fn!==t||o&&!s.once||r&&s.context!==r||a(this,i);else{for(var l=0,c=[],u=s.length;l<u;l++)(s[l].fn!==t||o&&!s[l].once||r&&s[l].context!==r)&&c.push(s[l]);c.length?this._events[i]=1===c.length?c[0]:c:a(this,i)}return this},s.prototype.removeAllListeners=function(e){var t;return e?(t=n?n+e:e,this._events[t]&&a(this,t)):(this._events=new r,this._eventsCount=0),this},s.prototype.off=s.prototype.removeListener,s.prototype.addListener=s.prototype.on,s.prefixed=n,s.EventEmitter=s,e.exports=s},4063:function(e){"use strict";e.exports=function e(t,n){if(t===n)return!0;if(t&&n&&"object"==typeof t&&"object"==typeof n){if(t.constructor!==n.constructor)return!1;var r,o,i;if(Array.isArray(t)){if((r=t.length)!=n.length)return!1;for(o=r;0!=o--;)if(!e(t[o],n[o]))return!1;return!0}if(t.constructor===RegExp)return t.source===n.source&&t.flags===n.flags;if(t.valueOf!==Object.prototype.valueOf)return t.valueOf()===n.valueOf();if(t.toString!==Object.prototype.toString)return t.toString()===n.toString();if((r=(i=Object.keys(t)).length)!==Object.keys(n).length)return!1;for(o=r;0!=o--;)if(!Object.prototype.hasOwnProperty.call(n,i[o]))return!1;for(o=r;0!=o--;){var a=i[o];if(!e(t[a],n[a]))return!1}return!0}return t!=t&&n!=n}},4445:function(e){e.exports=r,r.default=r,r.stable=a,r.stableStringify=a;var t=[],n=[];function r(e,r,i){var a;for(o(e,"",[],void 0),a=0===n.length?JSON.stringify(e,r,i):JSON.stringify(e,l(r),i);0!==t.length;){var s=t.pop();4===s.length?Object.defineProperty(s[0],s[1],s[3]):s[0][s[1]]=s[2]}return a}function o(e,r,i,a){var s;if("object"==typeof e&&null!==e){for(s=0;s<i.length;s++)if(i[s]===e){var l=Object.getOwnPropertyDescriptor(a,r);return void(void 0!==l.get?l.configurable?(Object.defineProperty(a,r,{value:"[Circular]"}),t.push([a,r,e,l])):n.push([e,r]):(a[r]="[Circular]",t.push([a,r,e])))}if(i.push(e),Array.isArray(e))for(s=0;s<e.length;s++)o(e[s],s,i,e);else{var c=Object.keys(e);for(s=0;s<c.length;s++){var u=c[s];o(e[u],u,i,e)}}i.pop()}}function i(e,t){return e<t?-1:e>t?1:0}function a(e,r,o){var i,a=s(e,"",[],void 0)||e;for(i=0===n.length?JSON.stringify(a,r,o):JSON.stringify(a,l(r),o);0!==t.length;){var c=t.pop();4===c.length?Object.defineProperty(c[0],c[1],c[3]):c[0][c[1]]=c[2]}return i}function s(e,r,o,a){var l;if("object"==typeof e&&null!==e){for(l=0;l<o.length;l++)if(o[l]===e){var c=Object.getOwnPropertyDescriptor(a,r);return void(void 0!==c.get?c.configurable?(Object.defineProperty(a,r,{value:"[Circular]"}),t.push([a,r,e,c])):n.push([e,r]):(a[r]="[Circular]",t.push([a,r,e])))}if("function"==typeof e.toJSON)return;if(o.push(e),Array.isArray(e))for(l=0;l<e.length;l++)s(e[l],l,o,e);else{var u={},p=Object.keys(e).sort(i);for(l=0;l<p.length;l++){var d=p[l];s(e[d],d,o,e),u[d]=e[d]}if(void 0===a)return u;t.push([a,r,e]),a[r]=u}o.pop()}}function l(e){return e=void 0!==e?e:function(e,t){return t},function(t,r){if(n.length>0)for(var o=0;o<n.length;o++){var i=n[o];if(i[1]===t&&i[0]===r){r="[Circular]",n.splice(o,1);break}}return e.call(this,t,r)}}},9804:function(e){var t=Object.prototype.hasOwnProperty,n=Object.prototype.toString;e.exports=function(e,r,o){if("[object Function]"!==n.call(r))throw new TypeError("iterator must be a function");var i=e.length;if(i===+i)for(var a=0;a<i;a++)r.call(o,e[a],a,e);else for(var s in e)t.call(e,s)&&r.call(o,e[s],s,e)}},8679:function(e,t,n){"use strict";var r=n(1296),o={childContextTypes:!0,contextType:!0,contextTypes:!0,defaultProps:!0,displayName:!0,getDefaultProps:!0,getDerivedStateFromError:!0,getDerivedStateFromProps:!0,mixins:!0,propTypes:!0,type:!0},i={name:!0,length:!0,prototype:!0,caller:!0,callee:!0,arguments:!0,arity:!0},a={$$typeof:!0,compare:!0,defaultProps:!0,displayName:!0,propTypes:!0,type:!0},s={};function l(e){return r.isMemo(e)?a:s[e.$$typeof]||o}s[r.ForwardRef]={$$typeof:!0,render:!0,defaultProps:!0,displayName:!0,propTypes:!0},s[r.Memo]=a;var c=Object.defineProperty,u=Object.getOwnPropertyNames,p=Object.getOwnPropertySymbols,d=Object.getOwnPropertyDescriptor,f=Object.getPrototypeOf,h=Object.prototype;e.exports=function e(t,n,r){if("string"!=typeof n){if(h){var o=f(n);o&&o!==h&&e(t,o,r)}var a=u(n);p&&(a=a.concat(p(n)));for(var s=l(t),m=l(n),g=0;g<a.length;++g){var y=a[g];if(!(i[y]||r&&r[y]||m&&m[y]||s&&s[y])){var v=d(n,y);try{c(t,y,v)}catch(e){}}}}return t}},6103:function(e,t){"use strict";var n="function"==typeof Symbol&&Symbol.for,r=n?Symbol.for("react.element"):60103,o=n?Symbol.for("react.portal"):60106,i=n?Symbol.for("react.fragment"):60107,a=n?Symbol.for("react.strict_mode"):60108,s=n?Symbol.for("react.profiler"):60114,l=n?Symbol.for("react.provider"):60109,c=n?Symbol.for("react.context"):60110,u=n?Symbol.for("react.async_mode"):60111,p=n?Symbol.for("react.concurrent_mode"):60111,d=n?Symbol.for("react.forward_ref"):60112,f=n?Symbol.for("react.suspense"):60113,h=n?Symbol.for("react.suspense_list"):60120,m=n?Symbol.for("react.memo"):60115,g=n?Symbol.for("react.lazy"):60116,y=n?Symbol.for("react.block"):60121,v=n?Symbol.for("react.fundamental"):60117,b=n?Symbol.for("react.responder"):60118,w=n?Symbol.for("react.scope"):60119;function x(e){if("object"==typeof e&&null!==e){var t=e.$$typeof;switch(t){case r:switch(e=e.type){case u:case p:case i:case s:case a:case f:return e;default:switch(e=e&&e.$$typeof){case c:case d:case g:case m:case l:return e;default:return t}}case o:return t}}}function k(e){return x(e)===p}t.AsyncMode=u,t.ConcurrentMode=p,t.ContextConsumer=c,t.ContextProvider=l,t.Element=r,t.ForwardRef=d,t.Fragment=i,t.Lazy=g,t.Memo=m,t.Portal=o,t.Profiler=s,t.StrictMode=a,t.Suspense=f,t.isAsyncMode=function(e){return k(e)||x(e)===u},t.isConcurrentMode=k,t.isContextConsumer=function(e){return x(e)===c},t.isContextProvider=function(e){return x(e)===l},t.isElement=function(e){return"object"==typeof e&&null!==e&&e.$$typeof===r},t.isForwardRef=function(e){return x(e)===d},t.isFragment=function(e){return x(e)===i},t.isLazy=function(e){return x(e)===g},t.isMemo=function(e){return x(e)===m},t.isPortal=function(e){return x(e)===o},t.isProfiler=function(e){return x(e)===s},t.isStrictMode=function(e){return x(e)===a},t.isSuspense=function(e){return x(e)===f},t.isValidElementType=function(e){return"string"==typeof e||"function"==typeof e||e===i||e===p||e===s||e===a||e===f||e===h||"object"==typeof e&&null!==e&&(e.$$typeof===g||e.$$typeof===m||e.$$typeof===l||e.$$typeof===c||e.$$typeof===d||e.$$typeof===v||e.$$typeof===b||e.$$typeof===w||e.$$typeof===y)},t.typeOf=x},1296:function(e,t,n){"use strict";e.exports=n(6103)},9991:function(e){"use strict";e.exports=function(){function e(e,t,n,r,o){return e<t||n<t?e>n?n+1:e+1:r===o?t:t+1}return function(t,n){if(t===n)return 0;if(t.length>n.length){var r=t;t=n,n=r}for(var o=t.length,i=n.length;o>0&&t.charCodeAt(o-1)===n.charCodeAt(i-1);)o--,i--;for(var a=0;a<o&&t.charCodeAt(a)===n.charCodeAt(a);)a++;if(i-=a,0==(o-=a)||i<3)return i;var s,l,c,u,p,d,f,h,m,g,y,v,b=0,w=[];for(s=0;s<o;s++)w.push(s+1),w.push(t.charCodeAt(a+s));for(var x=w.length-1;b<i-3;)for(m=n.charCodeAt(a+(l=b)),g=n.charCodeAt(a+(c=b+1)),y=n.charCodeAt(a+(u=b+2)),v=n.charCodeAt(a+(p=b+3)),d=b+=4,s=0;s<x;s+=2)l=e(f=w[s],l,c,m,h=w[s+1]),c=e(l,c,u,g,h),u=e(c,u,p,y,h),d=e(u,p,d,v,h),w[s]=d,p=u,u=c,c=l,l=f;for(;b<i;)for(m=n.charCodeAt(a+(l=b)),d=++b,s=0;s<x;s+=2)f=w[s],w[s]=d=e(f,l,d,m,w[s+1]),l=f;return d}}()},3320:function(e,t,n){"use strict";var r=n(7990),o=n(3150);function i(e,t){return function(){throw new Error("Function yaml."+e+" is removed in js-yaml 4. Use yaml."+t+" instead, which is now safe by default.")}}e.exports.Type=n(1364),e.exports.Schema=n(7657),e.exports.FAILSAFE_SCHEMA=n(4795),e.exports.JSON_SCHEMA=n(5966),e.exports.CORE_SCHEMA=n(9471),e.exports.DEFAULT_SCHEMA=n(6601),e.exports.load=r.load,e.exports.loadAll=r.loadAll,e.exports.dump=o.dump,e.exports.YAMLException=n(8425),e.exports.types={binary:n(3531),float:n(5215),map:n(945),null:n(151),pairs:n(6879),set:n(4982),timestamp:n(2156),bool:n(8771),int:n(1518),merge:n(7452),omap:n(1605),seq:n(6451),str:n(48)},e.exports.safeLoad=i("safeLoad","load"),e.exports.safeLoadAll=i("safeLoadAll","loadAll"),e.exports.safeDump=i("safeDump","dump")},8347:function(e){"use strict";function t(e){return null==e}e.exports.isNothing=t,e.exports.isObject=function(e){return"object"==typeof e&&null!==e},e.exports.toArray=function(e){return Array.isArray(e)?e:t(e)?[]:[e]},e.exports.repeat=function(e,t){var n,r="";for(n=0;n<t;n+=1)r+=e;return r},e.exports.isNegativeZero=function(e){return 0===e&&Number.NEGATIVE_INFINITY===1/e},e.exports.extend=function(e,t){var n,r,o,i;if(t)for(n=0,r=(i=Object.keys(t)).length;n<r;n+=1)e[o=i[n]]=t[o];return e}},3150:function(e,t,n){"use strict";var r=n(8347),o=n(8425),i=n(6601),a=Object.prototype.toString,s=Object.prototype.hasOwnProperty,l=65279,c={0:"\\0",7:"\\a",8:"\\b",9:"\\t",10:"\\n",11:"\\v",12:"\\f",13:"\\r",27:"\\e",34:'\\"',92:"\\\\",133:"\\N",160:"\\_",8232:"\\L",8233:"\\P"},u=["y","Y","yes","Yes","YES","on","On","ON","n","N","no","No","NO","off","Off","OFF"],p=/^[-+]?[0-9_]+(?::[0-9_]+)+(?:\.[0-9_]*)?$/;function d(e){var t,n,i;if(t=e.toString(16).toUpperCase(),e<=255)n="x",i=2;else if(e<=65535)n="u",i=4;else{if(!(e<=4294967295))throw new o("code point within a string may not be greater than 0xFFFFFFFF");n="U",i=8}return"\\"+n+r.repeat("0",i-t.length)+t}function f(e){this.schema=e.schema||i,this.indent=Math.max(1,e.indent||2),this.noArrayIndent=e.noArrayIndent||!1,this.skipInvalid=e.skipInvalid||!1,this.flowLevel=r.isNothing(e.flowLevel)?-1:e.flowLevel,this.styleMap=function(e,t){var n,r,o,i,a,l,c;if(null===t)return{};for(n={},o=0,i=(r=Object.keys(t)).length;o<i;o+=1)a=r[o],l=String(t[a]),"!!"===a.slice(0,2)&&(a="tag:yaml.org,2002:"+a.slice(2)),(c=e.compiledTypeMap.fallback[a])&&s.call(c.styleAliases,l)&&(l=c.styleAliases[l]),n[a]=l;return n}(this.schema,e.styles||null),this.sortKeys=e.sortKeys||!1,this.lineWidth=e.lineWidth||80,this.noRefs=e.noRefs||!1,this.noCompatMode=e.noCompatMode||!1,this.condenseFlow=e.condenseFlow||!1,this.quotingType='"'===e.quotingType?2:1,this.forceQuotes=e.forceQuotes||!1,this.replacer="function"==typeof e.replacer?e.replacer:null,this.implicitTypes=this.schema.compiledImplicit,this.explicitTypes=this.schema.compiledExplicit,this.tag=null,this.result="",this.duplicates=[],this.usedDuplicates=null}function h(e,t){for(var n,o=r.repeat(" ",t),i=0,a=-1,s="",l=e.length;i<l;)-1===(a=e.indexOf("\n",i))?(n=e.slice(i),i=l):(n=e.slice(i,a+1),i=a+1),n.length&&"\n"!==n&&(s+=o),s+=n;return s}function m(e,t){return"\n"+r.repeat(" ",e.indent*t)}function g(e){return 32===e||9===e}function y(e){return 32<=e&&e<=126||161<=e&&e<=55295&&8232!==e&&8233!==e||57344<=e&&e<=65533&&e!==l||65536<=e&&e<=1114111}function v(e){return y(e)&&e!==l&&13!==e&&10!==e}function b(e,t,n){var r=v(e),o=r&&!g(e);return(n?r:r&&44!==e&&91!==e&&93!==e&&123!==e&&125!==e)&&35!==e&&!(58===t&&!o)||v(t)&&!g(t)&&35===e||58===t&&o}function w(e,t){var n,r=e.charCodeAt(t);return r>=55296&&r<=56319&&t+1<e.length&&(n=e.charCodeAt(t+1))>=56320&&n<=57343?1024*(r-55296)+n-56320+65536:r}function x(e){return/^\n* /.test(e)}function k(e,t,n,r,i){e.dump=function(){if(0===t.length)return 2===e.quotingType?'""':"''";if(!e.noCompatMode&&(-1!==u.indexOf(t)||p.test(t)))return 2===e.quotingType?'"'+t+'"':"'"+t+"'";var a=e.indent*Math.max(1,n),s=-1===e.lineWidth?-1:Math.max(Math.min(e.lineWidth,40),e.lineWidth-a),f=r||e.flowLevel>-1&&n>=e.flowLevel;switch(function(e,t,n,r,o,i,a,s){var c,u,p=0,d=null,f=!1,h=!1,m=-1!==r,v=-1,k=y(u=w(e,0))&&u!==l&&!g(u)&&45!==u&&63!==u&&58!==u&&44!==u&&91!==u&&93!==u&&123!==u&&125!==u&&35!==u&&38!==u&&42!==u&&33!==u&&124!==u&&61!==u&&62!==u&&39!==u&&34!==u&&37!==u&&64!==u&&96!==u&&function(e){return!g(e)&&58!==e}(w(e,e.length-1));if(t||a)for(c=0;c<e.length;p>=65536?c+=2:c++){if(!y(p=w(e,c)))return 5;k=k&&b(p,d,s),d=p}else{for(c=0;c<e.length;p>=65536?c+=2:c++){if(10===(p=w(e,c)))f=!0,m&&(h=h||c-v-1>r&&" "!==e[v+1],v=c);else if(!y(p))return 5;k=k&&b(p,d,s),d=p}h=h||m&&c-v-1>r&&" "!==e[v+1]}return f||h?n>9&&x(e)?5:a?2===i?5:2:h?4:3:!k||a||o(e)?2===i?5:2:1}(t,f,e.indent,s,(function(t){return function(e,t){var n,r;for(n=0,r=e.implicitTypes.length;n<r;n+=1)if(e.implicitTypes[n].resolve(t))return!0;return!1}(e,t)}),e.quotingType,e.forceQuotes&&!r,i)){case 1:return t;case 2:return"'"+t.replace(/'/g,"''")+"'";case 3:return"|"+_(t,e.indent)+O(h(t,a));case 4:return">"+_(t,e.indent)+O(h(function(e,t){for(var n,r,o,i=/(\n+)([^\n]*)/g,a=(o=-1!==(o=e.indexOf("\n"))?o:e.length,i.lastIndex=o,S(e.slice(0,o),t)),s="\n"===e[0]||" "===e[0];r=i.exec(e);){var l=r[1],c=r[2];n=" "===c[0],a+=l+(s||n||""===c?"":"\n")+S(c,t),s=n}return a}(t,s),a));case 5:return'"'+function(e){for(var t,n="",r=0,o=0;o<e.length;r>=65536?o+=2:o++)r=w(e,o),!(t=c[r])&&y(r)?(n+=e[o],r>=65536&&(n+=e[o+1])):n+=t||d(r);return n}(t)+'"';default:throw new o("impossible error: invalid scalar style")}}()}function _(e,t){var n=x(e)?String(t):"",r="\n"===e[e.length-1];return n+(!r||"\n"!==e[e.length-2]&&"\n"!==e?r?"":"-":"+")+"\n"}function O(e){return"\n"===e[e.length-1]?e.slice(0,-1):e}function S(e,t){if(""===e||" "===e[0])return e;for(var n,r,o=/ [^ ]/g,i=0,a=0,s=0,l="";n=o.exec(e);)(s=n.index)-i>t&&(r=a>i?a:s,l+="\n"+e.slice(i,r),i=r+1),a=s;return l+="\n",e.length-i>t&&a>i?l+=e.slice(i,a)+"\n"+e.slice(a+1):l+=e.slice(i),l.slice(1)}function E(e,t,n,r){var o,i,a,s="",l=e.tag;for(o=0,i=n.length;o<i;o+=1)a=n[o],e.replacer&&(a=e.replacer.call(n,String(o),a)),(A(e,t+1,a,!0,!0,!1,!0)||void 0===a&&A(e,t+1,null,!0,!0,!1,!0))&&(r&&""===s||(s+=m(e,t)),e.dump&&10===e.dump.charCodeAt(0)?s+="-":s+="- ",s+=e.dump);e.tag=l,e.dump=s||"[]"}function P(e,t,n){var r,i,l,c,u,p;for(l=0,c=(i=n?e.explicitTypes:e.implicitTypes).length;l<c;l+=1)if(((u=i[l]).instanceOf||u.predicate)&&(!u.instanceOf||"object"==typeof t&&t instanceof u.instanceOf)&&(!u.predicate||u.predicate(t))){if(n?u.multi&&u.representName?e.tag=u.representName(t):e.tag=u.tag:e.tag="?",u.represent){if(p=e.styleMap[u.tag]||u.defaultStyle,"[object Function]"===a.call(u.represent))r=u.represent(t,p);else{if(!s.call(u.represent,p))throw new o("!<"+u.tag+'> tag resolver accepts not "'+p+'" style');r=u.represent[p](t,p)}e.dump=r}return!0}return!1}function A(e,t,n,r,i,s,l){e.tag=null,e.dump=n,P(e,n,!1)||P(e,n,!0);var c,u=a.call(e.dump),p=r;r&&(r=e.flowLevel<0||e.flowLevel>t);var d,f,h="[object Object]"===u||"[object Array]"===u;if(h&&(f=-1!==(d=e.duplicates.indexOf(n))),(null!==e.tag&&"?"!==e.tag||f||2!==e.indent&&t>0)&&(i=!1),f&&e.usedDuplicates[d])e.dump="*ref_"+d;else{if(h&&f&&!e.usedDuplicates[d]&&(e.usedDuplicates[d]=!0),"[object Object]"===u)r&&0!==Object.keys(e.dump).length?(function(e,t,n,r){var i,a,s,l,c,u,p="",d=e.tag,f=Object.keys(n);if(!0===e.sortKeys)f.sort();else if("function"==typeof e.sortKeys)f.sort(e.sortKeys);else if(e.sortKeys)throw new o("sortKeys must be a boolean or a function");for(i=0,a=f.length;i<a;i+=1)u="",r&&""===p||(u+=m(e,t)),l=n[s=f[i]],e.replacer&&(l=e.replacer.call(n,s,l)),A(e,t+1,s,!0,!0,!0)&&((c=null!==e.tag&&"?"!==e.tag||e.dump&&e.dump.length>1024)&&(e.dump&&10===e.dump.charCodeAt(0)?u+="?":u+="? "),u+=e.dump,c&&(u+=m(e,t)),A(e,t+1,l,!0,c)&&(e.dump&&10===e.dump.charCodeAt(0)?u+=":":u+=": ",p+=u+=e.dump));e.tag=d,e.dump=p||"{}"}(e,t,e.dump,i),f&&(e.dump="&ref_"+d+e.dump)):(function(e,t,n){var r,o,i,a,s,l="",c=e.tag,u=Object.keys(n);for(r=0,o=u.length;r<o;r+=1)s="",""!==l&&(s+=", "),e.condenseFlow&&(s+='"'),a=n[i=u[r]],e.replacer&&(a=e.replacer.call(n,i,a)),A(e,t,i,!1,!1)&&(e.dump.length>1024&&(s+="? "),s+=e.dump+(e.condenseFlow?'"':"")+":"+(e.condenseFlow?"":" "),A(e,t,a,!1,!1)&&(l+=s+=e.dump));e.tag=c,e.dump="{"+l+"}"}(e,t,e.dump),f&&(e.dump="&ref_"+d+" "+e.dump));else if("[object Array]"===u)r&&0!==e.dump.length?(e.noArrayIndent&&!l&&t>0?E(e,t-1,e.dump,i):E(e,t,e.dump,i),f&&(e.dump="&ref_"+d+e.dump)):(function(e,t,n){var r,o,i,a="",s=e.tag;for(r=0,o=n.length;r<o;r+=1)i=n[r],e.replacer&&(i=e.replacer.call(n,String(r),i)),(A(e,t,i,!1,!1)||void 0===i&&A(e,t,null,!1,!1))&&(""!==a&&(a+=","+(e.condenseFlow?"":" ")),a+=e.dump);e.tag=s,e.dump="["+a+"]"}(e,t,e.dump),f&&(e.dump="&ref_"+d+" "+e.dump));else{if("[object String]"!==u){if("[object Undefined]"===u)return!1;if(e.skipInvalid)return!1;throw new o("unacceptable kind of an object to dump "+u)}"?"!==e.tag&&k(e,e.dump,t,s,p)}null!==e.tag&&"?"!==e.tag&&(c=encodeURI("!"===e.tag[0]?e.tag.slice(1):e.tag).replace(/!/g,"%21"),c="!"===e.tag[0]?"!"+c:"tag:yaml.org,2002:"===c.slice(0,18)?"!!"+c.slice(18):"!<"+c+">",e.dump=c+" "+e.dump)}return!0}function $(e,t){var n,r,o=[],i=[];for(C(e,o,i),n=0,r=i.length;n<r;n+=1)t.duplicates.push(o[i[n]]);t.usedDuplicates=new Array(r)}function C(e,t,n){var r,o,i;if(null!==e&&"object"==typeof e)if(-1!==(o=t.indexOf(e)))-1===n.indexOf(o)&&n.push(o);else if(t.push(e),Array.isArray(e))for(o=0,i=e.length;o<i;o+=1)C(e[o],t,n);else for(o=0,i=(r=Object.keys(e)).length;o<i;o+=1)C(e[r[o]],t,n)}e.exports.dump=function(e,t){var n=new f(t=t||{});n.noRefs||$(e,n);var r=e;return n.replacer&&(r=n.replacer.call({"":r},"",r)),A(n,0,r,!0,!0)?n.dump+"\n":""}},8425:function(e){"use strict";function t(e,t){var n="",r=e.reason||"(unknown reason)";return e.mark?(e.mark.name&&(n+='in "'+e.mark.name+'" '),n+="("+(e.mark.line+1)+":"+(e.mark.column+1)+")",!t&&e.mark.snippet&&(n+="\n\n"+e.mark.snippet),r+" "+n):r}function n(e,n){Error.call(this),this.name="YAMLException",this.reason=e,this.mark=n,this.message=t(this,!1),Error.captureStackTrace?Error.captureStackTrace(this,this.constructor):this.stack=(new Error).stack||""}n.prototype=Object.create(Error.prototype),n.prototype.constructor=n,n.prototype.toString=function(e){return this.name+": "+t(this,e)},e.exports=n},7990:function(e,t,n){"use strict";var r=n(8347),o=n(8425),i=n(192),a=n(6601),s=Object.prototype.hasOwnProperty,l=/[\x00-\x08\x0B\x0C\x0E-\x1F\x7F-\x84\x86-\x9F\uFFFE\uFFFF]|[\uD800-\uDBFF](?![\uDC00-\uDFFF])|(?:[^\uD800-\uDBFF]|^)[\uDC00-\uDFFF]/,c=/[\x85\u2028\u2029]/,u=/[,\[\]\{\}]/,p=/^(?:!|!!|![a-z\-]+!)$/i,d=/^(?:!|[^,\[\]\{\}])(?:%[0-9a-f]{2}|[0-9a-z\-#;\/\?:@&=\+\$,_\.!~\*'\(\)\[\]])*$/i;function f(e){return Object.prototype.toString.call(e)}function h(e){return 10===e||13===e}function m(e){return 9===e||32===e}function g(e){return 9===e||32===e||10===e||13===e}function y(e){return 44===e||91===e||93===e||123===e||125===e}function v(e){var t;return 48<=e&&e<=57?e-48:97<=(t=32|e)&&t<=102?t-97+10:-1}function b(e){return 48===e?"\0":97===e?"":98===e?"\b":116===e||9===e?"\t":110===e?"\n":118===e?"\v":102===e?"\f":114===e?"\r":101===e?"":32===e?" ":34===e?'"':47===e?"/":92===e?"\\":78===e?"
":95===e?" ":76===e?"\u2028":80===e?"\u2029":""}function w(e){return e<=65535?String.fromCharCode(e):String.fromCharCode(55296+(e-65536>>10),56320+(e-65536&1023))}for(var x=new Array(256),k=new Array(256),_=0;_<256;_++)x[_]=b(_)?1:0,k[_]=b(_);function O(e,t){this.input=e,this.filename=t.filename||null,this.schema=t.schema||a,this.onWarning=t.onWarning||null,this.legacy=t.legacy||!1,this.json=t.json||!1,this.listener=t.listener||null,this.implicitTypes=this.schema.compiledImplicit,this.typeMap=this.schema.compiledTypeMap,this.length=e.length,this.position=0,this.line=0,this.lineStart=0,this.lineIndent=0,this.firstTabInLine=-1,this.documents=[]}function S(e,t){var n={name:e.filename,buffer:e.input.slice(0,-1),position:e.position,line:e.line,column:e.position-e.lineStart};return n.snippet=i(n),new o(t,n)}function E(e,t){throw S(e,t)}function P(e,t){e.onWarning&&e.onWarning.call(null,S(e,t))}var A={YAML:function(e,t,n){var r,o,i;null!==e.version&&E(e,"duplication of %YAML directive"),1!==n.length&&E(e,"YAML directive accepts exactly one argument"),null===(r=/^([0-9]+)\.([0-9]+)$/.exec(n[0]))&&E(e,"ill-formed argument of the YAML directive"),o=parseInt(r[1],10),i=parseInt(r[2],10),1!==o&&E(e,"unacceptable YAML version of the document"),e.version=n[0],e.checkLineBreaks=i<2,1!==i&&2!==i&&P(e,"unsupported YAML version of the document")},TAG:function(e,t,n){var r,o;2!==n.length&&E(e,"TAG directive accepts exactly two arguments"),r=n[0],o=n[1],p.test(r)||E(e,"ill-formed tag handle (first argument) of the TAG directive"),s.call(e.tagMap,r)&&E(e,'there is a previously declared suffix for "'+r+'" tag handle'),d.test(o)||E(e,"ill-formed tag prefix (second argument) of the TAG directive");try{o=decodeURIComponent(o)}catch(t){E(e,"tag prefix is malformed: "+o)}e.tagMap[r]=o}};function $(e,t,n,r){var o,i,a,s;if(t<n){if(s=e.input.slice(t,n),r)for(o=0,i=s.length;o<i;o+=1)9===(a=s.charCodeAt(o))||32<=a&&a<=1114111||E(e,"expected valid JSON character");else l.test(s)&&E(e,"the stream contains non-printable characters");e.result+=s}}function C(e,t,n,o){var i,a,l,c;for(r.isObject(n)||E(e,"cannot merge mappings; the provided source object is unacceptable"),l=0,c=(i=Object.keys(n)).length;l<c;l+=1)a=i[l],s.call(t,a)||(t[a]=n[a],o[a]=!0)}function R(e,t,n,r,o,i,a,l,c){var u,p;if(Array.isArray(o))for(u=0,p=(o=Array.prototype.slice.call(o)).length;u<p;u+=1)Array.isArray(o[u])&&E(e,"nested arrays are not supported inside keys"),"object"==typeof o&&"[object Object]"===f(o[u])&&(o[u]="[object Object]");if("object"==typeof o&&"[object Object]"===f(o)&&(o="[object Object]"),o=String(o),null===t&&(t={}),"tag:yaml.org,2002:merge"===r)if(Array.isArray(i))for(u=0,p=i.length;u<p;u+=1)C(e,t,i[u],n);else C(e,t,i,n);else e.json||s.call(n,o)||!s.call(t,o)||(e.line=a||e.line,e.lineStart=l||e.lineStart,e.position=c||e.position,E(e,"duplicated mapping key")),"__proto__"===o?Object.defineProperty(t,o,{configurable:!0,enumerable:!0,writable:!0,value:i}):t[o]=i,delete n[o];return t}function j(e){var t;10===(t=e.input.charCodeAt(e.position))?e.position++:13===t?(e.position++,10===e.input.charCodeAt(e.position)&&e.position++):E(e,"a line break is expected"),e.line+=1,e.lineStart=e.position,e.firstTabInLine=-1}function T(e,t,n){for(var r=0,o=e.input.charCodeAt(e.position);0!==o;){for(;m(o);)9===o&&-1===e.firstTabInLine&&(e.firstTabInLine=e.position),o=e.input.charCodeAt(++e.position);if(t&&35===o)do{o=e.input.charCodeAt(++e.position)}while(10!==o&&13!==o&&0!==o);if(!h(o))break;for(j(e),o=e.input.charCodeAt(e.position),r++,e.lineIndent=0;32===o;)e.lineIndent++,o=e.input.charCodeAt(++e.position)}return-1!==n&&0!==r&&e.lineIndent<n&&P(e,"deficient indentation"),r}function I(e){var t,n=e.position;return!(45!==(t=e.input.charCodeAt(n))&&46!==t||t!==e.input.charCodeAt(n+1)||t!==e.input.charCodeAt(n+2)||(n+=3,0!==(t=e.input.charCodeAt(n))&&!g(t)))}function N(e,t){1===t?e.result+=" ":t>1&&(e.result+=r.repeat("\n",t-1))}function D(e,t){var n,r,o=e.tag,i=e.anchor,a=[],s=!1;if(-1!==e.firstTabInLine)return!1;for(null!==e.anchor&&(e.anchorMap[e.anchor]=a),r=e.input.charCodeAt(e.position);0!==r&&(-1!==e.firstTabInLine&&(e.position=e.firstTabInLine,E(e,"tab characters must not be used in indentation")),45===r)&&g(e.input.charCodeAt(e.position+1));)if(s=!0,e.position++,T(e,!0,-1)&&e.lineIndent<=t)a.push(null),r=e.input.charCodeAt(e.position);else if(n=e.line,F(e,t,3,!1,!0),a.push(e.result),T(e,!0,-1),r=e.input.charCodeAt(e.position),(e.line===n||e.lineIndent>t)&&0!==r)E(e,"bad indentation of a sequence entry");else if(e.lineIndent<t)break;return!!s&&(e.tag=o,e.anchor=i,e.kind="sequence",e.result=a,!0)}function L(e){var t,n,r,o,i=!1,a=!1;if(33!==(o=e.input.charCodeAt(e.position)))return!1;if(null!==e.tag&&E(e,"duplication of a tag property"),60===(o=e.input.charCodeAt(++e.position))?(i=!0,o=e.input.charCodeAt(++e.position)):33===o?(a=!0,n="!!",o=e.input.charCodeAt(++e.position)):n="!",t=e.position,i){do{o=e.input.charCodeAt(++e.position)}while(0!==o&&62!==o);e.position<e.length?(r=e.input.slice(t,e.position),o=e.input.charCodeAt(++e.position)):E(e,"unexpected end of the stream within a verbatim tag")}else{for(;0!==o&&!g(o);)33===o&&(a?E(e,"tag suffix cannot contain exclamation marks"):(n=e.input.slice(t-1,e.position+1),p.test(n)||E(e,"named tag handle cannot contain such characters"),a=!0,t=e.position+1)),o=e.input.charCodeAt(++e.position);r=e.input.slice(t,e.position),u.test(r)&&E(e,"tag suffix cannot contain flow indicator characters")}r&&!d.test(r)&&E(e,"tag name cannot contain such characters: "+r);try{r=decodeURIComponent(r)}catch(t){E(e,"tag name is malformed: "+r)}return i?e.tag=r:s.call(e.tagMap,n)?e.tag=e.tagMap[n]+r:"!"===n?e.tag="!"+r:"!!"===n?e.tag="tag:yaml.org,2002:"+r:E(e,'undeclared tag handle "'+n+'"'),!0}function M(e){var t,n;if(38!==(n=e.input.charCodeAt(e.position)))return!1;for(null!==e.anchor&&E(e,"duplication of an anchor property"),n=e.input.charCodeAt(++e.position),t=e.position;0!==n&&!g(n)&&!y(n);)n=e.input.charCodeAt(++e.position);return e.position===t&&E(e,"name of an anchor node must contain at least one character"),e.anchor=e.input.slice(t,e.position),!0}function F(e,t,n,o,i){var a,l,c,u,p,d,f,b,_,O=1,S=!1,P=!1;if(null!==e.listener&&e.listener("open",e),e.tag=null,e.anchor=null,e.kind=null,e.result=null,a=l=c=4===n||3===n,o&&T(e,!0,-1)&&(S=!0,e.lineIndent>t?O=1:e.lineIndent===t?O=0:e.lineIndent<t&&(O=-1)),1===O)for(;L(e)||M(e);)T(e,!0,-1)?(S=!0,c=a,e.lineIndent>t?O=1:e.lineIndent===t?O=0:e.lineIndent<t&&(O=-1)):c=!1;if(c&&(c=S||i),1!==O&&4!==n||(b=1===n||2===n?t:t+1,_=e.position-e.lineStart,1===O?c&&(D(e,_)||function(e,t,n){var r,o,i,a,s,l,c,u=e.tag,p=e.anchor,d={},f=Object.create(null),h=null,y=null,v=null,b=!1,w=!1;if(-1!==e.firstTabInLine)return!1;for(null!==e.anchor&&(e.anchorMap[e.anchor]=d),c=e.input.charCodeAt(e.position);0!==c;){if(b||-1===e.firstTabInLine||(e.position=e.firstTabInLine,E(e,"tab characters must not be used in indentation")),r=e.input.charCodeAt(e.position+1),i=e.line,63!==c&&58!==c||!g(r)){if(a=e.line,s=e.lineStart,l=e.position,!F(e,n,2,!1,!0))break;if(e.line===i){for(c=e.input.charCodeAt(e.position);m(c);)c=e.input.charCodeAt(++e.position);if(58===c)g(c=e.input.charCodeAt(++e.position))||E(e,"a whitespace character is expected after the key-value separator within a block mapping"),b&&(R(e,d,f,h,y,null,a,s,l),h=y=v=null),w=!0,b=!1,o=!1,h=e.tag,y=e.result;else{if(!w)return e.tag=u,e.anchor=p,!0;E(e,"can not read an implicit mapping pair; a colon is missed")}}else{if(!w)return e.tag=u,e.anchor=p,!0;E(e,"can not read a block mapping entry; a multiline key may not be an implicit key")}}else 63===c?(b&&(R(e,d,f,h,y,null,a,s,l),h=y=v=null),w=!0,b=!0,o=!0):b?(b=!1,o=!0):E(e,"incomplete explicit mapping pair; a key node is missed; or followed by a non-tabulated empty line"),e.position+=1,c=r;if((e.line===i||e.lineIndent>t)&&(b&&(a=e.line,s=e.lineStart,l=e.position),F(e,t,4,!0,o)&&(b?y=e.result:v=e.result),b||(R(e,d,f,h,y,v,a,s,l),h=y=v=null),T(e,!0,-1),c=e.input.charCodeAt(e.position)),(e.line===i||e.lineIndent>t)&&0!==c)E(e,"bad indentation of a mapping entry");else if(e.lineIndent<t)break}return b&&R(e,d,f,h,y,null,a,s,l),w&&(e.tag=u,e.anchor=p,e.kind="mapping",e.result=d),w}(e,_,b))||function(e,t){var n,r,o,i,a,s,l,c,u,p,d,f,h=!0,m=e.tag,y=e.anchor,v=Object.create(null);if(91===(f=e.input.charCodeAt(e.position)))a=93,c=!1,i=[];else{if(123!==f)return!1;a=125,c=!0,i={}}for(null!==e.anchor&&(e.anchorMap[e.anchor]=i),f=e.input.charCodeAt(++e.position);0!==f;){if(T(e,!0,t),(f=e.input.charCodeAt(e.position))===a)return e.position++,e.tag=m,e.anchor=y,e.kind=c?"mapping":"sequence",e.result=i,!0;h?44===f&&E(e,"expected the node content, but found ','"):E(e,"missed comma between flow collection entries"),d=null,s=l=!1,63===f&&g(e.input.charCodeAt(e.position+1))&&(s=l=!0,e.position++,T(e,!0,t)),n=e.line,r=e.lineStart,o=e.position,F(e,t,1,!1,!0),p=e.tag,u=e.result,T(e,!0,t),f=e.input.charCodeAt(e.position),!l&&e.line!==n||58!==f||(s=!0,f=e.input.charCodeAt(++e.position),T(e,!0,t),F(e,t,1,!1,!0),d=e.result),c?R(e,i,v,p,u,d,n,r,o):s?i.push(R(e,null,v,p,u,d,n,r,o)):i.push(u),T(e,!0,t),44===(f=e.input.charCodeAt(e.position))?(h=!0,f=e.input.charCodeAt(++e.position)):h=!1}E(e,"unexpected end of the stream within a flow collection")}(e,b)?P=!0:(l&&function(e,t){var n,o,i,a,s,l=1,c=!1,u=!1,p=t,d=0,f=!1;if(124===(a=e.input.charCodeAt(e.position)))o=!1;else{if(62!==a)return!1;o=!0}for(e.kind="scalar",e.result="";0!==a;)if(43===(a=e.input.charCodeAt(++e.position))||45===a)1===l?l=43===a?3:2:E(e,"repeat of a chomping mode identifier");else{if(!((i=48<=(s=a)&&s<=57?s-48:-1)>=0))break;0===i?E(e,"bad explicit indentation width of a block scalar; it cannot be less than one"):u?E(e,"repeat of an indentation width identifier"):(p=t+i-1,u=!0)}if(m(a)){do{a=e.input.charCodeAt(++e.position)}while(m(a));if(35===a)do{a=e.input.charCodeAt(++e.position)}while(!h(a)&&0!==a)}for(;0!==a;){for(j(e),e.lineIndent=0,a=e.input.charCodeAt(e.position);(!u||e.lineIndent<p)&&32===a;)e.lineIndent++,a=e.input.charCodeAt(++e.position);if(!u&&e.lineIndent>p&&(p=e.lineIndent),h(a))d++;else{if(e.lineIndent<p){3===l?e.result+=r.repeat("\n",c?1+d:d):1===l&&c&&(e.result+="\n");break}for(o?m(a)?(f=!0,e.result+=r.repeat("\n",c?1+d:d)):f?(f=!1,e.result+=r.repeat("\n",d+1)):0===d?c&&(e.result+=" "):e.result+=r.repeat("\n",d):e.result+=r.repeat("\n",c?1+d:d),c=!0,u=!0,d=0,n=e.position;!h(a)&&0!==a;)a=e.input.charCodeAt(++e.position);$(e,n,e.position,!1)}}return!0}(e,b)||function(e,t){var n,r,o;if(39!==(n=e.input.charCodeAt(e.position)))return!1;for(e.kind="scalar",e.result="",e.position++,r=o=e.position;0!==(n=e.input.charCodeAt(e.position));)if(39===n){if($(e,r,e.position,!0),39!==(n=e.input.charCodeAt(++e.position)))return!0;r=e.position,e.position++,o=e.position}else h(n)?($(e,r,o,!0),N(e,T(e,!1,t)),r=o=e.position):e.position===e.lineStart&&I(e)?E(e,"unexpected end of the document within a single quoted scalar"):(e.position++,o=e.position);E(e,"unexpected end of the stream within a single quoted scalar")}(e,b)||function(e,t){var n,r,o,i,a,s,l;if(34!==(s=e.input.charCodeAt(e.position)))return!1;for(e.kind="scalar",e.result="",e.position++,n=r=e.position;0!==(s=e.input.charCodeAt(e.position));){if(34===s)return $(e,n,e.position,!0),e.position++,!0;if(92===s){if($(e,n,e.position,!0),h(s=e.input.charCodeAt(++e.position)))T(e,!1,t);else if(s<256&&x[s])e.result+=k[s],e.position++;else if((a=120===(l=s)?2:117===l?4:85===l?8:0)>0){for(o=a,i=0;o>0;o--)(a=v(s=e.input.charCodeAt(++e.position)))>=0?i=(i<<4)+a:E(e,"expected hexadecimal character");e.result+=w(i),e.position++}else E(e,"unknown escape sequence");n=r=e.position}else h(s)?($(e,n,r,!0),N(e,T(e,!1,t)),n=r=e.position):e.position===e.lineStart&&I(e)?E(e,"unexpected end of the document within a double quoted scalar"):(e.position++,r=e.position)}E(e,"unexpected end of the stream within a double quoted scalar")}(e,b)?P=!0:function(e){var t,n,r;if(42!==(r=e.input.charCodeAt(e.position)))return!1;for(r=e.input.charCodeAt(++e.position),t=e.position;0!==r&&!g(r)&&!y(r);)r=e.input.charCodeAt(++e.position);return e.position===t&&E(e,"name of an alias node must contain at least one character"),n=e.input.slice(t,e.position),s.call(e.anchorMap,n)||E(e,'unidentified alias "'+n+'"'),e.result=e.anchorMap[n],T(e,!0,-1),!0}(e)?(P=!0,null===e.tag&&null===e.anchor||E(e,"alias node should not have any properties")):function(e,t,n){var r,o,i,a,s,l,c,u,p=e.kind,d=e.result;if(g(u=e.input.charCodeAt(e.position))||y(u)||35===u||38===u||42===u||33===u||124===u||62===u||39===u||34===u||37===u||64===u||96===u)return!1;if((63===u||45===u)&&(g(r=e.input.charCodeAt(e.position+1))||n&&y(r)))return!1;for(e.kind="scalar",e.result="",o=i=e.position,a=!1;0!==u;){if(58===u){if(g(r=e.input.charCodeAt(e.position+1))||n&&y(r))break}else if(35===u){if(g(e.input.charCodeAt(e.position-1)))break}else{if(e.position===e.lineStart&&I(e)||n&&y(u))break;if(h(u)){if(s=e.line,l=e.lineStart,c=e.lineIndent,T(e,!1,-1),e.lineIndent>=t){a=!0,u=e.input.charCodeAt(e.position);continue}e.position=i,e.line=s,e.lineStart=l,e.lineIndent=c;break}}a&&($(e,o,i,!1),N(e,e.line-s),o=i=e.position,a=!1),m(u)||(i=e.position+1),u=e.input.charCodeAt(++e.position)}return $(e,o,i,!1),!!e.result||(e.kind=p,e.result=d,!1)}(e,b,1===n)&&(P=!0,null===e.tag&&(e.tag="?")),null!==e.anchor&&(e.anchorMap[e.anchor]=e.result)):0===O&&(P=c&&D(e,_))),null===e.tag)null!==e.anchor&&(e.anchorMap[e.anchor]=e.result);else if("?"===e.tag){for(null!==e.result&&"scalar"!==e.kind&&E(e,'unacceptable node kind for !<?> tag; it should be "scalar", not "'+e.kind+'"'),u=0,p=e.implicitTypes.length;u<p;u+=1)if((f=e.implicitTypes[u]).resolve(e.result)){e.result=f.construct(e.result),e.tag=f.tag,null!==e.anchor&&(e.anchorMap[e.anchor]=e.result);break}}else if("!"!==e.tag){if(s.call(e.typeMap[e.kind||"fallback"],e.tag))f=e.typeMap[e.kind||"fallback"][e.tag];else for(f=null,u=0,p=(d=e.typeMap.multi[e.kind||"fallback"]).length;u<p;u+=1)if(e.tag.slice(0,d[u].tag.length)===d[u].tag){f=d[u];break}f||E(e,"unknown tag !<"+e.tag+">"),null!==e.result&&f.kind!==e.kind&&E(e,"unacceptable node kind for !<"+e.tag+'> tag; it should be "'+f.kind+'", not "'+e.kind+'"'),f.resolve(e.result,e.tag)?(e.result=f.construct(e.result,e.tag),null!==e.anchor&&(e.anchorMap[e.anchor]=e.result)):E(e,"cannot resolve a node with !<"+e.tag+"> explicit tag")}return null!==e.listener&&e.listener("close",e),null!==e.tag||null!==e.anchor||P}function z(e){var t,n,r,o,i=e.position,a=!1;for(e.version=null,e.checkLineBreaks=e.legacy,e.tagMap=Object.create(null),e.anchorMap=Object.create(null);0!==(o=e.input.charCodeAt(e.position))&&(T(e,!0,-1),o=e.input.charCodeAt(e.position),!(e.lineIndent>0||37!==o));){for(a=!0,o=e.input.charCodeAt(++e.position),t=e.position;0!==o&&!g(o);)o=e.input.charCodeAt(++e.position);for(r=[],(n=e.input.slice(t,e.position)).length<1&&E(e,"directive name must not be less than one character in length");0!==o;){for(;m(o);)o=e.input.charCodeAt(++e.position);if(35===o){do{o=e.input.charCodeAt(++e.position)}while(0!==o&&!h(o));break}if(h(o))break;for(t=e.position;0!==o&&!g(o);)o=e.input.charCodeAt(++e.position);r.push(e.input.slice(t,e.position))}0!==o&&j(e),s.call(A,n)?A[n](e,n,r):P(e,'unknown document directive "'+n+'"')}T(e,!0,-1),0===e.lineIndent&&45===e.input.charCodeAt(e.position)&&45===e.input.charCodeAt(e.position+1)&&45===e.input.charCodeAt(e.position+2)?(e.position+=3,T(e,!0,-1)):a&&E(e,"directives end mark is expected"),F(e,e.lineIndent-1,4,!1,!0),T(e,!0,-1),e.checkLineBreaks&&c.test(e.input.slice(i,e.position))&&P(e,"non-ASCII line breaks are interpreted as content"),e.documents.push(e.result),e.position===e.lineStart&&I(e)?46===e.input.charCodeAt(e.position)&&(e.position+=3,T(e,!0,-1)):e.position<e.length-1&&E(e,"end of the stream or a document separator is expected")}function U(e,t){t=t||{},0!==(e=String(e)).length&&(10!==e.charCodeAt(e.length-1)&&13!==e.charCodeAt(e.length-1)&&(e+="\n"),65279===e.charCodeAt(0)&&(e=e.slice(1)));var n=new O(e,t),r=e.indexOf("\0");for(-1!==r&&(n.position=r,E(n,"null byte is not allowed in input")),n.input+="\0";32===n.input.charCodeAt(n.position);)n.lineIndent+=1,n.position+=1;for(;n.position<n.length-1;)z(n);return n.documents}e.exports.loadAll=function(e,t,n){null!==t&&"object"==typeof t&&void 0===n&&(n=t,t=null);var r=U(e,n);if("function"!=typeof t)return r;for(var o=0,i=r.length;o<i;o+=1)t(r[o])},e.exports.load=function(e,t){var n=U(e,t);if(0!==n.length){if(1===n.length)return n[0];throw new o("expected a single document in the stream, but found more")}}},7657:function(e,t,n){"use strict";var r=n(8425),o=n(1364);function i(e,t){var n=[];return e[t].forEach((function(e){var t=n.length;n.forEach((function(n,r){n.tag===e.tag&&n.kind===e.kind&&n.multi===e.multi&&(t=r)})),n[t]=e})),n}function a(e){return this.extend(e)}a.prototype.extend=function(e){var t=[],n=[];if(e instanceof o)n.push(e);else if(Array.isArray(e))n=n.concat(e);else{if(!e||!Array.isArray(e.implicit)&&!Array.isArray(e.explicit))throw new r("Schema.extend argument should be a Type, [ Type ], or a schema definition ({ implicit: [...], explicit: [...] })");e.implicit&&(t=t.concat(e.implicit)),e.explicit&&(n=n.concat(e.explicit))}t.forEach((function(e){if(!(e instanceof o))throw new r("Specified list of YAML types (or a single Type object) contains a non-Type object.");if(e.loadKind&&"scalar"!==e.loadKind)throw new r("There is a non-scalar type in the implicit list of a schema. Implicit resolving of such types is not supported.");if(e.multi)throw new r("There is a multi type in the implicit list of a schema. Multi tags can only be listed as explicit.")})),n.forEach((function(e){if(!(e instanceof o))throw new r("Specified list of YAML types (or a single Type object) contains a non-Type object.")}));var s=Object.create(a.prototype);return s.implicit=(this.implicit||[]).concat(t),s.explicit=(this.explicit||[]).concat(n),s.compiledImplicit=i(s,"implicit"),s.compiledExplicit=i(s,"explicit"),s.compiledTypeMap=function(){var e,t,n={scalar:{},sequence:{},mapping:{},fallback:{},multi:{scalar:[],sequence:[],mapping:[],fallback:[]}};function r(e){e.multi?(n.multi[e.kind].push(e),n.multi.fallback.push(e)):n[e.kind][e.tag]=n.fallback[e.tag]=e}for(e=0,t=arguments.length;e<t;e+=1)arguments[e].forEach(r);return n}(s.compiledImplicit,s.compiledExplicit),s},e.exports=a},9471:function(e,t,n){"use strict";e.exports=n(5966)},6601:function(e,t,n){"use strict";e.exports=n(9471).extend({implicit:[n(2156),n(7452)],explicit:[n(3531),n(1605),n(6879),n(4982)]})},4795:function(e,t,n){"use strict";var r=n(7657);e.exports=new r({explicit:[n(48),n(6451),n(945)]})},5966:function(e,t,n){"use strict";e.exports=n(4795).extend({implicit:[n(151),n(8771),n(1518),n(5215)]})},192:function(e,t,n){"use strict";var r=n(8347);function o(e,t,n,r,o){var i="",a="",s=Math.floor(o/2)-1;return r-t>s&&(t=r-s+(i=" ... ").length),n-r>s&&(n=r+s-(a=" ...").length),{str:i+e.slice(t,n).replace(/\t/g,"→")+a,pos:r-t+i.length}}function i(e,t){return r.repeat(" ",t-e.length)+e}e.exports=function(e,t){if(t=Object.create(t||null),!e.buffer)return null;t.maxLength||(t.maxLength=79),"number"!=typeof t.indent&&(t.indent=1),"number"!=typeof t.linesBefore&&(t.linesBefore=3),"number"!=typeof t.linesAfter&&(t.linesAfter=2);for(var n,a=/\r?\n|\r|\0/g,s=[0],l=[],c=-1;n=a.exec(e.buffer);)l.push(n.index),s.push(n.index+n[0].length),e.position<=n.index&&c<0&&(c=s.length-2);c<0&&(c=s.length-1);var u,p,d="",f=Math.min(e.line+t.linesAfter,l.length).toString().length,h=t.maxLength-(t.indent+f+3);for(u=1;u<=t.linesBefore&&!(c-u<0);u++)p=o(e.buffer,s[c-u],l[c-u],e.position-(s[c]-s[c-u]),h),d=r.repeat(" ",t.indent)+i((e.line-u+1).toString(),f)+" | "+p.str+"\n"+d;for(p=o(e.buffer,s[c],l[c],e.position,h),d+=r.repeat(" ",t.indent)+i((e.line+1).toString(),f)+" | "+p.str+"\n",d+=r.repeat("-",t.indent+f+3+p.pos)+"^\n",u=1;u<=t.linesAfter&&!(c+u>=l.length);u++)p=o(e.buffer,s[c+u],l[c+u],e.position-(s[c]-s[c+u]),h),d+=r.repeat(" ",t.indent)+i((e.line+u+1).toString(),f)+" | "+p.str+"\n";return d.replace(/\n$/,"")}},1364:function(e,t,n){"use strict";var r=n(8425),o=["kind","multi","resolve","construct","instanceOf","predicate","represent","representName","defaultStyle","styleAliases"],i=["scalar","sequence","mapping"];e.exports=function(e,t){var n,a;if(t=t||{},Object.keys(t).forEach((function(t){if(-1===o.indexOf(t))throw new r('Unknown option "'+t+'" is met in definition of "'+e+'" YAML type.')})),this.options=t,this.tag=e,this.kind=t.kind||null,this.resolve=t.resolve||function(){return!0},this.construct=t.construct||function(e){return e},this.instanceOf=t.instanceOf||null,this.predicate=t.predicate||null,this.represent=t.represent||null,this.representName=t.representName||null,this.defaultStyle=t.defaultStyle||null,this.multi=t.multi||!1,this.styleAliases=(n=t.styleAliases||null,a={},null!==n&&Object.keys(n).forEach((function(e){n[e].forEach((function(t){a[String(t)]=e}))})),a),-1===i.indexOf(this.kind))throw new r('Unknown kind "'+this.kind+'" is specified for "'+e+'" YAML type.')}},3531:function(e,t,n){"use strict";var r=n(1364),o="ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/=\n\r";e.exports=new r("tag:yaml.org,2002:binary",{kind:"scalar",resolve:function(e){if(null===e)return!1;var t,n,r=0,i=e.length,a=o;for(n=0;n<i;n++)if(!((t=a.indexOf(e.charAt(n)))>64)){if(t<0)return!1;r+=6}return r%8==0},construct:function(e){var t,n,r=e.replace(/[\r\n=]/g,""),i=r.length,a=o,s=0,l=[];for(t=0;t<i;t++)t%4==0&&t&&(l.push(s>>16&255),l.push(s>>8&255),l.push(255&s)),s=s<<6|a.indexOf(r.charAt(t));return 0==(n=i%4*6)?(l.push(s>>16&255),l.push(s>>8&255),l.push(255&s)):18===n?(l.push(s>>10&255),l.push(s>>2&255)):12===n&&l.push(s>>4&255),new Uint8Array(l)},predicate:function(e){return"[object Uint8Array]"===Object.prototype.toString.call(e)},represent:function(e){var t,n,r="",i=0,a=e.length,s=o;for(t=0;t<a;t++)t%3==0&&t&&(r+=s[i>>18&63],r+=s[i>>12&63],r+=s[i>>6&63],r+=s[63&i]),i=(i<<8)+e[t];return 0==(n=a%3)?(r+=s[i>>18&63],r+=s[i>>12&63],r+=s[i>>6&63],r+=s[63&i]):2===n?(r+=s[i>>10&63],r+=s[i>>4&63],r+=s[i<<2&63],r+=s[64]):1===n&&(r+=s[i>>2&63],r+=s[i<<4&63],r+=s[64],r+=s[64]),r}})},8771:function(e,t,n){"use strict";var r=n(1364);e.exports=new r("tag:yaml.org,2002:bool",{kind:"scalar",resolve:function(e){if(null===e)return!1;var t=e.length;return 4===t&&("true"===e||"True"===e||"TRUE"===e)||5===t&&("false"===e||"False"===e||"FALSE"===e)},construct:function(e){return"true"===e||"True"===e||"TRUE"===e},predicate:function(e){return"[object Boolean]"===Object.prototype.toString.call(e)},represent:{lowercase:function(e){return e?"true":"false"},uppercase:function(e){return e?"TRUE":"FALSE"},camelcase:function(e){return e?"True":"False"}},defaultStyle:"lowercase"})},5215:function(e,t,n){"use strict";var r=n(8347),o=n(1364),i=new RegExp("^(?:[-+]?(?:[0-9][0-9_]*)(?:\\.[0-9_]*)?(?:[eE][-+]?[0-9]+)?|\\.[0-9_]+(?:[eE][-+]?[0-9]+)?|[-+]?\\.(?:inf|Inf|INF)|\\.(?:nan|NaN|NAN))$"),a=/^[-+]?[0-9]+e/;e.exports=new o("tag:yaml.org,2002:float",{kind:"scalar",resolve:function(e){return null!==e&&!(!i.test(e)||"_"===e[e.length-1])},construct:function(e){var t,n;return n="-"===(t=e.replace(/_/g,"").toLowerCase())[0]?-1:1,"+-".indexOf(t[0])>=0&&(t=t.slice(1)),".inf"===t?1===n?Number.POSITIVE_INFINITY:Number.NEGATIVE_INFINITY:".nan"===t?NaN:n*parseFloat(t,10)},predicate:function(e){return"[object Number]"===Object.prototype.toString.call(e)&&(e%1!=0||r.isNegativeZero(e))},represent:function(e,t){var n;if(isNaN(e))switch(t){case"lowercase":return".nan";case"uppercase":return".NAN";case"camelcase":return".NaN"}else if(Number.POSITIVE_INFINITY===e)switch(t){case"lowercase":return".inf";case"uppercase":return".INF";case"camelcase":return".Inf"}else if(Number.NEGATIVE_INFINITY===e)switch(t){case"lowercase":return"-.inf";case"uppercase":return"-.INF";case"camelcase":return"-.Inf"}else if(r.isNegativeZero(e))return"-0.0";return n=e.toString(10),a.test(n)?n.replace("e",".e"):n},defaultStyle:"lowercase"})},1518:function(e,t,n){"use strict";var r=n(8347),o=n(1364);function i(e){return 48<=e&&e<=55}function a(e){return 48<=e&&e<=57}e.exports=new o("tag:yaml.org,2002:int",{kind:"scalar",resolve:function(e){if(null===e)return!1;var t,n,r=e.length,o=0,s=!1;if(!r)return!1;if("-"!==(t=e[o])&&"+"!==t||(t=e[++o]),"0"===t){if(o+1===r)return!0;if("b"===(t=e[++o])){for(o++;o<r;o++)if("_"!==(t=e[o])){if("0"!==t&&"1"!==t)return!1;s=!0}return s&&"_"!==t}if("x"===t){for(o++;o<r;o++)if("_"!==(t=e[o])){if(!(48<=(n=e.charCodeAt(o))&&n<=57||65<=n&&n<=70||97<=n&&n<=102))return!1;s=!0}return s&&"_"!==t}if("o"===t){for(o++;o<r;o++)if("_"!==(t=e[o])){if(!i(e.charCodeAt(o)))return!1;s=!0}return s&&"_"!==t}}if("_"===t)return!1;for(;o<r;o++)if("_"!==(t=e[o])){if(!a(e.charCodeAt(o)))return!1;s=!0}return!(!s||"_"===t)},construct:function(e){var t,n=e,r=1;if(-1!==n.indexOf("_")&&(n=n.replace(/_/g,"")),"-"!==(t=n[0])&&"+"!==t||("-"===t&&(r=-1),t=(n=n.slice(1))[0]),"0"===n)return 0;if("0"===t){if("b"===n[1])return r*parseInt(n.slice(2),2);if("x"===n[1])return r*parseInt(n.slice(2),16);if("o"===n[1])return r*parseInt(n.slice(2),8)}return r*parseInt(n,10)},predicate:function(e){return"[object Number]"===Object.prototype.toString.call(e)&&e%1==0&&!r.isNegativeZero(e)},represent:{binary:function(e){return e>=0?"0b"+e.toString(2):"-0b"+e.toString(2).slice(1)},octal:function(e){return e>=0?"0o"+e.toString(8):"-0o"+e.toString(8).slice(1)},decimal:function(e){return e.toString(10)},hexadecimal:function(e){return e>=0?"0x"+e.toString(16).toUpperCase():"-0x"+e.toString(16).toUpperCase().slice(1)}},defaultStyle:"decimal",styleAliases:{binary:[2,"bin"],octal:[8,"oct"],decimal:[10,"dec"],hexadecimal:[16,"hex"]}})},945:function(e,t,n){"use strict";var r=n(1364);e.exports=new r("tag:yaml.org,2002:map",{kind:"mapping",construct:function(e){return null!==e?e:{}}})},7452:function(e,t,n){"use strict";var r=n(1364);e.exports=new r("tag:yaml.org,2002:merge",{kind:"scalar",resolve:function(e){return"<<"===e||null===e}})},151:function(e,t,n){"use strict";var r=n(1364);e.exports=new r("tag:yaml.org,2002:null",{kind:"scalar",resolve:function(e){if(null===e)return!0;var t=e.length;return 1===t&&"~"===e||4===t&&("null"===e||"Null"===e||"NULL"===e)},construct:function(){return null},predicate:function(e){return null===e},represent:{canonical:function(){return"~"},lowercase:function(){return"null"},uppercase:function(){return"NULL"},camelcase:function(){return"Null"},empty:function(){return""}},defaultStyle:"lowercase"})},1605:function(e,t,n){"use strict";var r=n(1364),o=Object.prototype.hasOwnProperty,i=Object.prototype.toString;e.exports=new r("tag:yaml.org,2002:omap",{kind:"sequence",resolve:function(e){if(null===e)return!0;var t,n,r,a,s,l=[],c=e;for(t=0,n=c.length;t<n;t+=1){if(r=c[t],s=!1,"[object Object]"!==i.call(r))return!1;for(a in r)if(o.call(r,a)){if(s)return!1;s=!0}if(!s)return!1;if(-1!==l.indexOf(a))return!1;l.push(a)}return!0},construct:function(e){return null!==e?e:[]}})},6879:function(e,t,n){"use strict";var r=n(1364),o=Object.prototype.toString;e.exports=new r("tag:yaml.org,2002:pairs",{kind:"sequence",resolve:function(e){if(null===e)return!0;var t,n,r,i,a,s=e;for(a=new Array(s.length),t=0,n=s.length;t<n;t+=1){if(r=s[t],"[object Object]"!==o.call(r))return!1;if(1!==(i=Object.keys(r)).length)return!1;a[t]=[i[0],r[i[0]]]}return!0},construct:function(e){if(null===e)return[];var t,n,r,o,i,a=e;for(i=new Array(a.length),t=0,n=a.length;t<n;t+=1)r=a[t],o=Object.keys(r),i[t]=[o[0],r[o[0]]];return i}})},6451:function(e,t,n){"use strict";var r=n(1364);e.exports=new r("tag:yaml.org,2002:seq",{kind:"sequence",construct:function(e){return null!==e?e:[]}})},4982:function(e,t,n){"use strict";var r=n(1364),o=Object.prototype.hasOwnProperty;e.exports=new r("tag:yaml.org,2002:set",{kind:"mapping",resolve:function(e){if(null===e)return!0;var t,n=e;for(t in n)if(o.call(n,t)&&null!==n[t])return!1;return!0},construct:function(e){return null!==e?e:{}}})},48:function(e,t,n){"use strict";var r=n(1364);e.exports=new r("tag:yaml.org,2002:str",{kind:"scalar",construct:function(e){return null!==e?e:""}})},2156:function(e,t,n){"use strict";var r=n(1364),o=new RegExp("^([0-9][0-9][0-9][0-9])-([0-9][0-9])-([0-9][0-9])$"),i=new RegExp("^([0-9][0-9][0-9][0-9])-([0-9][0-9]?)-([0-9][0-9]?)(?:[Tt]|[ \\t]+)([0-9][0-9]?):([0-9][0-9]):([0-9][0-9])(?:\\.([0-9]*))?(?:[ \\t]*(Z|([-+])([0-9][0-9]?)(?::([0-9][0-9]))?))?$");e.exports=new r("tag:yaml.org,2002:timestamp",{kind:"scalar",resolve:function(e){return null!==e&&(null!==o.exec(e)||null!==i.exec(e))},construct:function(e){var t,n,r,a,s,l,c,u,p=0,d=null;if(null===(t=o.exec(e))&&(t=i.exec(e)),null===t)throw new Error("Date resolve error");if(n=+t[1],r=+t[2]-1,a=+t[3],!t[4])return new Date(Date.UTC(n,r,a));if(s=+t[4],l=+t[5],c=+t[6],t[7]){for(p=t[7].slice(0,3);p.length<3;)p+="0";p=+p}return t[9]&&(d=6e4*(60*+t[10]+ +(t[11]||0)),"-"===t[9]&&(d=-d)),u=new Date(Date.UTC(n,r,a,s,l,c,p)),d&&u.setTime(u.getTime()-d),u},instanceOf:Date,represent:function(e){return e.toISOString()}})},3573:function(e,t,n){"use strict";var r=n(9804);function o(e,t,n){if(3===arguments.length)return o.set(e,t,n);if(2===arguments.length)return o.get(e,t);var r=o.bind(o,e);for(var i in o)o.hasOwnProperty(i)&&(r[i]=o[i].bind(r,e));return r}e.exports=o,o.get=function(e,t){for(var n=Array.isArray(t)?t:o.parse(t),r=0;r<n.length;++r){var i=n[r];if("object"!=typeof e||!(i in e))throw new Error("Invalid reference token: "+i);e=e[i]}return e},o.set=function(e,t,n){var r=Array.isArray(t)?t:o.parse(t),i=r[0];if(0===r.length)throw Error("Can not set the root object");for(var a=0;a<r.length-1;++a){var s=r[a];"string"!=typeof s&&"number"!=typeof s&&(s=String(s)),"__proto__"!==s&&"constructor"!==s&&"prototype"!==s&&("-"===s&&Array.isArray(e)&&(s=e.length),i=r[a+1],s in e||(i.match(/^(\d+|-)$/)?e[s]=[]:e[s]={}),e=e[s])}return"-"===i&&Array.isArray(e)&&(i=e.length),e[i]=n,this},o.remove=function(e,t){var n=Array.isArray(t)?t:o.parse(t),r=n[n.length-1];if(void 0===r)throw new Error('Invalid JSON pointer for remove: "'+t+'"');var i=o.get(e,n.slice(0,-1));if(Array.isArray(i)){var a=+r;if(""===r&&isNaN(a))throw new Error('Invalid array index: "'+r+'"');Array.prototype.splice.call(i,a,1)}else delete i[r]},o.dict=function(e,t){var n={};return o.walk(e,(function(e,t){n[t]=e}),t),n},o.walk=function(e,t,n){var i=[];n=n||function(e){var t=Object.prototype.toString.call(e);return"[object Object]"===t||"[object Array]"===t},function e(a){r(a,(function(r,a){i.push(String(a)),n(r)?e(r):t(r,o.compile(i)),i.pop()}))}(e)},o.has=function(e,t){try{o.get(e,t)}catch(e){return!1}return!0},o.escape=function(e){return e.toString().replace(/~/g,"~0").replace(/\//g,"~1")},o.unescape=function(e){return e.replace(/~1/g,"/").replace(/~0/g,"~")},o.parse=function(e){if(""===e)return[];if("/"!==e.charAt(0))throw new Error("Invalid JSON pointer: "+e);return e.substring(1).split(/\//).map(o.unescape)},o.compile=function(e){return 0===e.length?"":"/"+e.map(o.escape).join("/")}},2307:function(e,t,n){e=n.nmd(e);var r="__lodash_hash_undefined__",o=9007199254740991,i="[object Arguments]",a="[object Array]",s="[object Boolean]",l="[object Date]",c="[object Error]",u="[object Function]",p="[object Map]",d="[object Number]",f="[object Object]",h="[object Promise]",m="[object RegExp]",g="[object Set]",y="[object String]",v="[object WeakMap]",b="[object ArrayBuffer]",w="[object DataView]",x=/^\[object .+?Constructor\]$/,k=/^(?:0|[1-9]\d*)$/,_={};_["[object Float32Array]"]=_["[object Float64Array]"]=_["[object Int8Array]"]=_["[object Int16Array]"]=_["[object Int32Array]"]=_["[object Uint8Array]"]=_["[object Uint8ClampedArray]"]=_["[object Uint16Array]"]=_["[object Uint32Array]"]=!0,_[i]=_[a]=_[b]=_[s]=_[w]=_[l]=_[c]=_[u]=_[p]=_[d]=_[f]=_[m]=_[g]=_[y]=_[v]=!1;var O="object"==typeof n.g&&n.g&&n.g.Object===Object&&n.g,S="object"==typeof self&&self&&self.Object===Object&&self,E=O||S||Function("return this")(),P=t&&!t.nodeType&&t,A=P&&e&&!e.nodeType&&e,$=A&&A.exports===P,C=$&&O.process,R=function(){try{return C&&C.binding&&C.binding("util")}catch(e){}}(),j=R&&R.isTypedArray;function T(e,t){for(var n=-1,r=null==e?0:e.length;++n<r;)if(t(e[n],n,e))return!0;return!1}function I(e,t){return e.has(t)}function N(e){var t=-1,n=Array(e.size);return e.forEach((function(e,r){n[++t]=[r,e]})),n}function D(e){var t=-1,n=Array(e.size);return e.forEach((function(e){n[++t]=e})),n}var L,M,F,z=Array.prototype,U=Function.prototype,V=Object.prototype,B=E["__core-js_shared__"],q=U.toString,W=V.hasOwnProperty,H=(L=/[^.]+$/.exec(B&&B.keys&&B.keys.IE_PROTO||""))?"Symbol(src)_1."+L:"",Y=V.toString,K=RegExp("^"+q.call(W).replace(/[\\^$.*+?()[\]{}|]/g,"\\$&").replace(/hasOwnProperty|(function).*?(?=\\\()| for .+?(?=\\\])/g,"$1.*?")+"$"),G=$?E.Buffer:void 0,Q=E.Symbol,X=E.Uint8Array,J=V.propertyIsEnumerable,Z=z.splice,ee=Q?Q.toStringTag:void 0,te=Object.getOwnPropertySymbols,ne=G?G.isBuffer:void 0,re=(M=Object.keys,F=Object,function(e){return M(F(e))}),oe=$e(E,"DataView"),ie=$e(E,"Map"),ae=$e(E,"Promise"),se=$e(E,"Set"),le=$e(E,"WeakMap"),ce=$e(Object,"create"),ue=Te(oe),pe=Te(ie),de=Te(ae),fe=Te(se),he=Te(le),me=Q?Q.prototype:void 0,ge=me?me.valueOf:void 0;function ye(e){var t=-1,n=null==e?0:e.length;for(this.clear();++t<n;){var r=e[t];this.set(r[0],r[1])}}function ve(e){var t=-1,n=null==e?0:e.length;for(this.clear();++t<n;){var r=e[t];this.set(r[0],r[1])}}function be(e){var t=-1,n=null==e?0:e.length;for(this.clear();++t<n;){var r=e[t];this.set(r[0],r[1])}}function we(e){var t=-1,n=null==e?0:e.length;for(this.__data__=new be;++t<n;)this.add(e[t])}function xe(e){var t=this.__data__=new ve(e);this.size=t.size}function ke(e,t){for(var n=e.length;n--;)if(Ie(e[n][0],t))return n;return-1}function _e(e){return null==e?void 0===e?"[object Undefined]":"[object Null]":ee&&ee in Object(e)?function(e){var t=W.call(e,ee),n=e[ee];try{e[ee]=void 0;var r=!0}catch(e){}var o=Y.call(e);return r&&(t?e[ee]=n:delete e[ee]),o}(e):function(e){return Y.call(e)}(e)}function Oe(e){return Ue(e)&&_e(e)==i}function Se(e,t,n,r,o){return e===t||(null==e||null==t||!Ue(e)&&!Ue(t)?e!=e&&t!=t:function(e,t,n,r,o,u){var h=De(e),v=De(t),x=h?a:Re(e),k=v?a:Re(t),_=(x=x==i?f:x)==f,O=(k=k==i?f:k)==f,S=x==k;if(S&&Le(e)){if(!Le(t))return!1;h=!0,_=!1}if(S&&!_)return u||(u=new xe),h||Ve(e)?Ee(e,t,n,r,o,u):function(e,t,n,r,o,i,a){switch(n){case w:if(e.byteLength!=t.byteLength||e.byteOffset!=t.byteOffset)return!1;e=e.buffer,t=t.buffer;case b:return!(e.byteLength!=t.byteLength||!i(new X(e),new X(t)));case s:case l:case d:return Ie(+e,+t);case c:return e.name==t.name&&e.message==t.message;case m:case y:return e==t+"";case p:var u=N;case g:var f=1&r;if(u||(u=D),e.size!=t.size&&!f)return!1;var h=a.get(e);if(h)return h==t;r|=2,a.set(e,t);var v=Ee(u(e),u(t),r,o,i,a);return a.delete(e),v;case"[object Symbol]":if(ge)return ge.call(e)==ge.call(t)}return!1}(e,t,x,n,r,o,u);if(!(1&n)){var E=_&&W.call(e,"__wrapped__"),P=O&&W.call(t,"__wrapped__");if(E||P){var A=E?e.value():e,$=P?t.value():t;return u||(u=new xe),o(A,$,n,r,u)}}return!!S&&(u||(u=new xe),function(e,t,n,r,o,i){var a=1&n,s=Pe(e),l=s.length;if(l!=Pe(t).length&&!a)return!1;for(var c=l;c--;){var u=s[c];if(!(a?u in t:W.call(t,u)))return!1}var p=i.get(e);if(p&&i.get(t))return p==t;var d=!0;i.set(e,t),i.set(t,e);for(var f=a;++c<l;){var h=e[u=s[c]],m=t[u];if(r)var g=a?r(m,h,u,t,e,i):r(h,m,u,e,t,i);if(!(void 0===g?h===m||o(h,m,n,r,i):g)){d=!1;break}f||(f="constructor"==u)}if(d&&!f){var y=e.constructor,v=t.constructor;y==v||!("constructor"in e)||!("constructor"in t)||"function"==typeof y&&y instanceof y&&"function"==typeof v&&v instanceof v||(d=!1)}return i.delete(e),i.delete(t),d}(e,t,n,r,o,u))}(e,t,n,r,Se,o))}function Ee(e,t,n,r,o,i){var a=1&n,s=e.length,l=t.length;if(s!=l&&!(a&&l>s))return!1;var c=i.get(e);if(c&&i.get(t))return c==t;var u=-1,p=!0,d=2&n?new we:void 0;for(i.set(e,t),i.set(t,e);++u<s;){var f=e[u],h=t[u];if(r)var m=a?r(h,f,u,t,e,i):r(f,h,u,e,t,i);if(void 0!==m){if(m)continue;p=!1;break}if(d){if(!T(t,(function(e,t){if(!I(d,t)&&(f===e||o(f,e,n,r,i)))return d.push(t)}))){p=!1;break}}else if(f!==h&&!o(f,h,n,r,i)){p=!1;break}}return i.delete(e),i.delete(t),p}function Pe(e){return function(e,t,n){var r=t(e);return De(e)?r:function(e,t){for(var n=-1,r=t.length,o=e.length;++n<r;)e[o+n]=t[n];return e}(r,n(e))}(e,Be,Ce)}function Ae(e,t){var n,r,o=e.__data__;return("string"==(r=typeof(n=t))||"number"==r||"symbol"==r||"boolean"==r?"__proto__"!==n:null===n)?o["string"==typeof t?"string":"hash"]:o.map}function $e(e,t){var n=function(e,t){return null==e?void 0:e[t]}(e,t);return function(e){return!(!ze(e)||function(e){return!!H&&H in e}(e))&&(Me(e)?K:x).test(Te(e))}(n)?n:void 0}ye.prototype.clear=function(){this.__data__=ce?ce(null):{},this.size=0},ye.prototype.delete=function(e){var t=this.has(e)&&delete this.__data__[e];return this.size-=t?1:0,t},ye.prototype.get=function(e){var t=this.__data__;if(ce){var n=t[e];return n===r?void 0:n}return W.call(t,e)?t[e]:void 0},ye.prototype.has=function(e){var t=this.__data__;return ce?void 0!==t[e]:W.call(t,e)},ye.prototype.set=function(e,t){var n=this.__data__;return this.size+=this.has(e)?0:1,n[e]=ce&&void 0===t?r:t,this},ve.prototype.clear=function(){this.__data__=[],this.size=0},ve.prototype.delete=function(e){var t=this.__data__,n=ke(t,e);return!(n<0||(n==t.length-1?t.pop():Z.call(t,n,1),--this.size,0))},ve.prototype.get=function(e){var t=this.__data__,n=ke(t,e);return n<0?void 0:t[n][1]},ve.prototype.has=function(e){return ke(this.__data__,e)>-1},ve.prototype.set=function(e,t){var n=this.__data__,r=ke(n,e);return r<0?(++this.size,n.push([e,t])):n[r][1]=t,this},be.prototype.clear=function(){this.size=0,this.__data__={hash:new ye,map:new(ie||ve),string:new ye}},be.prototype.delete=function(e){var t=Ae(this,e).delete(e);return this.size-=t?1:0,t},be.prototype.get=function(e){return Ae(this,e).get(e)},be.prototype.has=function(e){return Ae(this,e).has(e)},be.prototype.set=function(e,t){var n=Ae(this,e),r=n.size;return n.set(e,t),this.size+=n.size==r?0:1,this},we.prototype.add=we.prototype.push=function(e){return this.__data__.set(e,r),this},we.prototype.has=function(e){return this.__data__.has(e)},xe.prototype.clear=function(){this.__data__=new ve,this.size=0},xe.prototype.delete=function(e){var t=this.__data__,n=t.delete(e);return this.size=t.size,n},xe.prototype.get=function(e){return this.__data__.get(e)},xe.prototype.has=function(e){return this.__data__.has(e)},xe.prototype.set=function(e,t){var n=this.__data__;if(n instanceof ve){var r=n.__data__;if(!ie||r.length<199)return r.push([e,t]),this.size=++n.size,this;n=this.__data__=new be(r)}return n.set(e,t),this.size=n.size,this};var Ce=te?function(e){return null==e?[]:(e=Object(e),function(t,n){for(var r=-1,o=null==t?0:t.length,i=0,a=[];++r<o;){var s=t[r];l=s,J.call(e,l)&&(a[i++]=s)}var l;return a}(te(e)))}:function(){return[]},Re=_e;function je(e,t){return!!(t=null==t?o:t)&&("number"==typeof e||k.test(e))&&e>-1&&e%1==0&&e<t}function Te(e){if(null!=e){try{return q.call(e)}catch(e){}try{return e+""}catch(e){}}return""}function Ie(e,t){return e===t||e!=e&&t!=t}(oe&&Re(new oe(new ArrayBuffer(1)))!=w||ie&&Re(new ie)!=p||ae&&Re(ae.resolve())!=h||se&&Re(new se)!=g||le&&Re(new le)!=v)&&(Re=function(e){var t=_e(e),n=t==f?e.constructor:void 0,r=n?Te(n):"";if(r)switch(r){case ue:return w;case pe:return p;case de:return h;case fe:return g;case he:return v}return t});var Ne=Oe(function(){return arguments}())?Oe:function(e){return Ue(e)&&W.call(e,"callee")&&!J.call(e,"callee")},De=Array.isArray,Le=ne||function(){return!1};function Me(e){if(!ze(e))return!1;var t=_e(e);return t==u||"[object GeneratorFunction]"==t||"[object AsyncFunction]"==t||"[object Proxy]"==t}function Fe(e){return"number"==typeof e&&e>-1&&e%1==0&&e<=o}function ze(e){var t=typeof e;return null!=e&&("object"==t||"function"==t)}function Ue(e){return null!=e&&"object"==typeof e}var Ve=j?function(e){return function(t){return e(t)}}(j):function(e){return Ue(e)&&Fe(e.length)&&!!_[_e(e)]};function Be(e){return null!=(t=e)&&Fe(t.length)&&!Me(t)?function(e,t){var n=De(e),r=!n&&Ne(e),o=!n&&!r&&Le(e),i=!n&&!r&&!o&&Ve(e),a=n||r||o||i,s=a?function(e,t){for(var n=-1,r=Array(e);++n<e;)r[n]=t(n);return r}(e.length,String):[],l=s.length;for(var c in e)!t&&!W.call(e,c)||a&&("length"==c||o&&("offset"==c||"parent"==c)||i&&("buffer"==c||"byteLength"==c||"byteOffset"==c)||je(c,l))||s.push(c);return s}(e):function(e){if(n=(t=e)&&t.constructor,t!==("function"==typeof n&&n.prototype||V))return re(e);var t,n,r=[];for(var o in Object(e))W.call(e,o)&&"constructor"!=o&&r.push(o);return r}(e);var t}e.exports=function(e,t){return Se(e,t)}},4798:function(e){e.exports=function(){}},813:function(e){e.exports=function(){"use strict";var e="function"==typeof Symbol&&"symbol"==typeof Symbol.iterator?function(e){return typeof e}:function(e){return e&&"function"==typeof Symbol&&e.constructor===Symbol&&e!==Symbol.prototype?"symbol":typeof e},t=function(e,t){if(!(e instanceof t))throw new TypeError("Cannot call a class as a function")},n=function(){function e(e,t){for(var n=0;n<t.length;n++){var r=t[n];r.enumerable=r.enumerable||!1,r.configurable=!0,"value"in r&&(r.writable=!0),Object.defineProperty(e,r.key,r)}}return function(t,n,r){return n&&e(t.prototype,n),r&&e(t,r),t}}(),r=Object.assign||function(e){for(var t=1;t<arguments.length;t++){var n=arguments[t];for(var r in n)Object.prototype.hasOwnProperty.call(n,r)&&(e[r]=n[r])}return e},o=function(){function e(n){var r=!(arguments.length>1&&void 0!==arguments[1])||arguments[1],o=arguments.length>2&&void 0!==arguments[2]?arguments[2]:[],i=arguments.length>3&&void 0!==arguments[3]?arguments[3]:5e3;t(this,e),this.ctx=n,this.iframes=r,this.exclude=o,this.iframesTimeout=i}return n(e,[{key:"getContexts",value:function(){var e=[];return(void 0!==this.ctx&&this.ctx?NodeList.prototype.isPrototypeOf(this.ctx)?Array.prototype.slice.call(this.ctx):Array.isArray(this.ctx)?this.ctx:"string"==typeof this.ctx?Array.prototype.slice.call(document.querySelectorAll(this.ctx)):[this.ctx]:[]).forEach((function(t){var n=e.filter((function(e){return e.contains(t)})).length>0;-1!==e.indexOf(t)||n||e.push(t)})),e}},{key:"getIframeContents",value:function(e,t){var n=arguments.length>2&&void 0!==arguments[2]?arguments[2]:function(){},r=void 0;try{var o=e.contentWindow;if(r=o.document,!o||!r)throw new Error("iframe inaccessible")}catch(e){n()}r&&t(r)}},{key:"isIframeBlank",value:function(e){var t="about:blank",n=e.getAttribute("src").trim();return e.contentWindow.location.href===t&&n!==t&&n}},{key:"observeIframeLoad",value:function(e,t,n){var r=this,o=!1,i=null,a=function a(){if(!o){o=!0,clearTimeout(i);try{r.isIframeBlank(e)||(e.removeEventListener("load",a),r.getIframeContents(e,t,n))}catch(e){n()}}};e.addEventListener("load",a),i=setTimeout(a,this.iframesTimeout)}},{key:"onIframeReady",value:function(e,t,n){try{"complete"===e.contentWindow.document.readyState?this.isIframeBlank(e)?this.observeIframeLoad(e,t,n):this.getIframeContents(e,t,n):this.observeIframeLoad(e,t,n)}catch(e){n()}}},{key:"waitForIframes",value:function(e,t){var n=this,r=0;this.forEachIframe(e,(function(){return!0}),(function(e){r++,n.waitForIframes(e.querySelector("html"),(function(){--r||t()}))}),(function(e){e||t()}))}},{key:"forEachIframe",value:function(t,n,r){var o=this,i=arguments.length>3&&void 0!==arguments[3]?arguments[3]:function(){},a=t.querySelectorAll("iframe"),s=a.length,l=0;a=Array.prototype.slice.call(a);var c=function(){--s<=0&&i(l)};s||c(),a.forEach((function(t){e.matches(t,o.exclude)?c():o.onIframeReady(t,(function(e){n(t)&&(l++,r(e)),c()}),c)}))}},{key:"createIterator",value:function(e,t,n){return document.createNodeIterator(e,t,n,!1)}},{key:"createInstanceOnIframe",value:function(t){return new e(t.querySelector("html"),this.iframes)}},{key:"compareNodeIframe",value:function(e,t,n){if(e.compareDocumentPosition(n)&Node.DOCUMENT_POSITION_PRECEDING){if(null===t)return!0;if(t.compareDocumentPosition(n)&Node.DOCUMENT_POSITION_FOLLOWING)return!0}return!1}},{key:"getIteratorNode",value:function(e){var t=e.previousNode();return{prevNode:t,node:(null===t||e.nextNode())&&e.nextNode()}}},{key:"checkIframeFilter",value:function(e,t,n,r){var o=!1,i=!1;return r.forEach((function(e,t){e.val===n&&(o=t,i=e.handled)})),this.compareNodeIframe(e,t,n)?(!1!==o||i?!1===o||i||(r[o].handled=!0):r.push({val:n,handled:!0}),!0):(!1===o&&r.push({val:n,handled:!1}),!1)}},{key:"handleOpenIframes",value:function(e,t,n,r){var o=this;e.forEach((function(e){e.handled||o.getIframeContents(e.val,(function(e){o.createInstanceOnIframe(e).forEachNode(t,n,r)}))}))}},{key:"iterateThroughNodes",value:function(e,t,n,r,o){for(var i=this,a=this.createIterator(t,e,r),s=[],l=[],c=void 0,u=void 0;p=void 0,p=i.getIteratorNode(a),u=p.prevNode,c=p.node;)this.iframes&&this.forEachIframe(t,(function(e){return i.checkIframeFilter(c,u,e,s)}),(function(t){i.createInstanceOnIframe(t).forEachNode(e,(function(e){return l.push(e)}),r)})),l.push(c);var p;l.forEach((function(e){n(e)})),this.iframes&&this.handleOpenIframes(s,e,n,r),o()}},{key:"forEachNode",value:function(e,t,n){var r=this,o=arguments.length>3&&void 0!==arguments[3]?arguments[3]:function(){},i=this.getContexts(),a=i.length;a||o(),i.forEach((function(i){var s=function(){r.iterateThroughNodes(e,i,t,n,(function(){--a<=0&&o()}))};r.iframes?r.waitForIframes(i,s):s()}))}}],[{key:"matches",value:function(e,t){var n="string"==typeof t?[t]:t,r=e.matches||e.matchesSelector||e.msMatchesSelector||e.mozMatchesSelector||e.oMatchesSelector||e.webkitMatchesSelector;if(r){var o=!1;return n.every((function(t){return!r.call(e,t)||(o=!0,!1)})),o}return!1}}]),e}(),i=function(){function i(e){t(this,i),this.ctx=e,this.ie=!1;var n=window.navigator.userAgent;(n.indexOf("MSIE")>-1||n.indexOf("Trident")>-1)&&(this.ie=!0)}return n(i,[{key:"log",value:function(t){var n=arguments.length>1&&void 0!==arguments[1]?arguments[1]:"debug",r=this.opt.log;this.opt.debug&&"object"===(void 0===r?"undefined":e(r))&&"function"==typeof r[n]&&r[n]("mark.js: "+t)}},{key:"escapeStr",value:function(e){return e.replace(/[\-\[\]\/\{\}\(\)\*\+\?\.\\\^\$\|]/g,"\\$&")}},{key:"createRegExp",value:function(e){return"disabled"!==this.opt.wildcards&&(e=this.setupWildcardsRegExp(e)),e=this.escapeStr(e),Object.keys(this.opt.synonyms).length&&(e=this.createSynonymsRegExp(e)),(this.opt.ignoreJoiners||this.opt.ignorePunctuation.length)&&(e=this.setupIgnoreJoinersRegExp(e)),this.opt.diacritics&&(e=this.createDiacriticsRegExp(e)),e=this.createMergedBlanksRegExp(e),(this.opt.ignoreJoiners||this.opt.ignorePunctuation.length)&&(e=this.createJoinersRegExp(e)),"disabled"!==this.opt.wildcards&&(e=this.createWildcardsRegExp(e)),this.createAccuracyRegExp(e)}},{key:"createSynonymsRegExp",value:function(e){var t=this.opt.synonyms,n=this.opt.caseSensitive?"":"i",r=this.opt.ignoreJoiners||this.opt.ignorePunctuation.length?"\0":"";for(var o in t)if(t.hasOwnProperty(o)){var i=t[o],a="disabled"!==this.opt.wildcards?this.setupWildcardsRegExp(o):this.escapeStr(o),s="disabled"!==this.opt.wildcards?this.setupWildcardsRegExp(i):this.escapeStr(i);""!==a&&""!==s&&(e=e.replace(new RegExp("("+this.escapeStr(a)+"|"+this.escapeStr(s)+")","gm"+n),r+"("+this.processSynomyms(a)+"|"+this.processSynomyms(s)+")"+r))}return e}},{key:"processSynomyms",value:function(e){return(this.opt.ignoreJoiners||this.opt.ignorePunctuation.length)&&(e=this.setupIgnoreJoinersRegExp(e)),e}},{key:"setupWildcardsRegExp",value:function(e){return(e=e.replace(/(?:\\)*\?/g,(function(e){return"\\"===e.charAt(0)?"?":""}))).replace(/(?:\\)*\*/g,(function(e){return"\\"===e.charAt(0)?"*":""}))}},{key:"createWildcardsRegExp",value:function(e){var t="withSpaces"===this.opt.wildcards;return e.replace(/\u0001/g,t?"[\\S\\s]?":"\\S?").replace(/\u0002/g,t?"[\\S\\s]*?":"\\S*")}},{key:"setupIgnoreJoinersRegExp",value:function(e){return e.replace(/[^(|)\\]/g,(function(e,t,n){var r=n.charAt(t+1);return/[(|)\\]/.test(r)||""===r?e:e+"\0"}))}},{key:"createJoinersRegExp",value:function(e){var t=[],n=this.opt.ignorePunctuation;return Array.isArray(n)&&n.length&&t.push(this.escapeStr(n.join(""))),this.opt.ignoreJoiners&&t.push("\\u00ad\\u200b\\u200c\\u200d"),t.length?e.split(/\u0000+/).join("["+t.join("")+"]*"):e}},{key:"createDiacriticsRegExp",value:function(e){var t=this.opt.caseSensitive?"":"i",n=this.opt.caseSensitive?["aàáảãạăằắẳẵặâầấẩẫậäåāą","AÀÁẢÃẠĂẰẮẲẴẶÂẦẤẨẪẬÄÅĀĄ","cçćč","CÇĆČ","dđď","DĐĎ","eèéẻẽẹêềếểễệëěēę","EÈÉẺẼẸÊỀẾỂỄỆËĚĒĘ","iìíỉĩịîïī","IÌÍỈĨỊÎÏĪ","lł","LŁ","nñňń","NÑŇŃ","oòóỏõọôồốổỗộơởỡớờợöøō","OÒÓỎÕỌÔỒỐỔỖỘƠỞỠỚỜỢÖØŌ","rř","RŘ","sšśșş","SŠŚȘŞ","tťțţ","TŤȚŢ","uùúủũụưừứửữựûüůū","UÙÚỦŨỤƯỪỨỬỮỰÛÜŮŪ","yýỳỷỹỵÿ","YÝỲỶỸỴŸ","zžżź","ZŽŻŹ"]:["aàáảãạăằắẳẵặâầấẩẫậäåāąAÀÁẢÃẠĂẰẮẲẴẶÂẦẤẨẪẬÄÅĀĄ","cçćčCÇĆČ","dđďDĐĎ","eèéẻẽẹêềếểễệëěēęEÈÉẺẼẸÊỀẾỂỄỆËĚĒĘ","iìíỉĩịîïīIÌÍỈĨỊÎÏĪ","lłLŁ","nñňńNÑŇŃ","oòóỏõọôồốổỗộơởỡớờợöøōOÒÓỎÕỌÔỒỐỔỖỘƠỞỠỚỜỢÖØŌ","rřRŘ","sšśșşSŠŚȘŞ","tťțţTŤȚŢ","uùúủũụưừứửữựûüůūUÙÚỦŨỤƯỪỨỬỮỰÛÜŮŪ","yýỳỷỹỵÿYÝỲỶỸỴŸ","zžżźZŽŻŹ"],r=[];return e.split("").forEach((function(o){n.every((function(n){if(-1!==n.indexOf(o)){if(r.indexOf(n)>-1)return!1;e=e.replace(new RegExp("["+n+"]","gm"+t),"["+n+"]"),r.push(n)}return!0}))})),e}},{key:"createMergedBlanksRegExp",value:function(e){return e.replace(/[\s]+/gim,"[\\s]+")}},{key:"createAccuracyRegExp",value:function(e){var t=this,n=this.opt.accuracy,r="string"==typeof n?n:n.value,o="string"==typeof n?[]:n.limiters,i="";switch(o.forEach((function(e){i+="|"+t.escapeStr(e)})),r){case"partially":default:return"()("+e+")";case"complementary":return"()([^"+(i="\\s"+(i||this.escapeStr("!\"#$%&'()*+,-./:;<=>?@[\\]^_`{|}~¡¿")))+"]*"+e+"[^"+i+"]*)";case"exactly":return"(^|\\s"+i+")("+e+")(?=$|\\s"+i+")"}}},{key:"getSeparatedKeywords",value:function(e){var t=this,n=[];return e.forEach((function(e){t.opt.separateWordSearch?e.split(" ").forEach((function(e){e.trim()&&-1===n.indexOf(e)&&n.push(e)})):e.trim()&&-1===n.indexOf(e)&&n.push(e)})),{keywords:n.sort((function(e,t){return t.length-e.length})),length:n.length}}},{key:"isNumeric",value:function(e){return Number(parseFloat(e))==e}},{key:"checkRanges",value:function(e){var t=this;if(!Array.isArray(e)||"[object Object]"!==Object.prototype.toString.call(e[0]))return this.log("markRanges() will only accept an array of objects"),this.opt.noMatch(e),[];var n=[],r=0;return e.sort((function(e,t){return e.start-t.start})).forEach((function(e){var o=t.callNoMatchOnInvalidRanges(e,r),i=o.start,a=o.end;o.valid&&(e.start=i,e.length=a-i,n.push(e),r=a)})),n}},{key:"callNoMatchOnInvalidRanges",value:function(e,t){var n=void 0,r=void 0,o=!1;return e&&void 0!==e.start?(r=(n=parseInt(e.start,10))+parseInt(e.length,10),this.isNumeric(e.start)&&this.isNumeric(e.length)&&r-t>0&&r-n>0?o=!0:(this.log("Ignoring invalid or overlapping range: "+JSON.stringify(e)),this.opt.noMatch(e))):(this.log("Ignoring invalid range: "+JSON.stringify(e)),this.opt.noMatch(e)),{start:n,end:r,valid:o}}},{key:"checkWhitespaceRanges",value:function(e,t,n){var r=void 0,o=!0,i=n.length,a=t-i,s=parseInt(e.start,10)-a;return(r=(s=s>i?i:s)+parseInt(e.length,10))>i&&(r=i,this.log("End range automatically set to the max value of "+i)),s<0||r-s<0||s>i||r>i?(o=!1,this.log("Invalid range: "+JSON.stringify(e)),this.opt.noMatch(e)):""===n.substring(s,r).replace(/\s+/g,"")&&(o=!1,this.log("Skipping whitespace only range: "+JSON.stringify(e)),this.opt.noMatch(e)),{start:s,end:r,valid:o}}},{key:"getTextNodes",value:function(e){var t=this,n="",r=[];this.iterator.forEachNode(NodeFilter.SHOW_TEXT,(function(e){r.push({start:n.length,end:(n+=e.textContent).length,node:e})}),(function(e){return t.matchesExclude(e.parentNode)?NodeFilter.FILTER_REJECT:NodeFilter.FILTER_ACCEPT}),(function(){e({value:n,nodes:r})}))}},{key:"matchesExclude",value:function(e){return o.matches(e,this.opt.exclude.concat(["script","style","title","head","html"]))}},{key:"wrapRangeInTextNode",value:function(e,t,n){var r=this.opt.element?this.opt.element:"mark",o=e.splitText(t),i=o.splitText(n-t),a=document.createElement(r);return a.setAttribute("data-markjs","true"),this.opt.className&&a.setAttribute("class",this.opt.className),a.textContent=o.textContent,o.parentNode.replaceChild(a,o),i}},{key:"wrapRangeInMappedTextNode",value:function(e,t,n,r,o){var i=this;e.nodes.every((function(a,s){var l=e.nodes[s+1];if(void 0===l||l.start>t){if(!r(a.node))return!1;var c=t-a.start,u=(n>a.end?a.end:n)-a.start,p=e.value.substr(0,a.start),d=e.value.substr(u+a.start);if(a.node=i.wrapRangeInTextNode(a.node,c,u),e.value=p+d,e.nodes.forEach((function(t,n){n>=s&&(e.nodes[n].start>0&&n!==s&&(e.nodes[n].start-=u),e.nodes[n].end-=u)})),n-=u,o(a.node.previousSibling,a.start),!(n>a.end))return!1;t=a.end}return!0}))}},{key:"wrapMatches",value:function(e,t,n,r,o){var i=this,a=0===t?0:t+1;this.getTextNodes((function(t){t.nodes.forEach((function(t){t=t.node;for(var o=void 0;null!==(o=e.exec(t.textContent))&&""!==o[a];)if(n(o[a],t)){var s=o.index;if(0!==a)for(var l=1;l<a;l++)s+=o[l].length;t=i.wrapRangeInTextNode(t,s,s+o[a].length),r(t.previousSibling),e.lastIndex=0}})),o()}))}},{key:"wrapMatchesAcrossElements",value:function(e,t,n,r,o){var i=this,a=0===t?0:t+1;this.getTextNodes((function(t){for(var s=void 0;null!==(s=e.exec(t.value))&&""!==s[a];){var l=s.index;if(0!==a)for(var c=1;c<a;c++)l+=s[c].length;var u=l+s[a].length;i.wrapRangeInMappedTextNode(t,l,u,(function(e){return n(s[a],e)}),(function(t,n){e.lastIndex=n,r(t)}))}o()}))}},{key:"wrapRangeFromIndex",value:function(e,t,n,r){var o=this;this.getTextNodes((function(i){var a=i.value.length;e.forEach((function(e,r){var s=o.checkWhitespaceRanges(e,a,i.value),l=s.start,c=s.end;s.valid&&o.wrapRangeInMappedTextNode(i,l,c,(function(n){return t(n,e,i.value.substring(l,c),r)}),(function(t){n(t,e)}))})),r()}))}},{key:"unwrapMatches",value:function(e){for(var t=e.parentNode,n=document.createDocumentFragment();e.firstChild;)n.appendChild(e.removeChild(e.firstChild));t.replaceChild(n,e),this.ie?this.normalizeTextNode(t):t.normalize()}},{key:"normalizeTextNode",value:function(e){if(e){if(3===e.nodeType)for(;e.nextSibling&&3===e.nextSibling.nodeType;)e.nodeValue+=e.nextSibling.nodeValue,e.parentNode.removeChild(e.nextSibling);else this.normalizeTextNode(e.firstChild);this.normalizeTextNode(e.nextSibling)}}},{key:"markRegExp",value:function(e,t){var n=this;this.opt=t,this.log('Searching with expression "'+e+'"');var r=0,o="wrapMatches";this.opt.acrossElements&&(o="wrapMatchesAcrossElements"),this[o](e,this.opt.ignoreGroups,(function(e,t){return n.opt.filter(t,e,r)}),(function(e){r++,n.opt.each(e)}),(function(){0===r&&n.opt.noMatch(e),n.opt.done(r)}))}},{key:"mark",value:function(e,t){var n=this;this.opt=t;var r=0,o="wrapMatches",i=this.getSeparatedKeywords("string"==typeof e?[e]:e),a=i.keywords,s=i.length,l=this.opt.caseSensitive?"":"i";this.opt.acrossElements&&(o="wrapMatchesAcrossElements"),0===s?this.opt.done(r):function e(t){var i=new RegExp(n.createRegExp(t),"gm"+l),c=0;n.log('Searching with expression "'+i+'"'),n[o](i,1,(function(e,o){return n.opt.filter(o,t,r,c)}),(function(e){c++,r++,n.opt.each(e)}),(function(){0===c&&n.opt.noMatch(t),a[s-1]===t?n.opt.done(r):e(a[a.indexOf(t)+1])}))}(a[0])}},{key:"markRanges",value:function(e,t){var n=this;this.opt=t;var r=0,o=this.checkRanges(e);o&&o.length?(this.log("Starting to mark with the following ranges: "+JSON.stringify(o)),this.wrapRangeFromIndex(o,(function(e,t,r,o){return n.opt.filter(e,t,r,o)}),(function(e,t){r++,n.opt.each(e,t)}),(function(){n.opt.done(r)}))):this.opt.done(r)}},{key:"unmark",value:function(e){var t=this;this.opt=e;var n=this.opt.element?this.opt.element:"*";n+="[data-markjs]",this.opt.className&&(n+="."+this.opt.className),this.log('Removal selector "'+n+'"'),this.iterator.forEachNode(NodeFilter.SHOW_ELEMENT,(function(e){t.unwrapMatches(e)}),(function(e){var r=o.matches(e,n),i=t.matchesExclude(e);return!r||i?NodeFilter.FILTER_REJECT:NodeFilter.FILTER_ACCEPT}),this.opt.done)}},{key:"opt",set:function(e){this._opt=r({},{element:"",className:"",exclude:[],iframes:!1,iframesTimeout:5e3,separateWordSearch:!0,diacritics:!0,synonyms:{},accuracy:"partially",acrossElements:!1,caseSensitive:!1,ignoreJoiners:!1,ignoreGroups:0,ignorePunctuation:[],wildcards:"disabled",each:function(){},noMatch:function(){},filter:function(){return!0},done:function(){},debug:!1,log:window.console},e)},get:function(){return this._opt}},{key:"iterator",get:function(){return new o(this.ctx,this.opt.iframes,this.opt.exclude,this.opt.iframesTimeout)}}]),i}();return function(e){var t=this,n=new i(e);return this.mark=function(e,r){return n.mark(e,r),t},this.markRegExp=function(e,r){return n.markRegExp(e,r),t},this.markRanges=function(e,r){return n.markRanges(e,r),t},this.unmark=function(e){return n.unmark(e),t},this}}()},3342:function(e,t,n){"use strict";const r=n(4445),o={}.NODE_DISABLE_COLORS?{red:"",yellow:"",green:"",normal:""}:{red:"[31m",yellow:"[33;1m",green:"[32m",normal:"[0m"};function i(e,t){function n(e,t){return r.stringify(e)===r.stringify(Object.assign({},e,t))}return n(e,t)&&n(t,e)}function a(e){let t=(e=e.replace("[]","Array")).split("/");return t[0]=t[0].replace(/[^A-Za-z0-9_\-\.]+|\s+/gm,"_"),t.join("/")}String.prototype.toCamelCase=function(){return this.toLowerCase().replace(/[-_ \/\.](.)/g,(function(e,t){return t.toUpperCase()}))},e.exports={colour:o,uniqueOnly:function(e,t,n){return n.indexOf(e)===t},hasDuplicates:function(e){return new Set(e).size!==e.length},allSame:function(e){return new Set(e).size<=1},distinctArray:function(e){return e.length===function(e){let t=[];for(let n of e)t.find((function(e,t,r){return i(e,n)}))||t.push(n);return t}(e).length},firstDupe:function(e){return e.find((function(t,n,r){return e.indexOf(t)<n}))},hash:function(e){let t,n=0;if(0===e.length)return n;for(let r=0;r<e.length;r++)t=e.charCodeAt(r),n=(n<<5)-n+t,n|=0;return n},parameterTypeProperties:["format","minimum","maximum","exclusiveMinimum","exclusiveMaximum","minLength","maxLength","multipleOf","minItems","maxItems","uniqueItems","minProperties","maxProperties","additionalProperties","pattern","enum","default"],arrayProperties:["items","minItems","maxItems","uniqueItems"],httpMethods:["get","post","put","delete","patch","head","options","trace"],sanitise:a,sanitiseAll:function(e){return a(e.split("/").join("_"))}}},4856:function(e,t,n){"use strict";const r=n(9045),o=n(6470),i=n(8150),a=n(8150),s=n(8150),l=n(7053).jptr,c=n(8401).recurse,u=n(4683).clone,p=n(4593).dereference,d=n(2592).isRef,f=n(3342);function h(e,t,n,r,o,a){let s=a.externalRefs[n+r].paths[0],p=i.parse(o),h={},m=1;for(;m;)m=0,c(e,{identityDetection:!0},(function(e,n,r){if(d(e,n))if(e[n].startsWith("#"))if(h[e[n]]||e.$fixed){if(!e.$fixed){let t=(s+"/"+h[e[n]]).split("/#/").join("/");r.parent[r.pkey]={$ref:t,"x-miro":e[n],$fixed:!0},a.verbose>1&&console.warn("Replacing with",t),m++}}else{let o=u(l(t,e[n]));if(a.verbose>1&&console.warn((!1===o?f.colour.red:f.colour.green)+"Fragment resolution",e[n],f.colour.normal),!1===o){if(r.parent[r.pkey]={},a.fatal){let t=new Error("Fragment $ref resolution failed "+e[n]);if(!a.promise)throw t;a.promise.reject(t)}}else m++,r.parent[r.pkey]=o,h[e[n]]=r.path.replace("/%24ref","")}else if(p.protocol){let t=i.resolve(o,e[n]).toString();a.verbose>1&&console.warn(f.colour.yellow+"Rewriting external url ref",e[n],"as",t,f.colour.normal),e["x-miro"]=e[n],a.externalRefs[e[n]]&&(a.externalRefs[t]||(a.externalRefs[t]=a.externalRefs[e[n]]),a.externalRefs[t].failed=a.externalRefs[e[n]].failed),e[n]=t}else if(!e["x-miro"]){let t=i.resolve(o,e[n]).toString(),r=!1;a.externalRefs[e[n]]&&(r=a.externalRefs[e[n]].failed),r||(a.verbose>1&&console.warn(f.colour.yellow+"Rewriting external ref",e[n],"as",t,f.colour.normal),e["x-miro"]=e[n],e[n]=t)}}));return c(e,{},(function(e,t,n){d(e,t)&&void 0!==e.$fixed&&delete e.$fixed})),a.verbose>1&&console.warn("Finished fragment resolution"),e}function m(e,t){if(!t.filters||!t.filters.length)return e;for(let n of t.filters)e=n(e,t);return e}function g(e,t,n,a){var c=i.parse(n.source),p=n.source.split("\\").join("/").split("/");p.pop()||p.pop();let d="",f=t.split("#");f.length>1&&(d="#"+f[1],t=f[0]),p=p.join("/");let g=(y=i.parse(t).protocol,v=c.protocol,y&&y.length>2?y:v&&v.length>2?v:"file:");var y,v;let b;if(b="file:"===g?o.resolve(p?p+"/":"",t):i.resolve(p?p+"/":"",t),n.cache[b]){n.verbose&&console.warn("CACHED",b,d);let e=u(n.cache[b]),r=n.externalRef=e;if(d&&(r=l(r,d),!1===r&&(r={},n.fatal))){let e=new Error("Cached $ref resolution failed "+b+d);if(!n.promise)throw e;n.promise.reject(e)}return r=h(r,e,t,d,b,n),r=m(r,n),a(u(r),b,n),Promise.resolve(r)}if(n.verbose&&console.warn("GET",b,d),n.handlers&&n.handlers[g])return n.handlers[g](p,t,d,n).then((function(e){return n.externalRef=e,e=m(e,n),n.cache[b]=e,a(e,b,n),e})).catch((function(e){throw n.verbose&&console.warn(e),e}));if(g&&g.startsWith("http")){const e=Object.assign({},n.fetchOptions,{agent:n.agent});return n.fetch(b,e).then((function(e){if(200!==e.status){if(n.ignoreIOErrors)return n.verbose&&console.warn("FAILED",t),n.externalRefs[t].failed=!0,'{"$ref":"'+t+'"}';throw new Error(`Received status code ${e.status}: ${b}`)}return e.text()})).then((function(e){try{let r=s.parse(e,{schema:"core",prettyErrors:!0});if(e=n.externalRef=r,n.cache[b]=u(e),d&&!1===(e=l(e,d))&&(e={},n.fatal)){let e=new Error("Remote $ref resolution failed "+b+d);if(!n.promise)throw e;n.promise.reject(e)}e=m(e=h(e,r,t,d,b,n),n)}catch(e){if(n.verbose&&console.warn(e),!n.promise||!n.fatal)throw e;n.promise.reject(e)}return a(e,b,n),e})).catch((function(e){if(n.verbose&&console.warn(e),n.cache[b]={},!n.promise||!n.fatal)throw e;n.promise.reject(e)}))}{const e='{"$ref":"'+t+'"}';return function(e,t,n,o,i){return new Promise((function(a,s){r.readFile(e,t,(function(e,t){e?n.ignoreIOErrors&&i?(n.verbose&&console.warn("FAILED",o),n.externalRefs[o].failed=!0,a(i)):s(e):a(t)}))}))}(b,n.encoding||"utf8",n,t,e).then((function(e){try{let r=s.parse(e,{schema:"core",prettyErrors:!0});if(e=n.externalRef=r,n.cache[b]=u(e),d&&!1===(e=l(e,d))&&(e={},n.fatal)){let e=new Error("File $ref resolution failed "+b+d);if(!n.promise)throw e;n.promise.reject(e)}e=m(e=h(e,r,t,d,b,n),n)}catch(e){if(n.verbose&&console.warn(e),!n.promise||!n.fatal)throw e;n.promise.reject(e)}return a(e,b,n),e})).catch((function(e){if(n.verbose&&console.warn(e),!n.promise||!n.fatal)throw e;n.promise.reject(e)}))}}function y(e){return new Promise((function(t,n){(function(e){return new Promise((function(t,n){function r(t,n,r){if(t[n]&&d(t[n],"$ref")){let i=t[n].$ref;if(!i.startsWith("#")){let a="";if(!o[i]){let t=Object.keys(o).find((function(e,t,n){return i.startsWith(e+"/")}));t&&(e.verbose&&console.warn("Found potential subschema at",t),a="/"+(i.split("#")[1]||"").replace(t.split("#")[1]||""),a=a.split("/undefined").join(""),i=t)}if(o[i]||(o[i]={resolved:!1,paths:[],extras:{},description:t[n].description}),o[i].resolved)if(o[i].failed);else if(e.rewriteRefs){let r=o[i].resolvedAt;e.verbose>1&&console.warn("Rewriting ref",i,r),t[n]["x-miro"]=i,t[n].$ref=r+a}else t[n]=u(o[i].data);else o[i].paths.push(r.path),o[i].extras[r.path]=a}}}let o=e.externalRefs;if(e.resolver.depth>0&&e.source===e.resolver.base)return t(o);c(e.openapi.definitions,{identityDetection:!0,path:"#/definitions"},r),c(e.openapi.components,{identityDetection:!0,path:"#/components"},r),c(e.openapi,{identityDetection:!0},r),t(o)}))})(e).then((function(t){for(let n in t)if(!t[n].resolved){let r=e.resolver.depth;r>0&&r++,e.resolver.actions[r].push((function(){return g(e.openapi,n,e,(function(e,r,o){if(!t[n].resolved){let i={};i.context=t[n],i.$ref=n,i.original=u(e),i.updated=e,i.source=r,o.externals.push(i),t[n].resolved=!0}let i=Object.assign({},o,{source:"",resolver:{actions:o.resolver.actions,depth:o.resolver.actions.length-1,base:o.resolver.base}});o.patch&&t[n].description&&!e.description&&"object"==typeof e&&(e.description=t[n].description),t[n].data=e;let a=(s=t[n].paths,[...new Set(s)]);var s;a=a.sort((function(e,t){const n=e.startsWith("#/components/")||e.startsWith("#/definitions/"),r=t.startsWith("#/components/")||t.startsWith("#/definitions/");return n&&!r?-1:r&&!n?1:0}));for(let r of a)if(t[n].resolvedAt&&r!==t[n].resolvedAt&&r.indexOf("x-ms-examples/")<0)o.verbose>1&&console.warn("Creating pointer to data at",r),l(o.openapi,r,{$ref:t[n].resolvedAt+t[n].extras[r],"x-miro":n+t[n].extras[r]});else{t[n].resolvedAt?o.verbose>1&&console.warn("Avoiding circular reference"):(t[n].resolvedAt=r,o.verbose>1&&console.warn("Creating initial clone of data at",r));let i=u(e);l(o.openapi,r,i)}0===o.resolver.actions[i.resolver.depth].length&&o.resolver.actions[i.resolver.depth].push((function(){return y(i)}))}))}))}})).catch((function(t){e.verbose&&console.warn(t),n(t)}));let r={options:e};r.actions=e.resolver.actions[e.resolver.depth],t(r)}))}function v(e,t,n){e.resolver.actions.push([]),y(e).then((function(r){var o;(o=r.actions,o.reduce(((e,t)=>e.then((e=>t().then(Array.prototype.concat.bind(e))))),Promise.resolve([]))).then((function(){if(e.resolver.depth>=e.resolver.actions.length)return console.warn("Ran off the end of resolver actions"),t(!0);e.resolver.depth++,e.resolver.actions[e.resolver.depth].length?setTimeout((function(){v(r.options,t,n)}),0):(e.verbose>1&&console.warn(f.colour.yellow+"Finished external resolution!",f.colour.normal),e.resolveInternal&&(e.verbose>1&&console.warn(f.colour.yellow+"Starting internal resolution!",f.colour.normal),e.openapi=p(e.openapi,e.original,{verbose:e.verbose-1}),e.verbose>1&&console.warn(f.colour.yellow+"Finished internal resolution!",f.colour.normal)),c(e.openapi,{},(function(t,n,r){d(t,n)&&(e.preserveMiro||delete t["x-miro"])})),t(e))})).catch((function(t){e.verbose&&console.warn(t),n(t)}))})).catch((function(t){e.verbose&&console.warn(t),n(t)}))}function b(e){if(e.cache||(e.cache={}),e.fetch||(e.fetch=a),e.source){let t=i.parse(e.source);(!t.protocol||t.protocol.length<=2)&&(e.source=o.resolve(e.source))}e.externals=[],e.externalRefs={},e.rewriteRefs=!0,e.resolver={},e.resolver.depth=0,e.resolver.base=e.source,e.resolver.actions=[[]]}e.exports={optionalResolve:function(e){return b(e),new Promise((function(t,n){e.resolve?v(e,t,n):t(e)}))},resolve:function(e,t,n){return n||(n={}),n.openapi=e,n.source=t,n.resolve=!0,b(n),new Promise((function(e,t){v(n,e,t)}))}}},1804:function(e){"use strict";function t(){return{depth:0,seen:new WeakMap,top:!0,combine:!1,allowRefSiblings:!1}}e.exports={getDefaultState:t,walkSchema:function e(n,r,o,i){if(void 0===o.depth&&(o=t()),null==n)return n;if(void 0!==n.$ref){let e={$ref:n.$ref};return o.allowRefSiblings&&n.description&&(e.description=n.description),i(e,r,o),e}if(o.combine&&(n.allOf&&Array.isArray(n.allOf)&&1===n.allOf.length&&delete(n=Object.assign({},n.allOf[0],n)).allOf,n.anyOf&&Array.isArray(n.anyOf)&&1===n.anyOf.length&&delete(n=Object.assign({},n.anyOf[0],n)).anyOf,n.oneOf&&Array.isArray(n.oneOf)&&1===n.oneOf.length&&delete(n=Object.assign({},n.oneOf[0],n)).oneOf),i(n,r,o),o.seen.has(n))return n;if("object"==typeof n&&null!==n&&o.seen.set(n,!0),o.top=!1,o.depth++,void 0!==n.items&&(o.property="items",e(n.items,n,o,i)),n.additionalItems&&"object"==typeof n.additionalItems&&(o.property="additionalItems",e(n.additionalItems,n,o,i)),n.additionalProperties&&"object"==typeof n.additionalProperties&&(o.property="additionalProperties",e(n.additionalProperties,n,o,i)),n.properties)for(let t in n.properties){let r=n.properties[t];o.property="properties/"+t,e(r,n,o,i)}if(n.patternProperties)for(let t in n.patternProperties){let r=n.patternProperties[t];o.property="patternProperties/"+t,e(r,n,o,i)}if(n.allOf)for(let t in n.allOf){let r=n.allOf[t];o.property="allOf/"+t,e(r,n,o,i)}if(n.anyOf)for(let t in n.anyOf){let r=n.anyOf[t];o.property="anyOf/"+t,e(r,n,o,i)}if(n.oneOf)for(let t in n.oneOf){let r=n.oneOf[t];o.property="oneOf/"+t,e(r,n,o,i)}return n.not&&(o.property="not",e(n.not,n,o,i)),o.depth--,n}}},7418:function(e){"use strict";var t=Object.getOwnPropertySymbols,n=Object.prototype.hasOwnProperty,r=Object.prototype.propertyIsEnumerable;function o(e){if(null==e)throw new TypeError("Object.assign cannot be called with null or undefined");return Object(e)}e.exports=function(){try{if(!Object.assign)return!1;var e=new String("abc");if(e[5]="de","5"===Object.getOwnPropertyNames(e)[0])return!1;for(var t={},n=0;n<10;n++)t["_"+String.fromCharCode(n)]=n;if("0123456789"!==Object.getOwnPropertyNames(t).map((function(e){return t[e]})).join(""))return!1;var r={};return"abcdefghijklmnopqrst".split("").forEach((function(e){r[e]=e})),"abcdefghijklmnopqrst"===Object.keys(Object.assign({},r)).join("")}catch(e){return!1}}()?Object.assign:function(e,i){for(var a,s,l=o(e),c=1;c<arguments.length;c++){for(var u in a=Object(arguments[c]))n.call(a,u)&&(l[u]=a[u]);if(t){s=t(a);for(var p=0;p<s.length;p++)r.call(a,s[p])&&(l[s[p]]=a[s[p]])}}return l}},6470:function(e){"use strict";function t(e){if("string"!=typeof e)throw new TypeError("Path must be a string. Received "+JSON.stringify(e))}function n(e,t){for(var n,r="",o=0,i=-1,a=0,s=0;s<=e.length;++s){if(s<e.length)n=e.charCodeAt(s);else{if(47===n)break;n=47}if(47===n){if(i===s-1||1===a);else if(i!==s-1&&2===a){if(r.length<2||2!==o||46!==r.charCodeAt(r.length-1)||46!==r.charCodeAt(r.length-2))if(r.length>2){var l=r.lastIndexOf("/");if(l!==r.length-1){-1===l?(r="",o=0):o=(r=r.slice(0,l)).length-1-r.lastIndexOf("/"),i=s,a=0;continue}}else if(2===r.length||1===r.length){r="",o=0,i=s,a=0;continue}t&&(r.length>0?r+="/..":r="..",o=2)}else r.length>0?r+="/"+e.slice(i+1,s):r=e.slice(i+1,s),o=s-i-1;i=s,a=0}else 46===n&&-1!==a?++a:a=-1}return r}var r={resolve:function(){for(var e,r="",o=!1,i=arguments.length-1;i>=-1&&!o;i--){var a;i>=0?a=arguments[i]:(void 0===e&&(e=process.cwd()),a=e),t(a),0!==a.length&&(r=a+"/"+r,o=47===a.charCodeAt(0))}return r=n(r,!o),o?r.length>0?"/"+r:"/":r.length>0?r:"."},normalize:function(e){if(t(e),0===e.length)return".";var r=47===e.charCodeAt(0),o=47===e.charCodeAt(e.length-1);return 0!==(e=n(e,!r)).length||r||(e="."),e.length>0&&o&&(e+="/"),r?"/"+e:e},isAbsolute:function(e){return t(e),e.length>0&&47===e.charCodeAt(0)},join:function(){if(0===arguments.length)return".";for(var e,n=0;n<arguments.length;++n){var o=arguments[n];t(o),o.length>0&&(void 0===e?e=o:e+="/"+o)}return void 0===e?".":r.normalize(e)},relative:function(e,n){if(t(e),t(n),e===n)return"";if((e=r.resolve(e))===(n=r.resolve(n)))return"";for(var o=1;o<e.length&&47===e.charCodeAt(o);++o);for(var i=e.length,a=i-o,s=1;s<n.length&&47===n.charCodeAt(s);++s);for(var l=n.length-s,c=a<l?a:l,u=-1,p=0;p<=c;++p){if(p===c){if(l>c){if(47===n.charCodeAt(s+p))return n.slice(s+p+1);if(0===p)return n.slice(s+p)}else a>c&&(47===e.charCodeAt(o+p)?u=p:0===p&&(u=0));break}var d=e.charCodeAt(o+p);if(d!==n.charCodeAt(s+p))break;47===d&&(u=p)}var f="";for(p=o+u+1;p<=i;++p)p!==i&&47!==e.charCodeAt(p)||(0===f.length?f+="..":f+="/..");return f.length>0?f+n.slice(s+u):(s+=u,47===n.charCodeAt(s)&&++s,n.slice(s))},_makeLong:function(e){return e},dirname:function(e){if(t(e),0===e.length)return".";for(var n=e.charCodeAt(0),r=47===n,o=-1,i=!0,a=e.length-1;a>=1;--a)if(47===(n=e.charCodeAt(a))){if(!i){o=a;break}}else i=!1;return-1===o?r?"/":".":r&&1===o?"//":e.slice(0,o)},basename:function(e,n){if(void 0!==n&&"string"!=typeof n)throw new TypeError('"ext" argument must be a string');t(e);var r,o=0,i=-1,a=!0;if(void 0!==n&&n.length>0&&n.length<=e.length){if(n.length===e.length&&n===e)return"";var s=n.length-1,l=-1;for(r=e.length-1;r>=0;--r){var c=e.charCodeAt(r);if(47===c){if(!a){o=r+1;break}}else-1===l&&(a=!1,l=r+1),s>=0&&(c===n.charCodeAt(s)?-1==--s&&(i=r):(s=-1,i=l))}return o===i?i=l:-1===i&&(i=e.length),e.slice(o,i)}for(r=e.length-1;r>=0;--r)if(47===e.charCodeAt(r)){if(!a){o=r+1;break}}else-1===i&&(a=!1,i=r+1);return-1===i?"":e.slice(o,i)},extname:function(e){t(e);for(var n=-1,r=0,o=-1,i=!0,a=0,s=e.length-1;s>=0;--s){var l=e.charCodeAt(s);if(47!==l)-1===o&&(i=!1,o=s+1),46===l?-1===n?n=s:1!==a&&(a=1):-1!==n&&(a=-1);else if(!i){r=s+1;break}}return-1===n||-1===o||0===a||1===a&&n===o-1&&n===r+1?"":e.slice(n,o)},format:function(e){if(null===e||"object"!=typeof e)throw new TypeError('The "pathObject" argument must be of type Object. Received type '+typeof e);return function(e,t){var n=t.dir||t.root,r=t.base||(t.name||"")+(t.ext||"");return n?n===t.root?n+r:n+"/"+r:r}(0,e)},parse:function(e){t(e);var n={root:"",dir:"",base:"",ext:"",name:""};if(0===e.length)return n;var r,o=e.charCodeAt(0),i=47===o;i?(n.root="/",r=1):r=0;for(var a=-1,s=0,l=-1,c=!0,u=e.length-1,p=0;u>=r;--u)if(47!==(o=e.charCodeAt(u)))-1===l&&(c=!1,l=u+1),46===o?-1===a?a=u:1!==p&&(p=1):-1!==a&&(p=-1);else if(!c){s=u+1;break}return-1===a||-1===l||0===p||1===p&&a===l-1&&a===s+1?-1!==l&&(n.base=n.name=0===s&&i?e.slice(1,l):e.slice(s,l)):(0===s&&i?(n.name=e.slice(1,a),n.base=e.slice(1,l)):(n.name=e.slice(s,a),n.base=e.slice(s,l)),n.ext=e.slice(a,l)),s>0?n.dir=e.slice(0,s-1):i&&(n.dir="/"),n},sep:"/",delimiter:":",win32:null,posix:null};r.posix=r,e.exports=r},3450:function(e){e.exports=function(){var e=[],t=[],n={},r={},o={};function i(e){return"string"==typeof e?new RegExp("^"+e+"$","i"):e}function a(e,t){return e===t?t:e===e.toLowerCase()?t.toLowerCase():e===e.toUpperCase()?t.toUpperCase():e[0]===e[0].toUpperCase()?t.charAt(0).toUpperCase()+t.substr(1).toLowerCase():t.toLowerCase()}function s(e,t){return e.replace(/\$(\d{1,2})/g,(function(e,n){return t[n]||""}))}function l(e,t){return e.replace(t[0],(function(n,r){var o=s(t[1],arguments);return a(""===n?e[r-1]:n,o)}))}function c(e,t,r){if(!e.length||n.hasOwnProperty(e))return t;for(var o=r.length;o--;){var i=r[o];if(i[0].test(t))return l(t,i)}return t}function u(e,t,n){return function(r){var o=r.toLowerCase();return t.hasOwnProperty(o)?a(r,o):e.hasOwnProperty(o)?a(r,e[o]):c(o,r,n)}}function p(e,t,n,r){return function(r){var o=r.toLowerCase();return!!t.hasOwnProperty(o)||!e.hasOwnProperty(o)&&c(o,o,n)===o}}function d(e,t,n){return(n?t+" ":"")+(1===t?d.singular(e):d.plural(e))}return d.plural=u(o,r,e),d.isPlural=p(o,r,e),d.singular=u(r,o,t),d.isSingular=p(r,o,t),d.addPluralRule=function(t,n){e.push([i(t),n])},d.addSingularRule=function(e,n){t.push([i(e),n])},d.addUncountableRule=function(e){"string"!=typeof e?(d.addPluralRule(e,"$0"),d.addSingularRule(e,"$0")):n[e.toLowerCase()]=!0},d.addIrregularRule=function(e,t){t=t.toLowerCase(),e=e.toLowerCase(),o[e]=t,r[t]=e},[["I","we"],["me","us"],["he","they"],["she","they"],["them","them"],["myself","ourselves"],["yourself","yourselves"],["itself","themselves"],["herself","themselves"],["himself","themselves"],["themself","themselves"],["is","are"],["was","were"],["has","have"],["this","these"],["that","those"],["echo","echoes"],["dingo","dingoes"],["volcano","volcanoes"],["tornado","tornadoes"],["torpedo","torpedoes"],["genus","genera"],["viscus","viscera"],["stigma","stigmata"],["stoma","stomata"],["dogma","dogmata"],["lemma","lemmata"],["schema","schemata"],["anathema","anathemata"],["ox","oxen"],["axe","axes"],["die","dice"],["yes","yeses"],["foot","feet"],["eave","eaves"],["goose","geese"],["tooth","teeth"],["quiz","quizzes"],["human","humans"],["proof","proofs"],["carve","carves"],["valve","valves"],["looey","looies"],["thief","thieves"],["groove","grooves"],["pickaxe","pickaxes"],["passerby","passersby"]].forEach((function(e){return d.addIrregularRule(e[0],e[1])})),[[/s?$/i,"s"],[/[^\u0000-\u007F]$/i,"$0"],[/([^aeiou]ese)$/i,"$1"],[/(ax|test)is$/i,"$1es"],[/(alias|[^aou]us|t[lm]as|gas|ris)$/i,"$1es"],[/(e[mn]u)s?$/i,"$1s"],[/([^l]ias|[aeiou]las|[ejzr]as|[iu]am)$/i,"$1"],[/(alumn|syllab|vir|radi|nucle|fung|cact|stimul|termin|bacill|foc|uter|loc|strat)(?:us|i)$/i,"$1i"],[/(alumn|alg|vertebr)(?:a|ae)$/i,"$1ae"],[/(seraph|cherub)(?:im)?$/i,"$1im"],[/(her|at|gr)o$/i,"$1oes"],[/(agend|addend|millenni|dat|extrem|bacteri|desiderat|strat|candelabr|errat|ov|symposi|curricul|automat|quor)(?:a|um)$/i,"$1a"],[/(apheli|hyperbat|periheli|asyndet|noumen|phenomen|criteri|organ|prolegomen|hedr|automat)(?:a|on)$/i,"$1a"],[/sis$/i,"ses"],[/(?:(kni|wi|li)fe|(ar|l|ea|eo|oa|hoo)f)$/i,"$1$2ves"],[/([^aeiouy]|qu)y$/i,"$1ies"],[/([^ch][ieo][ln])ey$/i,"$1ies"],[/(x|ch|ss|sh|zz)$/i,"$1es"],[/(matr|cod|mur|sil|vert|ind|append)(?:ix|ex)$/i,"$1ices"],[/\b((?:tit)?m|l)(?:ice|ouse)$/i,"$1ice"],[/(pe)(?:rson|ople)$/i,"$1ople"],[/(child)(?:ren)?$/i,"$1ren"],[/eaux$/i,"$0"],[/m[ae]n$/i,"men"],["thou","you"]].forEach((function(e){return d.addPluralRule(e[0],e[1])})),[[/s$/i,""],[/(ss)$/i,"$1"],[/(wi|kni|(?:after|half|high|low|mid|non|night|[^\w]|^)li)ves$/i,"$1fe"],[/(ar|(?:wo|[ae])l|[eo][ao])ves$/i,"$1f"],[/ies$/i,"y"],[/\b([pl]|zomb|(?:neck|cross)?t|coll|faer|food|gen|goon|group|lass|talk|goal|cut)ies$/i,"$1ie"],[/\b(mon|smil)ies$/i,"$1ey"],[/\b((?:tit)?m|l)ice$/i,"$1ouse"],[/(seraph|cherub)im$/i,"$1"],[/(x|ch|ss|sh|zz|tto|go|cho|alias|[^aou]us|t[lm]as|gas|(?:her|at|gr)o|[aeiou]ris)(?:es)?$/i,"$1"],[/(analy|diagno|parenthe|progno|synop|the|empha|cri|ne)(?:sis|ses)$/i,"$1sis"],[/(movie|twelve|abuse|e[mn]u)s$/i,"$1"],[/(test)(?:is|es)$/i,"$1is"],[/(alumn|syllab|vir|radi|nucle|fung|cact|stimul|termin|bacill|foc|uter|loc|strat)(?:us|i)$/i,"$1us"],[/(agend|addend|millenni|dat|extrem|bacteri|desiderat|strat|candelabr|errat|ov|symposi|curricul|quor)a$/i,"$1um"],[/(apheli|hyperbat|periheli|asyndet|noumen|phenomen|criteri|organ|prolegomen|hedr|automat)a$/i,"$1on"],[/(alumn|alg|vertebr)ae$/i,"$1a"],[/(cod|mur|sil|vert|ind)ices$/i,"$1ex"],[/(matr|append)ices$/i,"$1ix"],[/(pe)(rson|ople)$/i,"$1rson"],[/(child)ren$/i,"$1"],[/(eau)x?$/i,"$1"],[/men$/i,"man"]].forEach((function(e){return d.addSingularRule(e[0],e[1])})),["adulthood","advice","agenda","aid","aircraft","alcohol","ammo","analytics","anime","athletics","audio","bison","blood","bream","buffalo","butter","carp","cash","chassis","chess","clothing","cod","commerce","cooperation","corps","debris","diabetes","digestion","elk","energy","equipment","excretion","expertise","firmware","flounder","fun","gallows","garbage","graffiti","hardware","headquarters","health","herpes","highjinks","homework","housework","information","jeans","justice","kudos","labour","literature","machinery","mackerel","mail","media","mews","moose","music","mud","manga","news","only","personnel","pike","plankton","pliers","police","pollution","premises","rain","research","rice","salmon","scissors","series","sewage","shambles","shrimp","software","species","staff","swine","tennis","traffic","transportation","trout","tuna","wealth","welfare","whiting","wildebeest","wildlife","you",/pok[eé]mon$/i,/[^aeiou]ese$/i,/deer$/i,/fish$/i,/measles$/i,/o[iu]s$/i,/pox$/i,/sheep$/i].forEach(d.addUncountableRule),d}()},7874:function(){!function(e){var t="\\b(?:BASH|BASHOPTS|BASH_ALIASES|BASH_ARGC|BASH_ARGV|BASH_CMDS|BASH_COMPLETION_COMPAT_DIR|BASH_LINENO|BASH_REMATCH|BASH_SOURCE|BASH_VERSINFO|BASH_VERSION|COLORTERM|COLUMNS|COMP_WORDBREAKS|DBUS_SESSION_BUS_ADDRESS|DEFAULTS_PATH|DESKTOP_SESSION|DIRSTACK|DISPLAY|EUID|GDMSESSION|GDM_LANG|GNOME_KEYRING_CONTROL|GNOME_KEYRING_PID|GPG_AGENT_INFO|GROUPS|HISTCONTROL|HISTFILE|HISTFILESIZE|HISTSIZE|HOME|HOSTNAME|HOSTTYPE|IFS|INSTANCE|JOB|LANG|LANGUAGE|LC_ADDRESS|LC_ALL|LC_IDENTIFICATION|LC_MEASUREMENT|LC_MONETARY|LC_NAME|LC_NUMERIC|LC_PAPER|LC_TELEPHONE|LC_TIME|LESSCLOSE|LESSOPEN|LINES|LOGNAME|LS_COLORS|MACHTYPE|MAILCHECK|MANDATORY_PATH|NO_AT_BRIDGE|OLDPWD|OPTERR|OPTIND|ORBIT_SOCKETDIR|OSTYPE|PAPERSIZE|PATH|PIPESTATUS|PPID|PS1|PS2|PS3|PS4|PWD|RANDOM|REPLY|SECONDS|SELINUX_INIT|SESSION|SESSIONTYPE|SESSION_MANAGER|SHELL|SHELLOPTS|SHLVL|SSH_AUTH_SOCK|TERM|UID|UPSTART_EVENTS|UPSTART_INSTANCE|UPSTART_JOB|UPSTART_SESSION|USER|WINDOWID|XAUTHORITY|XDG_CONFIG_DIRS|XDG_CURRENT_DESKTOP|XDG_DATA_DIRS|XDG_GREETER_DATA_DIR|XDG_MENU_PREFIX|XDG_RUNTIME_DIR|XDG_SEAT|XDG_SEAT_PATH|XDG_SESSION_DESKTOP|XDG_SESSION_ID|XDG_SESSION_PATH|XDG_SESSION_TYPE|XDG_VTNR|XMODIFIERS)\\b",n={pattern:/(^(["']?)\w+\2)[ \t]+\S.*/,lookbehind:!0,alias:"punctuation",inside:null},r={bash:n,environment:{pattern:RegExp("\\$"+t),alias:"constant"},variable:[{pattern:/\$?\(\([\s\S]+?\)\)/,greedy:!0,inside:{variable:[{pattern:/(^\$\(\([\s\S]+)\)\)/,lookbehind:!0},/^\$\(\(/],number:/\b0x[\dA-Fa-f]+\b|(?:\b\d+(?:\.\d*)?|\B\.\d+)(?:[Ee]-?\d+)?/,operator:/--|\+\+|\*\*=?|<<=?|>>=?|&&|\|\||[=!+\-*/%<>^&|]=?|[?~:]/,punctuation:/\(\(?|\)\)?|,|;/}},{pattern:/\$\((?:\([^)]+\)|[^()])+\)|`[^`]+`/,greedy:!0,inside:{variable:/^\$\(|^`|\)$|`$/}},{pattern:/\$\{[^}]+\}/,greedy:!0,inside:{operator:/:[-=?+]?|[!\/]|##?|%%?|\^\^?|,,?/,punctuation:/[\[\]]/,environment:{pattern:RegExp("(\\{)"+t),lookbehind:!0,alias:"constant"}}},/\$(?:\w+|[#?*!@$])/],entity:/\\(?:[abceEfnrtv\\"]|O?[0-7]{1,3}|U[0-9a-fA-F]{8}|u[0-9a-fA-F]{4}|x[0-9a-fA-F]{1,2})/};e.languages.bash={shebang:{pattern:/^#!\s*\/.*/,alias:"important"},comment:{pattern:/(^|[^"{\\$])#.*/,lookbehind:!0},"function-name":[{pattern:/(\bfunction\s+)[\w-]+(?=(?:\s*\(?:\s*\))?\s*\{)/,lookbehind:!0,alias:"function"},{pattern:/\b[\w-]+(?=\s*\(\s*\)\s*\{)/,alias:"function"}],"for-or-select":{pattern:/(\b(?:for|select)\s+)\w+(?=\s+in\s)/,alias:"variable",lookbehind:!0},"assign-left":{pattern:/(^|[\s;|&]|[<>]\()\w+(?=\+?=)/,inside:{environment:{pattern:RegExp("(^|[\\s;|&]|[<>]\\()"+t),lookbehind:!0,alias:"constant"}},alias:"variable",lookbehind:!0},string:[{pattern:/((?:^|[^<])<<-?\s*)(\w+)\s[\s\S]*?(?:\r?\n|\r)\2/,lookbehind:!0,greedy:!0,inside:r},{pattern:/((?:^|[^<])<<-?\s*)(["'])(\w+)\2\s[\s\S]*?(?:\r?\n|\r)\3/,lookbehind:!0,greedy:!0,inside:{bash:n}},{pattern:/(^|[^\\](?:\\\\)*)"(?:\\[\s\S]|\$\([^)]+\)|\$(?!\()|`[^`]+`|[^"\\`$])*"/,lookbehind:!0,greedy:!0,inside:r},{pattern:/(^|[^$\\])'[^']*'/,lookbehind:!0,greedy:!0},{pattern:/\$'(?:[^'\\]|\\[\s\S])*'/,greedy:!0,inside:{entity:r.entity}}],environment:{pattern:RegExp("\\$?"+t),alias:"constant"},variable:r.variable,function:{pattern:/(^|[\s;|&]|[<>]\()(?:add|apropos|apt|apt-cache|apt-get|aptitude|aspell|automysqlbackup|awk|basename|bash|bc|bconsole|bg|bzip2|cal|cat|cfdisk|chgrp|chkconfig|chmod|chown|chroot|cksum|clear|cmp|column|comm|composer|cp|cron|crontab|csplit|curl|cut|date|dc|dd|ddrescue|debootstrap|df|diff|diff3|dig|dir|dircolors|dirname|dirs|dmesg|docker|docker-compose|du|egrep|eject|env|ethtool|expand|expect|expr|fdformat|fdisk|fg|fgrep|file|find|fmt|fold|format|free|fsck|ftp|fuser|gawk|git|gparted|grep|groupadd|groupdel|groupmod|groups|grub-mkconfig|gzip|halt|head|hg|history|host|hostname|htop|iconv|id|ifconfig|ifdown|ifup|import|install|ip|jobs|join|kill|killall|less|link|ln|locate|logname|logrotate|look|lpc|lpr|lprint|lprintd|lprintq|lprm|ls|lsof|lynx|make|man|mc|mdadm|mkconfig|mkdir|mke2fs|mkfifo|mkfs|mkisofs|mknod|mkswap|mmv|more|most|mount|mtools|mtr|mutt|mv|nano|nc|netstat|nice|nl|node|nohup|notify-send|npm|nslookup|op|open|parted|passwd|paste|pathchk|ping|pkill|pnpm|podman|podman-compose|popd|pr|printcap|printenv|ps|pushd|pv|quota|quotacheck|quotactl|ram|rar|rcp|reboot|remsync|rename|renice|rev|rm|rmdir|rpm|rsync|scp|screen|sdiff|sed|sendmail|seq|service|sftp|sh|shellcheck|shuf|shutdown|sleep|slocate|sort|split|ssh|stat|strace|su|sudo|sum|suspend|swapon|sync|tac|tail|tar|tee|time|timeout|top|touch|tr|traceroute|tsort|tty|umount|uname|unexpand|uniq|units|unrar|unshar|unzip|update-grub|uptime|useradd|userdel|usermod|users|uudecode|uuencode|v|vcpkg|vdir|vi|vim|virsh|vmstat|wait|watch|wc|wget|whereis|which|who|whoami|write|xargs|xdg-open|yarn|yes|zenity|zip|zsh|zypper)(?=$|[)\s;|&])/,lookbehind:!0},keyword:{pattern:/(^|[\s;|&]|[<>]\()(?:case|do|done|elif|else|esac|fi|for|function|if|in|select|then|until|while)(?=$|[)\s;|&])/,lookbehind:!0},builtin:{pattern:/(^|[\s;|&]|[<>]\()(?:\.|:|alias|bind|break|builtin|caller|cd|command|continue|declare|echo|enable|eval|exec|exit|export|getopts|hash|help|let|local|logout|mapfile|printf|pwd|read|readarray|readonly|return|set|shift|shopt|source|test|times|trap|type|typeset|ulimit|umask|unalias|unset)(?=$|[)\s;|&])/,lookbehind:!0,alias:"class-name"},boolean:{pattern:/(^|[\s;|&]|[<>]\()(?:false|true)(?=$|[)\s;|&])/,lookbehind:!0},"file-descriptor":{pattern:/\B&\d\b/,alias:"important"},operator:{pattern:/\d?<>|>\||\+=|=[=~]?|!=?|<<[<-]?|[&\d]?>>|\d[<>]&?|[<>][&=]?|&[>&]?|\|[&|]?/,inside:{"file-descriptor":{pattern:/^\d/,alias:"important"}}},punctuation:/\$?\(\(?|\)\)?|\.\.|[{}[\];\\]/,number:{pattern:/(^|\s)(?:[1-9]\d*|0)(?:[.,]\d+)?\b/,lookbehind:!0}},n.inside=e.languages.bash;for(var o=["comment","function-name","for-or-select","assign-left","string","environment","function","keyword","builtin","boolean","file-descriptor","operator","punctuation","number"],i=r.variable[1].inside,a=0;a<o.length;a++)i[o[a]]=e.languages.bash[o[a]];e.languages.shell=e.languages.bash}(Prism)},4279:function(){Prism.languages.c=Prism.languages.extend("clike",{comment:{pattern:/\/\/(?:[^\r\n\\]|\\(?:\r\n?|\n|(?![\r\n])))*|\/\*[\s\S]*?(?:\*\/|$)/,greedy:!0},string:{pattern:/"(?:\\(?:\r\n|[\s\S])|[^"\\\r\n])*"/,greedy:!0},"class-name":{pattern:/(\b(?:enum|struct)\s+(?:__attribute__\s*\(\([\s\S]*?\)\)\s*)?)\w+|\b[a-z]\w*_t\b/,lookbehind:!0},keyword:/\b(?:_Alignas|_Alignof|_Atomic|_Bool|_Complex|_Generic|_Imaginary|_Noreturn|_Static_assert|_Thread_local|__attribute__|asm|auto|break|case|char|const|continue|default|do|double|else|enum|extern|float|for|goto|if|inline|int|long|register|return|short|signed|sizeof|static|struct|switch|typedef|typeof|union|unsigned|void|volatile|while)\b/,function:/\b[a-z_]\w*(?=\s*\()/i,number:/(?:\b0x(?:[\da-f]+(?:\.[\da-f]*)?|\.[\da-f]+)(?:p[+-]?\d+)?|(?:\b\d+(?:\.\d*)?|\B\.\d+)(?:e[+-]?\d+)?)[ful]{0,4}/i,operator:/>>=?|<<=?|->|([-+&|:])\1|[?:~]|[-+*/%&|^!=<>]=?/}),Prism.languages.insertBefore("c","string",{char:{pattern:/'(?:\\(?:\r\n|[\s\S])|[^'\\\r\n]){0,32}'/,greedy:!0}}),Prism.languages.insertBefore("c","string",{macro:{pattern:/(^[\t ]*)#\s*[a-z](?:[^\r\n\\/]|\/(?!\*)|\/\*(?:[^*]|\*(?!\/))*\*\/|\\(?:\r\n|[\s\S]))*/im,lookbehind:!0,greedy:!0,alias:"property",inside:{string:[{pattern:/^(#\s*include\s*)<[^>]+>/,lookbehind:!0},Prism.languages.c.string],char:Prism.languages.c.char,comment:Prism.languages.c.comment,"macro-name":[{pattern:/(^#\s*define\s+)\w+\b(?!\()/i,lookbehind:!0},{pattern:/(^#\s*define\s+)\w+\b(?=\()/i,lookbehind:!0,alias:"function"}],directive:{pattern:/^(#\s*)[a-z]+/,lookbehind:!0,alias:"keyword"},"directive-hash":/^#/,punctuation:/##|\\(?=[\r\n])/,expression:{pattern:/\S[\s\S]*/,inside:Prism.languages.c}}}}),Prism.languages.insertBefore("c","function",{constant:/\b(?:EOF|NULL|SEEK_CUR|SEEK_END|SEEK_SET|__DATE__|__FILE__|__LINE__|__TIMESTAMP__|__TIME__|__func__|stderr|stdin|stdout)\b/}),delete Prism.languages.c.boolean},5433:function(){Prism.languages.clike={comment:[{pattern:/(^|[^\\])\/\*[\s\S]*?(?:\*\/|$)/,lookbehind:!0,greedy:!0},{pattern:/(^|[^\\:])\/\/.*/,lookbehind:!0,greedy:!0}],string:{pattern:/(["'])(?:\\(?:\r\n|[\s\S])|(?!\1)[^\\\r\n])*\1/,greedy:!0},"class-name":{pattern:/(\b(?:class|extends|implements|instanceof|interface|new|trait)\s+|\bcatch\s+\()[\w.\\]+/i,lookbehind:!0,inside:{punctuation:/[.\\]/}},keyword:/\b(?:break|catch|continue|do|else|finally|for|function|if|in|instanceof|new|null|return|throw|try|while)\b/,boolean:/\b(?:false|true)\b/,function:/\b\w+(?=\()/,number:/\b0x[\da-f]+\b|(?:\b\d+(?:\.\d*)?|\B\.\d+)(?:e[+-]?\d+)?/i,operator:/[<>]=?|[!=]=?=?|--?|\+\+?|&&?|\|\|?|[?*/~^%]/,punctuation:/[{}[\];(),.:]/}},6213:function(){!function(e){var t=/#(?!\{).+/,n={pattern:/#\{[^}]+\}/,alias:"variable"};e.languages.coffeescript=e.languages.extend("javascript",{comment:t,string:[{pattern:/'(?:\\[\s\S]|[^\\'])*'/,greedy:!0},{pattern:/"(?:\\[\s\S]|[^\\"])*"/,greedy:!0,inside:{interpolation:n}}],keyword:/\b(?:and|break|by|catch|class|continue|debugger|delete|do|each|else|extend|extends|false|finally|for|if|in|instanceof|is|isnt|let|loop|namespace|new|no|not|null|of|off|on|or|own|return|super|switch|then|this|throw|true|try|typeof|undefined|unless|until|when|while|window|with|yes|yield)\b/,"class-member":{pattern:/@(?!\d)\w+/,alias:"variable"}}),e.languages.insertBefore("coffeescript","comment",{"multiline-comment":{pattern:/###[\s\S]+?###/,alias:"comment"},"block-regex":{pattern:/\/{3}[\s\S]*?\/{3}/,alias:"regex",inside:{comment:t,interpolation:n}}}),e.languages.insertBefore("coffeescript","string",{"inline-javascript":{pattern:/`(?:\\[\s\S]|[^\\`])*`/,inside:{delimiter:{pattern:/^`|`$/,alias:"punctuation"},script:{pattern:/[\s\S]+/,alias:"language-javascript",inside:e.languages.javascript}}},"multiline-string":[{pattern:/'''[\s\S]*?'''/,greedy:!0,alias:"string"},{pattern:/"""[\s\S]*?"""/,greedy:!0,alias:"string",inside:{interpolation:n}}]}),e.languages.insertBefore("coffeescript","keyword",{property:/(?!\d)\w+(?=\s*:(?!:))/}),delete e.languages.coffeescript["template-string"],e.languages.coffee=e.languages.coffeescript}(Prism)},2731:function(){!function(e){var t=/\b(?:alignas|alignof|asm|auto|bool|break|case|catch|char|char16_t|char32_t|char8_t|class|co_await|co_return|co_yield|compl|concept|const|const_cast|consteval|constexpr|constinit|continue|decltype|default|delete|do|double|dynamic_cast|else|enum|explicit|export|extern|final|float|for|friend|goto|if|import|inline|int|int16_t|int32_t|int64_t|int8_t|long|module|mutable|namespace|new|noexcept|nullptr|operator|override|private|protected|public|register|reinterpret_cast|requires|return|short|signed|sizeof|static|static_assert|static_cast|struct|switch|template|this|thread_local|throw|try|typedef|typeid|typename|uint16_t|uint32_t|uint64_t|uint8_t|union|unsigned|using|virtual|void|volatile|wchar_t|while)\b/,n=/\b(?!<keyword>)\w+(?:\s*\.\s*\w+)*\b/.source.replace(/<keyword>/g,(function(){return t.source}));e.languages.cpp=e.languages.extend("c",{"class-name":[{pattern:RegExp(/(\b(?:class|concept|enum|struct|typename)\s+)(?!<keyword>)\w+/.source.replace(/<keyword>/g,(function(){return t.source}))),lookbehind:!0},/\b[A-Z]\w*(?=\s*::\s*\w+\s*\()/,/\b[A-Z_]\w*(?=\s*::\s*~\w+\s*\()/i,/\b\w+(?=\s*<(?:[^<>]|<(?:[^<>]|<[^<>]*>)*>)*>\s*::\s*\w+\s*\()/],keyword:t,number:{pattern:/(?:\b0b[01']+|\b0x(?:[\da-f']+(?:\.[\da-f']*)?|\.[\da-f']+)(?:p[+-]?[\d']+)?|(?:\b[\d']+(?:\.[\d']*)?|\B\.[\d']+)(?:e[+-]?[\d']+)?)[ful]{0,4}/i,greedy:!0},operator:/>>=?|<<=?|->|--|\+\+|&&|\|\||[?:~]|<=>|[-+*/%&|^!=<>]=?|\b(?:and|and_eq|bitand|bitor|not|not_eq|or|or_eq|xor|xor_eq)\b/,boolean:/\b(?:false|true)\b/}),e.languages.insertBefore("cpp","string",{module:{pattern:RegExp(/(\b(?:import|module)\s+)/.source+"(?:"+/"(?:\\(?:\r\n|[\s\S])|[^"\\\r\n])*"|<[^<>\r\n]*>/.source+"|"+/<mod-name>(?:\s*:\s*<mod-name>)?|:\s*<mod-name>/.source.replace(/<mod-name>/g,(function(){return n}))+")"),lookbehind:!0,greedy:!0,inside:{string:/^[<"][\s\S]+/,operator:/:/,punctuation:/\./}},"raw-string":{pattern:/R"([^()\\ ]{0,16})\([\s\S]*?\)\1"/,alias:"string",greedy:!0}}),e.languages.insertBefore("cpp","keyword",{"generic-function":{pattern:/\b(?!operator\b)[a-z_]\w*\s*<(?:[^<>]|<[^<>]*>)*>(?=\s*\()/i,inside:{function:/^\w+/,generic:{pattern:/<[\s\S]+/,alias:"class-name",inside:e.languages.cpp}}}}),e.languages.insertBefore("cpp","operator",{"double-colon":{pattern:/::/,alias:"punctuation"}}),e.languages.insertBefore("cpp","class-name",{"base-clause":{pattern:/(\b(?:class|struct)\s+\w+\s*:\s*)[^;{}"'\s]+(?:\s+[^;{}"'\s]+)*(?=\s*[;{])/,lookbehind:!0,greedy:!0,inside:e.languages.extend("cpp",{})}}),e.languages.insertBefore("inside","double-colon",{"class-name":/\b[a-z_]\w*\b(?!\s*::)/i},e.languages.cpp["base-clause"])}(Prism)},3967:function(){!function(e){function t(e,t){return e.replace(/<<(\d+)>>/g,(function(e,n){return"(?:"+t[+n]+")"}))}function n(e,n,r){return RegExp(t(e,n),r||"")}function r(e,t){for(var n=0;n<t;n++)e=e.replace(/<<self>>/g,(function(){return"(?:"+e+")"}));return e.replace(/<<self>>/g,"[^\\s\\S]")}var o="bool byte char decimal double dynamic float int long object sbyte short string uint ulong ushort var void",i="class enum interface record struct",a="add alias and ascending async await by descending from(?=\\s*(?:\\w|$)) get global group into init(?=\\s*;) join let nameof not notnull on or orderby partial remove select set unmanaged value when where with(?=\\s*{)",s="abstract as base break case catch checked const continue default delegate do else event explicit extern finally fixed for foreach goto if implicit in internal is lock namespace new null operator out override params private protected public readonly ref return sealed sizeof stackalloc static switch this throw try typeof unchecked unsafe using virtual volatile while yield";function l(e){return"\\b(?:"+e.trim().replace(/ /g,"|")+")\\b"}var c=l(i),u=RegExp(l(o+" "+i+" "+a+" "+s)),p=l(i+" "+a+" "+s),d=l(o+" "+i+" "+s),f=r(/<(?:[^<>;=+\-*/%&|^]|<<self>>)*>/.source,2),h=r(/\((?:[^()]|<<self>>)*\)/.source,2),m=/@?\b[A-Za-z_]\w*\b/.source,g=t(/<<0>>(?:\s*<<1>>)?/.source,[m,f]),y=t(/(?!<<0>>)<<1>>(?:\s*\.\s*<<1>>)*/.source,[p,g]),v=/\[\s*(?:,\s*)*\]/.source,b=t(/<<0>>(?:\s*(?:\?\s*)?<<1>>)*(?:\s*\?)?/.source,[y,v]),w=t(/[^,()<>[\];=+\-*/%&|^]|<<0>>|<<1>>|<<2>>/.source,[f,h,v]),x=t(/\(<<0>>+(?:,<<0>>+)+\)/.source,[w]),k=t(/(?:<<0>>|<<1>>)(?:\s*(?:\?\s*)?<<2>>)*(?:\s*\?)?/.source,[x,y,v]),_={keyword:u,punctuation:/[<>()?,.:[\]]/},O=/'(?:[^\r\n'\\]|\\.|\\[Uux][\da-fA-F]{1,8})'/.source,S=/"(?:\\.|[^\\"\r\n])*"/.source,E=/@"(?:""|\\[\s\S]|[^\\"])*"(?!")/.source;e.languages.csharp=e.languages.extend("clike",{string:[{pattern:n(/(^|[^$\\])<<0>>/.source,[E]),lookbehind:!0,greedy:!0},{pattern:n(/(^|[^@$\\])<<0>>/.source,[S]),lookbehind:!0,greedy:!0}],"class-name":[{pattern:n(/(\busing\s+static\s+)<<0>>(?=\s*;)/.source,[y]),lookbehind:!0,inside:_},{pattern:n(/(\busing\s+<<0>>\s*=\s*)<<1>>(?=\s*;)/.source,[m,k]),lookbehind:!0,inside:_},{pattern:n(/(\busing\s+)<<0>>(?=\s*=)/.source,[m]),lookbehind:!0},{pattern:n(/(\b<<0>>\s+)<<1>>/.source,[c,g]),lookbehind:!0,inside:_},{pattern:n(/(\bcatch\s*\(\s*)<<0>>/.source,[y]),lookbehind:!0,inside:_},{pattern:n(/(\bwhere\s+)<<0>>/.source,[m]),lookbehind:!0},{pattern:n(/(\b(?:is(?:\s+not)?|as)\s+)<<0>>/.source,[b]),lookbehind:!0,inside:_},{pattern:n(/\b<<0>>(?=\s+(?!<<1>>|with\s*\{)<<2>>(?:\s*[=,;:{)\]]|\s+(?:in|when)\b))/.source,[k,d,m]),inside:_}],keyword:u,number:/(?:\b0(?:x[\da-f_]*[\da-f]|b[01_]*[01])|(?:\B\.\d+(?:_+\d+)*|\b\d+(?:_+\d+)*(?:\.\d+(?:_+\d+)*)?)(?:e[-+]?\d+(?:_+\d+)*)?)(?:[dflmu]|lu|ul)?\b/i,operator:/>>=?|<<=?|[-=]>|([-+&|])\1|~|\?\?=?|[-+*/%&|^!=<>]=?/,punctuation:/\?\.?|::|[{}[\];(),.:]/}),e.languages.insertBefore("csharp","number",{range:{pattern:/\.\./,alias:"operator"}}),e.languages.insertBefore("csharp","punctuation",{"named-parameter":{pattern:n(/([(,]\s*)<<0>>(?=\s*:)/.source,[m]),lookbehind:!0,alias:"punctuation"}}),e.languages.insertBefore("csharp","class-name",{namespace:{pattern:n(/(\b(?:namespace|using)\s+)<<0>>(?:\s*\.\s*<<0>>)*(?=\s*[;{])/.source,[m]),lookbehind:!0,inside:{punctuation:/\./}},"type-expression":{pattern:n(/(\b(?:default|sizeof|typeof)\s*\(\s*(?!\s))(?:[^()\s]|\s(?!\s)|<<0>>)*(?=\s*\))/.source,[h]),lookbehind:!0,alias:"class-name",inside:_},"return-type":{pattern:n(/<<0>>(?=\s+(?:<<1>>\s*(?:=>|[({]|\.\s*this\s*\[)|this\s*\[))/.source,[k,y]),inside:_,alias:"class-name"},"constructor-invocation":{pattern:n(/(\bnew\s+)<<0>>(?=\s*[[({])/.source,[k]),lookbehind:!0,inside:_,alias:"class-name"},"generic-method":{pattern:n(/<<0>>\s*<<1>>(?=\s*\()/.source,[m,f]),inside:{function:n(/^<<0>>/.source,[m]),generic:{pattern:RegExp(f),alias:"class-name",inside:_}}},"type-list":{pattern:n(/\b((?:<<0>>\s+<<1>>|record\s+<<1>>\s*<<5>>|where\s+<<2>>)\s*:\s*)(?:<<3>>|<<4>>|<<1>>\s*<<5>>|<<6>>)(?:\s*,\s*(?:<<3>>|<<4>>|<<6>>))*(?=\s*(?:where|[{;]|=>|$))/.source,[c,g,m,k,u.source,h,/\bnew\s*\(\s*\)/.source]),lookbehind:!0,inside:{"record-arguments":{pattern:n(/(^(?!new\s*\()<<0>>\s*)<<1>>/.source,[g,h]),lookbehind:!0,greedy:!0,inside:e.languages.csharp},keyword:u,"class-name":{pattern:RegExp(k),greedy:!0,inside:_},punctuation:/[,()]/}},preprocessor:{pattern:/(^[\t ]*)#.*/m,lookbehind:!0,alias:"property",inside:{directive:{pattern:/(#)\b(?:define|elif|else|endif|endregion|error|if|line|nullable|pragma|region|undef|warning)\b/,lookbehind:!0,alias:"keyword"}}}});var P=S+"|"+O,A=t(/\/(?![*/])|\/\/[^\r\n]*[\r\n]|\/\*(?:[^*]|\*(?!\/))*\*\/|<<0>>/.source,[P]),$=r(t(/[^"'/()]|<<0>>|\(<<self>>*\)/.source,[A]),2),C=/\b(?:assembly|event|field|method|module|param|property|return|type)\b/.source,R=t(/<<0>>(?:\s*\(<<1>>*\))?/.source,[y,$]);e.languages.insertBefore("csharp","class-name",{attribute:{pattern:n(/((?:^|[^\s\w>)?])\s*\[\s*)(?:<<0>>\s*:\s*)?<<1>>(?:\s*,\s*<<1>>)*(?=\s*\])/.source,[C,R]),lookbehind:!0,greedy:!0,inside:{target:{pattern:n(/^<<0>>(?=\s*:)/.source,[C]),alias:"keyword"},"attribute-arguments":{pattern:n(/\(<<0>>*\)/.source,[$]),inside:e.languages.csharp},"class-name":{pattern:RegExp(y),inside:{punctuation:/\./}},punctuation:/[:,]/}}});var j=/:[^}\r\n]+/.source,T=r(t(/[^"'/()]|<<0>>|\(<<self>>*\)/.source,[A]),2),I=t(/\{(?!\{)(?:(?![}:])<<0>>)*<<1>>?\}/.source,[T,j]),N=r(t(/[^"'/()]|\/(?!\*)|\/\*(?:[^*]|\*(?!\/))*\*\/|<<0>>|\(<<self>>*\)/.source,[P]),2),D=t(/\{(?!\{)(?:(?![}:])<<0>>)*<<1>>?\}/.source,[N,j]);function L(t,r){return{interpolation:{pattern:n(/((?:^|[^{])(?:\{\{)*)<<0>>/.source,[t]),lookbehind:!0,inside:{"format-string":{pattern:n(/(^\{(?:(?![}:])<<0>>)*)<<1>>(?=\}$)/.source,[r,j]),lookbehind:!0,inside:{punctuation:/^:/}},punctuation:/^\{|\}$/,expression:{pattern:/[\s\S]+/,alias:"language-csharp",inside:e.languages.csharp}}},string:/[\s\S]+/}}e.languages.insertBefore("csharp","string",{"interpolation-string":[{pattern:n(/(^|[^\\])(?:\$@|@\$)"(?:""|\\[\s\S]|\{\{|<<0>>|[^\\{"])*"/.source,[I]),lookbehind:!0,greedy:!0,inside:L(I,T)},{pattern:n(/(^|[^@\\])\$"(?:\\.|\{\{|<<0>>|[^\\"{])*"/.source,[D]),lookbehind:!0,greedy:!0,inside:L(D,N)}],char:{pattern:RegExp(O),greedy:!0}}),e.languages.dotnet=e.languages.cs=e.languages.csharp}(Prism)},8052:function(){Prism.languages.csv={value:/[^\r\n,"]+|"(?:[^"]|"")*"(?!")/,punctuation:/,/}},7046:function(){Prism.languages.go=Prism.languages.extend("clike",{string:{pattern:/(^|[^\\])"(?:\\.|[^"\\\r\n])*"|`[^`]*`/,lookbehind:!0,greedy:!0},keyword:/\b(?:break|case|chan|const|continue|default|defer|else|fallthrough|for|func|go(?:to)?|if|import|interface|map|package|range|return|select|struct|switch|type|var)\b/,boolean:/\b(?:_|false|iota|nil|true)\b/,number:[/\b0(?:b[01_]+|o[0-7_]+)i?\b/i,/\b0x(?:[a-f\d_]+(?:\.[a-f\d_]*)?|\.[a-f\d_]+)(?:p[+-]?\d+(?:_\d+)*)?i?(?!\w)/i,/(?:\b\d[\d_]*(?:\.[\d_]*)?|\B\.\d[\d_]*)(?:e[+-]?[\d_]+)?i?(?!\w)/i],operator:/[*\/%^!=]=?|\+[=+]?|-[=-]?|\|[=|]?|&(?:=|&|\^=?)?|>(?:>=?|=)?|<(?:<=?|=|-)?|:=|\.\.\./,builtin:/\b(?:append|bool|byte|cap|close|complex|complex(?:64|128)|copy|delete|error|float(?:32|64)|u?int(?:8|16|32|64)?|imag|len|make|new|panic|print(?:ln)?|real|recover|rune|string|uintptr)\b/}),Prism.languages.insertBefore("go","string",{char:{pattern:/'(?:\\.|[^'\\\r\n]){0,10}'/,greedy:!0}}),delete Prism.languages.go["class-name"]},57:function(){!function(e){function t(e){return RegExp("(^(?:"+e+"):[ \t]*(?![ \t]))[^]+","i")}e.languages.http={"request-line":{pattern:/^(?:CONNECT|DELETE|GET|HEAD|OPTIONS|PATCH|POST|PRI|PUT|SEARCH|TRACE)\s(?:https?:\/\/|\/)\S*\sHTTP\/[\d.]+/m,inside:{method:{pattern:/^[A-Z]+\b/,alias:"property"},"request-target":{pattern:/^(\s)(?:https?:\/\/|\/)\S*(?=\s)/,lookbehind:!0,alias:"url",inside:e.languages.uri},"http-version":{pattern:/^(\s)HTTP\/[\d.]+/,lookbehind:!0,alias:"property"}}},"response-status":{pattern:/^HTTP\/[\d.]+ \d+ .+/m,inside:{"http-version":{pattern:/^HTTP\/[\d.]+/,alias:"property"},"status-code":{pattern:/^(\s)\d+(?=\s)/,lookbehind:!0,alias:"number"},"reason-phrase":{pattern:/^(\s).+/,lookbehind:!0,alias:"string"}}},header:{pattern:/^[\w-]+:.+(?:(?:\r\n?|\n)[ \t].+)*/m,inside:{"header-value":[{pattern:t(/Content-Security-Policy/.source),lookbehind:!0,alias:["csp","languages-csp"],inside:e.languages.csp},{pattern:t(/Public-Key-Pins(?:-Report-Only)?/.source),lookbehind:!0,alias:["hpkp","languages-hpkp"],inside:e.languages.hpkp},{pattern:t(/Strict-Transport-Security/.source),lookbehind:!0,alias:["hsts","languages-hsts"],inside:e.languages.hsts},{pattern:t(/[^:]+/.source),lookbehind:!0}],"header-name":{pattern:/^[^:]+/,alias:"keyword"},punctuation:/^:/}}};var n,r=e.languages,o={"application/javascript":r.javascript,"application/json":r.json||r.javascript,"application/xml":r.xml,"text/xml":r.xml,"text/html":r.html,"text/css":r.css,"text/plain":r.plain},i={"application/json":!0,"application/xml":!0};function a(e){var t=e.replace(/^[a-z]+\//,"");return"(?:"+e+"|\\w+/(?:[\\w.-]+\\+)+"+t+"(?![+\\w.-]))"}for(var s in o)if(o[s]){n=n||{};var l=i[s]?a(s):s;n[s.replace(/\//g,"-")]={pattern:RegExp("("+/content-type:\s*/.source+l+/(?:(?:\r\n?|\n)[\w-].*)*(?:\r(?:\n|(?!\n))|\n)/.source+")"+/[^ \t\w-][\s\S]*/.source,"i"),lookbehind:!0,inside:o[s]}}n&&e.languages.insertBefore("http","header",n)}(Prism)},2503:function(){!function(e){var t=/\b(?:abstract|assert|boolean|break|byte|case|catch|char|class|const|continue|default|do|double|else|enum|exports|extends|final|finally|float|for|goto|if|implements|import|instanceof|int|interface|long|module|native|new|non-sealed|null|open|opens|package|permits|private|protected|provides|public|record|requires|return|sealed|short|static|strictfp|super|switch|synchronized|this|throw|throws|to|transient|transitive|try|uses|var|void|volatile|while|with|yield)\b/,n=/(^|[^\w.])(?:[a-z]\w*\s*\.\s*)*(?:[A-Z]\w*\s*\.\s*)*/.source,r={pattern:RegExp(n+/[A-Z](?:[\d_A-Z]*[a-z]\w*)?\b/.source),lookbehind:!0,inside:{namespace:{pattern:/^[a-z]\w*(?:\s*\.\s*[a-z]\w*)*(?:\s*\.)?/,inside:{punctuation:/\./}},punctuation:/\./}};e.languages.java=e.languages.extend("clike",{string:{pattern:/(^|[^\\])"(?:\\.|[^"\\\r\n])*"/,lookbehind:!0,greedy:!0},"class-name":[r,{pattern:RegExp(n+/[A-Z]\w*(?=\s+\w+\s*[;,=()])/.source),lookbehind:!0,inside:r.inside}],keyword:t,function:[e.languages.clike.function,{pattern:/(::\s*)[a-z_]\w*/,lookbehind:!0}],number:/\b0b[01][01_]*L?\b|\b0x(?:\.[\da-f_p+-]+|[\da-f_]+(?:\.[\da-f_p+-]+)?)\b|(?:\b\d[\d_]*(?:\.[\d_]*)?|\B\.\d[\d_]*)(?:e[+-]?\d[\d_]*)?[dfl]?/i,operator:{pattern:/(^|[^.])(?:<<=?|>>>?=?|->|--|\+\+|&&|\|\||::|[?:~]|[-+*/%&|^!=<>]=?)/m,lookbehind:!0}}),e.languages.insertBefore("java","string",{"triple-quoted-string":{pattern:/"""[ \t]*[\r\n](?:(?:"|"")?(?:\\.|[^"\\]))*"""/,greedy:!0,alias:"string"},char:{pattern:/'(?:\\.|[^'\\\r\n]){1,6}'/,greedy:!0}}),e.languages.insertBefore("java","class-name",{annotation:{pattern:/(^|[^.])@\w+(?:\s*\.\s*\w+)*/,lookbehind:!0,alias:"punctuation"},generics:{pattern:/<(?:[\w\s,.?]|&(?!&)|<(?:[\w\s,.?]|&(?!&)|<(?:[\w\s,.?]|&(?!&)|<(?:[\w\s,.?]|&(?!&))*>)*>)*>)*>/,inside:{"class-name":r,keyword:t,punctuation:/[<>(),.:]/,operator:/[?&|]/}},namespace:{pattern:RegExp(/(\b(?:exports|import(?:\s+static)?|module|open|opens|package|provides|requires|to|transitive|uses|with)\s+)(?!<keyword>)[a-z]\w*(?:\.[a-z]\w*)*\.?/.source.replace(/<keyword>/g,(function(){return t.source}))),lookbehind:!0,inside:{punctuation:/\./}}})}(Prism)},6841:function(){Prism.languages.lua={comment:/^#!.+|--(?:\[(=*)\[[\s\S]*?\]\1\]|.*)/m,string:{pattern:/(["'])(?:(?!\1)[^\\\r\n]|\\z(?:\r\n|\s)|\\(?:\r\n|[^z]))*\1|\[(=*)\[[\s\S]*?\]\2\]/,greedy:!0},number:/\b0x[a-f\d]+(?:\.[a-f\d]*)?(?:p[+-]?\d+)?\b|\b\d+(?:\.\B|(?:\.\d*)?(?:e[+-]?\d+)?\b)|\B\.\d+(?:e[+-]?\d+)?\b/i,keyword:/\b(?:and|break|do|else|elseif|end|false|for|function|goto|if|in|local|nil|not|or|repeat|return|then|true|until|while)\b/,function:/(?!\d)\w+(?=\s*(?:[({]))/,operator:[/[-+*%^&|#]|\/\/?|<[<=]?|>[>=]?|[=~]=?/,{pattern:/(^|[^.])\.\.(?!\.)/,lookbehind:!0}],punctuation:/[\[\](){},;]|\.+|:+/}},6854:function(){!function(e){function t(e,t){return"___"+e.toUpperCase()+t+"___"}Object.defineProperties(e.languages["markup-templating"]={},{buildPlaceholders:{value:function(n,r,o,i){if(n.language===r){var a=n.tokenStack=[];n.code=n.code.replace(o,(function(e){if("function"==typeof i&&!i(e))return e;for(var o,s=a.length;-1!==n.code.indexOf(o=t(r,s));)++s;return a[s]=e,o})),n.grammar=e.languages.markup}}},tokenizePlaceholders:{value:function(n,r){if(n.language===r&&n.tokenStack){n.grammar=e.languages[r];var o=0,i=Object.keys(n.tokenStack);!function a(s){for(var l=0;l<s.length&&!(o>=i.length);l++){var c=s[l];if("string"==typeof c||c.content&&"string"==typeof c.content){var u=i[o],p=n.tokenStack[u],d="string"==typeof c?c:c.content,f=t(r,u),h=d.indexOf(f);if(h>-1){++o;var m=d.substring(0,h),g=new e.Token(r,e.tokenize(p,n.grammar),"language-"+r,p),y=d.substring(h+f.length),v=[];m&&v.push.apply(v,a([m])),v.push(g),y&&v.push.apply(v,a([y])),"string"==typeof c?s.splice.apply(s,[l,1].concat(v)):c.content=v}}else c.content&&a(c.content)}return s}(n.tokens)}}}})}(Prism)},4335:function(){Prism.languages.markup={comment:{pattern:/<!--(?:(?!<!--)[\s\S])*?-->/,greedy:!0},prolog:{pattern:/<\?[\s\S]+?\?>/,greedy:!0},doctype:{pattern:/<!DOCTYPE(?:[^>"'[\]]|"[^"]*"|'[^']*')+(?:\[(?:[^<"'\]]|"[^"]*"|'[^']*'|<(?!!--)|<!--(?:[^-]|-(?!->))*-->)*\]\s*)?>/i,greedy:!0,inside:{"internal-subset":{pattern:/(^[^\[]*\[)[\s\S]+(?=\]>$)/,lookbehind:!0,greedy:!0,inside:null},string:{pattern:/"[^"]*"|'[^']*'/,greedy:!0},punctuation:/^<!|>$|[[\]]/,"doctype-tag":/^DOCTYPE/i,name:/[^\s<>'"]+/}},cdata:{pattern:/<!\[CDATA\[[\s\S]*?\]\]>/i,greedy:!0},tag:{pattern:/<\/?(?!\d)[^\s>\/=$<%]+(?:\s(?:\s*[^\s>\/=]+(?:\s*=\s*(?:"[^"]*"|'[^']*'|[^\s'">=]+(?=[\s>]))|(?=[\s/>])))+)?\s*\/?>/,greedy:!0,inside:{tag:{pattern:/^<\/?[^\s>\/]+/,inside:{punctuation:/^<\/?/,namespace:/^[^\s>\/:]+:/}},"special-attr":[],"attr-value":{pattern:/=\s*(?:"[^"]*"|'[^']*'|[^\s'">=]+)/,inside:{punctuation:[{pattern:/^=/,alias:"attr-equals"},/"|'/]}},punctuation:/\/?>/,"attr-name":{pattern:/[^\s>\/]+/,inside:{namespace:/^[^\s>\/:]+:/}}}},entity:[{pattern:/&[\da-z]{1,8};/i,alias:"named-entity"},/&#x?[\da-f]{1,8};/i]},Prism.languages.markup.tag.inside["attr-value"].inside.entity=Prism.languages.markup.entity,Prism.languages.markup.doctype.inside["internal-subset"].inside=Prism.languages.markup,Prism.hooks.add("wrap",(function(e){"entity"===e.type&&(e.attributes.title=e.content.replace(/&/,"&"))})),Object.defineProperty(Prism.languages.markup.tag,"addInlined",{value:function(e,t){var n={};n["language-"+t]={pattern:/(^<!\[CDATA\[)[\s\S]+?(?=\]\]>$)/i,lookbehind:!0,inside:Prism.languages[t]},n.cdata=/^<!\[CDATA\[|\]\]>$/i;var r={"included-cdata":{pattern:/<!\[CDATA\[[\s\S]*?\]\]>/i,inside:n}};r["language-"+t]={pattern:/[\s\S]+/,inside:Prism.languages[t]};var o={};o[e]={pattern:RegExp(/(<__[^>]*>)(?:<!\[CDATA\[(?:[^\]]|\](?!\]>))*\]\]>|(?!<!\[CDATA\[)[\s\S])*?(?=<\/__>)/.source.replace(/__/g,(function(){return e})),"i"),lookbehind:!0,greedy:!0,inside:r},Prism.languages.insertBefore("markup","cdata",o)}}),Object.defineProperty(Prism.languages.markup.tag,"addAttribute",{value:function(e,t){Prism.languages.markup.tag.inside["special-attr"].push({pattern:RegExp(/(^|["'\s])/.source+"(?:"+e+")"+/\s*=\s*(?:"[^"]*"|'[^']*'|[^\s'">=]+(?=[\s>]))/.source,"i"),lookbehind:!0,inside:{"attr-name":/^[^\s=]+/,"attr-value":{pattern:/=[\s\S]+/,inside:{value:{pattern:/(^=\s*(["']|(?!["'])))\S[\s\S]*(?=\2$)/,lookbehind:!0,alias:[t,"language-"+t],inside:Prism.languages[t]},punctuation:[{pattern:/^=/,alias:"attr-equals"},/"|'/]}}}})}}),Prism.languages.html=Prism.languages.markup,Prism.languages.mathml=Prism.languages.markup,Prism.languages.svg=Prism.languages.markup,Prism.languages.xml=Prism.languages.extend("markup",{}),Prism.languages.ssml=Prism.languages.xml,Prism.languages.atom=Prism.languages.xml,Prism.languages.rss=Prism.languages.xml},1426:function(){Prism.languages.objectivec=Prism.languages.extend("c",{string:{pattern:/@?"(?:\\(?:\r\n|[\s\S])|[^"\\\r\n])*"/,greedy:!0},keyword:/\b(?:asm|auto|break|case|char|const|continue|default|do|double|else|enum|extern|float|for|goto|if|in|inline|int|long|register|return|self|short|signed|sizeof|static|struct|super|switch|typedef|typeof|union|unsigned|void|volatile|while)\b|(?:@interface|@end|@implementation|@protocol|@class|@public|@protected|@private|@property|@try|@catch|@finally|@throw|@synthesize|@dynamic|@selector)\b/,operator:/-[->]?|\+\+?|!=?|<<?=?|>>?=?|==?|&&?|\|\|?|[~^%?*\/@]/}),delete Prism.languages.objectivec["class-name"],Prism.languages.objc=Prism.languages.objectivec},8246:function(){!function(e){var t=/(?:\((?:[^()\\]|\\[\s\S])*\)|\{(?:[^{}\\]|\\[\s\S])*\}|\[(?:[^[\]\\]|\\[\s\S])*\]|<(?:[^<>\\]|\\[\s\S])*>)/.source;e.languages.perl={comment:[{pattern:/(^\s*)=\w[\s\S]*?=cut.*/m,lookbehind:!0,greedy:!0},{pattern:/(^|[^\\$])#.*/,lookbehind:!0,greedy:!0}],string:[{pattern:RegExp(/\b(?:q|qq|qw|qx)(?![a-zA-Z0-9])\s*/.source+"(?:"+[/([^a-zA-Z0-9\s{(\[<])(?:(?!\1)[^\\]|\\[\s\S])*\1/.source,/([a-zA-Z0-9])(?:(?!\2)[^\\]|\\[\s\S])*\2/.source,t].join("|")+")"),greedy:!0},{pattern:/("|`)(?:(?!\1)[^\\]|\\[\s\S])*\1/,greedy:!0},{pattern:/'(?:[^'\\\r\n]|\\.)*'/,greedy:!0}],regex:[{pattern:RegExp(/\b(?:m|qr)(?![a-zA-Z0-9])\s*/.source+"(?:"+[/([^a-zA-Z0-9\s{(\[<])(?:(?!\1)[^\\]|\\[\s\S])*\1/.source,/([a-zA-Z0-9])(?:(?!\2)[^\\]|\\[\s\S])*\2/.source,t].join("|")+")"+/[msixpodualngc]*/.source),greedy:!0},{pattern:RegExp(/(^|[^-])\b(?:s|tr|y)(?![a-zA-Z0-9])\s*/.source+"(?:"+[/([^a-zA-Z0-9\s{(\[<])(?:(?!\2)[^\\]|\\[\s\S])*\2(?:(?!\2)[^\\]|\\[\s\S])*\2/.source,/([a-zA-Z0-9])(?:(?!\3)[^\\]|\\[\s\S])*\3(?:(?!\3)[^\\]|\\[\s\S])*\3/.source,t+/\s*/.source+t].join("|")+")"+/[msixpodualngcer]*/.source),lookbehind:!0,greedy:!0},{pattern:/\/(?:[^\/\\\r\n]|\\.)*\/[msixpodualngc]*(?=\s*(?:$|[\r\n,.;})&|\-+*~<>!?^]|(?:and|cmp|eq|ge|gt|le|lt|ne|not|or|x|xor)\b))/,greedy:!0}],variable:[/[&*$@%]\{\^[A-Z]+\}/,/[&*$@%]\^[A-Z_]/,/[&*$@%]#?(?=\{)/,/[&*$@%]#?(?:(?:::)*'?(?!\d)[\w$]+(?![\w$]))+(?:::)*/,/[&*$@%]\d+/,/(?!%=)[$@%][!"#$%&'()*+,\-.\/:;<=>?@[\\\]^_`{|}~]/],filehandle:{pattern:/<(?![<=])\S*?>|\b_\b/,alias:"symbol"},"v-string":{pattern:/v\d+(?:\.\d+)*|\d+(?:\.\d+){2,}/,alias:"string"},function:{pattern:/(\bsub[ \t]+)\w+/,lookbehind:!0},keyword:/\b(?:any|break|continue|default|delete|die|do|else|elsif|eval|for|foreach|given|goto|if|last|local|my|next|our|package|print|redo|require|return|say|state|sub|switch|undef|unless|until|use|when|while)\b/,number:/\b(?:0x[\dA-Fa-f](?:_?[\dA-Fa-f])*|0b[01](?:_?[01])*|(?:(?:\d(?:_?\d)*)?\.)?\d(?:_?\d)*(?:[Ee][+-]?\d+)?)\b/,operator:/-[rwxoRWXOezsfdlpSbctugkTBMAC]\b|\+[+=]?|-[-=>]?|\*\*?=?|\/\/?=?|=[=~>]?|~[~=]?|\|\|?=?|&&?=?|<(?:=>?|<=?)?|>>?=?|![~=]?|[%^]=?|\.(?:=|\.\.?)?|[\\?]|\bx(?:=|\b)|\b(?:and|cmp|eq|ge|gt|le|lt|ne|not|or|xor)\b/,punctuation:/[{}[\];(),:]/}}(Prism)},9945:function(){!function(e){var t=/\/\*[\s\S]*?\*\/|\/\/.*|#(?!\[).*/,n=[{pattern:/\b(?:false|true)\b/i,alias:"boolean"},{pattern:/(::\s*)\b[a-z_]\w*\b(?!\s*\()/i,greedy:!0,lookbehind:!0},{pattern:/(\b(?:case|const)\s+)\b[a-z_]\w*(?=\s*[;=])/i,greedy:!0,lookbehind:!0},/\b(?:null)\b/i,/\b[A-Z_][A-Z0-9_]*\b(?!\s*\()/],r=/\b0b[01]+(?:_[01]+)*\b|\b0o[0-7]+(?:_[0-7]+)*\b|\b0x[\da-f]+(?:_[\da-f]+)*\b|(?:\b\d+(?:_\d+)*\.?(?:\d+(?:_\d+)*)?|\B\.\d+)(?:e[+-]?\d+)?/i,o=/<?=>|\?\?=?|\.{3}|\??->|[!=]=?=?|::|\*\*=?|--|\+\+|&&|\|\||<<|>>|[?~]|[/^|%*&<>.+-]=?/,i=/[{}\[\](),:;]/;e.languages.php={delimiter:{pattern:/\?>$|^<\?(?:php(?=\s)|=)?/i,alias:"important"},comment:t,variable:/\$+(?:\w+\b|(?=\{))/,package:{pattern:/(namespace\s+|use\s+(?:function\s+)?)(?:\\?\b[a-z_]\w*)+\b(?!\\)/i,lookbehind:!0,inside:{punctuation:/\\/}},"class-name-definition":{pattern:/(\b(?:class|enum|interface|trait)\s+)\b[a-z_]\w*(?!\\)\b/i,lookbehind:!0,alias:"class-name"},"function-definition":{pattern:/(\bfunction\s+)[a-z_]\w*(?=\s*\()/i,lookbehind:!0,alias:"function"},keyword:[{pattern:/(\(\s*)\b(?:array|bool|boolean|float|int|integer|object|string)\b(?=\s*\))/i,alias:"type-casting",greedy:!0,lookbehind:!0},{pattern:/([(,?]\s*)\b(?:array(?!\s*\()|bool|callable|(?:false|null)(?=\s*\|)|float|int|iterable|mixed|object|self|static|string)\b(?=\s*\$)/i,alias:"type-hint",greedy:!0,lookbehind:!0},{pattern:/(\)\s*:\s*(?:\?\s*)?)\b(?:array(?!\s*\()|bool|callable|(?:false|null)(?=\s*\|)|float|int|iterable|mixed|object|self|static|string|void)\b/i,alias:"return-type",greedy:!0,lookbehind:!0},{pattern:/\b(?:array(?!\s*\()|bool|float|int|iterable|mixed|object|string|void)\b/i,alias:"type-declaration",greedy:!0},{pattern:/(\|\s*)(?:false|null)\b|\b(?:false|null)(?=\s*\|)/i,alias:"type-declaration",greedy:!0,lookbehind:!0},{pattern:/\b(?:parent|self|static)(?=\s*::)/i,alias:"static-context",greedy:!0},{pattern:/(\byield\s+)from\b/i,lookbehind:!0},/\bclass\b/i,{pattern:/((?:^|[^\s>:]|(?:^|[^-])>|(?:^|[^:]):)\s*)\b(?:abstract|and|array|as|break|callable|case|catch|clone|const|continue|declare|default|die|do|echo|else|elseif|empty|enddeclare|endfor|endforeach|endif|endswitch|endwhile|enum|eval|exit|extends|final|finally|fn|for|foreach|function|global|goto|if|implements|include|include_once|instanceof|insteadof|interface|isset|list|match|namespace|new|or|parent|print|private|protected|public|require|require_once|return|self|static|switch|throw|trait|try|unset|use|var|while|xor|yield|__halt_compiler)\b/i,lookbehind:!0}],"argument-name":{pattern:/([(,]\s+)\b[a-z_]\w*(?=\s*:(?!:))/i,lookbehind:!0},"class-name":[{pattern:/(\b(?:extends|implements|instanceof|new(?!\s+self|\s+static))\s+|\bcatch\s*\()\b[a-z_]\w*(?!\\)\b/i,greedy:!0,lookbehind:!0},{pattern:/(\|\s*)\b[a-z_]\w*(?!\\)\b/i,greedy:!0,lookbehind:!0},{pattern:/\b[a-z_]\w*(?!\\)\b(?=\s*\|)/i,greedy:!0},{pattern:/(\|\s*)(?:\\?\b[a-z_]\w*)+\b/i,alias:"class-name-fully-qualified",greedy:!0,lookbehind:!0,inside:{punctuation:/\\/}},{pattern:/(?:\\?\b[a-z_]\w*)+\b(?=\s*\|)/i,alias:"class-name-fully-qualified",greedy:!0,inside:{punctuation:/\\/}},{pattern:/(\b(?:extends|implements|instanceof|new(?!\s+self\b|\s+static\b))\s+|\bcatch\s*\()(?:\\?\b[a-z_]\w*)+\b(?!\\)/i,alias:"class-name-fully-qualified",greedy:!0,lookbehind:!0,inside:{punctuation:/\\/}},{pattern:/\b[a-z_]\w*(?=\s*\$)/i,alias:"type-declaration",greedy:!0},{pattern:/(?:\\?\b[a-z_]\w*)+(?=\s*\$)/i,alias:["class-name-fully-qualified","type-declaration"],greedy:!0,inside:{punctuation:/\\/}},{pattern:/\b[a-z_]\w*(?=\s*::)/i,alias:"static-context",greedy:!0},{pattern:/(?:\\?\b[a-z_]\w*)+(?=\s*::)/i,alias:["class-name-fully-qualified","static-context"],greedy:!0,inside:{punctuation:/\\/}},{pattern:/([(,?]\s*)[a-z_]\w*(?=\s*\$)/i,alias:"type-hint",greedy:!0,lookbehind:!0},{pattern:/([(,?]\s*)(?:\\?\b[a-z_]\w*)+(?=\s*\$)/i,alias:["class-name-fully-qualified","type-hint"],greedy:!0,lookbehind:!0,inside:{punctuation:/\\/}},{pattern:/(\)\s*:\s*(?:\?\s*)?)\b[a-z_]\w*(?!\\)\b/i,alias:"return-type",greedy:!0,lookbehind:!0},{pattern:/(\)\s*:\s*(?:\?\s*)?)(?:\\?\b[a-z_]\w*)+\b(?!\\)/i,alias:["class-name-fully-qualified","return-type"],greedy:!0,lookbehind:!0,inside:{punctuation:/\\/}}],constant:n,function:{pattern:/(^|[^\\\w])\\?[a-z_](?:[\w\\]*\w)?(?=\s*\()/i,lookbehind:!0,inside:{punctuation:/\\/}},property:{pattern:/(->\s*)\w+/,lookbehind:!0},number:r,operator:o,punctuation:i};var a={pattern:/\{\$(?:\{(?:\{[^{}]+\}|[^{}]+)\}|[^{}])+\}|(^|[^\\{])\$+(?:\w+(?:\[[^\r\n\[\]]+\]|->\w+)?)/,lookbehind:!0,inside:e.languages.php},s=[{pattern:/<<<'([^']+)'[\r\n](?:.*[\r\n])*?\1;/,alias:"nowdoc-string",greedy:!0,inside:{delimiter:{pattern:/^<<<'[^']+'|[a-z_]\w*;$/i,alias:"symbol",inside:{punctuation:/^<<<'?|[';]$/}}}},{pattern:/<<<(?:"([^"]+)"[\r\n](?:.*[\r\n])*?\1;|([a-z_]\w*)[\r\n](?:.*[\r\n])*?\2;)/i,alias:"heredoc-string",greedy:!0,inside:{delimiter:{pattern:/^<<<(?:"[^"]+"|[a-z_]\w*)|[a-z_]\w*;$/i,alias:"symbol",inside:{punctuation:/^<<<"?|[";]$/}},interpolation:a}},{pattern:/`(?:\\[\s\S]|[^\\`])*`/,alias:"backtick-quoted-string",greedy:!0},{pattern:/'(?:\\[\s\S]|[^\\'])*'/,alias:"single-quoted-string",greedy:!0},{pattern:/"(?:\\[\s\S]|[^\\"])*"/,alias:"double-quoted-string",greedy:!0,inside:{interpolation:a}}];e.languages.insertBefore("php","variable",{string:s,attribute:{pattern:/#\[(?:[^"'\/#]|\/(?![*/])|\/\/.*$|#(?!\[).*$|\/\*(?:[^*]|\*(?!\/))*\*\/|"(?:\\[\s\S]|[^\\"])*"|'(?:\\[\s\S]|[^\\'])*')+\](?=\s*[a-z$#])/im,greedy:!0,inside:{"attribute-content":{pattern:/^(#\[)[\s\S]+(?=\]$)/,lookbehind:!0,inside:{comment:t,string:s,"attribute-class-name":[{pattern:/([^:]|^)\b[a-z_]\w*(?!\\)\b/i,alias:"class-name",greedy:!0,lookbehind:!0},{pattern:/([^:]|^)(?:\\?\b[a-z_]\w*)+/i,alias:["class-name","class-name-fully-qualified"],greedy:!0,lookbehind:!0,inside:{punctuation:/\\/}}],constant:n,number:r,operator:o,punctuation:i}},delimiter:{pattern:/^#\[|\]$/,alias:"punctuation"}}}}),e.hooks.add("before-tokenize",(function(t){/<\?/.test(t.code)&&e.languages["markup-templating"].buildPlaceholders(t,"php",/<\?(?:[^"'/#]|\/(?![*/])|("|')(?:\\[\s\S]|(?!\1)[^\\])*\1|(?:\/\/|#(?!\[))(?:[^?\n\r]|\?(?!>))*(?=$|\?>|[\r\n])|#\[|\/\*(?:[^*]|\*(?!\/))*(?:\*\/|$))*?(?:\?>|$)/g)})),e.hooks.add("after-tokenize",(function(t){e.languages["markup-templating"].tokenizePlaceholders(t,"php")}))}(Prism)},366:function(){Prism.languages.python={comment:{pattern:/(^|[^\\])#.*/,lookbehind:!0,greedy:!0},"string-interpolation":{pattern:/(?:f|fr|rf)(?:("""|''')[\s\S]*?\1|("|')(?:\\.|(?!\2)[^\\\r\n])*\2)/i,greedy:!0,inside:{interpolation:{pattern:/((?:^|[^{])(?:\{\{)*)\{(?!\{)(?:[^{}]|\{(?!\{)(?:[^{}]|\{(?!\{)(?:[^{}])+\})+\})+\}/,lookbehind:!0,inside:{"format-spec":{pattern:/(:)[^:(){}]+(?=\}$)/,lookbehind:!0},"conversion-option":{pattern://,alias:"punctuation"},rest:null}},string:/[\s\S]+/}},"triple-quoted-string":{pattern:/(?:[rub]|br|rb)?("""|''')[\s\S]*?\1/i,greedy:!0,alias:"string"},string:{pattern:/(?:[rub]|br|rb)?("|')(?:\\.|(?!\1)[^\\\r\n])*\1/i,greedy:!0},function:{pattern:/((?:^|\s)def[ \t]+)[a-zA-Z_]\w*(?=\s*\()/g,lookbehind:!0},"class-name":{pattern:/(\bclass\s+)\w+/i,lookbehind:!0},decorator:{pattern:/(^[\t ]*)@\w+(?:\.\w+)*/m,lookbehind:!0,alias:["annotation","punctuation"],inside:{punctuation:/\./}},keyword:/\b(?:_(?=\s*:)|and|as|assert|async|await|break|case|class|continue|def|del|elif|else|except|exec|finally|for|from|global|if|import|in|is|lambda|match|nonlocal|not|or|pass|print|raise|return|try|while|with|yield)\b/,builtin:/\b(?:__import__|abs|all|any|apply|ascii|basestring|bin|bool|buffer|bytearray|bytes|callable|chr|classmethod|cmp|coerce|compile|complex|delattr|dict|dir|divmod|enumerate|eval|execfile|file|filter|float|format|frozenset|getattr|globals|hasattr|hash|help|hex|id|input|int|intern|isinstance|issubclass|iter|len|list|locals|long|map|max|memoryview|min|next|object|oct|open|ord|pow|property|range|raw_input|reduce|reload|repr|reversed|round|set|setattr|slice|sorted|staticmethod|str|sum|super|tuple|type|unichr|unicode|vars|xrange|zip)\b/,boolean:/\b(?:False|None|True)\b/,number:/\b0(?:b(?:_?[01])+|o(?:_?[0-7])+|x(?:_?[a-f0-9])+)\b|(?:\b\d+(?:_\d+)*(?:\.(?:\d+(?:_\d+)*)?)?|\B\.\d+(?:_\d+)*)(?:e[+-]?\d+(?:_\d+)*)?j?(?!\w)/i,operator:/[-+%=]=?|!=|:=|\*\*?=?|\/\/?=?|<[<=>]?|>[=>]?|[&|^~]/,punctuation:/[{}[\];(),.:]/},Prism.languages.python["string-interpolation"].inside.interpolation.inside.rest=Prism.languages.python,Prism.languages.py=Prism.languages.python},2939:function(){Prism.languages.q={string:/"(?:\\.|[^"\\\r\n])*"/,comment:[{pattern:/([\t )\]}])\/.*/,lookbehind:!0,greedy:!0},{pattern:/(^|\r?\n|\r)\/[\t ]*(?:(?:\r?\n|\r)(?:.*(?:\r?\n|\r(?!\n)))*?(?:\\(?=[\t ]*(?:\r?\n|\r))|$)|\S.*)/,lookbehind:!0,greedy:!0},{pattern:/^\\[\t ]*(?:\r?\n|\r)[\s\S]+/m,greedy:!0},{pattern:/^#!.+/m,greedy:!0}],symbol:/`(?::\S+|[\w.]*)/,datetime:{pattern:/0N[mdzuvt]|0W[dtz]|\d{4}\.\d\d(?:m|\.\d\d(?:T(?:\d\d(?::\d\d(?::\d\d(?:[.:]\d\d\d)?)?)?)?)?[dz]?)|\d\d:\d\d(?::\d\d(?:[.:]\d\d\d)?)?[uvt]?/,alias:"number"},number:/\b(?![01]:)(?:0N[hje]?|0W[hj]?|0[wn]|0x[\da-fA-F]+|\d+(?:\.\d*)?(?:e[+-]?\d+)?[hjfeb]?)/,keyword:/\\\w+\b|\b(?:abs|acos|aj0?|all|and|any|asc|asin|asof|atan|attr|avgs?|binr?|by|ceiling|cols|cor|cos|count|cov|cross|csv|cut|delete|deltas|desc|dev|differ|distinct|div|do|dsave|ej|enlist|eval|except|exec|exit|exp|fby|fills|first|fkeys|flip|floor|from|get|getenv|group|gtime|hclose|hcount|hdel|hopen|hsym|iasc|identity|idesc|if|ij|in|insert|inter|inv|keys?|last|like|list|ljf?|load|log|lower|lsq|ltime|ltrim|mavg|maxs?|mcount|md5|mdev|med|meta|mins?|mmax|mmin|mmu|mod|msum|neg|next|not|null|or|over|parse|peach|pj|plist|prds?|prev|prior|rand|rank|ratios|raze|read0|read1|reciprocal|reval|reverse|rload|rotate|rsave|rtrim|save|scan|scov|sdev|select|set|setenv|show|signum|sin|sqrt|ssr?|string|sublist|sums?|sv|svar|system|tables|tan|til|trim|txf|type|uj|ungroup|union|update|upper|upsert|value|var|views?|vs|wavg|where|while|within|wj1?|wsum|ww|xasc|xbar|xcols?|xdesc|xexp|xgroup|xkey|xlog|xprev|xrank)\b/,adverb:{pattern:/['\/\\]:?|\beach\b/,alias:"function"},verb:{pattern:/(?:\B\.\B|\b[01]:|<[=>]?|>=?|[:+\-*%,!?~=|$&#@^]):?|\b_\b:?/,alias:"operator"},punctuation:/[(){}\[\];.]/}},9385:function(){!function(e){e.languages.ruby=e.languages.extend("clike",{comment:{pattern:/#.*|^=begin\s[\s\S]*?^=end/m,greedy:!0},"class-name":{pattern:/(\b(?:class|module)\s+|\bcatch\s+\()[\w.\\]+|\b[A-Z_]\w*(?=\s*\.\s*new\b)/,lookbehind:!0,inside:{punctuation:/[.\\]/}},keyword:/\b(?:BEGIN|END|alias|and|begin|break|case|class|def|define_method|defined|do|each|else|elsif|end|ensure|extend|for|if|in|include|module|new|next|nil|not|or|prepend|private|protected|public|raise|redo|require|rescue|retry|return|self|super|then|throw|undef|unless|until|when|while|yield)\b/,operator:/\.{2,3}|&\.|===|<?=>|[!=]?~|(?:&&|\|\||<<|>>|\*\*|[+\-*/%<>!^&|=])=?|[?:]/,punctuation:/[(){}[\].,;]/}),e.languages.insertBefore("ruby","operator",{"double-colon":{pattern:/::/,alias:"punctuation"}});var t={pattern:/((?:^|[^\\])(?:\\{2})*)#\{(?:[^{}]|\{[^{}]*\})*\}/,lookbehind:!0,inside:{content:{pattern:/^(#\{)[\s\S]+(?=\}$)/,lookbehind:!0,inside:e.languages.ruby},delimiter:{pattern:/^#\{|\}$/,alias:"punctuation"}}};delete e.languages.ruby.function;var n="(?:"+[/([^a-zA-Z0-9\s{(\[<=])(?:(?!\1)[^\\]|\\[\s\S])*\1/.source,/\((?:[^()\\]|\\[\s\S]|\((?:[^()\\]|\\[\s\S])*\))*\)/.source,/\{(?:[^{}\\]|\\[\s\S]|\{(?:[^{}\\]|\\[\s\S])*\})*\}/.source,/\[(?:[^\[\]\\]|\\[\s\S]|\[(?:[^\[\]\\]|\\[\s\S])*\])*\]/.source,/<(?:[^<>\\]|\\[\s\S]|<(?:[^<>\\]|\\[\s\S])*>)*>/.source].join("|")+")",r=/(?:"(?:\\.|[^"\\\r\n])*"|(?:\b[a-zA-Z_]\w*|[^\s\0-\x7F]+)[?!]?|\$.)/.source;e.languages.insertBefore("ruby","keyword",{"regex-literal":[{pattern:RegExp(/%r/.source+n+/[egimnosux]{0,6}/.source),greedy:!0,inside:{interpolation:t,regex:/[\s\S]+/}},{pattern:/(^|[^/])\/(?!\/)(?:\[[^\r\n\]]+\]|\\.|[^[/\\\r\n])+\/[egimnosux]{0,6}(?=\s*(?:$|[\r\n,.;})#]))/,lookbehind:!0,greedy:!0,inside:{interpolation:t,regex:/[\s\S]+/}}],variable:/[@$]+[a-zA-Z_]\w*(?:[?!]|\b)/,symbol:[{pattern:RegExp(/(^|[^:]):/.source+r),lookbehind:!0,greedy:!0},{pattern:RegExp(/([\r\n{(,][ \t]*)/.source+r+/(?=:(?!:))/.source),lookbehind:!0,greedy:!0}],"method-definition":{pattern:/(\bdef\s+)\w+(?:\s*\.\s*\w+)?/,lookbehind:!0,inside:{function:/\b\w+$/,keyword:/^self\b/,"class-name":/^\w+/,punctuation:/\./}}}),e.languages.insertBefore("ruby","string",{"string-literal":[{pattern:RegExp(/%[qQiIwWs]?/.source+n),greedy:!0,inside:{interpolation:t,string:/[\s\S]+/}},{pattern:/("|')(?:#\{[^}]+\}|#(?!\{)|\\(?:\r\n|[\s\S])|(?!\1)[^\\#\r\n])*\1/,greedy:!0,inside:{interpolation:t,string:/[\s\S]+/}},{pattern:/<<[-~]?([a-z_]\w*)[\r\n](?:.*[\r\n])*?[\t ]*\1/i,alias:"heredoc-string",greedy:!0,inside:{delimiter:{pattern:/^<<[-~]?[a-z_]\w*|\b[a-z_]\w*$/i,inside:{symbol:/\b\w+/,punctuation:/^<<[-~]?/}},interpolation:t,string:/[\s\S]+/}},{pattern:/<<[-~]?'([a-z_]\w*)'[\r\n](?:.*[\r\n])*?[\t ]*\1/i,alias:"heredoc-string",greedy:!0,inside:{delimiter:{pattern:/^<<[-~]?'[a-z_]\w*'|\b[a-z_]\w*$/i,inside:{symbol:/\b\w+/,punctuation:/^<<[-~]?'|'$/}},string:/[\s\S]+/}}],"command-literal":[{pattern:RegExp(/%x/.source+n),greedy:!0,inside:{interpolation:t,command:{pattern:/[\s\S]+/,alias:"string"}}},{pattern:/`(?:#\{[^}]+\}|#(?!\{)|\\(?:\r\n|[\s\S])|[^\\`#\r\n])*`/,greedy:!0,inside:{interpolation:t,command:{pattern:/[\s\S]+/,alias:"string"}}}]}),delete e.languages.ruby.string,e.languages.insertBefore("ruby","number",{builtin:/\b(?:Array|Bignum|Binding|Class|Continuation|Dir|Exception|FalseClass|File|Fixnum|Float|Hash|IO|Integer|MatchData|Method|Module|NilClass|Numeric|Object|Proc|Range|Regexp|Stat|String|Struct|Symbol|TMS|Thread|ThreadGroup|Time|TrueClass)\b/,constant:/\b[A-Z][A-Z0-9_]*(?:[?!]|\b)/}),e.languages.rb=e.languages.ruby}(Prism)},2886:function(){Prism.languages.scala=Prism.languages.extend("java",{"triple-quoted-string":{pattern:/"""[\s\S]*?"""/,greedy:!0,alias:"string"},string:{pattern:/("|')(?:\\.|(?!\1)[^\\\r\n])*\1/,greedy:!0},keyword:/<-|=>|\b(?:abstract|case|catch|class|def|do|else|extends|final|finally|for|forSome|if|implicit|import|lazy|match|new|null|object|override|package|private|protected|return|sealed|self|super|this|throw|trait|try|type|val|var|while|with|yield)\b/,number:/\b0x(?:[\da-f]*\.)?[\da-f]+|(?:\b\d+(?:\.\d*)?|\B\.\d+)(?:e\d+)?[dfl]?/i,builtin:/\b(?:Any|AnyRef|AnyVal|Boolean|Byte|Char|Double|Float|Int|Long|Nothing|Short|String|Unit)\b/,symbol:/'[^\d\s\\]\w*/}),Prism.languages.insertBefore("scala","triple-quoted-string",{"string-interpolation":{pattern:/\b[a-z]\w*(?:"""(?:[^$]|\$(?:[^{]|\{(?:[^{}]|\{[^{}]*\})*\}))*?"""|"(?:[^$"\r\n]|\$(?:[^{]|\{(?:[^{}]|\{[^{}]*\})*\}))*")/i,greedy:!0,inside:{id:{pattern:/^\w+/,greedy:!0,alias:"function"},escape:{pattern:/\\\$"|\$[$"]/,greedy:!0,alias:"symbol"},interpolation:{pattern:/\$(?:\w+|\{(?:[^{}]|\{[^{}]*\})*\})/,greedy:!0,inside:{punctuation:/^\$\{?|\}$/,expression:{pattern:/[\s\S]+/,inside:Prism.languages.scala}}},string:/[\s\S]+/}}}),delete Prism.languages.scala["class-name"],delete Prism.languages.scala.function},5266:function(){Prism.languages.sql={comment:{pattern:/(^|[^\\])(?:\/\*[\s\S]*?\*\/|(?:--|\/\/|#).*)/,lookbehind:!0},variable:[{pattern:/@(["'`])(?:\\[\s\S]|(?!\1)[^\\])+\1/,greedy:!0},/@[\w.$]+/],string:{pattern:/(^|[^@\\])("|')(?:\\[\s\S]|(?!\2)[^\\]|\2\2)*\2/,greedy:!0,lookbehind:!0},identifier:{pattern:/(^|[^@\\])`(?:\\[\s\S]|[^`\\]|``)*`/,greedy:!0,lookbehind:!0,inside:{punctuation:/^`|`$/}},function:/\b(?:AVG|COUNT|FIRST|FORMAT|LAST|LCASE|LEN|MAX|MID|MIN|MOD|NOW|ROUND|SUM|UCASE)(?=\s*\()/i,keyword:/\b(?:ACTION|ADD|AFTER|ALGORITHM|ALL|ALTER|ANALYZE|ANY|APPLY|AS|ASC|AUTHORIZATION|AUTO_INCREMENT|BACKUP|BDB|BEGIN|BERKELEYDB|BIGINT|BINARY|BIT|BLOB|BOOL|BOOLEAN|BREAK|BROWSE|BTREE|BULK|BY|CALL|CASCADED?|CASE|CHAIN|CHAR(?:ACTER|SET)?|CHECK(?:POINT)?|CLOSE|CLUSTERED|COALESCE|COLLATE|COLUMNS?|COMMENT|COMMIT(?:TED)?|COMPUTE|CONNECT|CONSISTENT|CONSTRAINT|CONTAINS(?:TABLE)?|CONTINUE|CONVERT|CREATE|CROSS|CURRENT(?:_DATE|_TIME|_TIMESTAMP|_USER)?|CURSOR|CYCLE|DATA(?:BASES?)?|DATE(?:TIME)?|DAY|DBCC|DEALLOCATE|DEC|DECIMAL|DECLARE|DEFAULT|DEFINER|DELAYED|DELETE|DELIMITERS?|DENY|DESC|DESCRIBE|DETERMINISTIC|DISABLE|DISCARD|DISK|DISTINCT|DISTINCTROW|DISTRIBUTED|DO|DOUBLE|DROP|DUMMY|DUMP(?:FILE)?|DUPLICATE|ELSE(?:IF)?|ENABLE|ENCLOSED|END|ENGINE|ENUM|ERRLVL|ERRORS|ESCAPED?|EXCEPT|EXEC(?:UTE)?|EXISTS|EXIT|EXPLAIN|EXTENDED|FETCH|FIELDS|FILE|FILLFACTOR|FIRST|FIXED|FLOAT|FOLLOWING|FOR(?: EACH ROW)?|FORCE|FOREIGN|FREETEXT(?:TABLE)?|FROM|FULL|FUNCTION|GEOMETRY(?:COLLECTION)?|GLOBAL|GOTO|GRANT|GROUP|HANDLER|HASH|HAVING|HOLDLOCK|HOUR|IDENTITY(?:COL|_INSERT)?|IF|IGNORE|IMPORT|INDEX|INFILE|INNER|INNODB|INOUT|INSERT|INT|INTEGER|INTERSECT|INTERVAL|INTO|INVOKER|ISOLATION|ITERATE|JOIN|KEYS?|KILL|LANGUAGE|LAST|LEAVE|LEFT|LEVEL|LIMIT|LINENO|LINES|LINESTRING|LOAD|LOCAL|LOCK|LONG(?:BLOB|TEXT)|LOOP|MATCH(?:ED)?|MEDIUM(?:BLOB|INT|TEXT)|MERGE|MIDDLEINT|MINUTE|MODE|MODIFIES|MODIFY|MONTH|MULTI(?:LINESTRING|POINT|POLYGON)|NATIONAL|NATURAL|NCHAR|NEXT|NO|NONCLUSTERED|NULLIF|NUMERIC|OFF?|OFFSETS?|ON|OPEN(?:DATASOURCE|QUERY|ROWSET)?|OPTIMIZE|OPTION(?:ALLY)?|ORDER|OUT(?:ER|FILE)?|OVER|PARTIAL|PARTITION|PERCENT|PIVOT|PLAN|POINT|POLYGON|PRECEDING|PRECISION|PREPARE|PREV|PRIMARY|PRINT|PRIVILEGES|PROC(?:EDURE)?|PUBLIC|PURGE|QUICK|RAISERROR|READS?|REAL|RECONFIGURE|REFERENCES|RELEASE|RENAME|REPEAT(?:ABLE)?|REPLACE|REPLICATION|REQUIRE|RESIGNAL|RESTORE|RESTRICT|RETURN(?:ING|S)?|REVOKE|RIGHT|ROLLBACK|ROUTINE|ROW(?:COUNT|GUIDCOL|S)?|RTREE|RULE|SAVE(?:POINT)?|SCHEMA|SECOND|SELECT|SERIAL(?:IZABLE)?|SESSION(?:_USER)?|SET(?:USER)?|SHARE|SHOW|SHUTDOWN|SIMPLE|SMALLINT|SNAPSHOT|SOME|SONAME|SQL|START(?:ING)?|STATISTICS|STATUS|STRIPED|SYSTEM_USER|TABLES?|TABLESPACE|TEMP(?:ORARY|TABLE)?|TERMINATED|TEXT(?:SIZE)?|THEN|TIME(?:STAMP)?|TINY(?:BLOB|INT|TEXT)|TOP?|TRAN(?:SACTIONS?)?|TRIGGER|TRUNCATE|TSEQUAL|TYPES?|UNBOUNDED|UNCOMMITTED|UNDEFINED|UNION|UNIQUE|UNLOCK|UNPIVOT|UNSIGNED|UPDATE(?:TEXT)?|USAGE|USE|USER|USING|VALUES?|VAR(?:BINARY|CHAR|CHARACTER|YING)|VIEW|WAITFOR|WARNINGS|WHEN|WHERE|WHILE|WITH(?: ROLLUP|IN)?|WORK|WRITE(?:TEXT)?|YEAR)\b/i,boolean:/\b(?:FALSE|NULL|TRUE)\b/i,number:/\b0x[\da-f]+\b|\b\d+(?:\.\d*)?|\B\.\d+\b/i,operator:/[-+*\/=%^~]|&&?|\|\|?|!=?|<(?:=>?|<|>)?|>[>=]?|\b(?:AND|BETWEEN|DIV|ILIKE|IN|IS|LIKE|NOT|OR|REGEXP|RLIKE|SOUNDS LIKE|XOR)\b/i,punctuation:/[;[\]()`,.]/}},874:function(){Prism.languages.swift={comment:{pattern:/(^|[^\\:])(?:\/\/.*|\/\*(?:[^/*]|\/(?!\*)|\*(?!\/)|\/\*(?:[^*]|\*(?!\/))*\*\/)*\*\/)/,lookbehind:!0,greedy:!0},"string-literal":[{pattern:RegExp(/(^|[^"#])/.source+"(?:"+/"(?:\\(?:\((?:[^()]|\([^()]*\))*\)|\r\n|[^(])|[^\\\r\n"])*"/.source+"|"+/"""(?:\\(?:\((?:[^()]|\([^()]*\))*\)|[^(])|[^\\"]|"(?!""))*"""/.source+")"+/(?!["#])/.source),lookbehind:!0,greedy:!0,inside:{interpolation:{pattern:/(\\\()(?:[^()]|\([^()]*\))*(?=\))/,lookbehind:!0,inside:null},"interpolation-punctuation":{pattern:/^\)|\\\($/,alias:"punctuation"},punctuation:/\\(?=[\r\n])/,string:/[\s\S]+/}},{pattern:RegExp(/(^|[^"#])(#+)/.source+"(?:"+/"(?:\\(?:#+\((?:[^()]|\([^()]*\))*\)|\r\n|[^#])|[^\\\r\n])*?"/.source+"|"+/"""(?:\\(?:#+\((?:[^()]|\([^()]*\))*\)|[^#])|[^\\])*?"""/.source+")\\2"),lookbehind:!0,greedy:!0,inside:{interpolation:{pattern:/(\\#+\()(?:[^()]|\([^()]*\))*(?=\))/,lookbehind:!0,inside:null},"interpolation-punctuation":{pattern:/^\)|\\#+\($/,alias:"punctuation"},string:/[\s\S]+/}}],directive:{pattern:RegExp(/#/.source+"(?:"+/(?:elseif|if)\b/.source+"(?:[ \t]*"+/(?:![ \t]*)?(?:\b\w+\b(?:[ \t]*\((?:[^()]|\([^()]*\))*\))?|\((?:[^()]|\([^()]*\))*\))(?:[ \t]*(?:&&|\|\|))?/.source+")+|"+/(?:else|endif)\b/.source+")"),alias:"property",inside:{"directive-name":/^#\w+/,boolean:/\b(?:false|true)\b/,number:/\b\d+(?:\.\d+)*\b/,operator:/!|&&|\|\||[<>]=?/,punctuation:/[(),]/}},literal:{pattern:/#(?:colorLiteral|column|dsohandle|file(?:ID|Literal|Path)?|function|imageLiteral|line)\b/,alias:"constant"},"other-directive":{pattern:/#\w+\b/,alias:"property"},attribute:{pattern:/@\w+/,alias:"atrule"},"function-definition":{pattern:/(\bfunc\s+)\w+/,lookbehind:!0,alias:"function"},label:{pattern:/\b(break|continue)\s+\w+|\b[a-zA-Z_]\w*(?=\s*:\s*(?:for|repeat|while)\b)/,lookbehind:!0,alias:"important"},keyword:/\b(?:Any|Protocol|Self|Type|actor|as|assignment|associatedtype|associativity|async|await|break|case|catch|class|continue|convenience|default|defer|deinit|didSet|do|dynamic|else|enum|extension|fallthrough|fileprivate|final|for|func|get|guard|higherThan|if|import|in|indirect|infix|init|inout|internal|is|isolated|lazy|left|let|lowerThan|mutating|none|nonisolated|nonmutating|open|operator|optional|override|postfix|precedencegroup|prefix|private|protocol|public|repeat|required|rethrows|return|right|safe|self|set|some|static|struct|subscript|super|switch|throw|throws|try|typealias|unowned|unsafe|var|weak|where|while|willSet)\b/,boolean:/\b(?:false|true)\b/,nil:{pattern:/\bnil\b/,alias:"constant"},"short-argument":/\$\d+\b/,omit:{pattern:/\b_\b/,alias:"keyword"},number:/\b(?:[\d_]+(?:\.[\de_]+)?|0x[a-f0-9_]+(?:\.[a-f0-9p_]+)?|0b[01_]+|0o[0-7_]+)\b/i,"class-name":/\b[A-Z](?:[A-Z_\d]*[a-z]\w*)?\b/,function:/\b[a-z_]\w*(?=\s*\()/i,constant:/\b(?:[A-Z_]{2,}|k[A-Z][A-Za-z_]+)\b/,operator:/[-+*/%=!<>&|^~?]+|\.[.\-+*/%=!<>&|^~?]+/,punctuation:/[{}[\]();,.:\\]/},Prism.languages.swift["string-literal"].forEach((function(e){e.inside.interpolation.inside=Prism.languages.swift}))},3358:function(){!function(e){var t=/[*&][^\s[\]{},]+/,n=/!(?:<[\w\-%#;/?:@&=+$,.!~*'()[\]]+>|(?:[a-zA-Z\d-]*!)?[\w\-%#;/?:@&=+$.~*'()]+)?/,r="(?:"+n.source+"(?:[ \t]+"+t.source+")?|"+t.source+"(?:[ \t]+"+n.source+")?)",o=/(?:[^\s\x00-\x08\x0e-\x1f!"#%&'*,\-:>?@[\]`{|}\x7f-\x84\x86-\x9f\ud800-\udfff\ufffe\uffff]|[?:-]<PLAIN>)(?:[ \t]*(?:(?![#:])<PLAIN>|:<PLAIN>))*/.source.replace(/<PLAIN>/g,(function(){return/[^\s\x00-\x08\x0e-\x1f,[\]{}\x7f-\x84\x86-\x9f\ud800-\udfff\ufffe\uffff]/.source})),i=/"(?:[^"\\\r\n]|\\.)*"|'(?:[^'\\\r\n]|\\.)*'/.source;function a(e,t){t=(t||"").replace(/m/g,"")+"m";var n=/([:\-,[{]\s*(?:\s<<prop>>[ \t]+)?)(?:<<value>>)(?=[ \t]*(?:$|,|\]|\}|(?:[\r\n]\s*)?#))/.source.replace(/<<prop>>/g,(function(){return r})).replace(/<<value>>/g,(function(){return e}));return RegExp(n,t)}e.languages.yaml={scalar:{pattern:RegExp(/([\-:]\s*(?:\s<<prop>>[ \t]+)?[|>])[ \t]*(?:((?:\r?\n|\r)[ \t]+)\S[^\r\n]*(?:\2[^\r\n]+)*)/.source.replace(/<<prop>>/g,(function(){return r}))),lookbehind:!0,alias:"string"},comment:/#.*/,key:{pattern:RegExp(/((?:^|[:\-,[{\r\n?])[ \t]*(?:<<prop>>[ \t]+)?)<<key>>(?=\s*:\s)/.source.replace(/<<prop>>/g,(function(){return r})).replace(/<<key>>/g,(function(){return"(?:"+o+"|"+i+")"}))),lookbehind:!0,greedy:!0,alias:"atrule"},directive:{pattern:/(^[ \t]*)%.+/m,lookbehind:!0,alias:"important"},datetime:{pattern:a(/\d{4}-\d\d?-\d\d?(?:[tT]|[ \t]+)\d\d?:\d{2}:\d{2}(?:\.\d*)?(?:[ \t]*(?:Z|[-+]\d\d?(?::\d{2})?))?|\d{4}-\d{2}-\d{2}|\d\d?:\d{2}(?::\d{2}(?:\.\d*)?)?/.source),lookbehind:!0,alias:"number"},boolean:{pattern:a(/false|true/.source,"i"),lookbehind:!0,alias:"important"},null:{pattern:a(/null|~/.source,"i"),lookbehind:!0,alias:"important"},string:{pattern:a(i),lookbehind:!0,greedy:!0},number:{pattern:a(/[+-]?(?:0x[\da-f]+|0o[0-7]+|(?:\d+(?:\.\d*)?|\.\d+)(?:e[+-]?\d+)?|\.inf|\.nan)/.source,"i"),lookbehind:!0},tag:n,important:t,punctuation:/---|[:[\]{}\-,|>?]|\.\.\./},e.languages.yml=e.languages.yaml}(Prism)},5660:function(e,t,n){var r=function(e){var t=/(?:^|\s)lang(?:uage)?-([\w-]+)(?=\s|$)/i,n=0,r={},o={manual:e.Prism&&e.Prism.manual,disableWorkerMessageHandler:e.Prism&&e.Prism.disableWorkerMessageHandler,util:{encode:function e(t){return t instanceof i?new i(t.type,e(t.content),t.alias):Array.isArray(t)?t.map(e):t.replace(/&/g,"&").replace(/</g,"<").replace(/\u00a0/g," ")},type:function(e){return Object.prototype.toString.call(e).slice(8,-1)},objId:function(e){return e.__id||Object.defineProperty(e,"__id",{value:++n}),e.__id},clone:function e(t,n){var r,i;switch(n=n||{},o.util.type(t)){case"Object":if(i=o.util.objId(t),n[i])return n[i];for(var a in r={},n[i]=r,t)t.hasOwnProperty(a)&&(r[a]=e(t[a],n));return r;case"Array":return i=o.util.objId(t),n[i]?n[i]:(r=[],n[i]=r,t.forEach((function(t,o){r[o]=e(t,n)})),r);default:return t}},getLanguage:function(e){for(;e;){var n=t.exec(e.className);if(n)return n[1].toLowerCase();e=e.parentElement}return"none"},setLanguage:function(e,n){e.className=e.className.replace(RegExp(t,"gi"),""),e.classList.add("language-"+n)},currentScript:function(){if("undefined"==typeof document)return null;if("currentScript"in document)return document.currentScript;try{throw new Error}catch(r){var e=(/at [^(\r\n]*\((.*):[^:]+:[^:]+\)$/i.exec(r.stack)||[])[1];if(e){var t=document.getElementsByTagName("script");for(var n in t)if(t[n].src==e)return t[n]}return null}},isActive:function(e,t,n){for(var r="no-"+t;e;){var o=e.classList;if(o.contains(t))return!0;if(o.contains(r))return!1;e=e.parentElement}return!!n}},languages:{plain:r,plaintext:r,text:r,txt:r,extend:function(e,t){var n=o.util.clone(o.languages[e]);for(var r in t)n[r]=t[r];return n},insertBefore:function(e,t,n,r){var i=(r=r||o.languages)[e],a={};for(var s in i)if(i.hasOwnProperty(s)){if(s==t)for(var l in n)n.hasOwnProperty(l)&&(a[l]=n[l]);n.hasOwnProperty(s)||(a[s]=i[s])}var c=r[e];return r[e]=a,o.languages.DFS(o.languages,(function(t,n){n===c&&t!=e&&(this[t]=a)})),a},DFS:function e(t,n,r,i){i=i||{};var a=o.util.objId;for(var s in t)if(t.hasOwnProperty(s)){n.call(t,s,t[s],r||s);var l=t[s],c=o.util.type(l);"Object"!==c||i[a(l)]?"Array"!==c||i[a(l)]||(i[a(l)]=!0,e(l,n,s,i)):(i[a(l)]=!0,e(l,n,null,i))}}},plugins:{},highlightAll:function(e,t){o.highlightAllUnder(document,e,t)},highlightAllUnder:function(e,t,n){var r={callback:n,container:e,selector:'code[class*="language-"], [class*="language-"] code, code[class*="lang-"], [class*="lang-"] code'};o.hooks.run("before-highlightall",r),r.elements=Array.prototype.slice.apply(r.container.querySelectorAll(r.selector)),o.hooks.run("before-all-elements-highlight",r);for(var i,a=0;i=r.elements[a++];)o.highlightElement(i,!0===t,r.callback)},highlightElement:function(t,n,r){var i=o.util.getLanguage(t),a=o.languages[i];o.util.setLanguage(t,i);var s=t.parentElement;s&&"pre"===s.nodeName.toLowerCase()&&o.util.setLanguage(s,i);var l={element:t,language:i,grammar:a,code:t.textContent};function c(e){l.highlightedCode=e,o.hooks.run("before-insert",l),l.element.innerHTML=l.highlightedCode,o.hooks.run("after-highlight",l),o.hooks.run("complete",l),r&&r.call(l.element)}if(o.hooks.run("before-sanity-check",l),(s=l.element.parentElement)&&"pre"===s.nodeName.toLowerCase()&&!s.hasAttribute("tabindex")&&s.setAttribute("tabindex","0"),!l.code)return o.hooks.run("complete",l),void(r&&r.call(l.element));if(o.hooks.run("before-highlight",l),l.grammar)if(n&&e.Worker){var u=new Worker(o.filename);u.onmessage=function(e){c(e.data)},u.postMessage(JSON.stringify({language:l.language,code:l.code,immediateClose:!0}))}else c(o.highlight(l.code,l.grammar,l.language));else c(o.util.encode(l.code))},highlight:function(e,t,n){var r={code:e,grammar:t,language:n};if(o.hooks.run("before-tokenize",r),!r.grammar)throw new Error('The language "'+r.language+'" has no grammar.');return r.tokens=o.tokenize(r.code,r.grammar),o.hooks.run("after-tokenize",r),i.stringify(o.util.encode(r.tokens),r.language)},tokenize:function(e,t){var n=t.rest;if(n){for(var r in n)t[r]=n[r];delete t.rest}var o=new l;return c(o,o.head,e),s(e,o,t,o.head,0),function(e){for(var t=[],n=e.head.next;n!==e.tail;)t.push(n.value),n=n.next;return t}(o)},hooks:{all:{},add:function(e,t){var n=o.hooks.all;n[e]=n[e]||[],n[e].push(t)},run:function(e,t){var n=o.hooks.all[e];if(n&&n.length)for(var r,i=0;r=n[i++];)r(t)}},Token:i};function i(e,t,n,r){this.type=e,this.content=t,this.alias=n,this.length=0|(r||"").length}function a(e,t,n,r){e.lastIndex=t;var o=e.exec(n);if(o&&r&&o[1]){var i=o[1].length;o.index+=i,o[0]=o[0].slice(i)}return o}function s(e,t,n,r,l,p){for(var d in n)if(n.hasOwnProperty(d)&&n[d]){var f=n[d];f=Array.isArray(f)?f:[f];for(var h=0;h<f.length;++h){if(p&&p.cause==d+","+h)return;var m=f[h],g=m.inside,y=!!m.lookbehind,v=!!m.greedy,b=m.alias;if(v&&!m.pattern.global){var w=m.pattern.toString().match(/[imsuy]*$/)[0];m.pattern=RegExp(m.pattern.source,w+"g")}for(var x=m.pattern||m,k=r.next,_=l;k!==t.tail&&!(p&&_>=p.reach);_+=k.value.length,k=k.next){var O=k.value;if(t.length>e.length)return;if(!(O instanceof i)){var S,E=1;if(v){if(!(S=a(x,_,e,y))||S.index>=e.length)break;var P=S.index,A=S.index+S[0].length,$=_;for($+=k.value.length;P>=$;)$+=(k=k.next).value.length;if(_=$-=k.value.length,k.value instanceof i)continue;for(var C=k;C!==t.tail&&($<A||"string"==typeof C.value);C=C.next)E++,$+=C.value.length;E--,O=e.slice(_,$),S.index-=_}else if(!(S=a(x,0,O,y)))continue;P=S.index;var R=S[0],j=O.slice(0,P),T=O.slice(P+R.length),I=_+O.length;p&&I>p.reach&&(p.reach=I);var N=k.prev;if(j&&(N=c(t,N,j),_+=j.length),u(t,N,E),k=c(t,N,new i(d,g?o.tokenize(R,g):R,b,R)),T&&c(t,k,T),E>1){var D={cause:d+","+h,reach:I};s(e,t,n,k.prev,_,D),p&&D.reach>p.reach&&(p.reach=D.reach)}}}}}}function l(){var e={value:null,prev:null,next:null},t={value:null,prev:e,next:null};e.next=t,this.head=e,this.tail=t,this.length=0}function c(e,t,n){var r=t.next,o={value:n,prev:t,next:r};return t.next=o,r.prev=o,e.length++,o}function u(e,t,n){for(var r=t.next,o=0;o<n&&r!==e.tail;o++)r=r.next;t.next=r,r.prev=t,e.length-=o}if(e.Prism=o,i.stringify=function e(t,n){if("string"==typeof t)return t;if(Array.isArray(t)){var r="";return t.forEach((function(t){r+=e(t,n)})),r}var i={type:t.type,content:e(t.content,n),tag:"span",classes:["token",t.type],attributes:{},language:n},a=t.alias;a&&(Array.isArray(a)?Array.prototype.push.apply(i.classes,a):i.classes.push(a)),o.hooks.run("wrap",i);var s="";for(var l in i.attributes)s+=" "+l+'="'+(i.attributes[l]||"").replace(/"/g,""")+'"';return"<"+i.tag+' class="'+i.classes.join(" ")+'"'+s+">"+i.content+"</"+i.tag+">"},!e.document)return e.addEventListener?(o.disableWorkerMessageHandler||e.addEventListener("message",(function(t){var n=JSON.parse(t.data),r=n.language,i=n.code,a=n.immediateClose;e.postMessage(o.highlight(i,o.languages[r],r)),a&&e.close()}),!1),o):o;var p=o.util.currentScript();function d(){o.manual||o.highlightAll()}if(p&&(o.filename=p.src,p.hasAttribute("data-manual")&&(o.manual=!0)),!o.manual){var f=document.readyState;"loading"===f||"interactive"===f&&p&&p.defer?document.addEventListener("DOMContentLoaded",d):window.requestAnimationFrame?window.requestAnimationFrame(d):window.setTimeout(d,16)}return o}("undefined"!=typeof window?window:"undefined"!=typeof WorkerGlobalScope&&self instanceof WorkerGlobalScope?self:{});e.exports&&(e.exports=r),void 0!==n.g&&(n.g.Prism=r),r.languages.markup={comment:{pattern:/<!--(?:(?!<!--)[\s\S])*?-->/,greedy:!0},prolog:{pattern:/<\?[\s\S]+?\?>/,greedy:!0},doctype:{pattern:/<!DOCTYPE(?:[^>"'[\]]|"[^"]*"|'[^']*')+(?:\[(?:[^<"'\]]|"[^"]*"|'[^']*'|<(?!!--)|<!--(?:[^-]|-(?!->))*-->)*\]\s*)?>/i,greedy:!0,inside:{"internal-subset":{pattern:/(^[^\[]*\[)[\s\S]+(?=\]>$)/,lookbehind:!0,greedy:!0,inside:null},string:{pattern:/"[^"]*"|'[^']*'/,greedy:!0},punctuation:/^<!|>$|[[\]]/,"doctype-tag":/^DOCTYPE/i,name:/[^\s<>'"]+/}},cdata:{pattern:/<!\[CDATA\[[\s\S]*?\]\]>/i,greedy:!0},tag:{pattern:/<\/?(?!\d)[^\s>\/=$<%]+(?:\s(?:\s*[^\s>\/=]+(?:\s*=\s*(?:"[^"]*"|'[^']*'|[^\s'">=]+(?=[\s>]))|(?=[\s/>])))+)?\s*\/?>/,greedy:!0,inside:{tag:{pattern:/^<\/?[^\s>\/]+/,inside:{punctuation:/^<\/?/,namespace:/^[^\s>\/:]+:/}},"special-attr":[],"attr-value":{pattern:/=\s*(?:"[^"]*"|'[^']*'|[^\s'">=]+)/,inside:{punctuation:[{pattern:/^=/,alias:"attr-equals"},/"|'/]}},punctuation:/\/?>/,"attr-name":{pattern:/[^\s>\/]+/,inside:{namespace:/^[^\s>\/:]+:/}}}},entity:[{pattern:/&[\da-z]{1,8};/i,alias:"named-entity"},/&#x?[\da-f]{1,8};/i]},r.languages.markup.tag.inside["attr-value"].inside.entity=r.languages.markup.entity,r.languages.markup.doctype.inside["internal-subset"].inside=r.languages.markup,r.hooks.add("wrap",(function(e){"entity"===e.type&&(e.attributes.title=e.content.replace(/&/,"&"))})),Object.defineProperty(r.languages.markup.tag,"addInlined",{value:function(e,t){var n={};n["language-"+t]={pattern:/(^<!\[CDATA\[)[\s\S]+?(?=\]\]>$)/i,lookbehind:!0,inside:r.languages[t]},n.cdata=/^<!\[CDATA\[|\]\]>$/i;var o={"included-cdata":{pattern:/<!\[CDATA\[[\s\S]*?\]\]>/i,inside:n}};o["language-"+t]={pattern:/[\s\S]+/,inside:r.languages[t]};var i={};i[e]={pattern:RegExp(/(<__[^>]*>)(?:<!\[CDATA\[(?:[^\]]|\](?!\]>))*\]\]>|(?!<!\[CDATA\[)[\s\S])*?(?=<\/__>)/.source.replace(/__/g,(function(){return e})),"i"),lookbehind:!0,greedy:!0,inside:o},r.languages.insertBefore("markup","cdata",i)}}),Object.defineProperty(r.languages.markup.tag,"addAttribute",{value:function(e,t){r.languages.markup.tag.inside["special-attr"].push({pattern:RegExp(/(^|["'\s])/.source+"(?:"+e+")"+/\s*=\s*(?:"[^"]*"|'[^']*'|[^\s'">=]+(?=[\s>]))/.source,"i"),lookbehind:!0,inside:{"attr-name":/^[^\s=]+/,"attr-value":{pattern:/=[\s\S]+/,inside:{value:{pattern:/(^=\s*(["']|(?!["'])))\S[\s\S]*(?=\2$)/,lookbehind:!0,alias:[t,"language-"+t],inside:r.languages[t]},punctuation:[{pattern:/^=/,alias:"attr-equals"},/"|'/]}}}})}}),r.languages.html=r.languages.markup,r.languages.mathml=r.languages.markup,r.languages.svg=r.languages.markup,r.languages.xml=r.languages.extend("markup",{}),r.languages.ssml=r.languages.xml,r.languages.atom=r.languages.xml,r.languages.rss=r.languages.xml,function(e){var t=/(?:"(?:\\(?:\r\n|[\s\S])|[^"\\\r\n])*"|'(?:\\(?:\r\n|[\s\S])|[^'\\\r\n])*')/;e.languages.css={comment:/\/\*[\s\S]*?\*\//,atrule:{pattern:/@[\w-](?:[^;{\s]|\s+(?![\s{]))*(?:;|(?=\s*\{))/,inside:{rule:/^@[\w-]+/,"selector-function-argument":{pattern:/(\bselector\s*\(\s*(?![\s)]))(?:[^()\s]|\s+(?![\s)])|\((?:[^()]|\([^()]*\))*\))+(?=\s*\))/,lookbehind:!0,alias:"selector"},keyword:{pattern:/(^|[^\w-])(?:and|not|only|or)(?![\w-])/,lookbehind:!0}}},url:{pattern:RegExp("\\burl\\((?:"+t.source+"|"+/(?:[^\\\r\n()"']|\\[\s\S])*/.source+")\\)","i"),greedy:!0,inside:{function:/^url/i,punctuation:/^\(|\)$/,string:{pattern:RegExp("^"+t.source+"$"),alias:"url"}}},selector:{pattern:RegExp("(^|[{}\\s])[^{}\\s](?:[^{};\"'\\s]|\\s+(?![\\s{])|"+t.source+")*(?=\\s*\\{)"),lookbehind:!0},string:{pattern:t,greedy:!0},property:{pattern:/(^|[^-\w\xA0-\uFFFF])(?!\s)[-_a-z\xA0-\uFFFF](?:(?!\s)[-\w\xA0-\uFFFF])*(?=\s*:)/i,lookbehind:!0},important:/!important\b/i,function:{pattern:/(^|[^-a-z0-9])[-a-z0-9]+(?=\()/i,lookbehind:!0},punctuation:/[(){};:,]/},e.languages.css.atrule.inside.rest=e.languages.css;var n=e.languages.markup;n&&(n.tag.addInlined("style","css"),n.tag.addAttribute("style","css"))}(r),r.languages.clike={comment:[{pattern:/(^|[^\\])\/\*[\s\S]*?(?:\*\/|$)/,lookbehind:!0,greedy:!0},{pattern:/(^|[^\\:])\/\/.*/,lookbehind:!0,greedy:!0}],string:{pattern:/(["'])(?:\\(?:\r\n|[\s\S])|(?!\1)[^\\\r\n])*\1/,greedy:!0},"class-name":{pattern:/(\b(?:class|extends|implements|instanceof|interface|new|trait)\s+|\bcatch\s+\()[\w.\\]+/i,lookbehind:!0,inside:{punctuation:/[.\\]/}},keyword:/\b(?:break|catch|continue|do|else|finally|for|function|if|in|instanceof|new|null|return|throw|try|while)\b/,boolean:/\b(?:false|true)\b/,function:/\b\w+(?=\()/,number:/\b0x[\da-f]+\b|(?:\b\d+(?:\.\d*)?|\B\.\d+)(?:e[+-]?\d+)?/i,operator:/[<>]=?|[!=]=?=?|--?|\+\+?|&&?|\|\|?|[?*/~^%]/,punctuation:/[{}[\];(),.:]/},r.languages.javascript=r.languages.extend("clike",{"class-name":[r.languages.clike["class-name"],{pattern:/(^|[^$\w\xA0-\uFFFF])(?!\s)[_$A-Z\xA0-\uFFFF](?:(?!\s)[$\w\xA0-\uFFFF])*(?=\.(?:constructor|prototype))/,lookbehind:!0}],keyword:[{pattern:/((?:^|\})\s*)catch\b/,lookbehind:!0},{pattern:/(^|[^.]|\.\.\.\s*)\b(?:as|assert(?=\s*\{)|async(?=\s*(?:function\b|\(|[$\w\xA0-\uFFFF]|$))|await|break|case|class|const|continue|debugger|default|delete|do|else|enum|export|extends|finally(?=\s*(?:\{|$))|for|from(?=\s*(?:['"]|$))|function|(?:get|set)(?=\s*(?:[#\[$\w\xA0-\uFFFF]|$))|if|implements|import|in|instanceof|interface|let|new|null|of|package|private|protected|public|return|static|super|switch|this|throw|try|typeof|undefined|var|void|while|with|yield)\b/,lookbehind:!0}],function:/#?(?!\s)[_$a-zA-Z\xA0-\uFFFF](?:(?!\s)[$\w\xA0-\uFFFF])*(?=\s*(?:\.\s*(?:apply|bind|call)\s*)?\()/,number:{pattern:RegExp(/(^|[^\w$])/.source+"(?:"+/NaN|Infinity/.source+"|"+/0[bB][01]+(?:_[01]+)*n?/.source+"|"+/0[oO][0-7]+(?:_[0-7]+)*n?/.source+"|"+/0[xX][\dA-Fa-f]+(?:_[\dA-Fa-f]+)*n?/.source+"|"+/\d+(?:_\d+)*n/.source+"|"+/(?:\d+(?:_\d+)*(?:\.(?:\d+(?:_\d+)*)?)?|\.\d+(?:_\d+)*)(?:[Ee][+-]?\d+(?:_\d+)*)?/.source+")"+/(?![\w$])/.source),lookbehind:!0},operator:/--|\+\+|\*\*=?|=>|&&=?|\|\|=?|[!=]==|<<=?|>>>?=?|[-+*/%&|^!=<>]=?|\.{3}|\?\?=?|\?\.?|[~:]/}),r.languages.javascript["class-name"][0].pattern=/(\b(?:class|extends|implements|instanceof|interface|new)\s+)[\w.\\]+/,r.languages.insertBefore("javascript","keyword",{regex:{pattern:/((?:^|[^$\w\xA0-\uFFFF."'\])\s]|\b(?:return|yield))\s*)\/(?:\[(?:[^\]\\\r\n]|\\.)*\]|\\.|[^/\\\[\r\n])+\/[dgimyus]{0,7}(?=(?:\s|\/\*(?:[^*]|\*(?!\/))*\*\/)*(?:$|[\r\n,.;:})\]]|\/\/))/,lookbehind:!0,greedy:!0,inside:{"regex-source":{pattern:/^(\/)[\s\S]+(?=\/[a-z]*$)/,lookbehind:!0,alias:"language-regex",inside:r.languages.regex},"regex-delimiter":/^\/|\/$/,"regex-flags":/^[a-z]+$/}},"function-variable":{pattern:/#?(?!\s)[_$a-zA-Z\xA0-\uFFFF](?:(?!\s)[$\w\xA0-\uFFFF])*(?=\s*[=:]\s*(?:async\s*)?(?:\bfunction\b|(?:\((?:[^()]|\([^()]*\))*\)|(?!\s)[_$a-zA-Z\xA0-\uFFFF](?:(?!\s)[$\w\xA0-\uFFFF])*)\s*=>))/,alias:"function"},parameter:[{pattern:/(function(?:\s+(?!\s)[_$a-zA-Z\xA0-\uFFFF](?:(?!\s)[$\w\xA0-\uFFFF])*)?\s*\(\s*)(?!\s)(?:[^()\s]|\s+(?![\s)])|\([^()]*\))+(?=\s*\))/,lookbehind:!0,inside:r.languages.javascript},{pattern:/(^|[^$\w\xA0-\uFFFF])(?!\s)[_$a-z\xA0-\uFFFF](?:(?!\s)[$\w\xA0-\uFFFF])*(?=\s*=>)/i,lookbehind:!0,inside:r.languages.javascript},{pattern:/(\(\s*)(?!\s)(?:[^()\s]|\s+(?![\s)])|\([^()]*\))+(?=\s*\)\s*=>)/,lookbehind:!0,inside:r.languages.javascript},{pattern:/((?:\b|\s|^)(?!(?:as|async|await|break|case|catch|class|const|continue|debugger|default|delete|do|else|enum|export|extends|finally|for|from|function|get|if|implements|import|in|instanceof|interface|let|new|null|of|package|private|protected|public|return|set|static|super|switch|this|throw|try|typeof|undefined|var|void|while|with|yield)(?![$\w\xA0-\uFFFF]))(?:(?!\s)[_$a-zA-Z\xA0-\uFFFF](?:(?!\s)[$\w\xA0-\uFFFF])*\s*)\(\s*|\]\s*\(\s*)(?!\s)(?:[^()\s]|\s+(?![\s)])|\([^()]*\))+(?=\s*\)\s*\{)/,lookbehind:!0,inside:r.languages.javascript}],constant:/\b[A-Z](?:[A-Z_]|\dx?)*\b/}),r.languages.insertBefore("javascript","string",{hashbang:{pattern:/^#!.*/,greedy:!0,alias:"comment"},"template-string":{pattern:/`(?:\\[\s\S]|\$\{(?:[^{}]|\{(?:[^{}]|\{[^}]*\})*\})+\}|(?!\$\{)[^\\`])*`/,greedy:!0,inside:{"template-punctuation":{pattern:/^`|`$/,alias:"string"},interpolation:{pattern:/((?:^|[^\\])(?:\\{2})*)\$\{(?:[^{}]|\{(?:[^{}]|\{[^}]*\})*\})+\}/,lookbehind:!0,inside:{"interpolation-punctuation":{pattern:/^\$\{|\}$/,alias:"punctuation"},rest:r.languages.javascript}},string:/[\s\S]+/}},"string-property":{pattern:/((?:^|[,{])[ \t]*)(["'])(?:\\(?:\r\n|[\s\S])|(?!\2)[^\\\r\n])*\2(?=\s*:)/m,lookbehind:!0,greedy:!0,alias:"property"}}),r.languages.insertBefore("javascript","operator",{"literal-property":{pattern:/((?:^|[,{])[ \t]*)(?!\s)[_$a-zA-Z\xA0-\uFFFF](?:(?!\s)[$\w\xA0-\uFFFF])*(?=\s*:)/m,lookbehind:!0,alias:"property"}}),r.languages.markup&&(r.languages.markup.tag.addInlined("script","javascript"),r.languages.markup.tag.addAttribute(/on(?:abort|blur|change|click|composition(?:end|start|update)|dblclick|error|focus(?:in|out)?|key(?:down|up)|load|mouse(?:down|enter|leave|move|out|over|up)|reset|resize|scroll|select|slotchange|submit|unload|wheel)/.source,"javascript")),r.languages.js=r.languages.javascript,function(){if(void 0!==r&&"undefined"!=typeof document){Element.prototype.matches||(Element.prototype.matches=Element.prototype.msMatchesSelector||Element.prototype.webkitMatchesSelector);var e={js:"javascript",py:"python",rb:"ruby",ps1:"powershell",psm1:"powershell",sh:"bash",bat:"batch",h:"c",tex:"latex"},t="data-src-status",n="loaded",o='pre[data-src]:not([data-src-status="loaded"]):not([data-src-status="loading"])';r.hooks.add("before-highlightall",(function(e){e.selector+=", "+o})),r.hooks.add("before-sanity-check",(function(i){var a=i.element;if(a.matches(o)){i.code="",a.setAttribute(t,"loading");var s=a.appendChild(document.createElement("CODE"));s.textContent="Loading…";var l=a.getAttribute("data-src"),c=i.language;if("none"===c){var u=(/\.(\w+)$/.exec(l)||[,"none"])[1];c=e[u]||u}r.util.setLanguage(s,c),r.util.setLanguage(a,c);var p=r.plugins.autoloader;p&&p.loadLanguages(c),function(e,o,i){var l=new XMLHttpRequest;l.open("GET",e,!0),l.onreadystatechange=function(){4==l.readyState&&(l.status<400&&l.responseText?function(e){a.setAttribute(t,n);var o=function(e){var t=/^\s*(\d+)\s*(?:(,)\s*(?:(\d+)\s*)?)?$/.exec(e||"");if(t){var n=Number(t[1]),r=t[2],o=t[3];return r?o?[n,Number(o)]:[n,void 0]:[n,n]}}(a.getAttribute("data-range"));if(o){var i=e.split(/\r\n?|\n/g),l=o[0],c=null==o[1]?i.length:o[1];l<0&&(l+=i.length),l=Math.max(0,Math.min(l-1,i.length)),c<0&&(c+=i.length),c=Math.max(0,Math.min(c,i.length)),e=i.slice(l,c).join("\n"),a.hasAttribute("data-start")||a.setAttribute("data-start",String(l+1))}s.textContent=e,r.highlightElement(s)}(l.responseText):l.status>=400?i("✖ Error "+l.status+" while fetching file: "+l.statusText):i("✖ Error: File does not exist or is empty"))},l.send(null)}(l,0,(function(e){a.setAttribute(t,"failed"),s.textContent=e}))}})),r.plugins.fileHighlight={highlight:function(e){for(var t,n=(e||document).querySelectorAll(o),i=0;t=n[i++];)r.highlightElement(t)}};var i=!1;r.fileHighlight=function(){i||(console.warn("Prism.fileHighlight is deprecated. Use `Prism.plugins.fileHighlight.highlight` instead."),i=!0),r.plugins.fileHighlight.highlight.apply(this,arguments)}}}()},2703:function(e,t,n){"use strict";var r=n(414);function o(){}function i(){}i.resetWarningCache=o,e.exports=function(){function e(e,t,n,o,i,a){if(a!==r){var s=new Error("Calling PropTypes validators directly is not supported by the `prop-types` package. Use PropTypes.checkPropTypes() to call them. Read more at http://fb.me/use-check-prop-types");throw s.name="Invariant Violation",s}}function t(){return e}e.isRequired=e;var n={array:e,bool:e,func:e,number:e,object:e,string:e,symbol:e,any:e,arrayOf:t,element:e,elementType:e,instanceOf:t,node:e,objectOf:t,oneOf:t,oneOfType:t,shape:t,exact:t,checkPropTypes:i,resetWarningCache:o};return n.PropTypes=n,n}},5697:function(e,t,n){e.exports=n(2703)()},414:function(e){"use strict";e.exports="SECRET_DO_NOT_PASS_THIS_OR_YOU_WILL_BE_FIRED"},4448:function(e,t,n){"use strict";var r=n(7294),o=n(7418),i=n(3840);function a(e){for(var t="https://reactjs.org/docs/error-decoder.html?invariant="+e,n=1;n<arguments.length;n++)t+="&args[]="+encodeURIComponent(arguments[n]);return"Minified React error #"+e+"; visit "+t+" for the full message or use the non-minified dev environment for full errors and additional helpful warnings."}if(!r)throw Error(a(227));var s=new Set,l={};function c(e,t){u(e,t),u(e+"Capture",t)}function u(e,t){for(l[e]=t,e=0;e<t.length;e++)s.add(t[e])}var p=!("undefined"==typeof window||void 0===window.document||void 0===window.document.createElement),d=/^[:A-Z_a-z\u00C0-\u00D6\u00D8-\u00F6\u00F8-\u02FF\u0370-\u037D\u037F-\u1FFF\u200C-\u200D\u2070-\u218F\u2C00-\u2FEF\u3001-\uD7FF\uF900-\uFDCF\uFDF0-\uFFFD][:A-Z_a-z\u00C0-\u00D6\u00D8-\u00F6\u00F8-\u02FF\u0370-\u037D\u037F-\u1FFF\u200C-\u200D\u2070-\u218F\u2C00-\u2FEF\u3001-\uD7FF\uF900-\uFDCF\uFDF0-\uFFFD\-.0-9\u00B7\u0300-\u036F\u203F-\u2040]*$/,f=Object.prototype.hasOwnProperty,h={},m={};function g(e,t,n,r,o,i,a){this.acceptsBooleans=2===t||3===t||4===t,this.attributeName=r,this.attributeNamespace=o,this.mustUseProperty=n,this.propertyName=e,this.type=t,this.sanitizeURL=i,this.removeEmptyString=a}var y={};"children dangerouslySetInnerHTML defaultValue defaultChecked innerHTML suppressContentEditableWarning suppressHydrationWarning style".split(" ").forEach((function(e){y[e]=new g(e,0,!1,e,null,!1,!1)})),[["acceptCharset","accept-charset"],["className","class"],["htmlFor","for"],["httpEquiv","http-equiv"]].forEach((function(e){var t=e[0];y[t]=new g(t,1,!1,e[1],null,!1,!1)})),["contentEditable","draggable","spellCheck","value"].forEach((function(e){y[e]=new g(e,2,!1,e.toLowerCase(),null,!1,!1)})),["autoReverse","externalResourcesRequired","focusable","preserveAlpha"].forEach((function(e){y[e]=new g(e,2,!1,e,null,!1,!1)})),"allowFullScreen async autoFocus autoPlay controls default defer disabled disablePictureInPicture disableRemotePlayback formNoValidate hidden loop noModule noValidate open playsInline readOnly required reversed scoped seamless itemScope".split(" ").forEach((function(e){y[e]=new g(e,3,!1,e.toLowerCase(),null,!1,!1)})),["checked","multiple","muted","selected"].forEach((function(e){y[e]=new g(e,3,!0,e,null,!1,!1)})),["capture","download"].forEach((function(e){y[e]=new g(e,4,!1,e,null,!1,!1)})),["cols","rows","size","span"].forEach((function(e){y[e]=new g(e,6,!1,e,null,!1,!1)})),["rowSpan","start"].forEach((function(e){y[e]=new g(e,5,!1,e.toLowerCase(),null,!1,!1)}));var v=/[\-:]([a-z])/g;function b(e){return e[1].toUpperCase()}function w(e,t,n,r){var o=y.hasOwnProperty(t)?y[t]:null;(null!==o?0===o.type:!r&&2<t.length&&("o"===t[0]||"O"===t[0])&&("n"===t[1]||"N"===t[1]))||(function(e,t,n,r){if(null==t||function(e,t,n,r){if(null!==n&&0===n.type)return!1;switch(typeof t){case"function":case"symbol":return!0;case"boolean":return!r&&(null!==n?!n.acceptsBooleans:"data-"!==(e=e.toLowerCase().slice(0,5))&&"aria-"!==e);default:return!1}}(e,t,n,r))return!0;if(r)return!1;if(null!==n)switch(n.type){case 3:return!t;case 4:return!1===t;case 5:return isNaN(t);case 6:return isNaN(t)||1>t}return!1}(t,n,o,r)&&(n=null),r||null===o?function(e){return!!f.call(m,e)||!f.call(h,e)&&(d.test(e)?m[e]=!0:(h[e]=!0,!1))}(t)&&(null===n?e.removeAttribute(t):e.setAttribute(t,""+n)):o.mustUseProperty?e[o.propertyName]=null===n?3!==o.type&&"":n:(t=o.attributeName,r=o.attributeNamespace,null===n?e.removeAttribute(t):(n=3===(o=o.type)||4===o&&!0===n?"":""+n,r?e.setAttributeNS(r,t,n):e.setAttribute(t,n))))}"accent-height alignment-baseline arabic-form baseline-shift cap-height clip-path clip-rule color-interpolation color-interpolation-filters color-profile color-rendering dominant-baseline enable-background fill-opacity fill-rule flood-color flood-opacity font-family font-size font-size-adjust font-stretch font-style font-variant font-weight glyph-name glyph-orientation-horizontal glyph-orientation-vertical horiz-adv-x horiz-origin-x image-rendering letter-spacing lighting-color marker-end marker-mid marker-start overline-position overline-thickness paint-order panose-1 pointer-events rendering-intent shape-rendering stop-color stop-opacity strikethrough-position strikethrough-thickness stroke-dasharray stroke-dashoffset stroke-linecap stroke-linejoin stroke-miterlimit stroke-opacity stroke-width text-anchor text-decoration text-rendering underline-position underline-thickness unicode-bidi unicode-range units-per-em v-alphabetic v-hanging v-ideographic v-mathematical vector-effect vert-adv-y vert-origin-x vert-origin-y word-spacing writing-mode xmlns:xlink x-height".split(" ").forEach((function(e){var t=e.replace(v,b);y[t]=new g(t,1,!1,e,null,!1,!1)})),"xlink:actuate xlink:arcrole xlink:role xlink:show xlink:title xlink:type".split(" ").forEach((function(e){var t=e.replace(v,b);y[t]=new g(t,1,!1,e,"http://www.w3.org/1999/xlink",!1,!1)})),["xml:base","xml:lang","xml:space"].forEach((function(e){var t=e.replace(v,b);y[t]=new g(t,1,!1,e,"http://www.w3.org/XML/1998/namespace",!1,!1)})),["tabIndex","crossOrigin"].forEach((function(e){y[e]=new g(e,1,!1,e.toLowerCase(),null,!1,!1)})),y.xlinkHref=new g("xlinkHref",1,!1,"xlink:href","http://www.w3.org/1999/xlink",!0,!1),["src","href","action","formAction"].forEach((function(e){y[e]=new g(e,1,!1,e.toLowerCase(),null,!0,!0)}));var x=r.__SECRET_INTERNALS_DO_NOT_USE_OR_YOU_WILL_BE_FIRED,k=60103,_=60106,O=60107,S=60108,E=60114,P=60109,A=60110,$=60112,C=60113,R=60120,j=60115,T=60116,I=60121,N=60128,D=60129,L=60130,M=60131;if("function"==typeof Symbol&&Symbol.for){var F=Symbol.for;k=F("react.element"),_=F("react.portal"),O=F("react.fragment"),S=F("react.strict_mode"),E=F("react.profiler"),P=F("react.provider"),A=F("react.context"),$=F("react.forward_ref"),C=F("react.suspense"),R=F("react.suspense_list"),j=F("react.memo"),T=F("react.lazy"),I=F("react.block"),F("react.scope"),N=F("react.opaque.id"),D=F("react.debug_trace_mode"),L=F("react.offscreen"),M=F("react.legacy_hidden")}var z,U="function"==typeof Symbol&&Symbol.iterator;function V(e){return null===e||"object"!=typeof e?null:"function"==typeof(e=U&&e[U]||e["@@iterator"])?e:null}function B(e){if(void 0===z)try{throw Error()}catch(e){var t=e.stack.trim().match(/\n( *(at )?)/);z=t&&t[1]||""}return"\n"+z+e}var q=!1;function W(e,t){if(!e||q)return"";q=!0;var n=Error.prepareStackTrace;Error.prepareStackTrace=void 0;try{if(t)if(t=function(){throw Error()},Object.defineProperty(t.prototype,"props",{set:function(){throw Error()}}),"object"==typeof Reflect&&Reflect.construct){try{Reflect.construct(t,[])}catch(e){var r=e}Reflect.construct(e,[],t)}else{try{t.call()}catch(e){r=e}e.call(t.prototype)}else{try{throw Error()}catch(e){r=e}e()}}catch(e){if(e&&r&&"string"==typeof e.stack){for(var o=e.stack.split("\n"),i=r.stack.split("\n"),a=o.length-1,s=i.length-1;1<=a&&0<=s&&o[a]!==i[s];)s--;for(;1<=a&&0<=s;a--,s--)if(o[a]!==i[s]){if(1!==a||1!==s)do{if(a--,0>--s||o[a]!==i[s])return"\n"+o[a].replace(" at new "," at ")}while(1<=a&&0<=s);break}}}finally{q=!1,Error.prepareStackTrace=n}return(e=e?e.displayName||e.name:"")?B(e):""}function H(e){switch(e.tag){case 5:return B(e.type);case 16:return B("Lazy");case 13:return B("Suspense");case 19:return B("SuspenseList");case 0:case 2:case 15:return W(e.type,!1);case 11:return W(e.type.render,!1);case 22:return W(e.type._render,!1);case 1:return W(e.type,!0);default:return""}}function Y(e){if(null==e)return null;if("function"==typeof e)return e.displayName||e.name||null;if("string"==typeof e)return e;switch(e){case O:return"Fragment";case _:return"Portal";case E:return"Profiler";case S:return"StrictMode";case C:return"Suspense";case R:return"SuspenseList"}if("object"==typeof e)switch(e.$$typeof){case A:return(e.displayName||"Context")+".Consumer";case P:return(e._context.displayName||"Context")+".Provider";case $:var t=e.render;return t=t.displayName||t.name||"",e.displayName||(""!==t?"ForwardRef("+t+")":"ForwardRef");case j:return Y(e.type);case I:return Y(e._render);case T:t=e._payload,e=e._init;try{return Y(e(t))}catch(e){}}return null}function K(e){switch(typeof e){case"boolean":case"number":case"object":case"string":case"undefined":return e;default:return""}}function G(e){var t=e.type;return(e=e.nodeName)&&"input"===e.toLowerCase()&&("checkbox"===t||"radio"===t)}function Q(e){e._valueTracker||(e._valueTracker=function(e){var t=G(e)?"checked":"value",n=Object.getOwnPropertyDescriptor(e.constructor.prototype,t),r=""+e[t];if(!e.hasOwnProperty(t)&&void 0!==n&&"function"==typeof n.get&&"function"==typeof n.set){var o=n.get,i=n.set;return Object.defineProperty(e,t,{configurable:!0,get:function(){return o.call(this)},set:function(e){r=""+e,i.call(this,e)}}),Object.defineProperty(e,t,{enumerable:n.enumerable}),{getValue:function(){return r},setValue:function(e){r=""+e},stopTracking:function(){e._valueTracker=null,delete e[t]}}}}(e))}function X(e){if(!e)return!1;var t=e._valueTracker;if(!t)return!0;var n=t.getValue(),r="";return e&&(r=G(e)?e.checked?"true":"false":e.value),(e=r)!==n&&(t.setValue(e),!0)}function J(e){if(void 0===(e=e||("undefined"!=typeof document?document:void 0)))return null;try{return e.activeElement||e.body}catch(t){return e.body}}function Z(e,t){var n=t.checked;return o({},t,{defaultChecked:void 0,defaultValue:void 0,value:void 0,checked:null!=n?n:e._wrapperState.initialChecked})}function ee(e,t){var n=null==t.defaultValue?"":t.defaultValue,r=null!=t.checked?t.checked:t.defaultChecked;n=K(null!=t.value?t.value:n),e._wrapperState={initialChecked:r,initialValue:n,controlled:"checkbox"===t.type||"radio"===t.type?null!=t.checked:null!=t.value}}function te(e,t){null!=(t=t.checked)&&w(e,"checked",t,!1)}function ne(e,t){te(e,t);var n=K(t.value),r=t.type;if(null!=n)"number"===r?(0===n&&""===e.value||e.value!=n)&&(e.value=""+n):e.value!==""+n&&(e.value=""+n);else if("submit"===r||"reset"===r)return void e.removeAttribute("value");t.hasOwnProperty("value")?oe(e,t.type,n):t.hasOwnProperty("defaultValue")&&oe(e,t.type,K(t.defaultValue)),null==t.checked&&null!=t.defaultChecked&&(e.defaultChecked=!!t.defaultChecked)}function re(e,t,n){if(t.hasOwnProperty("value")||t.hasOwnProperty("defaultValue")){var r=t.type;if(!("submit"!==r&&"reset"!==r||void 0!==t.value&&null!==t.value))return;t=""+e._wrapperState.initialValue,n||t===e.value||(e.value=t),e.defaultValue=t}""!==(n=e.name)&&(e.name=""),e.defaultChecked=!!e._wrapperState.initialChecked,""!==n&&(e.name=n)}function oe(e,t,n){"number"===t&&J(e.ownerDocument)===e||(null==n?e.defaultValue=""+e._wrapperState.initialValue:e.defaultValue!==""+n&&(e.defaultValue=""+n))}function ie(e,t){return e=o({children:void 0},t),(t=function(e){var t="";return r.Children.forEach(e,(function(e){null!=e&&(t+=e)})),t}(t.children))&&(e.children=t),e}function ae(e,t,n,r){if(e=e.options,t){t={};for(var o=0;o<n.length;o++)t["$"+n[o]]=!0;for(n=0;n<e.length;n++)o=t.hasOwnProperty("$"+e[n].value),e[n].selected!==o&&(e[n].selected=o),o&&r&&(e[n].defaultSelected=!0)}else{for(n=""+K(n),t=null,o=0;o<e.length;o++){if(e[o].value===n)return e[o].selected=!0,void(r&&(e[o].defaultSelected=!0));null!==t||e[o].disabled||(t=e[o])}null!==t&&(t.selected=!0)}}function se(e,t){if(null!=t.dangerouslySetInnerHTML)throw Error(a(91));return o({},t,{value:void 0,defaultValue:void 0,children:""+e._wrapperState.initialValue})}function le(e,t){var n=t.value;if(null==n){if(n=t.children,t=t.defaultValue,null!=n){if(null!=t)throw Error(a(92));if(Array.isArray(n)){if(!(1>=n.length))throw Error(a(93));n=n[0]}t=n}null==t&&(t=""),n=t}e._wrapperState={initialValue:K(n)}}function ce(e,t){var n=K(t.value),r=K(t.defaultValue);null!=n&&((n=""+n)!==e.value&&(e.value=n),null==t.defaultValue&&e.defaultValue!==n&&(e.defaultValue=n)),null!=r&&(e.defaultValue=""+r)}function ue(e){var t=e.textContent;t===e._wrapperState.initialValue&&""!==t&&null!==t&&(e.value=t)}var pe="http://www.w3.org/1999/xhtml";function de(e){switch(e){case"svg":return"http://www.w3.org/2000/svg";case"math":return"http://www.w3.org/1998/Math/MathML";default:return"http://www.w3.org/1999/xhtml"}}function fe(e,t){return null==e||"http://www.w3.org/1999/xhtml"===e?de(t):"http://www.w3.org/2000/svg"===e&&"foreignObject"===t?"http://www.w3.org/1999/xhtml":e}var he,me,ge=(me=function(e,t){if("http://www.w3.org/2000/svg"!==e.namespaceURI||"innerHTML"in e)e.innerHTML=t;else{for((he=he||document.createElement("div")).innerHTML="<svg>"+t.valueOf().toString()+"</svg>",t=he.firstChild;e.firstChild;)e.removeChild(e.firstChild);for(;t.firstChild;)e.appendChild(t.firstChild)}},"undefined"!=typeof MSApp&&MSApp.execUnsafeLocalFunction?function(e,t,n,r){MSApp.execUnsafeLocalFunction((function(){return me(e,t)}))}:me);function ye(e,t){if(t){var n=e.firstChild;if(n&&n===e.lastChild&&3===n.nodeType)return void(n.nodeValue=t)}e.textContent=t}var ve={animationIterationCount:!0,borderImageOutset:!0,borderImageSlice:!0,borderImageWidth:!0,boxFlex:!0,boxFlexGroup:!0,boxOrdinalGroup:!0,columnCount:!0,columns:!0,flex:!0,flexGrow:!0,flexPositive:!0,flexShrink:!0,flexNegative:!0,flexOrder:!0,gridArea:!0,gridRow:!0,gridRowEnd:!0,gridRowSpan:!0,gridRowStart:!0,gridColumn:!0,gridColumnEnd:!0,gridColumnSpan:!0,gridColumnStart:!0,fontWeight:!0,lineClamp:!0,lineHeight:!0,opacity:!0,order:!0,orphans:!0,tabSize:!0,widows:!0,zIndex:!0,zoom:!0,fillOpacity:!0,floodOpacity:!0,stopOpacity:!0,strokeDasharray:!0,strokeDashoffset:!0,strokeMiterlimit:!0,strokeOpacity:!0,strokeWidth:!0},be=["Webkit","ms","Moz","O"];function we(e,t,n){return null==t||"boolean"==typeof t||""===t?"":n||"number"!=typeof t||0===t||ve.hasOwnProperty(e)&&ve[e]?(""+t).trim():t+"px"}function xe(e,t){for(var n in e=e.style,t)if(t.hasOwnProperty(n)){var r=0===n.indexOf("--"),o=we(n,t[n],r);"float"===n&&(n="cssFloat"),r?e.setProperty(n,o):e[n]=o}}Object.keys(ve).forEach((function(e){be.forEach((function(t){t=t+e.charAt(0).toUpperCase()+e.substring(1),ve[t]=ve[e]}))}));var ke=o({menuitem:!0},{area:!0,base:!0,br:!0,col:!0,embed:!0,hr:!0,img:!0,input:!0,keygen:!0,link:!0,meta:!0,param:!0,source:!0,track:!0,wbr:!0});function _e(e,t){if(t){if(ke[e]&&(null!=t.children||null!=t.dangerouslySetInnerHTML))throw Error(a(137,e));if(null!=t.dangerouslySetInnerHTML){if(null!=t.children)throw Error(a(60));if("object"!=typeof t.dangerouslySetInnerHTML||!("__html"in t.dangerouslySetInnerHTML))throw Error(a(61))}if(null!=t.style&&"object"!=typeof t.style)throw Error(a(62))}}function Oe(e,t){if(-1===e.indexOf("-"))return"string"==typeof t.is;switch(e){case"annotation-xml":case"color-profile":case"font-face":case"font-face-src":case"font-face-uri":case"font-face-format":case"font-face-name":case"missing-glyph":return!1;default:return!0}}function Se(e){return(e=e.target||e.srcElement||window).correspondingUseElement&&(e=e.correspondingUseElement),3===e.nodeType?e.parentNode:e}var Ee=null,Pe=null,Ae=null;function $e(e){if(e=to(e)){if("function"!=typeof Ee)throw Error(a(280));var t=e.stateNode;t&&(t=ro(t),Ee(e.stateNode,e.type,t))}}function Ce(e){Pe?Ae?Ae.push(e):Ae=[e]:Pe=e}function Re(){if(Pe){var e=Pe,t=Ae;if(Ae=Pe=null,$e(e),t)for(e=0;e<t.length;e++)$e(t[e])}}function je(e,t){return e(t)}function Te(e,t,n,r,o){return e(t,n,r,o)}function Ie(){}var Ne=je,De=!1,Le=!1;function Me(){null===Pe&&null===Ae||(Ie(),Re())}function Fe(e,t){var n=e.stateNode;if(null===n)return null;var r=ro(n);if(null===r)return null;n=r[t];e:switch(t){case"onClick":case"onClickCapture":case"onDoubleClick":case"onDoubleClickCapture":case"onMouseDown":case"onMouseDownCapture":case"onMouseMove":case"onMouseMoveCapture":case"onMouseUp":case"onMouseUpCapture":case"onMouseEnter":(r=!r.disabled)||(r=!("button"===(e=e.type)||"input"===e||"select"===e||"textarea"===e)),e=!r;break e;default:e=!1}if(e)return null;if(n&&"function"!=typeof n)throw Error(a(231,t,typeof n));return n}var ze=!1;if(p)try{var Ue={};Object.defineProperty(Ue,"passive",{get:function(){ze=!0}}),window.addEventListener("test",Ue,Ue),window.removeEventListener("test",Ue,Ue)}catch(me){ze=!1}function Ve(e,t,n,r,o,i,a,s,l){var c=Array.prototype.slice.call(arguments,3);try{t.apply(n,c)}catch(e){this.onError(e)}}var Be=!1,qe=null,We=!1,He=null,Ye={onError:function(e){Be=!0,qe=e}};function Ke(e,t,n,r,o,i,a,s,l){Be=!1,qe=null,Ve.apply(Ye,arguments)}function Ge(e){var t=e,n=e;if(e.alternate)for(;t.return;)t=t.return;else{e=t;do{0!=(1026&(t=e).flags)&&(n=t.return),e=t.return}while(e)}return 3===t.tag?n:null}function Qe(e){if(13===e.tag){var t=e.memoizedState;if(null===t&&null!==(e=e.alternate)&&(t=e.memoizedState),null!==t)return t.dehydrated}return null}function Xe(e){if(Ge(e)!==e)throw Error(a(188))}function Je(e,t){for(var n=e.alternate;null!==t;){if(t===e||t===n)return!0;t=t.return}return!1}var Ze,et,tt,nt,rt=!1,ot=[],it=null,at=null,st=null,lt=new Map,ct=new Map,ut=[],pt="mousedown mouseup touchcancel touchend touchstart auxclick dblclick pointercancel pointerdown pointerup dragend dragstart drop compositionend compositionstart keydown keypress keyup input textInput copy cut paste click change contextmenu reset submit".split(" ");function dt(e,t,n,r,o){return{blockedOn:e,domEventName:t,eventSystemFlags:16|n,nativeEvent:o,targetContainers:[r]}}function ft(e,t){switch(e){case"focusin":case"focusout":it=null;break;case"dragenter":case"dragleave":at=null;break;case"mouseover":case"mouseout":st=null;break;case"pointerover":case"pointerout":lt.delete(t.pointerId);break;case"gotpointercapture":case"lostpointercapture":ct.delete(t.pointerId)}}function ht(e,t,n,r,o,i){return null===e||e.nativeEvent!==i?(e=dt(t,n,r,o,i),null!==t&&null!==(t=to(t))&&et(t),e):(e.eventSystemFlags|=r,t=e.targetContainers,null!==o&&-1===t.indexOf(o)&&t.push(o),e)}function mt(e){var t=eo(e.target);if(null!==t){var n=Ge(t);if(null!==n)if(13===(t=n.tag)){if(null!==(t=Qe(n)))return e.blockedOn=t,void nt(e.lanePriority,(function(){i.unstable_runWithPriority(e.priority,(function(){tt(n)}))}))}else if(3===t&&n.stateNode.hydrate)return void(e.blockedOn=3===n.tag?n.stateNode.containerInfo:null)}e.blockedOn=null}function gt(e){if(null!==e.blockedOn)return!1;for(var t=e.targetContainers;0<t.length;){var n=Xt(e.domEventName,e.eventSystemFlags,t[0],e.nativeEvent);if(null!==n)return null!==(t=to(n))&&et(t),e.blockedOn=n,!1;t.shift()}return!0}function yt(e,t,n){gt(e)&&n.delete(t)}function vt(){for(rt=!1;0<ot.length;){var e=ot[0];if(null!==e.blockedOn){null!==(e=to(e.blockedOn))&&Ze(e);break}for(var t=e.targetContainers;0<t.length;){var n=Xt(e.domEventName,e.eventSystemFlags,t[0],e.nativeEvent);if(null!==n){e.blockedOn=n;break}t.shift()}null===e.blockedOn&&ot.shift()}null!==it&>(it)&&(it=null),null!==at&>(at)&&(at=null),null!==st&>(st)&&(st=null),lt.forEach(yt),ct.forEach(yt)}function bt(e,t){e.blockedOn===t&&(e.blockedOn=null,rt||(rt=!0,i.unstable_scheduleCallback(i.unstable_NormalPriority,vt)))}function wt(e){function t(t){return bt(t,e)}if(0<ot.length){bt(ot[0],e);for(var n=1;n<ot.length;n++){var r=ot[n];r.blockedOn===e&&(r.blockedOn=null)}}for(null!==it&&bt(it,e),null!==at&&bt(at,e),null!==st&&bt(st,e),lt.forEach(t),ct.forEach(t),n=0;n<ut.length;n++)(r=ut[n]).blockedOn===e&&(r.blockedOn=null);for(;0<ut.length&&null===(n=ut[0]).blockedOn;)mt(n),null===n.blockedOn&&ut.shift()}function xt(e,t){var n={};return n[e.toLowerCase()]=t.toLowerCase(),n["Webkit"+e]="webkit"+t,n["Moz"+e]="moz"+t,n}var kt={animationend:xt("Animation","AnimationEnd"),animationiteration:xt("Animation","AnimationIteration"),animationstart:xt("Animation","AnimationStart"),transitionend:xt("Transition","TransitionEnd")},_t={},Ot={};function St(e){if(_t[e])return _t[e];if(!kt[e])return e;var t,n=kt[e];for(t in n)if(n.hasOwnProperty(t)&&t in Ot)return _t[e]=n[t];return e}p&&(Ot=document.createElement("div").style,"AnimationEvent"in window||(delete kt.animationend.animation,delete kt.animationiteration.animation,delete kt.animationstart.animation),"TransitionEvent"in window||delete kt.transitionend.transition);var Et=St("animationend"),Pt=St("animationiteration"),At=St("animationstart"),$t=St("transitionend"),Ct=new Map,Rt=new Map,jt=["abort","abort",Et,"animationEnd",Pt,"animationIteration",At,"animationStart","canplay","canPlay","canplaythrough","canPlayThrough","durationchange","durationChange","emptied","emptied","encrypted","encrypted","ended","ended","error","error","gotpointercapture","gotPointerCapture","load","load","loadeddata","loadedData","loadedmetadata","loadedMetadata","loadstart","loadStart","lostpointercapture","lostPointerCapture","playing","playing","progress","progress","seeking","seeking","stalled","stalled","suspend","suspend","timeupdate","timeUpdate",$t,"transitionEnd","waiting","waiting"];function Tt(e,t){for(var n=0;n<e.length;n+=2){var r=e[n],o=e[n+1];o="on"+(o[0].toUpperCase()+o.slice(1)),Rt.set(r,t),Ct.set(r,o),c(o,[r])}}(0,i.unstable_now)();var It=8;function Nt(e){if(0!=(1&e))return It=15,1;if(0!=(2&e))return It=14,2;if(0!=(4&e))return It=13,4;var t=24&e;return 0!==t?(It=12,t):0!=(32&e)?(It=11,32):0!=(t=192&e)?(It=10,t):0!=(256&e)?(It=9,256):0!=(t=3584&e)?(It=8,t):0!=(4096&e)?(It=7,4096):0!=(t=4186112&e)?(It=6,t):0!=(t=62914560&e)?(It=5,t):67108864&e?(It=4,67108864):0!=(134217728&e)?(It=3,134217728):0!=(t=805306368&e)?(It=2,t):0!=(1073741824&e)?(It=1,1073741824):(It=8,e)}function Dt(e,t){var n=e.pendingLanes;if(0===n)return It=0;var r=0,o=0,i=e.expiredLanes,a=e.suspendedLanes,s=e.pingedLanes;if(0!==i)r=i,o=It=15;else if(0!=(i=134217727&n)){var l=i&~a;0!==l?(r=Nt(l),o=It):0!=(s&=i)&&(r=Nt(s),o=It)}else 0!=(i=n&~a)?(r=Nt(i),o=It):0!==s&&(r=Nt(s),o=It);if(0===r)return 0;if(r=n&((0>(r=31-Vt(r))?0:1<<r)<<1)-1,0!==t&&t!==r&&0==(t&a)){if(Nt(t),o<=It)return t;It=o}if(0!==(t=e.entangledLanes))for(e=e.entanglements,t&=r;0<t;)o=1<<(n=31-Vt(t)),r|=e[n],t&=~o;return r}function Lt(e){return 0!=(e=-1073741825&e.pendingLanes)?e:1073741824&e?1073741824:0}function Mt(e,t){switch(e){case 15:return 1;case 14:return 2;case 12:return 0===(e=Ft(24&~t))?Mt(10,t):e;case 10:return 0===(e=Ft(192&~t))?Mt(8,t):e;case 8:return 0===(e=Ft(3584&~t))&&0===(e=Ft(4186112&~t))&&(e=512),e;case 2:return 0===(t=Ft(805306368&~t))&&(t=268435456),t}throw Error(a(358,e))}function Ft(e){return e&-e}function zt(e){for(var t=[],n=0;31>n;n++)t.push(e);return t}function Ut(e,t,n){e.pendingLanes|=t;var r=t-1;e.suspendedLanes&=r,e.pingedLanes&=r,(e=e.eventTimes)[t=31-Vt(t)]=n}var Vt=Math.clz32?Math.clz32:function(e){return 0===e?32:31-(Bt(e)/qt|0)|0},Bt=Math.log,qt=Math.LN2,Wt=i.unstable_UserBlockingPriority,Ht=i.unstable_runWithPriority,Yt=!0;function Kt(e,t,n,r){De||Ie();var o=Qt,i=De;De=!0;try{Te(o,e,t,n,r)}finally{(De=i)||Me()}}function Gt(e,t,n,r){Ht(Wt,Qt.bind(null,e,t,n,r))}function Qt(e,t,n,r){var o;if(Yt)if((o=0==(4&t))&&0<ot.length&&-1<pt.indexOf(e))e=dt(null,e,t,n,r),ot.push(e);else{var i=Xt(e,t,n,r);if(null===i)o&&ft(e,r);else{if(o){if(-1<pt.indexOf(e))return e=dt(i,e,t,n,r),void ot.push(e);if(function(e,t,n,r,o){switch(t){case"focusin":return it=ht(it,e,t,n,r,o),!0;case"dragenter":return at=ht(at,e,t,n,r,o),!0;case"mouseover":return st=ht(st,e,t,n,r,o),!0;case"pointerover":var i=o.pointerId;return lt.set(i,ht(lt.get(i)||null,e,t,n,r,o)),!0;case"gotpointercapture":return i=o.pointerId,ct.set(i,ht(ct.get(i)||null,e,t,n,r,o)),!0}return!1}(i,e,t,n,r))return;ft(e,r)}Tr(e,t,r,null,n)}}}function Xt(e,t,n,r){var o=Se(r);if(null!==(o=eo(o))){var i=Ge(o);if(null===i)o=null;else{var a=i.tag;if(13===a){if(null!==(o=Qe(i)))return o;o=null}else if(3===a){if(i.stateNode.hydrate)return 3===i.tag?i.stateNode.containerInfo:null;o=null}else i!==o&&(o=null)}}return Tr(e,t,r,o,n),null}var Jt=null,Zt=null,en=null;function tn(){if(en)return en;var e,t,n=Zt,r=n.length,o="value"in Jt?Jt.value:Jt.textContent,i=o.length;for(e=0;e<r&&n[e]===o[e];e++);var a=r-e;for(t=1;t<=a&&n[r-t]===o[i-t];t++);return en=o.slice(e,1<t?1-t:void 0)}function nn(e){var t=e.keyCode;return"charCode"in e?0===(e=e.charCode)&&13===t&&(e=13):e=t,10===e&&(e=13),32<=e||13===e?e:0}function rn(){return!0}function on(){return!1}function an(e){function t(t,n,r,o,i){for(var a in this._reactName=t,this._targetInst=r,this.type=n,this.nativeEvent=o,this.target=i,this.currentTarget=null,e)e.hasOwnProperty(a)&&(t=e[a],this[a]=t?t(o):o[a]);return this.isDefaultPrevented=(null!=o.defaultPrevented?o.defaultPrevented:!1===o.returnValue)?rn:on,this.isPropagationStopped=on,this}return o(t.prototype,{preventDefault:function(){this.defaultPrevented=!0;var e=this.nativeEvent;e&&(e.preventDefault?e.preventDefault():"unknown"!=typeof e.returnValue&&(e.returnValue=!1),this.isDefaultPrevented=rn)},stopPropagation:function(){var e=this.nativeEvent;e&&(e.stopPropagation?e.stopPropagation():"unknown"!=typeof e.cancelBubble&&(e.cancelBubble=!0),this.isPropagationStopped=rn)},persist:function(){},isPersistent:rn}),t}var sn,ln,cn,un={eventPhase:0,bubbles:0,cancelable:0,timeStamp:function(e){return e.timeStamp||Date.now()},defaultPrevented:0,isTrusted:0},pn=an(un),dn=o({},un,{view:0,detail:0}),fn=an(dn),hn=o({},dn,{screenX:0,screenY:0,clientX:0,clientY:0,pageX:0,pageY:0,ctrlKey:0,shiftKey:0,altKey:0,metaKey:0,getModifierState:En,button:0,buttons:0,relatedTarget:function(e){return void 0===e.relatedTarget?e.fromElement===e.srcElement?e.toElement:e.fromElement:e.relatedTarget},movementX:function(e){return"movementX"in e?e.movementX:(e!==cn&&(cn&&"mousemove"===e.type?(sn=e.screenX-cn.screenX,ln=e.screenY-cn.screenY):ln=sn=0,cn=e),sn)},movementY:function(e){return"movementY"in e?e.movementY:ln}}),mn=an(hn),gn=an(o({},hn,{dataTransfer:0})),yn=an(o({},dn,{relatedTarget:0})),vn=an(o({},un,{animationName:0,elapsedTime:0,pseudoElement:0})),bn=o({},un,{clipboardData:function(e){return"clipboardData"in e?e.clipboardData:window.clipboardData}}),wn=an(bn),xn=an(o({},un,{data:0})),kn={Esc:"Escape",Spacebar:" ",Left:"ArrowLeft",Up:"ArrowUp",Right:"ArrowRight",Down:"ArrowDown",Del:"Delete",Win:"OS",Menu:"ContextMenu",Apps:"ContextMenu",Scroll:"ScrollLock",MozPrintableKey:"Unidentified"},_n={8:"Backspace",9:"Tab",12:"Clear",13:"Enter",16:"Shift",17:"Control",18:"Alt",19:"Pause",20:"CapsLock",27:"Escape",32:" ",33:"PageUp",34:"PageDown",35:"End",36:"Home",37:"ArrowLeft",38:"ArrowUp",39:"ArrowRight",40:"ArrowDown",45:"Insert",46:"Delete",112:"F1",113:"F2",114:"F3",115:"F4",116:"F5",117:"F6",118:"F7",119:"F8",120:"F9",121:"F10",122:"F11",123:"F12",144:"NumLock",145:"ScrollLock",224:"Meta"},On={Alt:"altKey",Control:"ctrlKey",Meta:"metaKey",Shift:"shiftKey"};function Sn(e){var t=this.nativeEvent;return t.getModifierState?t.getModifierState(e):!!(e=On[e])&&!!t[e]}function En(){return Sn}var Pn=o({},dn,{key:function(e){if(e.key){var t=kn[e.key]||e.key;if("Unidentified"!==t)return t}return"keypress"===e.type?13===(e=nn(e))?"Enter":String.fromCharCode(e):"keydown"===e.type||"keyup"===e.type?_n[e.keyCode]||"Unidentified":""},code:0,location:0,ctrlKey:0,shiftKey:0,altKey:0,metaKey:0,repeat:0,locale:0,getModifierState:En,charCode:function(e){return"keypress"===e.type?nn(e):0},keyCode:function(e){return"keydown"===e.type||"keyup"===e.type?e.keyCode:0},which:function(e){return"keypress"===e.type?nn(e):"keydown"===e.type||"keyup"===e.type?e.keyCode:0}}),An=an(Pn),$n=an(o({},hn,{pointerId:0,width:0,height:0,pressure:0,tangentialPressure:0,tiltX:0,tiltY:0,twist:0,pointerType:0,isPrimary:0})),Cn=an(o({},dn,{touches:0,targetTouches:0,changedTouches:0,altKey:0,metaKey:0,ctrlKey:0,shiftKey:0,getModifierState:En})),Rn=an(o({},un,{propertyName:0,elapsedTime:0,pseudoElement:0})),jn=o({},hn,{deltaX:function(e){return"deltaX"in e?e.deltaX:"wheelDeltaX"in e?-e.wheelDeltaX:0},deltaY:function(e){return"deltaY"in e?e.deltaY:"wheelDeltaY"in e?-e.wheelDeltaY:"wheelDelta"in e?-e.wheelDelta:0},deltaZ:0,deltaMode:0}),Tn=an(jn),In=[9,13,27,32],Nn=p&&"CompositionEvent"in window,Dn=null;p&&"documentMode"in document&&(Dn=document.documentMode);var Ln=p&&"TextEvent"in window&&!Dn,Mn=p&&(!Nn||Dn&&8<Dn&&11>=Dn),Fn=String.fromCharCode(32),zn=!1;function Un(e,t){switch(e){case"keyup":return-1!==In.indexOf(t.keyCode);case"keydown":return 229!==t.keyCode;case"keypress":case"mousedown":case"focusout":return!0;default:return!1}}function Vn(e){return"object"==typeof(e=e.detail)&&"data"in e?e.data:null}var Bn=!1,qn={color:!0,date:!0,datetime:!0,"datetime-local":!0,email:!0,month:!0,number:!0,password:!0,range:!0,search:!0,tel:!0,text:!0,time:!0,url:!0,week:!0};function Wn(e){var t=e&&e.nodeName&&e.nodeName.toLowerCase();return"input"===t?!!qn[e.type]:"textarea"===t}function Hn(e,t,n,r){Ce(r),0<(t=Nr(t,"onChange")).length&&(n=new pn("onChange","change",null,n,r),e.push({event:n,listeners:t}))}var Yn=null,Kn=null;function Gn(e){Pr(e,0)}function Qn(e){if(X(no(e)))return e}function Xn(e,t){if("change"===e)return t}var Jn=!1;if(p){var Zn;if(p){var er="oninput"in document;if(!er){var tr=document.createElement("div");tr.setAttribute("oninput","return;"),er="function"==typeof tr.oninput}Zn=er}else Zn=!1;Jn=Zn&&(!document.documentMode||9<document.documentMode)}function nr(){Yn&&(Yn.detachEvent("onpropertychange",rr),Kn=Yn=null)}function rr(e){if("value"===e.propertyName&&Qn(Kn)){var t=[];if(Hn(t,Kn,e,Se(e)),e=Gn,De)e(t);else{De=!0;try{je(e,t)}finally{De=!1,Me()}}}}function or(e,t,n){"focusin"===e?(nr(),Kn=n,(Yn=t).attachEvent("onpropertychange",rr)):"focusout"===e&&nr()}function ir(e){if("selectionchange"===e||"keyup"===e||"keydown"===e)return Qn(Kn)}function ar(e,t){if("click"===e)return Qn(t)}function sr(e,t){if("input"===e||"change"===e)return Qn(t)}var lr="function"==typeof Object.is?Object.is:function(e,t){return e===t&&(0!==e||1/e==1/t)||e!=e&&t!=t},cr=Object.prototype.hasOwnProperty;function ur(e,t){if(lr(e,t))return!0;if("object"!=typeof e||null===e||"object"!=typeof t||null===t)return!1;var n=Object.keys(e),r=Object.keys(t);if(n.length!==r.length)return!1;for(r=0;r<n.length;r++)if(!cr.call(t,n[r])||!lr(e[n[r]],t[n[r]]))return!1;return!0}function pr(e){for(;e&&e.firstChild;)e=e.firstChild;return e}function dr(e,t){var n,r=pr(e);for(e=0;r;){if(3===r.nodeType){if(n=e+r.textContent.length,e<=t&&n>=t)return{node:r,offset:t-e};e=n}e:{for(;r;){if(r.nextSibling){r=r.nextSibling;break e}r=r.parentNode}r=void 0}r=pr(r)}}function fr(e,t){return!(!e||!t)&&(e===t||(!e||3!==e.nodeType)&&(t&&3===t.nodeType?fr(e,t.parentNode):"contains"in e?e.contains(t):!!e.compareDocumentPosition&&!!(16&e.compareDocumentPosition(t))))}function hr(){for(var e=window,t=J();t instanceof e.HTMLIFrameElement;){try{var n="string"==typeof t.contentWindow.location.href}catch(e){n=!1}if(!n)break;t=J((e=t.contentWindow).document)}return t}function mr(e){var t=e&&e.nodeName&&e.nodeName.toLowerCase();return t&&("input"===t&&("text"===e.type||"search"===e.type||"tel"===e.type||"url"===e.type||"password"===e.type)||"textarea"===t||"true"===e.contentEditable)}var gr=p&&"documentMode"in document&&11>=document.documentMode,yr=null,vr=null,br=null,wr=!1;function xr(e,t,n){var r=n.window===n?n.document:9===n.nodeType?n:n.ownerDocument;wr||null==yr||yr!==J(r)||(r="selectionStart"in(r=yr)&&mr(r)?{start:r.selectionStart,end:r.selectionEnd}:{anchorNode:(r=(r.ownerDocument&&r.ownerDocument.defaultView||window).getSelection()).anchorNode,anchorOffset:r.anchorOffset,focusNode:r.focusNode,focusOffset:r.focusOffset},br&&ur(br,r)||(br=r,0<(r=Nr(vr,"onSelect")).length&&(t=new pn("onSelect","select",null,t,n),e.push({event:t,listeners:r}),t.target=yr)))}Tt("cancel cancel click click close close contextmenu contextMenu copy copy cut cut auxclick auxClick dblclick doubleClick dragend dragEnd dragstart dragStart drop drop focusin focus focusout blur input input invalid invalid keydown keyDown keypress keyPress keyup keyUp mousedown mouseDown mouseup mouseUp paste paste pause pause play play pointercancel pointerCancel pointerdown pointerDown pointerup pointerUp ratechange rateChange reset reset seeked seeked submit submit touchcancel touchCancel touchend touchEnd touchstart touchStart volumechange volumeChange".split(" "),0),Tt("drag drag dragenter dragEnter dragexit dragExit dragleave dragLeave dragover dragOver mousemove mouseMove mouseout mouseOut mouseover mouseOver pointermove pointerMove pointerout pointerOut pointerover pointerOver scroll scroll toggle toggle touchmove touchMove wheel wheel".split(" "),1),Tt(jt,2);for(var kr="change selectionchange textInput compositionstart compositionend compositionupdate".split(" "),_r=0;_r<kr.length;_r++)Rt.set(kr[_r],0);u("onMouseEnter",["mouseout","mouseover"]),u("onMouseLeave",["mouseout","mouseover"]),u("onPointerEnter",["pointerout","pointerover"]),u("onPointerLeave",["pointerout","pointerover"]),c("onChange","change click focusin focusout input keydown keyup selectionchange".split(" ")),c("onSelect","focusout contextmenu dragend focusin keydown keyup mousedown mouseup selectionchange".split(" ")),c("onBeforeInput",["compositionend","keypress","textInput","paste"]),c("onCompositionEnd","compositionend focusout keydown keypress keyup mousedown".split(" ")),c("onCompositionStart","compositionstart focusout keydown keypress keyup mousedown".split(" ")),c("onCompositionUpdate","compositionupdate focusout keydown keypress keyup mousedown".split(" "));var Or="abort canplay canplaythrough durationchange emptied encrypted ended error loadeddata loadedmetadata loadstart pause play playing progress ratechange seeked seeking stalled suspend timeupdate volumechange waiting".split(" "),Sr=new Set("cancel close invalid load scroll toggle".split(" ").concat(Or));function Er(e,t,n){var r=e.type||"unknown-event";e.currentTarget=n,function(e,t,n,r,o,i,s,l,c){if(Ke.apply(this,arguments),Be){if(!Be)throw Error(a(198));var u=qe;Be=!1,qe=null,We||(We=!0,He=u)}}(r,t,void 0,e),e.currentTarget=null}function Pr(e,t){t=0!=(4&t);for(var n=0;n<e.length;n++){var r=e[n],o=r.event;r=r.listeners;e:{var i=void 0;if(t)for(var a=r.length-1;0<=a;a--){var s=r[a],l=s.instance,c=s.currentTarget;if(s=s.listener,l!==i&&o.isPropagationStopped())break e;Er(o,s,c),i=l}else for(a=0;a<r.length;a++){if(l=(s=r[a]).instance,c=s.currentTarget,s=s.listener,l!==i&&o.isPropagationStopped())break e;Er(o,s,c),i=l}}}if(We)throw e=He,We=!1,He=null,e}function Ar(e,t){var n=oo(t),r=e+"__bubble";n.has(r)||(jr(t,e,2,!1),n.add(r))}var $r="_reactListening"+Math.random().toString(36).slice(2);function Cr(e){e[$r]||(e[$r]=!0,s.forEach((function(t){Sr.has(t)||Rr(t,!1,e,null),Rr(t,!0,e,null)})))}function Rr(e,t,n,r){var o=4<arguments.length&&void 0!==arguments[4]?arguments[4]:0,i=n;if("selectionchange"===e&&9!==n.nodeType&&(i=n.ownerDocument),null!==r&&!t&&Sr.has(e)){if("scroll"!==e)return;o|=2,i=r}var a=oo(i),s=e+"__"+(t?"capture":"bubble");a.has(s)||(t&&(o|=4),jr(i,e,o,t),a.add(s))}function jr(e,t,n,r){var o=Rt.get(t);switch(void 0===o?2:o){case 0:o=Kt;break;case 1:o=Gt;break;default:o=Qt}n=o.bind(null,t,n,e),o=void 0,!ze||"touchstart"!==t&&"touchmove"!==t&&"wheel"!==t||(o=!0),r?void 0!==o?e.addEventListener(t,n,{capture:!0,passive:o}):e.addEventListener(t,n,!0):void 0!==o?e.addEventListener(t,n,{passive:o}):e.addEventListener(t,n,!1)}function Tr(e,t,n,r,o){var i=r;if(0==(1&t)&&0==(2&t)&&null!==r)e:for(;;){if(null===r)return;var a=r.tag;if(3===a||4===a){var s=r.stateNode.containerInfo;if(s===o||8===s.nodeType&&s.parentNode===o)break;if(4===a)for(a=r.return;null!==a;){var l=a.tag;if((3===l||4===l)&&((l=a.stateNode.containerInfo)===o||8===l.nodeType&&l.parentNode===o))return;a=a.return}for(;null!==s;){if(null===(a=eo(s)))return;if(5===(l=a.tag)||6===l){r=i=a;continue e}s=s.parentNode}}r=r.return}!function(e,t,n){if(Le)return e();Le=!0;try{Ne(e,t,n)}finally{Le=!1,Me()}}((function(){var r=i,o=Se(n),a=[];e:{var s=Ct.get(e);if(void 0!==s){var l=pn,c=e;switch(e){case"keypress":if(0===nn(n))break e;case"keydown":case"keyup":l=An;break;case"focusin":c="focus",l=yn;break;case"focusout":c="blur",l=yn;break;case"beforeblur":case"afterblur":l=yn;break;case"click":if(2===n.button)break e;case"auxclick":case"dblclick":case"mousedown":case"mousemove":case"mouseup":case"mouseout":case"mouseover":case"contextmenu":l=mn;break;case"drag":case"dragend":case"dragenter":case"dragexit":case"dragleave":case"dragover":case"dragstart":case"drop":l=gn;break;case"touchcancel":case"touchend":case"touchmove":case"touchstart":l=Cn;break;case Et:case Pt:case At:l=vn;break;case $t:l=Rn;break;case"scroll":l=fn;break;case"wheel":l=Tn;break;case"copy":case"cut":case"paste":l=wn;break;case"gotpointercapture":case"lostpointercapture":case"pointercancel":case"pointerdown":case"pointermove":case"pointerout":case"pointerover":case"pointerup":l=$n}var u=0!=(4&t),p=!u&&"scroll"===e,d=u?null!==s?s+"Capture":null:s;u=[];for(var f,h=r;null!==h;){var m=(f=h).stateNode;if(5===f.tag&&null!==m&&(f=m,null!==d&&null!=(m=Fe(h,d))&&u.push(Ir(h,m,f))),p)break;h=h.return}0<u.length&&(s=new l(s,c,null,n,o),a.push({event:s,listeners:u}))}}if(0==(7&t)){if(l="mouseout"===e||"pointerout"===e,(!(s="mouseover"===e||"pointerover"===e)||0!=(16&t)||!(c=n.relatedTarget||n.fromElement)||!eo(c)&&!c[Jr])&&(l||s)&&(s=o.window===o?o:(s=o.ownerDocument)?s.defaultView||s.parentWindow:window,l?(l=r,null!==(c=(c=n.relatedTarget||n.toElement)?eo(c):null)&&(c!==(p=Ge(c))||5!==c.tag&&6!==c.tag)&&(c=null)):(l=null,c=r),l!==c)){if(u=mn,m="onMouseLeave",d="onMouseEnter",h="mouse","pointerout"!==e&&"pointerover"!==e||(u=$n,m="onPointerLeave",d="onPointerEnter",h="pointer"),p=null==l?s:no(l),f=null==c?s:no(c),(s=new u(m,h+"leave",l,n,o)).target=p,s.relatedTarget=f,m=null,eo(o)===r&&((u=new u(d,h+"enter",c,n,o)).target=f,u.relatedTarget=p,m=u),p=m,l&&c)e:{for(d=c,h=0,f=u=l;f;f=Dr(f))h++;for(f=0,m=d;m;m=Dr(m))f++;for(;0<h-f;)u=Dr(u),h--;for(;0<f-h;)d=Dr(d),f--;for(;h--;){if(u===d||null!==d&&u===d.alternate)break e;u=Dr(u),d=Dr(d)}u=null}else u=null;null!==l&&Lr(a,s,l,u,!1),null!==c&&null!==p&&Lr(a,p,c,u,!0)}if("select"===(l=(s=r?no(r):window).nodeName&&s.nodeName.toLowerCase())||"input"===l&&"file"===s.type)var g=Xn;else if(Wn(s))if(Jn)g=sr;else{g=ir;var y=or}else(l=s.nodeName)&&"input"===l.toLowerCase()&&("checkbox"===s.type||"radio"===s.type)&&(g=ar);switch(g&&(g=g(e,r))?Hn(a,g,n,o):(y&&y(e,s,r),"focusout"===e&&(y=s._wrapperState)&&y.controlled&&"number"===s.type&&oe(s,"number",s.value)),y=r?no(r):window,e){case"focusin":(Wn(y)||"true"===y.contentEditable)&&(yr=y,vr=r,br=null);break;case"focusout":br=vr=yr=null;break;case"mousedown":wr=!0;break;case"contextmenu":case"mouseup":case"dragend":wr=!1,xr(a,n,o);break;case"selectionchange":if(gr)break;case"keydown":case"keyup":xr(a,n,o)}var v;if(Nn)e:{switch(e){case"compositionstart":var b="onCompositionStart";break e;case"compositionend":b="onCompositionEnd";break e;case"compositionupdate":b="onCompositionUpdate";break e}b=void 0}else Bn?Un(e,n)&&(b="onCompositionEnd"):"keydown"===e&&229===n.keyCode&&(b="onCompositionStart");b&&(Mn&&"ko"!==n.locale&&(Bn||"onCompositionStart"!==b?"onCompositionEnd"===b&&Bn&&(v=tn()):(Zt="value"in(Jt=o)?Jt.value:Jt.textContent,Bn=!0)),0<(y=Nr(r,b)).length&&(b=new xn(b,e,null,n,o),a.push({event:b,listeners:y}),(v||null!==(v=Vn(n)))&&(b.data=v))),(v=Ln?function(e,t){switch(e){case"compositionend":return Vn(t);case"keypress":return 32!==t.which?null:(zn=!0,Fn);case"textInput":return(e=t.data)===Fn&&zn?null:e;default:return null}}(e,n):function(e,t){if(Bn)return"compositionend"===e||!Nn&&Un(e,t)?(e=tn(),en=Zt=Jt=null,Bn=!1,e):null;switch(e){case"paste":default:return null;case"keypress":if(!(t.ctrlKey||t.altKey||t.metaKey)||t.ctrlKey&&t.altKey){if(t.char&&1<t.char.length)return t.char;if(t.which)return String.fromCharCode(t.which)}return null;case"compositionend":return Mn&&"ko"!==t.locale?null:t.data}}(e,n))&&0<(r=Nr(r,"onBeforeInput")).length&&(o=new xn("onBeforeInput","beforeinput",null,n,o),a.push({event:o,listeners:r}),o.data=v)}Pr(a,t)}))}function Ir(e,t,n){return{instance:e,listener:t,currentTarget:n}}function Nr(e,t){for(var n=t+"Capture",r=[];null!==e;){var o=e,i=o.stateNode;5===o.tag&&null!==i&&(o=i,null!=(i=Fe(e,n))&&r.unshift(Ir(e,i,o)),null!=(i=Fe(e,t))&&r.push(Ir(e,i,o))),e=e.return}return r}function Dr(e){if(null===e)return null;do{e=e.return}while(e&&5!==e.tag);return e||null}function Lr(e,t,n,r,o){for(var i=t._reactName,a=[];null!==n&&n!==r;){var s=n,l=s.alternate,c=s.stateNode;if(null!==l&&l===r)break;5===s.tag&&null!==c&&(s=c,o?null!=(l=Fe(n,i))&&a.unshift(Ir(n,l,s)):o||null!=(l=Fe(n,i))&&a.push(Ir(n,l,s))),n=n.return}0!==a.length&&e.push({event:t,listeners:a})}function Mr(){}var Fr=null,zr=null;function Ur(e,t){switch(e){case"button":case"input":case"select":case"textarea":return!!t.autoFocus}return!1}function Vr(e,t){return"textarea"===e||"option"===e||"noscript"===e||"string"==typeof t.children||"number"==typeof t.children||"object"==typeof t.dangerouslySetInnerHTML&&null!==t.dangerouslySetInnerHTML&&null!=t.dangerouslySetInnerHTML.__html}var Br="function"==typeof setTimeout?setTimeout:void 0,qr="function"==typeof clearTimeout?clearTimeout:void 0;function Wr(e){(1===e.nodeType||9===e.nodeType&&null!=(e=e.body))&&(e.textContent="")}function Hr(e){for(;null!=e;e=e.nextSibling){var t=e.nodeType;if(1===t||3===t)break}return e}function Yr(e){e=e.previousSibling;for(var t=0;e;){if(8===e.nodeType){var n=e.data;if("$"===n||"$!"===n||"$?"===n){if(0===t)return e;t--}else"/$"===n&&t++}e=e.previousSibling}return null}var Kr=0,Gr=Math.random().toString(36).slice(2),Qr="__reactFiber$"+Gr,Xr="__reactProps$"+Gr,Jr="__reactContainer$"+Gr,Zr="__reactEvents$"+Gr;function eo(e){var t=e[Qr];if(t)return t;for(var n=e.parentNode;n;){if(t=n[Jr]||n[Qr]){if(n=t.alternate,null!==t.child||null!==n&&null!==n.child)for(e=Yr(e);null!==e;){if(n=e[Qr])return n;e=Yr(e)}return t}n=(e=n).parentNode}return null}function to(e){return!(e=e[Qr]||e[Jr])||5!==e.tag&&6!==e.tag&&13!==e.tag&&3!==e.tag?null:e}function no(e){if(5===e.tag||6===e.tag)return e.stateNode;throw Error(a(33))}function ro(e){return e[Xr]||null}function oo(e){var t=e[Zr];return void 0===t&&(t=e[Zr]=new Set),t}var io=[],ao=-1;function so(e){return{current:e}}function lo(e){0>ao||(e.current=io[ao],io[ao]=null,ao--)}function co(e,t){ao++,io[ao]=e.current,e.current=t}var uo={},po=so(uo),fo=so(!1),ho=uo;function mo(e,t){var n=e.type.contextTypes;if(!n)return uo;var r=e.stateNode;if(r&&r.__reactInternalMemoizedUnmaskedChildContext===t)return r.__reactInternalMemoizedMaskedChildContext;var o,i={};for(o in n)i[o]=t[o];return r&&((e=e.stateNode).__reactInternalMemoizedUnmaskedChildContext=t,e.__reactInternalMemoizedMaskedChildContext=i),i}function go(e){return null!=e.childContextTypes}function yo(){lo(fo),lo(po)}function vo(e,t,n){if(po.current!==uo)throw Error(a(168));co(po,t),co(fo,n)}function bo(e,t,n){var r=e.stateNode;if(e=t.childContextTypes,"function"!=typeof r.getChildContext)return n;for(var i in r=r.getChildContext())if(!(i in e))throw Error(a(108,Y(t)||"Unknown",i));return o({},n,r)}function wo(e){return e=(e=e.stateNode)&&e.__reactInternalMemoizedMergedChildContext||uo,ho=po.current,co(po,e),co(fo,fo.current),!0}function xo(e,t,n){var r=e.stateNode;if(!r)throw Error(a(169));n?(e=bo(e,t,ho),r.__reactInternalMemoizedMergedChildContext=e,lo(fo),lo(po),co(po,e)):lo(fo),co(fo,n)}var ko=null,_o=null,Oo=i.unstable_runWithPriority,So=i.unstable_scheduleCallback,Eo=i.unstable_cancelCallback,Po=i.unstable_shouldYield,Ao=i.unstable_requestPaint,$o=i.unstable_now,Co=i.unstable_getCurrentPriorityLevel,Ro=i.unstable_ImmediatePriority,jo=i.unstable_UserBlockingPriority,To=i.unstable_NormalPriority,Io=i.unstable_LowPriority,No=i.unstable_IdlePriority,Do={},Lo=void 0!==Ao?Ao:function(){},Mo=null,Fo=null,zo=!1,Uo=$o(),Vo=1e4>Uo?$o:function(){return $o()-Uo};function Bo(){switch(Co()){case Ro:return 99;case jo:return 98;case To:return 97;case Io:return 96;case No:return 95;default:throw Error(a(332))}}function qo(e){switch(e){case 99:return Ro;case 98:return jo;case 97:return To;case 96:return Io;case 95:return No;default:throw Error(a(332))}}function Wo(e,t){return e=qo(e),Oo(e,t)}function Ho(e,t,n){return e=qo(e),So(e,t,n)}function Yo(){if(null!==Fo){var e=Fo;Fo=null,Eo(e)}Ko()}function Ko(){if(!zo&&null!==Mo){zo=!0;var e=0;try{var t=Mo;Wo(99,(function(){for(;e<t.length;e++){var n=t[e];do{n=n(!0)}while(null!==n)}})),Mo=null}catch(t){throw null!==Mo&&(Mo=Mo.slice(e+1)),So(Ro,Yo),t}finally{zo=!1}}}var Go=x.ReactCurrentBatchConfig;function Qo(e,t){if(e&&e.defaultProps){for(var n in t=o({},t),e=e.defaultProps)void 0===t[n]&&(t[n]=e[n]);return t}return t}var Xo=so(null),Jo=null,Zo=null,ei=null;function ti(){ei=Zo=Jo=null}function ni(e){var t=Xo.current;lo(Xo),e.type._context._currentValue=t}function ri(e,t){for(;null!==e;){var n=e.alternate;if((e.childLanes&t)===t){if(null===n||(n.childLanes&t)===t)break;n.childLanes|=t}else e.childLanes|=t,null!==n&&(n.childLanes|=t);e=e.return}}function oi(e,t){Jo=e,ei=Zo=null,null!==(e=e.dependencies)&&null!==e.firstContext&&(0!=(e.lanes&t)&&(Na=!0),e.firstContext=null)}function ii(e,t){if(ei!==e&&!1!==t&&0!==t)if("number"==typeof t&&1073741823!==t||(ei=e,t=1073741823),t={context:e,observedBits:t,next:null},null===Zo){if(null===Jo)throw Error(a(308));Zo=t,Jo.dependencies={lanes:0,firstContext:t,responders:null}}else Zo=Zo.next=t;return e._currentValue}var ai=!1;function si(e){e.updateQueue={baseState:e.memoizedState,firstBaseUpdate:null,lastBaseUpdate:null,shared:{pending:null},effects:null}}function li(e,t){e=e.updateQueue,t.updateQueue===e&&(t.updateQueue={baseState:e.baseState,firstBaseUpdate:e.firstBaseUpdate,lastBaseUpdate:e.lastBaseUpdate,shared:e.shared,effects:e.effects})}function ci(e,t){return{eventTime:e,lane:t,tag:0,payload:null,callback:null,next:null}}function ui(e,t){if(null!==(e=e.updateQueue)){var n=(e=e.shared).pending;null===n?t.next=t:(t.next=n.next,n.next=t),e.pending=t}}function pi(e,t){var n=e.updateQueue,r=e.alternate;if(null!==r&&n===(r=r.updateQueue)){var o=null,i=null;if(null!==(n=n.firstBaseUpdate)){do{var a={eventTime:n.eventTime,lane:n.lane,tag:n.tag,payload:n.payload,callback:n.callback,next:null};null===i?o=i=a:i=i.next=a,n=n.next}while(null!==n);null===i?o=i=t:i=i.next=t}else o=i=t;return n={baseState:r.baseState,firstBaseUpdate:o,lastBaseUpdate:i,shared:r.shared,effects:r.effects},void(e.updateQueue=n)}null===(e=n.lastBaseUpdate)?n.firstBaseUpdate=t:e.next=t,n.lastBaseUpdate=t}function di(e,t,n,r){var i=e.updateQueue;ai=!1;var a=i.firstBaseUpdate,s=i.lastBaseUpdate,l=i.shared.pending;if(null!==l){i.shared.pending=null;var c=l,u=c.next;c.next=null,null===s?a=u:s.next=u,s=c;var p=e.alternate;if(null!==p){var d=(p=p.updateQueue).lastBaseUpdate;d!==s&&(null===d?p.firstBaseUpdate=u:d.next=u,p.lastBaseUpdate=c)}}if(null!==a){for(d=i.baseState,s=0,p=u=c=null;;){l=a.lane;var f=a.eventTime;if((r&l)===l){null!==p&&(p=p.next={eventTime:f,lane:0,tag:a.tag,payload:a.payload,callback:a.callback,next:null});e:{var h=e,m=a;switch(l=t,f=n,m.tag){case 1:if("function"==typeof(h=m.payload)){d=h.call(f,d,l);break e}d=h;break e;case 3:h.flags=-4097&h.flags|64;case 0:if(null==(l="function"==typeof(h=m.payload)?h.call(f,d,l):h))break e;d=o({},d,l);break e;case 2:ai=!0}}null!==a.callback&&(e.flags|=32,null===(l=i.effects)?i.effects=[a]:l.push(a))}else f={eventTime:f,lane:l,tag:a.tag,payload:a.payload,callback:a.callback,next:null},null===p?(u=p=f,c=d):p=p.next=f,s|=l;if(null===(a=a.next)){if(null===(l=i.shared.pending))break;a=l.next,l.next=null,i.lastBaseUpdate=l,i.shared.pending=null}}null===p&&(c=d),i.baseState=c,i.firstBaseUpdate=u,i.lastBaseUpdate=p,Ls|=s,e.lanes=s,e.memoizedState=d}}function fi(e,t,n){if(e=t.effects,t.effects=null,null!==e)for(t=0;t<e.length;t++){var r=e[t],o=r.callback;if(null!==o){if(r.callback=null,r=n,"function"!=typeof o)throw Error(a(191,o));o.call(r)}}}var hi=(new r.Component).refs;function mi(e,t,n,r){n=null==(n=n(r,t=e.memoizedState))?t:o({},t,n),e.memoizedState=n,0===e.lanes&&(e.updateQueue.baseState=n)}var gi={isMounted:function(e){return!!(e=e._reactInternals)&&Ge(e)===e},enqueueSetState:function(e,t,n){e=e._reactInternals;var r=ll(),o=cl(e),i=ci(r,o);i.payload=t,null!=n&&(i.callback=n),ui(e,i),ul(e,o,r)},enqueueReplaceState:function(e,t,n){e=e._reactInternals;var r=ll(),o=cl(e),i=ci(r,o);i.tag=1,i.payload=t,null!=n&&(i.callback=n),ui(e,i),ul(e,o,r)},enqueueForceUpdate:function(e,t){e=e._reactInternals;var n=ll(),r=cl(e),o=ci(n,r);o.tag=2,null!=t&&(o.callback=t),ui(e,o),ul(e,r,n)}};function yi(e,t,n,r,o,i,a){return"function"==typeof(e=e.stateNode).shouldComponentUpdate?e.shouldComponentUpdate(r,i,a):!(t.prototype&&t.prototype.isPureReactComponent&&ur(n,r)&&ur(o,i))}function vi(e,t,n){var r=!1,o=uo,i=t.contextType;return"object"==typeof i&&null!==i?i=ii(i):(o=go(t)?ho:po.current,i=(r=null!=(r=t.contextTypes))?mo(e,o):uo),t=new t(n,i),e.memoizedState=null!==t.state&&void 0!==t.state?t.state:null,t.updater=gi,e.stateNode=t,t._reactInternals=e,r&&((e=e.stateNode).__reactInternalMemoizedUnmaskedChildContext=o,e.__reactInternalMemoizedMaskedChildContext=i),t}function bi(e,t,n,r){e=t.state,"function"==typeof t.componentWillReceiveProps&&t.componentWillReceiveProps(n,r),"function"==typeof t.UNSAFE_componentWillReceiveProps&&t.UNSAFE_componentWillReceiveProps(n,r),t.state!==e&&gi.enqueueReplaceState(t,t.state,null)}function wi(e,t,n,r){var o=e.stateNode;o.props=n,o.state=e.memoizedState,o.refs=hi,si(e);var i=t.contextType;"object"==typeof i&&null!==i?o.context=ii(i):(i=go(t)?ho:po.current,o.context=mo(e,i)),di(e,n,o,r),o.state=e.memoizedState,"function"==typeof(i=t.getDerivedStateFromProps)&&(mi(e,t,i,n),o.state=e.memoizedState),"function"==typeof t.getDerivedStateFromProps||"function"==typeof o.getSnapshotBeforeUpdate||"function"!=typeof o.UNSAFE_componentWillMount&&"function"!=typeof o.componentWillMount||(t=o.state,"function"==typeof o.componentWillMount&&o.componentWillMount(),"function"==typeof o.UNSAFE_componentWillMount&&o.UNSAFE_componentWillMount(),t!==o.state&&gi.enqueueReplaceState(o,o.state,null),di(e,n,o,r),o.state=e.memoizedState),"function"==typeof o.componentDidMount&&(e.flags|=4)}var xi=Array.isArray;function ki(e,t,n){if(null!==(e=n.ref)&&"function"!=typeof e&&"object"!=typeof e){if(n._owner){if(n=n._owner){if(1!==n.tag)throw Error(a(309));var r=n.stateNode}if(!r)throw Error(a(147,e));var o=""+e;return null!==t&&null!==t.ref&&"function"==typeof t.ref&&t.ref._stringRef===o?t.ref:(t=function(e){var t=r.refs;t===hi&&(t=r.refs={}),null===e?delete t[o]:t[o]=e},t._stringRef=o,t)}if("string"!=typeof e)throw Error(a(284));if(!n._owner)throw Error(a(290,e))}return e}function _i(e,t){if("textarea"!==e.type)throw Error(a(31,"[object Object]"===Object.prototype.toString.call(t)?"object with keys {"+Object.keys(t).join(", ")+"}":t))}function Oi(e){function t(t,n){if(e){var r=t.lastEffect;null!==r?(r.nextEffect=n,t.lastEffect=n):t.firstEffect=t.lastEffect=n,n.nextEffect=null,n.flags=8}}function n(n,r){if(!e)return null;for(;null!==r;)t(n,r),r=r.sibling;return null}function r(e,t){for(e=new Map;null!==t;)null!==t.key?e.set(t.key,t):e.set(t.index,t),t=t.sibling;return e}function o(e,t){return(e=Vl(e,t)).index=0,e.sibling=null,e}function i(t,n,r){return t.index=r,e?null!==(r=t.alternate)?(r=r.index)<n?(t.flags=2,n):r:(t.flags=2,n):n}function s(t){return e&&null===t.alternate&&(t.flags=2),t}function l(e,t,n,r){return null===t||6!==t.tag?((t=Hl(n,e.mode,r)).return=e,t):((t=o(t,n)).return=e,t)}function c(e,t,n,r){return null!==t&&t.elementType===n.type?((r=o(t,n.props)).ref=ki(e,t,n),r.return=e,r):((r=Bl(n.type,n.key,n.props,null,e.mode,r)).ref=ki(e,t,n),r.return=e,r)}function u(e,t,n,r){return null===t||4!==t.tag||t.stateNode.containerInfo!==n.containerInfo||t.stateNode.implementation!==n.implementation?((t=Yl(n,e.mode,r)).return=e,t):((t=o(t,n.children||[])).return=e,t)}function p(e,t,n,r,i){return null===t||7!==t.tag?((t=ql(n,e.mode,r,i)).return=e,t):((t=o(t,n)).return=e,t)}function d(e,t,n){if("string"==typeof t||"number"==typeof t)return(t=Hl(""+t,e.mode,n)).return=e,t;if("object"==typeof t&&null!==t){switch(t.$$typeof){case k:return(n=Bl(t.type,t.key,t.props,null,e.mode,n)).ref=ki(e,null,t),n.return=e,n;case _:return(t=Yl(t,e.mode,n)).return=e,t}if(xi(t)||V(t))return(t=ql(t,e.mode,n,null)).return=e,t;_i(e,t)}return null}function f(e,t,n,r){var o=null!==t?t.key:null;if("string"==typeof n||"number"==typeof n)return null!==o?null:l(e,t,""+n,r);if("object"==typeof n&&null!==n){switch(n.$$typeof){case k:return n.key===o?n.type===O?p(e,t,n.props.children,r,o):c(e,t,n,r):null;case _:return n.key===o?u(e,t,n,r):null}if(xi(n)||V(n))return null!==o?null:p(e,t,n,r,null);_i(e,n)}return null}function h(e,t,n,r,o){if("string"==typeof r||"number"==typeof r)return l(t,e=e.get(n)||null,""+r,o);if("object"==typeof r&&null!==r){switch(r.$$typeof){case k:return e=e.get(null===r.key?n:r.key)||null,r.type===O?p(t,e,r.props.children,o,r.key):c(t,e,r,o);case _:return u(t,e=e.get(null===r.key?n:r.key)||null,r,o)}if(xi(r)||V(r))return p(t,e=e.get(n)||null,r,o,null);_i(t,r)}return null}function m(o,a,s,l){for(var c=null,u=null,p=a,m=a=0,g=null;null!==p&&m<s.length;m++){p.index>m?(g=p,p=null):g=p.sibling;var y=f(o,p,s[m],l);if(null===y){null===p&&(p=g);break}e&&p&&null===y.alternate&&t(o,p),a=i(y,a,m),null===u?c=y:u.sibling=y,u=y,p=g}if(m===s.length)return n(o,p),c;if(null===p){for(;m<s.length;m++)null!==(p=d(o,s[m],l))&&(a=i(p,a,m),null===u?c=p:u.sibling=p,u=p);return c}for(p=r(o,p);m<s.length;m++)null!==(g=h(p,o,m,s[m],l))&&(e&&null!==g.alternate&&p.delete(null===g.key?m:g.key),a=i(g,a,m),null===u?c=g:u.sibling=g,u=g);return e&&p.forEach((function(e){return t(o,e)})),c}function g(o,s,l,c){var u=V(l);if("function"!=typeof u)throw Error(a(150));if(null==(l=u.call(l)))throw Error(a(151));for(var p=u=null,m=s,g=s=0,y=null,v=l.next();null!==m&&!v.done;g++,v=l.next()){m.index>g?(y=m,m=null):y=m.sibling;var b=f(o,m,v.value,c);if(null===b){null===m&&(m=y);break}e&&m&&null===b.alternate&&t(o,m),s=i(b,s,g),null===p?u=b:p.sibling=b,p=b,m=y}if(v.done)return n(o,m),u;if(null===m){for(;!v.done;g++,v=l.next())null!==(v=d(o,v.value,c))&&(s=i(v,s,g),null===p?u=v:p.sibling=v,p=v);return u}for(m=r(o,m);!v.done;g++,v=l.next())null!==(v=h(m,o,g,v.value,c))&&(e&&null!==v.alternate&&m.delete(null===v.key?g:v.key),s=i(v,s,g),null===p?u=v:p.sibling=v,p=v);return e&&m.forEach((function(e){return t(o,e)})),u}return function(e,r,i,l){var c="object"==typeof i&&null!==i&&i.type===O&&null===i.key;c&&(i=i.props.children);var u="object"==typeof i&&null!==i;if(u)switch(i.$$typeof){case k:e:{for(u=i.key,c=r;null!==c;){if(c.key===u){if(7===c.tag){if(i.type===O){n(e,c.sibling),(r=o(c,i.props.children)).return=e,e=r;break e}}else if(c.elementType===i.type){n(e,c.sibling),(r=o(c,i.props)).ref=ki(e,c,i),r.return=e,e=r;break e}n(e,c);break}t(e,c),c=c.sibling}i.type===O?((r=ql(i.props.children,e.mode,l,i.key)).return=e,e=r):((l=Bl(i.type,i.key,i.props,null,e.mode,l)).ref=ki(e,r,i),l.return=e,e=l)}return s(e);case _:e:{for(c=i.key;null!==r;){if(r.key===c){if(4===r.tag&&r.stateNode.containerInfo===i.containerInfo&&r.stateNode.implementation===i.implementation){n(e,r.sibling),(r=o(r,i.children||[])).return=e,e=r;break e}n(e,r);break}t(e,r),r=r.sibling}(r=Yl(i,e.mode,l)).return=e,e=r}return s(e)}if("string"==typeof i||"number"==typeof i)return i=""+i,null!==r&&6===r.tag?(n(e,r.sibling),(r=o(r,i)).return=e,e=r):(n(e,r),(r=Hl(i,e.mode,l)).return=e,e=r),s(e);if(xi(i))return m(e,r,i,l);if(V(i))return g(e,r,i,l);if(u&&_i(e,i),void 0===i&&!c)switch(e.tag){case 1:case 22:case 0:case 11:case 15:throw Error(a(152,Y(e.type)||"Component"))}return n(e,r)}}var Si=Oi(!0),Ei=Oi(!1),Pi={},Ai=so(Pi),$i=so(Pi),Ci=so(Pi);function Ri(e){if(e===Pi)throw Error(a(174));return e}function ji(e,t){switch(co(Ci,t),co($i,e),co(Ai,Pi),e=t.nodeType){case 9:case 11:t=(t=t.documentElement)?t.namespaceURI:fe(null,"");break;default:t=fe(t=(e=8===e?t.parentNode:t).namespaceURI||null,e=e.tagName)}lo(Ai),co(Ai,t)}function Ti(){lo(Ai),lo($i),lo(Ci)}function Ii(e){Ri(Ci.current);var t=Ri(Ai.current),n=fe(t,e.type);t!==n&&(co($i,e),co(Ai,n))}function Ni(e){$i.current===e&&(lo(Ai),lo($i))}var Di=so(0);function Li(e){for(var t=e;null!==t;){if(13===t.tag){var n=t.memoizedState;if(null!==n&&(null===(n=n.dehydrated)||"$?"===n.data||"$!"===n.data))return t}else if(19===t.tag&&void 0!==t.memoizedProps.revealOrder){if(0!=(64&t.flags))return t}else if(null!==t.child){t.child.return=t,t=t.child;continue}if(t===e)break;for(;null===t.sibling;){if(null===t.return||t.return===e)return null;t=t.return}t.sibling.return=t.return,t=t.sibling}return null}var Mi=null,Fi=null,zi=!1;function Ui(e,t){var n=zl(5,null,null,0);n.elementType="DELETED",n.type="DELETED",n.stateNode=t,n.return=e,n.flags=8,null!==e.lastEffect?(e.lastEffect.nextEffect=n,e.lastEffect=n):e.firstEffect=e.lastEffect=n}function Vi(e,t){switch(e.tag){case 5:var n=e.type;return null!==(t=1!==t.nodeType||n.toLowerCase()!==t.nodeName.toLowerCase()?null:t)&&(e.stateNode=t,!0);case 6:return null!==(t=""===e.pendingProps||3!==t.nodeType?null:t)&&(e.stateNode=t,!0);default:return!1}}function Bi(e){if(zi){var t=Fi;if(t){var n=t;if(!Vi(e,t)){if(!(t=Hr(n.nextSibling))||!Vi(e,t))return e.flags=-1025&e.flags|2,zi=!1,void(Mi=e);Ui(Mi,n)}Mi=e,Fi=Hr(t.firstChild)}else e.flags=-1025&e.flags|2,zi=!1,Mi=e}}function qi(e){for(e=e.return;null!==e&&5!==e.tag&&3!==e.tag&&13!==e.tag;)e=e.return;Mi=e}function Wi(e){if(e!==Mi)return!1;if(!zi)return qi(e),zi=!0,!1;var t=e.type;if(5!==e.tag||"head"!==t&&"body"!==t&&!Vr(t,e.memoizedProps))for(t=Fi;t;)Ui(e,t),t=Hr(t.nextSibling);if(qi(e),13===e.tag){if(!(e=null!==(e=e.memoizedState)?e.dehydrated:null))throw Error(a(317));e:{for(e=e.nextSibling,t=0;e;){if(8===e.nodeType){var n=e.data;if("/$"===n){if(0===t){Fi=Hr(e.nextSibling);break e}t--}else"$"!==n&&"$!"!==n&&"$?"!==n||t++}e=e.nextSibling}Fi=null}}else Fi=Mi?Hr(e.stateNode.nextSibling):null;return!0}function Hi(){Fi=Mi=null,zi=!1}var Yi=[];function Ki(){for(var e=0;e<Yi.length;e++)Yi[e]._workInProgressVersionPrimary=null;Yi.length=0}var Gi=x.ReactCurrentDispatcher,Qi=x.ReactCurrentBatchConfig,Xi=0,Ji=null,Zi=null,ea=null,ta=!1,na=!1;function ra(){throw Error(a(321))}function oa(e,t){if(null===t)return!1;for(var n=0;n<t.length&&n<e.length;n++)if(!lr(e[n],t[n]))return!1;return!0}function ia(e,t,n,r,o,i){if(Xi=i,Ji=t,t.memoizedState=null,t.updateQueue=null,t.lanes=0,Gi.current=null===e||null===e.memoizedState?Ra:ja,e=n(r,o),na){i=0;do{if(na=!1,!(25>i))throw Error(a(301));i+=1,ea=Zi=null,t.updateQueue=null,Gi.current=Ta,e=n(r,o)}while(na)}if(Gi.current=Ca,t=null!==Zi&&null!==Zi.next,Xi=0,ea=Zi=Ji=null,ta=!1,t)throw Error(a(300));return e}function aa(){var e={memoizedState:null,baseState:null,baseQueue:null,queue:null,next:null};return null===ea?Ji.memoizedState=ea=e:ea=ea.next=e,ea}function sa(){if(null===Zi){var e=Ji.alternate;e=null!==e?e.memoizedState:null}else e=Zi.next;var t=null===ea?Ji.memoizedState:ea.next;if(null!==t)ea=t,Zi=e;else{if(null===e)throw Error(a(310));e={memoizedState:(Zi=e).memoizedState,baseState:Zi.baseState,baseQueue:Zi.baseQueue,queue:Zi.queue,next:null},null===ea?Ji.memoizedState=ea=e:ea=ea.next=e}return ea}function la(e,t){return"function"==typeof t?t(e):t}function ca(e){var t=sa(),n=t.queue;if(null===n)throw Error(a(311));n.lastRenderedReducer=e;var r=Zi,o=r.baseQueue,i=n.pending;if(null!==i){if(null!==o){var s=o.next;o.next=i.next,i.next=s}r.baseQueue=o=i,n.pending=null}if(null!==o){o=o.next,r=r.baseState;var l=s=i=null,c=o;do{var u=c.lane;if((Xi&u)===u)null!==l&&(l=l.next={lane:0,action:c.action,eagerReducer:c.eagerReducer,eagerState:c.eagerState,next:null}),r=c.eagerReducer===e?c.eagerState:e(r,c.action);else{var p={lane:u,action:c.action,eagerReducer:c.eagerReducer,eagerState:c.eagerState,next:null};null===l?(s=l=p,i=r):l=l.next=p,Ji.lanes|=u,Ls|=u}c=c.next}while(null!==c&&c!==o);null===l?i=r:l.next=s,lr(r,t.memoizedState)||(Na=!0),t.memoizedState=r,t.baseState=i,t.baseQueue=l,n.lastRenderedState=r}return[t.memoizedState,n.dispatch]}function ua(e){var t=sa(),n=t.queue;if(null===n)throw Error(a(311));n.lastRenderedReducer=e;var r=n.dispatch,o=n.pending,i=t.memoizedState;if(null!==o){n.pending=null;var s=o=o.next;do{i=e(i,s.action),s=s.next}while(s!==o);lr(i,t.memoizedState)||(Na=!0),t.memoizedState=i,null===t.baseQueue&&(t.baseState=i),n.lastRenderedState=i}return[i,r]}function pa(e,t,n){var r=t._getVersion;r=r(t._source);var o=t._workInProgressVersionPrimary;if(null!==o?e=o===r:(e=e.mutableReadLanes,(e=(Xi&e)===e)&&(t._workInProgressVersionPrimary=r,Yi.push(t))),e)return n(t._source);throw Yi.push(t),Error(a(350))}function da(e,t,n,r){var o=$s;if(null===o)throw Error(a(349));var i=t._getVersion,s=i(t._source),l=Gi.current,c=l.useState((function(){return pa(o,t,n)})),u=c[1],p=c[0];c=ea;var d=e.memoizedState,f=d.refs,h=f.getSnapshot,m=d.source;d=d.subscribe;var g=Ji;return e.memoizedState={refs:f,source:t,subscribe:r},l.useEffect((function(){f.getSnapshot=n,f.setSnapshot=u;var e=i(t._source);if(!lr(s,e)){e=n(t._source),lr(p,e)||(u(e),e=cl(g),o.mutableReadLanes|=e&o.pendingLanes),e=o.mutableReadLanes,o.entangledLanes|=e;for(var r=o.entanglements,a=e;0<a;){var l=31-Vt(a),c=1<<l;r[l]|=e,a&=~c}}}),[n,t,r]),l.useEffect((function(){return r(t._source,(function(){var e=f.getSnapshot,n=f.setSnapshot;try{n(e(t._source));var r=cl(g);o.mutableReadLanes|=r&o.pendingLanes}catch(e){n((function(){throw e}))}}))}),[t,r]),lr(h,n)&&lr(m,t)&&lr(d,r)||((e={pending:null,dispatch:null,lastRenderedReducer:la,lastRenderedState:p}).dispatch=u=$a.bind(null,Ji,e),c.queue=e,c.baseQueue=null,p=pa(o,t,n),c.memoizedState=c.baseState=p),p}function fa(e,t,n){return da(sa(),e,t,n)}function ha(e){var t=aa();return"function"==typeof e&&(e=e()),t.memoizedState=t.baseState=e,e=(e=t.queue={pending:null,dispatch:null,lastRenderedReducer:la,lastRenderedState:e}).dispatch=$a.bind(null,Ji,e),[t.memoizedState,e]}function ma(e,t,n,r){return e={tag:e,create:t,destroy:n,deps:r,next:null},null===(t=Ji.updateQueue)?(t={lastEffect:null},Ji.updateQueue=t,t.lastEffect=e.next=e):null===(n=t.lastEffect)?t.lastEffect=e.next=e:(r=n.next,n.next=e,e.next=r,t.lastEffect=e),e}function ga(e){return e={current:e},aa().memoizedState=e}function ya(){return sa().memoizedState}function va(e,t,n,r){var o=aa();Ji.flags|=e,o.memoizedState=ma(1|t,n,void 0,void 0===r?null:r)}function ba(e,t,n,r){var o=sa();r=void 0===r?null:r;var i=void 0;if(null!==Zi){var a=Zi.memoizedState;if(i=a.destroy,null!==r&&oa(r,a.deps))return void ma(t,n,i,r)}Ji.flags|=e,o.memoizedState=ma(1|t,n,i,r)}function wa(e,t){return va(516,4,e,t)}function xa(e,t){return ba(516,4,e,t)}function ka(e,t){return ba(4,2,e,t)}function _a(e,t){return"function"==typeof t?(e=e(),t(e),function(){t(null)}):null!=t?(e=e(),t.current=e,function(){t.current=null}):void 0}function Oa(e,t,n){return n=null!=n?n.concat([e]):null,ba(4,2,_a.bind(null,t,e),n)}function Sa(){}function Ea(e,t){var n=sa();t=void 0===t?null:t;var r=n.memoizedState;return null!==r&&null!==t&&oa(t,r[1])?r[0]:(n.memoizedState=[e,t],e)}function Pa(e,t){var n=sa();t=void 0===t?null:t;var r=n.memoizedState;return null!==r&&null!==t&&oa(t,r[1])?r[0]:(e=e(),n.memoizedState=[e,t],e)}function Aa(e,t){var n=Bo();Wo(98>n?98:n,(function(){e(!0)})),Wo(97<n?97:n,(function(){var n=Qi.transition;Qi.transition=1;try{e(!1),t()}finally{Qi.transition=n}}))}function $a(e,t,n){var r=ll(),o=cl(e),i={lane:o,action:n,eagerReducer:null,eagerState:null,next:null},a=t.pending;if(null===a?i.next=i:(i.next=a.next,a.next=i),t.pending=i,a=e.alternate,e===Ji||null!==a&&a===Ji)na=ta=!0;else{if(0===e.lanes&&(null===a||0===a.lanes)&&null!==(a=t.lastRenderedReducer))try{var s=t.lastRenderedState,l=a(s,n);if(i.eagerReducer=a,i.eagerState=l,lr(l,s))return}catch(e){}ul(e,o,r)}}var Ca={readContext:ii,useCallback:ra,useContext:ra,useEffect:ra,useImperativeHandle:ra,useLayoutEffect:ra,useMemo:ra,useReducer:ra,useRef:ra,useState:ra,useDebugValue:ra,useDeferredValue:ra,useTransition:ra,useMutableSource:ra,useOpaqueIdentifier:ra,unstable_isNewReconciler:!1},Ra={readContext:ii,useCallback:function(e,t){return aa().memoizedState=[e,void 0===t?null:t],e},useContext:ii,useEffect:wa,useImperativeHandle:function(e,t,n){return n=null!=n?n.concat([e]):null,va(4,2,_a.bind(null,t,e),n)},useLayoutEffect:function(e,t){return va(4,2,e,t)},useMemo:function(e,t){var n=aa();return t=void 0===t?null:t,e=e(),n.memoizedState=[e,t],e},useReducer:function(e,t,n){var r=aa();return t=void 0!==n?n(t):t,r.memoizedState=r.baseState=t,e=(e=r.queue={pending:null,dispatch:null,lastRenderedReducer:e,lastRenderedState:t}).dispatch=$a.bind(null,Ji,e),[r.memoizedState,e]},useRef:ga,useState:ha,useDebugValue:Sa,useDeferredValue:function(e){var t=ha(e),n=t[0],r=t[1];return wa((function(){var t=Qi.transition;Qi.transition=1;try{r(e)}finally{Qi.transition=t}}),[e]),n},useTransition:function(){var e=ha(!1),t=e[0];return ga(e=Aa.bind(null,e[1])),[e,t]},useMutableSource:function(e,t,n){var r=aa();return r.memoizedState={refs:{getSnapshot:t,setSnapshot:null},source:e,subscribe:n},da(r,e,t,n)},useOpaqueIdentifier:function(){if(zi){var e=!1,t=function(e){return{$$typeof:N,toString:e,valueOf:e}}((function(){throw e||(e=!0,n("r:"+(Kr++).toString(36))),Error(a(355))})),n=ha(t)[1];return 0==(2&Ji.mode)&&(Ji.flags|=516,ma(5,(function(){n("r:"+(Kr++).toString(36))}),void 0,null)),t}return ha(t="r:"+(Kr++).toString(36)),t},unstable_isNewReconciler:!1},ja={readContext:ii,useCallback:Ea,useContext:ii,useEffect:xa,useImperativeHandle:Oa,useLayoutEffect:ka,useMemo:Pa,useReducer:ca,useRef:ya,useState:function(){return ca(la)},useDebugValue:Sa,useDeferredValue:function(e){var t=ca(la),n=t[0],r=t[1];return xa((function(){var t=Qi.transition;Qi.transition=1;try{r(e)}finally{Qi.transition=t}}),[e]),n},useTransition:function(){var e=ca(la)[0];return[ya().current,e]},useMutableSource:fa,useOpaqueIdentifier:function(){return ca(la)[0]},unstable_isNewReconciler:!1},Ta={readContext:ii,useCallback:Ea,useContext:ii,useEffect:xa,useImperativeHandle:Oa,useLayoutEffect:ka,useMemo:Pa,useReducer:ua,useRef:ya,useState:function(){return ua(la)},useDebugValue:Sa,useDeferredValue:function(e){var t=ua(la),n=t[0],r=t[1];return xa((function(){var t=Qi.transition;Qi.transition=1;try{r(e)}finally{Qi.transition=t}}),[e]),n},useTransition:function(){var e=ua(la)[0];return[ya().current,e]},useMutableSource:fa,useOpaqueIdentifier:function(){return ua(la)[0]},unstable_isNewReconciler:!1},Ia=x.ReactCurrentOwner,Na=!1;function Da(e,t,n,r){t.child=null===e?Ei(t,null,n,r):Si(t,e.child,n,r)}function La(e,t,n,r,o){n=n.render;var i=t.ref;return oi(t,o),r=ia(e,t,n,r,i,o),null===e||Na?(t.flags|=1,Da(e,t,r,o),t.child):(t.updateQueue=e.updateQueue,t.flags&=-517,e.lanes&=~o,ts(e,t,o))}function Ma(e,t,n,r,o,i){if(null===e){var a=n.type;return"function"!=typeof a||Ul(a)||void 0!==a.defaultProps||null!==n.compare||void 0!==n.defaultProps?((e=Bl(n.type,null,r,t,t.mode,i)).ref=t.ref,e.return=t,t.child=e):(t.tag=15,t.type=a,Fa(e,t,a,r,o,i))}return a=e.child,0==(o&i)&&(o=a.memoizedProps,(n=null!==(n=n.compare)?n:ur)(o,r)&&e.ref===t.ref)?ts(e,t,i):(t.flags|=1,(e=Vl(a,r)).ref=t.ref,e.return=t,t.child=e)}function Fa(e,t,n,r,o,i){if(null!==e&&ur(e.memoizedProps,r)&&e.ref===t.ref){if(Na=!1,0==(i&o))return t.lanes=e.lanes,ts(e,t,i);0!=(16384&e.flags)&&(Na=!0)}return Va(e,t,n,r,i)}function za(e,t,n){var r=t.pendingProps,o=r.children,i=null!==e?e.memoizedState:null;if("hidden"===r.mode||"unstable-defer-without-hiding"===r.mode)if(0==(4&t.mode))t.memoizedState={baseLanes:0},vl(0,n);else{if(0==(1073741824&n))return e=null!==i?i.baseLanes|n:n,t.lanes=t.childLanes=1073741824,t.memoizedState={baseLanes:e},vl(0,e),null;t.memoizedState={baseLanes:0},vl(0,null!==i?i.baseLanes:n)}else null!==i?(r=i.baseLanes|n,t.memoizedState=null):r=n,vl(0,r);return Da(e,t,o,n),t.child}function Ua(e,t){var n=t.ref;(null===e&&null!==n||null!==e&&e.ref!==n)&&(t.flags|=128)}function Va(e,t,n,r,o){var i=go(n)?ho:po.current;return i=mo(t,i),oi(t,o),n=ia(e,t,n,r,i,o),null===e||Na?(t.flags|=1,Da(e,t,n,o),t.child):(t.updateQueue=e.updateQueue,t.flags&=-517,e.lanes&=~o,ts(e,t,o))}function Ba(e,t,n,r,o){if(go(n)){var i=!0;wo(t)}else i=!1;if(oi(t,o),null===t.stateNode)null!==e&&(e.alternate=null,t.alternate=null,t.flags|=2),vi(t,n,r),wi(t,n,r,o),r=!0;else if(null===e){var a=t.stateNode,s=t.memoizedProps;a.props=s;var l=a.context,c=n.contextType;c="object"==typeof c&&null!==c?ii(c):mo(t,c=go(n)?ho:po.current);var u=n.getDerivedStateFromProps,p="function"==typeof u||"function"==typeof a.getSnapshotBeforeUpdate;p||"function"!=typeof a.UNSAFE_componentWillReceiveProps&&"function"!=typeof a.componentWillReceiveProps||(s!==r||l!==c)&&bi(t,a,r,c),ai=!1;var d=t.memoizedState;a.state=d,di(t,r,a,o),l=t.memoizedState,s!==r||d!==l||fo.current||ai?("function"==typeof u&&(mi(t,n,u,r),l=t.memoizedState),(s=ai||yi(t,n,s,r,d,l,c))?(p||"function"!=typeof a.UNSAFE_componentWillMount&&"function"!=typeof a.componentWillMount||("function"==typeof a.componentWillMount&&a.componentWillMount(),"function"==typeof a.UNSAFE_componentWillMount&&a.UNSAFE_componentWillMount()),"function"==typeof a.componentDidMount&&(t.flags|=4)):("function"==typeof a.componentDidMount&&(t.flags|=4),t.memoizedProps=r,t.memoizedState=l),a.props=r,a.state=l,a.context=c,r=s):("function"==typeof a.componentDidMount&&(t.flags|=4),r=!1)}else{a=t.stateNode,li(e,t),s=t.memoizedProps,c=t.type===t.elementType?s:Qo(t.type,s),a.props=c,p=t.pendingProps,d=a.context,l="object"==typeof(l=n.contextType)&&null!==l?ii(l):mo(t,l=go(n)?ho:po.current);var f=n.getDerivedStateFromProps;(u="function"==typeof f||"function"==typeof a.getSnapshotBeforeUpdate)||"function"!=typeof a.UNSAFE_componentWillReceiveProps&&"function"!=typeof a.componentWillReceiveProps||(s!==p||d!==l)&&bi(t,a,r,l),ai=!1,d=t.memoizedState,a.state=d,di(t,r,a,o);var h=t.memoizedState;s!==p||d!==h||fo.current||ai?("function"==typeof f&&(mi(t,n,f,r),h=t.memoizedState),(c=ai||yi(t,n,c,r,d,h,l))?(u||"function"!=typeof a.UNSAFE_componentWillUpdate&&"function"!=typeof a.componentWillUpdate||("function"==typeof a.componentWillUpdate&&a.componentWillUpdate(r,h,l),"function"==typeof a.UNSAFE_componentWillUpdate&&a.UNSAFE_componentWillUpdate(r,h,l)),"function"==typeof a.componentDidUpdate&&(t.flags|=4),"function"==typeof a.getSnapshotBeforeUpdate&&(t.flags|=256)):("function"!=typeof a.componentDidUpdate||s===e.memoizedProps&&d===e.memoizedState||(t.flags|=4),"function"!=typeof a.getSnapshotBeforeUpdate||s===e.memoizedProps&&d===e.memoizedState||(t.flags|=256),t.memoizedProps=r,t.memoizedState=h),a.props=r,a.state=h,a.context=l,r=c):("function"!=typeof a.componentDidUpdate||s===e.memoizedProps&&d===e.memoizedState||(t.flags|=4),"function"!=typeof a.getSnapshotBeforeUpdate||s===e.memoizedProps&&d===e.memoizedState||(t.flags|=256),r=!1)}return qa(e,t,n,r,i,o)}function qa(e,t,n,r,o,i){Ua(e,t);var a=0!=(64&t.flags);if(!r&&!a)return o&&xo(t,n,!1),ts(e,t,i);r=t.stateNode,Ia.current=t;var s=a&&"function"!=typeof n.getDerivedStateFromError?null:r.render();return t.flags|=1,null!==e&&a?(t.child=Si(t,e.child,null,i),t.child=Si(t,null,s,i)):Da(e,t,s,i),t.memoizedState=r.state,o&&xo(t,n,!0),t.child}function Wa(e){var t=e.stateNode;t.pendingContext?vo(0,t.pendingContext,t.pendingContext!==t.context):t.context&&vo(0,t.context,!1),ji(e,t.containerInfo)}var Ha,Ya,Ka,Ga={dehydrated:null,retryLane:0};function Qa(e,t,n){var r,o=t.pendingProps,i=Di.current,a=!1;return(r=0!=(64&t.flags))||(r=(null===e||null!==e.memoizedState)&&0!=(2&i)),r?(a=!0,t.flags&=-65):null!==e&&null===e.memoizedState||void 0===o.fallback||!0===o.unstable_avoidThisFallback||(i|=1),co(Di,1&i),null===e?(void 0!==o.fallback&&Bi(t),e=o.children,i=o.fallback,a?(e=Xa(t,e,i,n),t.child.memoizedState={baseLanes:n},t.memoizedState=Ga,e):"number"==typeof o.unstable_expectedLoadTime?(e=Xa(t,e,i,n),t.child.memoizedState={baseLanes:n},t.memoizedState=Ga,t.lanes=33554432,e):((n=Wl({mode:"visible",children:e},t.mode,n,null)).return=t,t.child=n)):(e.memoizedState,a?(o=function(e,t,n,r,o){var i=t.mode,a=e.child;e=a.sibling;var s={mode:"hidden",children:n};return 0==(2&i)&&t.child!==a?((n=t.child).childLanes=0,n.pendingProps=s,null!==(a=n.lastEffect)?(t.firstEffect=n.firstEffect,t.lastEffect=a,a.nextEffect=null):t.firstEffect=t.lastEffect=null):n=Vl(a,s),null!==e?r=Vl(e,r):(r=ql(r,i,o,null)).flags|=2,r.return=t,n.return=t,n.sibling=r,t.child=n,r}(e,t,o.children,o.fallback,n),a=t.child,i=e.child.memoizedState,a.memoizedState=null===i?{baseLanes:n}:{baseLanes:i.baseLanes|n},a.childLanes=e.childLanes&~n,t.memoizedState=Ga,o):(n=function(e,t,n,r){var o=e.child;return e=o.sibling,n=Vl(o,{mode:"visible",children:n}),0==(2&t.mode)&&(n.lanes=r),n.return=t,n.sibling=null,null!==e&&(e.nextEffect=null,e.flags=8,t.firstEffect=t.lastEffect=e),t.child=n}(e,t,o.children,n),t.memoizedState=null,n))}function Xa(e,t,n,r){var o=e.mode,i=e.child;return t={mode:"hidden",children:t},0==(2&o)&&null!==i?(i.childLanes=0,i.pendingProps=t):i=Wl(t,o,0,null),n=ql(n,o,r,null),i.return=e,n.return=e,i.sibling=n,e.child=i,n}function Ja(e,t){e.lanes|=t;var n=e.alternate;null!==n&&(n.lanes|=t),ri(e.return,t)}function Za(e,t,n,r,o,i){var a=e.memoizedState;null===a?e.memoizedState={isBackwards:t,rendering:null,renderingStartTime:0,last:r,tail:n,tailMode:o,lastEffect:i}:(a.isBackwards=t,a.rendering=null,a.renderingStartTime=0,a.last=r,a.tail=n,a.tailMode=o,a.lastEffect=i)}function es(e,t,n){var r=t.pendingProps,o=r.revealOrder,i=r.tail;if(Da(e,t,r.children,n),0!=(2&(r=Di.current)))r=1&r|2,t.flags|=64;else{if(null!==e&&0!=(64&e.flags))e:for(e=t.child;null!==e;){if(13===e.tag)null!==e.memoizedState&&Ja(e,n);else if(19===e.tag)Ja(e,n);else if(null!==e.child){e.child.return=e,e=e.child;continue}if(e===t)break e;for(;null===e.sibling;){if(null===e.return||e.return===t)break e;e=e.return}e.sibling.return=e.return,e=e.sibling}r&=1}if(co(Di,r),0==(2&t.mode))t.memoizedState=null;else switch(o){case"forwards":for(n=t.child,o=null;null!==n;)null!==(e=n.alternate)&&null===Li(e)&&(o=n),n=n.sibling;null===(n=o)?(o=t.child,t.child=null):(o=n.sibling,n.sibling=null),Za(t,!1,o,n,i,t.lastEffect);break;case"backwards":for(n=null,o=t.child,t.child=null;null!==o;){if(null!==(e=o.alternate)&&null===Li(e)){t.child=o;break}e=o.sibling,o.sibling=n,n=o,o=e}Za(t,!0,n,null,i,t.lastEffect);break;case"together":Za(t,!1,null,null,void 0,t.lastEffect);break;default:t.memoizedState=null}return t.child}function ts(e,t,n){if(null!==e&&(t.dependencies=e.dependencies),Ls|=t.lanes,0!=(n&t.childLanes)){if(null!==e&&t.child!==e.child)throw Error(a(153));if(null!==t.child){for(n=Vl(e=t.child,e.pendingProps),t.child=n,n.return=t;null!==e.sibling;)e=e.sibling,(n=n.sibling=Vl(e,e.pendingProps)).return=t;n.sibling=null}return t.child}return null}function ns(e,t){if(!zi)switch(e.tailMode){case"hidden":t=e.tail;for(var n=null;null!==t;)null!==t.alternate&&(n=t),t=t.sibling;null===n?e.tail=null:n.sibling=null;break;case"collapsed":n=e.tail;for(var r=null;null!==n;)null!==n.alternate&&(r=n),n=n.sibling;null===r?t||null===e.tail?e.tail=null:e.tail.sibling=null:r.sibling=null}}function rs(e,t,n){var r=t.pendingProps;switch(t.tag){case 2:case 16:case 15:case 0:case 11:case 7:case 8:case 12:case 9:case 14:return null;case 1:case 17:return go(t.type)&&yo(),null;case 3:return Ti(),lo(fo),lo(po),Ki(),(r=t.stateNode).pendingContext&&(r.context=r.pendingContext,r.pendingContext=null),null!==e&&null!==e.child||(Wi(t)?t.flags|=4:r.hydrate||(t.flags|=256)),null;case 5:Ni(t);var i=Ri(Ci.current);if(n=t.type,null!==e&&null!=t.stateNode)Ya(e,t,n,r),e.ref!==t.ref&&(t.flags|=128);else{if(!r){if(null===t.stateNode)throw Error(a(166));return null}if(e=Ri(Ai.current),Wi(t)){r=t.stateNode,n=t.type;var s=t.memoizedProps;switch(r[Qr]=t,r[Xr]=s,n){case"dialog":Ar("cancel",r),Ar("close",r);break;case"iframe":case"object":case"embed":Ar("load",r);break;case"video":case"audio":for(e=0;e<Or.length;e++)Ar(Or[e],r);break;case"source":Ar("error",r);break;case"img":case"image":case"link":Ar("error",r),Ar("load",r);break;case"details":Ar("toggle",r);break;case"input":ee(r,s),Ar("invalid",r);break;case"select":r._wrapperState={wasMultiple:!!s.multiple},Ar("invalid",r);break;case"textarea":le(r,s),Ar("invalid",r)}for(var c in _e(n,s),e=null,s)s.hasOwnProperty(c)&&(i=s[c],"children"===c?"string"==typeof i?r.textContent!==i&&(e=["children",i]):"number"==typeof i&&r.textContent!==""+i&&(e=["children",""+i]):l.hasOwnProperty(c)&&null!=i&&"onScroll"===c&&Ar("scroll",r));switch(n){case"input":Q(r),re(r,s,!0);break;case"textarea":Q(r),ue(r);break;case"select":case"option":break;default:"function"==typeof s.onClick&&(r.onclick=Mr)}r=e,t.updateQueue=r,null!==r&&(t.flags|=4)}else{switch(c=9===i.nodeType?i:i.ownerDocument,e===pe&&(e=de(n)),e===pe?"script"===n?((e=c.createElement("div")).innerHTML="<script><\/script>",e=e.removeChild(e.firstChild)):"string"==typeof r.is?e=c.createElement(n,{is:r.is}):(e=c.createElement(n),"select"===n&&(c=e,r.multiple?c.multiple=!0:r.size&&(c.size=r.size))):e=c.createElementNS(e,n),e[Qr]=t,e[Xr]=r,Ha(e,t),t.stateNode=e,c=Oe(n,r),n){case"dialog":Ar("cancel",e),Ar("close",e),i=r;break;case"iframe":case"object":case"embed":Ar("load",e),i=r;break;case"video":case"audio":for(i=0;i<Or.length;i++)Ar(Or[i],e);i=r;break;case"source":Ar("error",e),i=r;break;case"img":case"image":case"link":Ar("error",e),Ar("load",e),i=r;break;case"details":Ar("toggle",e),i=r;break;case"input":ee(e,r),i=Z(e,r),Ar("invalid",e);break;case"option":i=ie(e,r);break;case"select":e._wrapperState={wasMultiple:!!r.multiple},i=o({},r,{value:void 0}),Ar("invalid",e);break;case"textarea":le(e,r),i=se(e,r),Ar("invalid",e);break;default:i=r}_e(n,i);var u=i;for(s in u)if(u.hasOwnProperty(s)){var p=u[s];"style"===s?xe(e,p):"dangerouslySetInnerHTML"===s?null!=(p=p?p.__html:void 0)&&ge(e,p):"children"===s?"string"==typeof p?("textarea"!==n||""!==p)&&ye(e,p):"number"==typeof p&&ye(e,""+p):"suppressContentEditableWarning"!==s&&"suppressHydrationWarning"!==s&&"autoFocus"!==s&&(l.hasOwnProperty(s)?null!=p&&"onScroll"===s&&Ar("scroll",e):null!=p&&w(e,s,p,c))}switch(n){case"input":Q(e),re(e,r,!1);break;case"textarea":Q(e),ue(e);break;case"option":null!=r.value&&e.setAttribute("value",""+K(r.value));break;case"select":e.multiple=!!r.multiple,null!=(s=r.value)?ae(e,!!r.multiple,s,!1):null!=r.defaultValue&&ae(e,!!r.multiple,r.defaultValue,!0);break;default:"function"==typeof i.onClick&&(e.onclick=Mr)}Ur(n,r)&&(t.flags|=4)}null!==t.ref&&(t.flags|=128)}return null;case 6:if(e&&null!=t.stateNode)Ka(0,t,e.memoizedProps,r);else{if("string"!=typeof r&&null===t.stateNode)throw Error(a(166));n=Ri(Ci.current),Ri(Ai.current),Wi(t)?(r=t.stateNode,n=t.memoizedProps,r[Qr]=t,r.nodeValue!==n&&(t.flags|=4)):((r=(9===n.nodeType?n:n.ownerDocument).createTextNode(r))[Qr]=t,t.stateNode=r)}return null;case 13:return lo(Di),r=t.memoizedState,0!=(64&t.flags)?(t.lanes=n,t):(r=null!==r,n=!1,null===e?void 0!==t.memoizedProps.fallback&&Wi(t):n=null!==e.memoizedState,r&&!n&&0!=(2&t.mode)&&(null===e&&!0!==t.memoizedProps.unstable_avoidThisFallback||0!=(1&Di.current)?0===Is&&(Is=3):(0!==Is&&3!==Is||(Is=4),null===$s||0==(134217727&Ls)&&0==(134217727&Ms)||hl($s,Rs))),(r||n)&&(t.flags|=4),null);case 4:return Ti(),null===e&&Cr(t.stateNode.containerInfo),null;case 10:return ni(t),null;case 19:if(lo(Di),null===(r=t.memoizedState))return null;if(s=0!=(64&t.flags),null===(c=r.rendering))if(s)ns(r,!1);else{if(0!==Is||null!==e&&0!=(64&e.flags))for(e=t.child;null!==e;){if(null!==(c=Li(e))){for(t.flags|=64,ns(r,!1),null!==(s=c.updateQueue)&&(t.updateQueue=s,t.flags|=4),null===r.lastEffect&&(t.firstEffect=null),t.lastEffect=r.lastEffect,r=n,n=t.child;null!==n;)e=r,(s=n).flags&=2,s.nextEffect=null,s.firstEffect=null,s.lastEffect=null,null===(c=s.alternate)?(s.childLanes=0,s.lanes=e,s.child=null,s.memoizedProps=null,s.memoizedState=null,s.updateQueue=null,s.dependencies=null,s.stateNode=null):(s.childLanes=c.childLanes,s.lanes=c.lanes,s.child=c.child,s.memoizedProps=c.memoizedProps,s.memoizedState=c.memoizedState,s.updateQueue=c.updateQueue,s.type=c.type,e=c.dependencies,s.dependencies=null===e?null:{lanes:e.lanes,firstContext:e.firstContext}),n=n.sibling;return co(Di,1&Di.current|2),t.child}e=e.sibling}null!==r.tail&&Vo()>Vs&&(t.flags|=64,s=!0,ns(r,!1),t.lanes=33554432)}else{if(!s)if(null!==(e=Li(c))){if(t.flags|=64,s=!0,null!==(n=e.updateQueue)&&(t.updateQueue=n,t.flags|=4),ns(r,!0),null===r.tail&&"hidden"===r.tailMode&&!c.alternate&&!zi)return null!==(t=t.lastEffect=r.lastEffect)&&(t.nextEffect=null),null}else 2*Vo()-r.renderingStartTime>Vs&&1073741824!==n&&(t.flags|=64,s=!0,ns(r,!1),t.lanes=33554432);r.isBackwards?(c.sibling=t.child,t.child=c):(null!==(n=r.last)?n.sibling=c:t.child=c,r.last=c)}return null!==r.tail?(n=r.tail,r.rendering=n,r.tail=n.sibling,r.lastEffect=t.lastEffect,r.renderingStartTime=Vo(),n.sibling=null,t=Di.current,co(Di,s?1&t|2:1&t),n):null;case 23:case 24:return bl(),null!==e&&null!==e.memoizedState!=(null!==t.memoizedState)&&"unstable-defer-without-hiding"!==r.mode&&(t.flags|=4),null}throw Error(a(156,t.tag))}function os(e){switch(e.tag){case 1:go(e.type)&&yo();var t=e.flags;return 4096&t?(e.flags=-4097&t|64,e):null;case 3:if(Ti(),lo(fo),lo(po),Ki(),0!=(64&(t=e.flags)))throw Error(a(285));return e.flags=-4097&t|64,e;case 5:return Ni(e),null;case 13:return lo(Di),4096&(t=e.flags)?(e.flags=-4097&t|64,e):null;case 19:return lo(Di),null;case 4:return Ti(),null;case 10:return ni(e),null;case 23:case 24:return bl(),null;default:return null}}function is(e,t){try{var n="",r=t;do{n+=H(r),r=r.return}while(r);var o=n}catch(e){o="\nError generating stack: "+e.message+"\n"+e.stack}return{value:e,source:t,stack:o}}function as(e,t){try{console.error(t.value)}catch(e){setTimeout((function(){throw e}))}}Ha=function(e,t){for(var n=t.child;null!==n;){if(5===n.tag||6===n.tag)e.appendChild(n.stateNode);else if(4!==n.tag&&null!==n.child){n.child.return=n,n=n.child;continue}if(n===t)break;for(;null===n.sibling;){if(null===n.return||n.return===t)return;n=n.return}n.sibling.return=n.return,n=n.sibling}},Ya=function(e,t,n,r){var i=e.memoizedProps;if(i!==r){e=t.stateNode,Ri(Ai.current);var a,s=null;switch(n){case"input":i=Z(e,i),r=Z(e,r),s=[];break;case"option":i=ie(e,i),r=ie(e,r),s=[];break;case"select":i=o({},i,{value:void 0}),r=o({},r,{value:void 0}),s=[];break;case"textarea":i=se(e,i),r=se(e,r),s=[];break;default:"function"!=typeof i.onClick&&"function"==typeof r.onClick&&(e.onclick=Mr)}for(p in _e(n,r),n=null,i)if(!r.hasOwnProperty(p)&&i.hasOwnProperty(p)&&null!=i[p])if("style"===p){var c=i[p];for(a in c)c.hasOwnProperty(a)&&(n||(n={}),n[a]="")}else"dangerouslySetInnerHTML"!==p&&"children"!==p&&"suppressContentEditableWarning"!==p&&"suppressHydrationWarning"!==p&&"autoFocus"!==p&&(l.hasOwnProperty(p)?s||(s=[]):(s=s||[]).push(p,null));for(p in r){var u=r[p];if(c=null!=i?i[p]:void 0,r.hasOwnProperty(p)&&u!==c&&(null!=u||null!=c))if("style"===p)if(c){for(a in c)!c.hasOwnProperty(a)||u&&u.hasOwnProperty(a)||(n||(n={}),n[a]="");for(a in u)u.hasOwnProperty(a)&&c[a]!==u[a]&&(n||(n={}),n[a]=u[a])}else n||(s||(s=[]),s.push(p,n)),n=u;else"dangerouslySetInnerHTML"===p?(u=u?u.__html:void 0,c=c?c.__html:void 0,null!=u&&c!==u&&(s=s||[]).push(p,u)):"children"===p?"string"!=typeof u&&"number"!=typeof u||(s=s||[]).push(p,""+u):"suppressContentEditableWarning"!==p&&"suppressHydrationWarning"!==p&&(l.hasOwnProperty(p)?(null!=u&&"onScroll"===p&&Ar("scroll",e),s||c===u||(s=[])):"object"==typeof u&&null!==u&&u.$$typeof===N?u.toString():(s=s||[]).push(p,u))}n&&(s=s||[]).push("style",n);var p=s;(t.updateQueue=p)&&(t.flags|=4)}},Ka=function(e,t,n,r){n!==r&&(t.flags|=4)};var ss="function"==typeof WeakMap?WeakMap:Map;function ls(e,t,n){(n=ci(-1,n)).tag=3,n.payload={element:null};var r=t.value;return n.callback=function(){Hs||(Hs=!0,Ys=r),as(0,t)},n}function cs(e,t,n){(n=ci(-1,n)).tag=3;var r=e.type.getDerivedStateFromError;if("function"==typeof r){var o=t.value;n.payload=function(){return as(0,t),r(o)}}var i=e.stateNode;return null!==i&&"function"==typeof i.componentDidCatch&&(n.callback=function(){"function"!=typeof r&&(null===Ks?Ks=new Set([this]):Ks.add(this),as(0,t));var e=t.stack;this.componentDidCatch(t.value,{componentStack:null!==e?e:""})}),n}var us="function"==typeof WeakSet?WeakSet:Set;function ps(e){var t=e.ref;if(null!==t)if("function"==typeof t)try{t(null)}catch(t){Dl(e,t)}else t.current=null}function ds(e,t){switch(t.tag){case 0:case 11:case 15:case 22:case 5:case 6:case 4:case 17:return;case 1:if(256&t.flags&&null!==e){var n=e.memoizedProps,r=e.memoizedState;t=(e=t.stateNode).getSnapshotBeforeUpdate(t.elementType===t.type?n:Qo(t.type,n),r),e.__reactInternalSnapshotBeforeUpdate=t}return;case 3:return void(256&t.flags&&Wr(t.stateNode.containerInfo))}throw Error(a(163))}function fs(e,t,n){switch(n.tag){case 0:case 11:case 15:case 22:if(null!==(t=null!==(t=n.updateQueue)?t.lastEffect:null)){e=t=t.next;do{if(3==(3&e.tag)){var r=e.create;e.destroy=r()}e=e.next}while(e!==t)}if(null!==(t=null!==(t=n.updateQueue)?t.lastEffect:null)){e=t=t.next;do{var o=e;r=o.next,0!=(4&(o=o.tag))&&0!=(1&o)&&(Tl(n,e),jl(n,e)),e=r}while(e!==t)}return;case 1:return e=n.stateNode,4&n.flags&&(null===t?e.componentDidMount():(r=n.elementType===n.type?t.memoizedProps:Qo(n.type,t.memoizedProps),e.componentDidUpdate(r,t.memoizedState,e.__reactInternalSnapshotBeforeUpdate))),void(null!==(t=n.updateQueue)&&fi(n,t,e));case 3:if(null!==(t=n.updateQueue)){if(e=null,null!==n.child)switch(n.child.tag){case 5:case 1:e=n.child.stateNode}fi(n,t,e)}return;case 5:return e=n.stateNode,void(null===t&&4&n.flags&&Ur(n.type,n.memoizedProps)&&e.focus());case 6:case 4:case 12:case 19:case 17:case 20:case 21:case 23:case 24:return;case 13:return void(null===n.memoizedState&&(n=n.alternate,null!==n&&(n=n.memoizedState,null!==n&&(n=n.dehydrated,null!==n&&wt(n)))))}throw Error(a(163))}function hs(e,t){for(var n=e;;){if(5===n.tag){var r=n.stateNode;if(t)"function"==typeof(r=r.style).setProperty?r.setProperty("display","none","important"):r.display="none";else{r=n.stateNode;var o=n.memoizedProps.style;o=null!=o&&o.hasOwnProperty("display")?o.display:null,r.style.display=we("display",o)}}else if(6===n.tag)n.stateNode.nodeValue=t?"":n.memoizedProps;else if((23!==n.tag&&24!==n.tag||null===n.memoizedState||n===e)&&null!==n.child){n.child.return=n,n=n.child;continue}if(n===e)break;for(;null===n.sibling;){if(null===n.return||n.return===e)return;n=n.return}n.sibling.return=n.return,n=n.sibling}}function ms(e,t){if(_o&&"function"==typeof _o.onCommitFiberUnmount)try{_o.onCommitFiberUnmount(ko,t)}catch(e){}switch(t.tag){case 0:case 11:case 14:case 15:case 22:if(null!==(e=t.updateQueue)&&null!==(e=e.lastEffect)){var n=e=e.next;do{var r=n,o=r.destroy;if(r=r.tag,void 0!==o)if(0!=(4&r))Tl(t,n);else{r=t;try{o()}catch(e){Dl(r,e)}}n=n.next}while(n!==e)}break;case 1:if(ps(t),"function"==typeof(e=t.stateNode).componentWillUnmount)try{e.props=t.memoizedProps,e.state=t.memoizedState,e.componentWillUnmount()}catch(e){Dl(t,e)}break;case 5:ps(t);break;case 4:xs(e,t)}}function gs(e){e.alternate=null,e.child=null,e.dependencies=null,e.firstEffect=null,e.lastEffect=null,e.memoizedProps=null,e.memoizedState=null,e.pendingProps=null,e.return=null,e.updateQueue=null}function ys(e){return 5===e.tag||3===e.tag||4===e.tag}function vs(e){e:{for(var t=e.return;null!==t;){if(ys(t))break e;t=t.return}throw Error(a(160))}var n=t;switch(t=n.stateNode,n.tag){case 5:var r=!1;break;case 3:case 4:t=t.containerInfo,r=!0;break;default:throw Error(a(161))}16&n.flags&&(ye(t,""),n.flags&=-17);e:t:for(n=e;;){for(;null===n.sibling;){if(null===n.return||ys(n.return)){n=null;break e}n=n.return}for(n.sibling.return=n.return,n=n.sibling;5!==n.tag&&6!==n.tag&&18!==n.tag;){if(2&n.flags)continue t;if(null===n.child||4===n.tag)continue t;n.child.return=n,n=n.child}if(!(2&n.flags)){n=n.stateNode;break e}}r?bs(e,n,t):ws(e,n,t)}function bs(e,t,n){var r=e.tag,o=5===r||6===r;if(o)e=o?e.stateNode:e.stateNode.instance,t?8===n.nodeType?n.parentNode.insertBefore(e,t):n.insertBefore(e,t):(8===n.nodeType?(t=n.parentNode).insertBefore(e,n):(t=n).appendChild(e),null!=(n=n._reactRootContainer)||null!==t.onclick||(t.onclick=Mr));else if(4!==r&&null!==(e=e.child))for(bs(e,t,n),e=e.sibling;null!==e;)bs(e,t,n),e=e.sibling}function ws(e,t,n){var r=e.tag,o=5===r||6===r;if(o)e=o?e.stateNode:e.stateNode.instance,t?n.insertBefore(e,t):n.appendChild(e);else if(4!==r&&null!==(e=e.child))for(ws(e,t,n),e=e.sibling;null!==e;)ws(e,t,n),e=e.sibling}function xs(e,t){for(var n,r,o=t,i=!1;;){if(!i){i=o.return;e:for(;;){if(null===i)throw Error(a(160));switch(n=i.stateNode,i.tag){case 5:r=!1;break e;case 3:case 4:n=n.containerInfo,r=!0;break e}i=i.return}i=!0}if(5===o.tag||6===o.tag){e:for(var s=e,l=o,c=l;;)if(ms(s,c),null!==c.child&&4!==c.tag)c.child.return=c,c=c.child;else{if(c===l)break e;for(;null===c.sibling;){if(null===c.return||c.return===l)break e;c=c.return}c.sibling.return=c.return,c=c.sibling}r?(s=n,l=o.stateNode,8===s.nodeType?s.parentNode.removeChild(l):s.removeChild(l)):n.removeChild(o.stateNode)}else if(4===o.tag){if(null!==o.child){n=o.stateNode.containerInfo,r=!0,o.child.return=o,o=o.child;continue}}else if(ms(e,o),null!==o.child){o.child.return=o,o=o.child;continue}if(o===t)break;for(;null===o.sibling;){if(null===o.return||o.return===t)return;4===(o=o.return).tag&&(i=!1)}o.sibling.return=o.return,o=o.sibling}}function ks(e,t){switch(t.tag){case 0:case 11:case 14:case 15:case 22:var n=t.updateQueue;if(null!==(n=null!==n?n.lastEffect:null)){var r=n=n.next;do{3==(3&r.tag)&&(e=r.destroy,r.destroy=void 0,void 0!==e&&e()),r=r.next}while(r!==n)}return;case 1:case 12:case 17:return;case 5:if(null!=(n=t.stateNode)){r=t.memoizedProps;var o=null!==e?e.memoizedProps:r;e=t.type;var i=t.updateQueue;if(t.updateQueue=null,null!==i){for(n[Xr]=r,"input"===e&&"radio"===r.type&&null!=r.name&&te(n,r),Oe(e,o),t=Oe(e,r),o=0;o<i.length;o+=2){var s=i[o],l=i[o+1];"style"===s?xe(n,l):"dangerouslySetInnerHTML"===s?ge(n,l):"children"===s?ye(n,l):w(n,s,l,t)}switch(e){case"input":ne(n,r);break;case"textarea":ce(n,r);break;case"select":e=n._wrapperState.wasMultiple,n._wrapperState.wasMultiple=!!r.multiple,null!=(i=r.value)?ae(n,!!r.multiple,i,!1):e!==!!r.multiple&&(null!=r.defaultValue?ae(n,!!r.multiple,r.defaultValue,!0):ae(n,!!r.multiple,r.multiple?[]:"",!1))}}}return;case 6:if(null===t.stateNode)throw Error(a(162));return void(t.stateNode.nodeValue=t.memoizedProps);case 3:return void((n=t.stateNode).hydrate&&(n.hydrate=!1,wt(n.containerInfo)));case 13:return null!==t.memoizedState&&(Us=Vo(),hs(t.child,!0)),void _s(t);case 19:return void _s(t);case 23:case 24:return void hs(t,null!==t.memoizedState)}throw Error(a(163))}function _s(e){var t=e.updateQueue;if(null!==t){e.updateQueue=null;var n=e.stateNode;null===n&&(n=e.stateNode=new us),t.forEach((function(t){var r=Ml.bind(null,e,t);n.has(t)||(n.add(t),t.then(r,r))}))}}function Os(e,t){return null!==e&&(null===(e=e.memoizedState)||null!==e.dehydrated)&&null!==(t=t.memoizedState)&&null===t.dehydrated}var Ss=Math.ceil,Es=x.ReactCurrentDispatcher,Ps=x.ReactCurrentOwner,As=0,$s=null,Cs=null,Rs=0,js=0,Ts=so(0),Is=0,Ns=null,Ds=0,Ls=0,Ms=0,Fs=0,zs=null,Us=0,Vs=1/0;function Bs(){Vs=Vo()+500}var qs,Ws=null,Hs=!1,Ys=null,Ks=null,Gs=!1,Qs=null,Xs=90,Js=[],Zs=[],el=null,tl=0,nl=null,rl=-1,ol=0,il=0,al=null,sl=!1;function ll(){return 0!=(48&As)?Vo():-1!==rl?rl:rl=Vo()}function cl(e){if(0==(2&(e=e.mode)))return 1;if(0==(4&e))return 99===Bo()?1:2;if(0===ol&&(ol=Ds),0!==Go.transition){0!==il&&(il=null!==zs?zs.pendingLanes:0),e=ol;var t=4186112&~il;return 0==(t&=-t)&&0==(t=(e=4186112&~e)&-e)&&(t=8192),t}return e=Bo(),e=Mt(0!=(4&As)&&98===e?12:e=function(e){switch(e){case 99:return 15;case 98:return 10;case 97:case 96:return 8;case 95:return 2;default:return 0}}(e),ol)}function ul(e,t,n){if(50<tl)throw tl=0,nl=null,Error(a(185));if(null===(e=pl(e,t)))return null;Ut(e,t,n),e===$s&&(Ms|=t,4===Is&&hl(e,Rs));var r=Bo();1===t?0!=(8&As)&&0==(48&As)?ml(e):(dl(e,n),0===As&&(Bs(),Yo())):(0==(4&As)||98!==r&&99!==r||(null===el?el=new Set([e]):el.add(e)),dl(e,n)),zs=e}function pl(e,t){e.lanes|=t;var n=e.alternate;for(null!==n&&(n.lanes|=t),n=e,e=e.return;null!==e;)e.childLanes|=t,null!==(n=e.alternate)&&(n.childLanes|=t),n=e,e=e.return;return 3===n.tag?n.stateNode:null}function dl(e,t){for(var n=e.callbackNode,r=e.suspendedLanes,o=e.pingedLanes,i=e.expirationTimes,s=e.pendingLanes;0<s;){var l=31-Vt(s),c=1<<l,u=i[l];if(-1===u){if(0==(c&r)||0!=(c&o)){u=t,Nt(c);var p=It;i[l]=10<=p?u+250:6<=p?u+5e3:-1}}else u<=t&&(e.expiredLanes|=c);s&=~c}if(r=Dt(e,e===$s?Rs:0),t=It,0===r)null!==n&&(n!==Do&&Eo(n),e.callbackNode=null,e.callbackPriority=0);else{if(null!==n){if(e.callbackPriority===t)return;n!==Do&&Eo(n)}15===t?(n=ml.bind(null,e),null===Mo?(Mo=[n],Fo=So(Ro,Ko)):Mo.push(n),n=Do):14===t?n=Ho(99,ml.bind(null,e)):(n=function(e){switch(e){case 15:case 14:return 99;case 13:case 12:case 11:case 10:return 98;case 9:case 8:case 7:case 6:case 4:case 5:return 97;case 3:case 2:case 1:return 95;case 0:return 90;default:throw Error(a(358,e))}}(t),n=Ho(n,fl.bind(null,e))),e.callbackPriority=t,e.callbackNode=n}}function fl(e){if(rl=-1,il=ol=0,0!=(48&As))throw Error(a(327));var t=e.callbackNode;if(Rl()&&e.callbackNode!==t)return null;var n=Dt(e,e===$s?Rs:0);if(0===n)return null;var r=n,o=As;As|=16;var i=kl();for($s===e&&Rs===r||(Bs(),wl(e,r));;)try{Sl();break}catch(t){xl(e,t)}if(ti(),Es.current=i,As=o,null!==Cs?r=0:($s=null,Rs=0,r=Is),0!=(Ds&Ms))wl(e,0);else if(0!==r){if(2===r&&(As|=64,e.hydrate&&(e.hydrate=!1,Wr(e.containerInfo)),0!==(n=Lt(e))&&(r=_l(e,n))),1===r)throw t=Ns,wl(e,0),hl(e,n),dl(e,Vo()),t;switch(e.finishedWork=e.current.alternate,e.finishedLanes=n,r){case 0:case 1:throw Error(a(345));case 2:case 5:Al(e);break;case 3:if(hl(e,n),(62914560&n)===n&&10<(r=Us+500-Vo())){if(0!==Dt(e,0))break;if(((o=e.suspendedLanes)&n)!==n){ll(),e.pingedLanes|=e.suspendedLanes&o;break}e.timeoutHandle=Br(Al.bind(null,e),r);break}Al(e);break;case 4:if(hl(e,n),(4186112&n)===n)break;for(r=e.eventTimes,o=-1;0<n;){var s=31-Vt(n);i=1<<s,(s=r[s])>o&&(o=s),n&=~i}if(n=o,10<(n=(120>(n=Vo()-n)?120:480>n?480:1080>n?1080:1920>n?1920:3e3>n?3e3:4320>n?4320:1960*Ss(n/1960))-n)){e.timeoutHandle=Br(Al.bind(null,e),n);break}Al(e);break;default:throw Error(a(329))}}return dl(e,Vo()),e.callbackNode===t?fl.bind(null,e):null}function hl(e,t){for(t&=~Fs,t&=~Ms,e.suspendedLanes|=t,e.pingedLanes&=~t,e=e.expirationTimes;0<t;){var n=31-Vt(t),r=1<<n;e[n]=-1,t&=~r}}function ml(e){if(0!=(48&As))throw Error(a(327));if(Rl(),e===$s&&0!=(e.expiredLanes&Rs)){var t=Rs,n=_l(e,t);0!=(Ds&Ms)&&(n=_l(e,t=Dt(e,t)))}else n=_l(e,t=Dt(e,0));if(0!==e.tag&&2===n&&(As|=64,e.hydrate&&(e.hydrate=!1,Wr(e.containerInfo)),0!==(t=Lt(e))&&(n=_l(e,t))),1===n)throw n=Ns,wl(e,0),hl(e,t),dl(e,Vo()),n;return e.finishedWork=e.current.alternate,e.finishedLanes=t,Al(e),dl(e,Vo()),null}function gl(e,t){var n=As;As|=1;try{return e(t)}finally{0===(As=n)&&(Bs(),Yo())}}function yl(e,t){var n=As;As&=-2,As|=8;try{return e(t)}finally{0===(As=n)&&(Bs(),Yo())}}function vl(e,t){co(Ts,js),js|=t,Ds|=t}function bl(){js=Ts.current,lo(Ts)}function wl(e,t){e.finishedWork=null,e.finishedLanes=0;var n=e.timeoutHandle;if(-1!==n&&(e.timeoutHandle=-1,qr(n)),null!==Cs)for(n=Cs.return;null!==n;){var r=n;switch(r.tag){case 1:null!=(r=r.type.childContextTypes)&&yo();break;case 3:Ti(),lo(fo),lo(po),Ki();break;case 5:Ni(r);break;case 4:Ti();break;case 13:case 19:lo(Di);break;case 10:ni(r);break;case 23:case 24:bl()}n=n.return}$s=e,Cs=Vl(e.current,null),Rs=js=Ds=t,Is=0,Ns=null,Fs=Ms=Ls=0}function xl(e,t){for(;;){var n=Cs;try{if(ti(),Gi.current=Ca,ta){for(var r=Ji.memoizedState;null!==r;){var o=r.queue;null!==o&&(o.pending=null),r=r.next}ta=!1}if(Xi=0,ea=Zi=Ji=null,na=!1,Ps.current=null,null===n||null===n.return){Is=1,Ns=t,Cs=null;break}e:{var i=e,a=n.return,s=n,l=t;if(t=Rs,s.flags|=2048,s.firstEffect=s.lastEffect=null,null!==l&&"object"==typeof l&&"function"==typeof l.then){var c=l;if(0==(2&s.mode)){var u=s.alternate;u?(s.updateQueue=u.updateQueue,s.memoizedState=u.memoizedState,s.lanes=u.lanes):(s.updateQueue=null,s.memoizedState=null)}var p=0!=(1&Di.current),d=a;do{var f;if(f=13===d.tag){var h=d.memoizedState;if(null!==h)f=null!==h.dehydrated;else{var m=d.memoizedProps;f=void 0!==m.fallback&&(!0!==m.unstable_avoidThisFallback||!p)}}if(f){var g=d.updateQueue;if(null===g){var y=new Set;y.add(c),d.updateQueue=y}else g.add(c);if(0==(2&d.mode)){if(d.flags|=64,s.flags|=16384,s.flags&=-2981,1===s.tag)if(null===s.alternate)s.tag=17;else{var v=ci(-1,1);v.tag=2,ui(s,v)}s.lanes|=1;break e}l=void 0,s=t;var b=i.pingCache;if(null===b?(b=i.pingCache=new ss,l=new Set,b.set(c,l)):void 0===(l=b.get(c))&&(l=new Set,b.set(c,l)),!l.has(s)){l.add(s);var w=Ll.bind(null,i,c,s);c.then(w,w)}d.flags|=4096,d.lanes=t;break e}d=d.return}while(null!==d);l=Error((Y(s.type)||"A React component")+" suspended while rendering, but no fallback UI was specified.\n\nAdd a <Suspense fallback=...> component higher in the tree to provide a loading indicator or placeholder to display.")}5!==Is&&(Is=2),l=is(l,s),d=a;do{switch(d.tag){case 3:i=l,d.flags|=4096,t&=-t,d.lanes|=t,pi(d,ls(0,i,t));break e;case 1:i=l;var x=d.type,k=d.stateNode;if(0==(64&d.flags)&&("function"==typeof x.getDerivedStateFromError||null!==k&&"function"==typeof k.componentDidCatch&&(null===Ks||!Ks.has(k)))){d.flags|=4096,t&=-t,d.lanes|=t,pi(d,cs(d,i,t));break e}}d=d.return}while(null!==d)}Pl(n)}catch(e){t=e,Cs===n&&null!==n&&(Cs=n=n.return);continue}break}}function kl(){var e=Es.current;return Es.current=Ca,null===e?Ca:e}function _l(e,t){var n=As;As|=16;var r=kl();for($s===e&&Rs===t||wl(e,t);;)try{Ol();break}catch(t){xl(e,t)}if(ti(),As=n,Es.current=r,null!==Cs)throw Error(a(261));return $s=null,Rs=0,Is}function Ol(){for(;null!==Cs;)El(Cs)}function Sl(){for(;null!==Cs&&!Po();)El(Cs)}function El(e){var t=qs(e.alternate,e,js);e.memoizedProps=e.pendingProps,null===t?Pl(e):Cs=t,Ps.current=null}function Pl(e){var t=e;do{var n=t.alternate;if(e=t.return,0==(2048&t.flags)){if(null!==(n=rs(n,t,js)))return void(Cs=n);if(24!==(n=t).tag&&23!==n.tag||null===n.memoizedState||0!=(1073741824&js)||0==(4&n.mode)){for(var r=0,o=n.child;null!==o;)r|=o.lanes|o.childLanes,o=o.sibling;n.childLanes=r}null!==e&&0==(2048&e.flags)&&(null===e.firstEffect&&(e.firstEffect=t.firstEffect),null!==t.lastEffect&&(null!==e.lastEffect&&(e.lastEffect.nextEffect=t.firstEffect),e.lastEffect=t.lastEffect),1<t.flags&&(null!==e.lastEffect?e.lastEffect.nextEffect=t:e.firstEffect=t,e.lastEffect=t))}else{if(null!==(n=os(t)))return n.flags&=2047,void(Cs=n);null!==e&&(e.firstEffect=e.lastEffect=null,e.flags|=2048)}if(null!==(t=t.sibling))return void(Cs=t);Cs=t=e}while(null!==t);0===Is&&(Is=5)}function Al(e){var t=Bo();return Wo(99,$l.bind(null,e,t)),null}function $l(e,t){do{Rl()}while(null!==Qs);if(0!=(48&As))throw Error(a(327));var n=e.finishedWork;if(null===n)return null;if(e.finishedWork=null,e.finishedLanes=0,n===e.current)throw Error(a(177));e.callbackNode=null;var r=n.lanes|n.childLanes,o=r,i=e.pendingLanes&~o;e.pendingLanes=o,e.suspendedLanes=0,e.pingedLanes=0,e.expiredLanes&=o,e.mutableReadLanes&=o,e.entangledLanes&=o,o=e.entanglements;for(var s=e.eventTimes,l=e.expirationTimes;0<i;){var c=31-Vt(i),u=1<<c;o[c]=0,s[c]=-1,l[c]=-1,i&=~u}if(null!==el&&0==(24&r)&&el.has(e)&&el.delete(e),e===$s&&(Cs=$s=null,Rs=0),1<n.flags?null!==n.lastEffect?(n.lastEffect.nextEffect=n,r=n.firstEffect):r=n:r=n.firstEffect,null!==r){if(o=As,As|=32,Ps.current=null,Fr=Yt,mr(s=hr())){if("selectionStart"in s)l={start:s.selectionStart,end:s.selectionEnd};else e:if(l=(l=s.ownerDocument)&&l.defaultView||window,(u=l.getSelection&&l.getSelection())&&0!==u.rangeCount){l=u.anchorNode,i=u.anchorOffset,c=u.focusNode,u=u.focusOffset;try{l.nodeType,c.nodeType}catch(e){l=null;break e}var p=0,d=-1,f=-1,h=0,m=0,g=s,y=null;t:for(;;){for(var v;g!==l||0!==i&&3!==g.nodeType||(d=p+i),g!==c||0!==u&&3!==g.nodeType||(f=p+u),3===g.nodeType&&(p+=g.nodeValue.length),null!==(v=g.firstChild);)y=g,g=v;for(;;){if(g===s)break t;if(y===l&&++h===i&&(d=p),y===c&&++m===u&&(f=p),null!==(v=g.nextSibling))break;y=(g=y).parentNode}g=v}l=-1===d||-1===f?null:{start:d,end:f}}else l=null;l=l||{start:0,end:0}}else l=null;zr={focusedElem:s,selectionRange:l},Yt=!1,al=null,sl=!1,Ws=r;do{try{Cl()}catch(e){if(null===Ws)throw Error(a(330));Dl(Ws,e),Ws=Ws.nextEffect}}while(null!==Ws);al=null,Ws=r;do{try{for(s=e;null!==Ws;){var b=Ws.flags;if(16&b&&ye(Ws.stateNode,""),128&b){var w=Ws.alternate;if(null!==w){var x=w.ref;null!==x&&("function"==typeof x?x(null):x.current=null)}}switch(1038&b){case 2:vs(Ws),Ws.flags&=-3;break;case 6:vs(Ws),Ws.flags&=-3,ks(Ws.alternate,Ws);break;case 1024:Ws.flags&=-1025;break;case 1028:Ws.flags&=-1025,ks(Ws.alternate,Ws);break;case 4:ks(Ws.alternate,Ws);break;case 8:xs(s,l=Ws);var k=l.alternate;gs(l),null!==k&&gs(k)}Ws=Ws.nextEffect}}catch(e){if(null===Ws)throw Error(a(330));Dl(Ws,e),Ws=Ws.nextEffect}}while(null!==Ws);if(x=zr,w=hr(),b=x.focusedElem,s=x.selectionRange,w!==b&&b&&b.ownerDocument&&fr(b.ownerDocument.documentElement,b)){null!==s&&mr(b)&&(w=s.start,void 0===(x=s.end)&&(x=w),"selectionStart"in b?(b.selectionStart=w,b.selectionEnd=Math.min(x,b.value.length)):(x=(w=b.ownerDocument||document)&&w.defaultView||window).getSelection&&(x=x.getSelection(),l=b.textContent.length,k=Math.min(s.start,l),s=void 0===s.end?k:Math.min(s.end,l),!x.extend&&k>s&&(l=s,s=k,k=l),l=dr(b,k),i=dr(b,s),l&&i&&(1!==x.rangeCount||x.anchorNode!==l.node||x.anchorOffset!==l.offset||x.focusNode!==i.node||x.focusOffset!==i.offset)&&((w=w.createRange()).setStart(l.node,l.offset),x.removeAllRanges(),k>s?(x.addRange(w),x.extend(i.node,i.offset)):(w.setEnd(i.node,i.offset),x.addRange(w))))),w=[];for(x=b;x=x.parentNode;)1===x.nodeType&&w.push({element:x,left:x.scrollLeft,top:x.scrollTop});for("function"==typeof b.focus&&b.focus(),b=0;b<w.length;b++)(x=w[b]).element.scrollLeft=x.left,x.element.scrollTop=x.top}Yt=!!Fr,zr=Fr=null,e.current=n,Ws=r;do{try{for(b=e;null!==Ws;){var _=Ws.flags;if(36&_&&fs(b,Ws.alternate,Ws),128&_){w=void 0;var O=Ws.ref;if(null!==O){var S=Ws.stateNode;Ws.tag,w=S,"function"==typeof O?O(w):O.current=w}}Ws=Ws.nextEffect}}catch(e){if(null===Ws)throw Error(a(330));Dl(Ws,e),Ws=Ws.nextEffect}}while(null!==Ws);Ws=null,Lo(),As=o}else e.current=n;if(Gs)Gs=!1,Qs=e,Xs=t;else for(Ws=r;null!==Ws;)t=Ws.nextEffect,Ws.nextEffect=null,8&Ws.flags&&((_=Ws).sibling=null,_.stateNode=null),Ws=t;if(0===(r=e.pendingLanes)&&(Ks=null),1===r?e===nl?tl++:(tl=0,nl=e):tl=0,n=n.stateNode,_o&&"function"==typeof _o.onCommitFiberRoot)try{_o.onCommitFiberRoot(ko,n,void 0,64==(64&n.current.flags))}catch(e){}if(dl(e,Vo()),Hs)throw Hs=!1,e=Ys,Ys=null,e;return 0!=(8&As)||Yo(),null}function Cl(){for(;null!==Ws;){var e=Ws.alternate;sl||null===al||(0!=(8&Ws.flags)?Je(Ws,al)&&(sl=!0):13===Ws.tag&&Os(e,Ws)&&Je(Ws,al)&&(sl=!0));var t=Ws.flags;0!=(256&t)&&ds(e,Ws),0==(512&t)||Gs||(Gs=!0,Ho(97,(function(){return Rl(),null}))),Ws=Ws.nextEffect}}function Rl(){if(90!==Xs){var e=97<Xs?97:Xs;return Xs=90,Wo(e,Il)}return!1}function jl(e,t){Js.push(t,e),Gs||(Gs=!0,Ho(97,(function(){return Rl(),null})))}function Tl(e,t){Zs.push(t,e),Gs||(Gs=!0,Ho(97,(function(){return Rl(),null})))}function Il(){if(null===Qs)return!1;var e=Qs;if(Qs=null,0!=(48&As))throw Error(a(331));var t=As;As|=32;var n=Zs;Zs=[];for(var r=0;r<n.length;r+=2){var o=n[r],i=n[r+1],s=o.destroy;if(o.destroy=void 0,"function"==typeof s)try{s()}catch(e){if(null===i)throw Error(a(330));Dl(i,e)}}for(n=Js,Js=[],r=0;r<n.length;r+=2){o=n[r],i=n[r+1];try{var l=o.create;o.destroy=l()}catch(e){if(null===i)throw Error(a(330));Dl(i,e)}}for(l=e.current.firstEffect;null!==l;)e=l.nextEffect,l.nextEffect=null,8&l.flags&&(l.sibling=null,l.stateNode=null),l=e;return As=t,Yo(),!0}function Nl(e,t,n){ui(e,t=ls(0,t=is(n,t),1)),t=ll(),null!==(e=pl(e,1))&&(Ut(e,1,t),dl(e,t))}function Dl(e,t){if(3===e.tag)Nl(e,e,t);else for(var n=e.return;null!==n;){if(3===n.tag){Nl(n,e,t);break}if(1===n.tag){var r=n.stateNode;if("function"==typeof n.type.getDerivedStateFromError||"function"==typeof r.componentDidCatch&&(null===Ks||!Ks.has(r))){var o=cs(n,e=is(t,e),1);if(ui(n,o),o=ll(),null!==(n=pl(n,1)))Ut(n,1,o),dl(n,o);else if("function"==typeof r.componentDidCatch&&(null===Ks||!Ks.has(r)))try{r.componentDidCatch(t,e)}catch(e){}break}}n=n.return}}function Ll(e,t,n){var r=e.pingCache;null!==r&&r.delete(t),t=ll(),e.pingedLanes|=e.suspendedLanes&n,$s===e&&(Rs&n)===n&&(4===Is||3===Is&&(62914560&Rs)===Rs&&500>Vo()-Us?wl(e,0):Fs|=n),dl(e,t)}function Ml(e,t){var n=e.stateNode;null!==n&&n.delete(t),0==(t=0)&&(0==(2&(t=e.mode))?t=1:0==(4&t)?t=99===Bo()?1:2:(0===ol&&(ol=Ds),0===(t=Ft(62914560&~ol))&&(t=4194304))),n=ll(),null!==(e=pl(e,t))&&(Ut(e,t,n),dl(e,n))}function Fl(e,t,n,r){this.tag=e,this.key=n,this.sibling=this.child=this.return=this.stateNode=this.type=this.elementType=null,this.index=0,this.ref=null,this.pendingProps=t,this.dependencies=this.memoizedState=this.updateQueue=this.memoizedProps=null,this.mode=r,this.flags=0,this.lastEffect=this.firstEffect=this.nextEffect=null,this.childLanes=this.lanes=0,this.alternate=null}function zl(e,t,n,r){return new Fl(e,t,n,r)}function Ul(e){return!(!(e=e.prototype)||!e.isReactComponent)}function Vl(e,t){var n=e.alternate;return null===n?((n=zl(e.tag,t,e.key,e.mode)).elementType=e.elementType,n.type=e.type,n.stateNode=e.stateNode,n.alternate=e,e.alternate=n):(n.pendingProps=t,n.type=e.type,n.flags=0,n.nextEffect=null,n.firstEffect=null,n.lastEffect=null),n.childLanes=e.childLanes,n.lanes=e.lanes,n.child=e.child,n.memoizedProps=e.memoizedProps,n.memoizedState=e.memoizedState,n.updateQueue=e.updateQueue,t=e.dependencies,n.dependencies=null===t?null:{lanes:t.lanes,firstContext:t.firstContext},n.sibling=e.sibling,n.index=e.index,n.ref=e.ref,n}function Bl(e,t,n,r,o,i){var s=2;if(r=e,"function"==typeof e)Ul(e)&&(s=1);else if("string"==typeof e)s=5;else e:switch(e){case O:return ql(n.children,o,i,t);case D:s=8,o|=16;break;case S:s=8,o|=1;break;case E:return(e=zl(12,n,t,8|o)).elementType=E,e.type=E,e.lanes=i,e;case C:return(e=zl(13,n,t,o)).type=C,e.elementType=C,e.lanes=i,e;case R:return(e=zl(19,n,t,o)).elementType=R,e.lanes=i,e;case L:return Wl(n,o,i,t);case M:return(e=zl(24,n,t,o)).elementType=M,e.lanes=i,e;default:if("object"==typeof e&&null!==e)switch(e.$$typeof){case P:s=10;break e;case A:s=9;break e;case $:s=11;break e;case j:s=14;break e;case T:s=16,r=null;break e;case I:s=22;break e}throw Error(a(130,null==e?e:typeof e,""))}return(t=zl(s,n,t,o)).elementType=e,t.type=r,t.lanes=i,t}function ql(e,t,n,r){return(e=zl(7,e,r,t)).lanes=n,e}function Wl(e,t,n,r){return(e=zl(23,e,r,t)).elementType=L,e.lanes=n,e}function Hl(e,t,n){return(e=zl(6,e,null,t)).lanes=n,e}function Yl(e,t,n){return(t=zl(4,null!==e.children?e.children:[],e.key,t)).lanes=n,t.stateNode={containerInfo:e.containerInfo,pendingChildren:null,implementation:e.implementation},t}function Kl(e,t,n){this.tag=t,this.containerInfo=e,this.finishedWork=this.pingCache=this.current=this.pendingChildren=null,this.timeoutHandle=-1,this.pendingContext=this.context=null,this.hydrate=n,this.callbackNode=null,this.callbackPriority=0,this.eventTimes=zt(0),this.expirationTimes=zt(-1),this.entangledLanes=this.finishedLanes=this.mutableReadLanes=this.expiredLanes=this.pingedLanes=this.suspendedLanes=this.pendingLanes=0,this.entanglements=zt(0),this.mutableSourceEagerHydrationData=null}function Gl(e,t,n,r){var o=t.current,i=ll(),s=cl(o);e:if(n){t:{if(Ge(n=n._reactInternals)!==n||1!==n.tag)throw Error(a(170));var l=n;do{switch(l.tag){case 3:l=l.stateNode.context;break t;case 1:if(go(l.type)){l=l.stateNode.__reactInternalMemoizedMergedChildContext;break t}}l=l.return}while(null!==l);throw Error(a(171))}if(1===n.tag){var c=n.type;if(go(c)){n=bo(n,c,l);break e}}n=l}else n=uo;return null===t.context?t.context=n:t.pendingContext=n,(t=ci(i,s)).payload={element:e},null!==(r=void 0===r?null:r)&&(t.callback=r),ui(o,t),ul(o,s,i),s}function Ql(e){return(e=e.current).child?(e.child.tag,e.child.stateNode):null}function Xl(e,t){if(null!==(e=e.memoizedState)&&null!==e.dehydrated){var n=e.retryLane;e.retryLane=0!==n&&n<t?n:t}}function Jl(e,t){Xl(e,t),(e=e.alternate)&&Xl(e,t)}function Zl(e,t,n){var r=null!=n&&null!=n.hydrationOptions&&n.hydrationOptions.mutableSources||null;if(n=new Kl(e,t,null!=n&&!0===n.hydrate),t=zl(3,null,null,2===t?7:1===t?3:0),n.current=t,t.stateNode=n,si(t),e[Jr]=n.current,Cr(8===e.nodeType?e.parentNode:e),r)for(e=0;e<r.length;e++){var o=(t=r[e])._getVersion;o=o(t._source),null==n.mutableSourceEagerHydrationData?n.mutableSourceEagerHydrationData=[t,o]:n.mutableSourceEagerHydrationData.push(t,o)}this._internalRoot=n}function ec(e){return!(!e||1!==e.nodeType&&9!==e.nodeType&&11!==e.nodeType&&(8!==e.nodeType||" react-mount-point-unstable "!==e.nodeValue))}function tc(e,t,n,r,o){var i=n._reactRootContainer;if(i){var a=i._internalRoot;if("function"==typeof o){var s=o;o=function(){var e=Ql(a);s.call(e)}}Gl(t,a,e,o)}else{if(i=n._reactRootContainer=function(e,t){if(t||(t=!(!(t=e?9===e.nodeType?e.documentElement:e.firstChild:null)||1!==t.nodeType||!t.hasAttribute("data-reactroot"))),!t)for(var n;n=e.lastChild;)e.removeChild(n);return new Zl(e,0,t?{hydrate:!0}:void 0)}(n,r),a=i._internalRoot,"function"==typeof o){var l=o;o=function(){var e=Ql(a);l.call(e)}}yl((function(){Gl(t,a,e,o)}))}return Ql(a)}qs=function(e,t,n){var r=t.lanes;if(null!==e)if(e.memoizedProps!==t.pendingProps||fo.current)Na=!0;else{if(0==(n&r)){switch(Na=!1,t.tag){case 3:Wa(t),Hi();break;case 5:Ii(t);break;case 1:go(t.type)&&wo(t);break;case 4:ji(t,t.stateNode.containerInfo);break;case 10:r=t.memoizedProps.value;var o=t.type._context;co(Xo,o._currentValue),o._currentValue=r;break;case 13:if(null!==t.memoizedState)return 0!=(n&t.child.childLanes)?Qa(e,t,n):(co(Di,1&Di.current),null!==(t=ts(e,t,n))?t.sibling:null);co(Di,1&Di.current);break;case 19:if(r=0!=(n&t.childLanes),0!=(64&e.flags)){if(r)return es(e,t,n);t.flags|=64}if(null!==(o=t.memoizedState)&&(o.rendering=null,o.tail=null,o.lastEffect=null),co(Di,Di.current),r)break;return null;case 23:case 24:return t.lanes=0,za(e,t,n)}return ts(e,t,n)}Na=0!=(16384&e.flags)}else Na=!1;switch(t.lanes=0,t.tag){case 2:if(r=t.type,null!==e&&(e.alternate=null,t.alternate=null,t.flags|=2),e=t.pendingProps,o=mo(t,po.current),oi(t,n),o=ia(null,t,r,e,o,n),t.flags|=1,"object"==typeof o&&null!==o&&"function"==typeof o.render&&void 0===o.$$typeof){if(t.tag=1,t.memoizedState=null,t.updateQueue=null,go(r)){var i=!0;wo(t)}else i=!1;t.memoizedState=null!==o.state&&void 0!==o.state?o.state:null,si(t);var s=r.getDerivedStateFromProps;"function"==typeof s&&mi(t,r,s,e),o.updater=gi,t.stateNode=o,o._reactInternals=t,wi(t,r,e,n),t=qa(null,t,r,!0,i,n)}else t.tag=0,Da(null,t,o,n),t=t.child;return t;case 16:o=t.elementType;e:{switch(null!==e&&(e.alternate=null,t.alternate=null,t.flags|=2),e=t.pendingProps,o=(i=o._init)(o._payload),t.type=o,i=t.tag=function(e){if("function"==typeof e)return Ul(e)?1:0;if(null!=e){if((e=e.$$typeof)===$)return 11;if(e===j)return 14}return 2}(o),e=Qo(o,e),i){case 0:t=Va(null,t,o,e,n);break e;case 1:t=Ba(null,t,o,e,n);break e;case 11:t=La(null,t,o,e,n);break e;case 14:t=Ma(null,t,o,Qo(o.type,e),r,n);break e}throw Error(a(306,o,""))}return t;case 0:return r=t.type,o=t.pendingProps,Va(e,t,r,o=t.elementType===r?o:Qo(r,o),n);case 1:return r=t.type,o=t.pendingProps,Ba(e,t,r,o=t.elementType===r?o:Qo(r,o),n);case 3:if(Wa(t),r=t.updateQueue,null===e||null===r)throw Error(a(282));if(r=t.pendingProps,o=null!==(o=t.memoizedState)?o.element:null,li(e,t),di(t,r,null,n),(r=t.memoizedState.element)===o)Hi(),t=ts(e,t,n);else{if((i=(o=t.stateNode).hydrate)&&(Fi=Hr(t.stateNode.containerInfo.firstChild),Mi=t,i=zi=!0),i){if(null!=(e=o.mutableSourceEagerHydrationData))for(o=0;o<e.length;o+=2)(i=e[o])._workInProgressVersionPrimary=e[o+1],Yi.push(i);for(n=Ei(t,null,r,n),t.child=n;n;)n.flags=-3&n.flags|1024,n=n.sibling}else Da(e,t,r,n),Hi();t=t.child}return t;case 5:return Ii(t),null===e&&Bi(t),r=t.type,o=t.pendingProps,i=null!==e?e.memoizedProps:null,s=o.children,Vr(r,o)?s=null:null!==i&&Vr(r,i)&&(t.flags|=16),Ua(e,t),Da(e,t,s,n),t.child;case 6:return null===e&&Bi(t),null;case 13:return Qa(e,t,n);case 4:return ji(t,t.stateNode.containerInfo),r=t.pendingProps,null===e?t.child=Si(t,null,r,n):Da(e,t,r,n),t.child;case 11:return r=t.type,o=t.pendingProps,La(e,t,r,o=t.elementType===r?o:Qo(r,o),n);case 7:return Da(e,t,t.pendingProps,n),t.child;case 8:case 12:return Da(e,t,t.pendingProps.children,n),t.child;case 10:e:{r=t.type._context,o=t.pendingProps,s=t.memoizedProps,i=o.value;var l=t.type._context;if(co(Xo,l._currentValue),l._currentValue=i,null!==s)if(l=s.value,0==(i=lr(l,i)?0:0|("function"==typeof r._calculateChangedBits?r._calculateChangedBits(l,i):1073741823))){if(s.children===o.children&&!fo.current){t=ts(e,t,n);break e}}else for(null!==(l=t.child)&&(l.return=t);null!==l;){var c=l.dependencies;if(null!==c){s=l.child;for(var u=c.firstContext;null!==u;){if(u.context===r&&0!=(u.observedBits&i)){1===l.tag&&((u=ci(-1,n&-n)).tag=2,ui(l,u)),l.lanes|=n,null!==(u=l.alternate)&&(u.lanes|=n),ri(l.return,n),c.lanes|=n;break}u=u.next}}else s=10===l.tag&&l.type===t.type?null:l.child;if(null!==s)s.return=l;else for(s=l;null!==s;){if(s===t){s=null;break}if(null!==(l=s.sibling)){l.return=s.return,s=l;break}s=s.return}l=s}Da(e,t,o.children,n),t=t.child}return t;case 9:return o=t.type,r=(i=t.pendingProps).children,oi(t,n),r=r(o=ii(o,i.unstable_observedBits)),t.flags|=1,Da(e,t,r,n),t.child;case 14:return i=Qo(o=t.type,t.pendingProps),Ma(e,t,o,i=Qo(o.type,i),r,n);case 15:return Fa(e,t,t.type,t.pendingProps,r,n);case 17:return r=t.type,o=t.pendingProps,o=t.elementType===r?o:Qo(r,o),null!==e&&(e.alternate=null,t.alternate=null,t.flags|=2),t.tag=1,go(r)?(e=!0,wo(t)):e=!1,oi(t,n),vi(t,r,o),wi(t,r,o,n),qa(null,t,r,!0,e,n);case 19:return es(e,t,n);case 23:case 24:return za(e,t,n)}throw Error(a(156,t.tag))},Zl.prototype.render=function(e){Gl(e,this._internalRoot,null,null)},Zl.prototype.unmount=function(){var e=this._internalRoot,t=e.containerInfo;Gl(null,e,null,(function(){t[Jr]=null}))},Ze=function(e){13===e.tag&&(ul(e,4,ll()),Jl(e,4))},et=function(e){13===e.tag&&(ul(e,67108864,ll()),Jl(e,67108864))},tt=function(e){if(13===e.tag){var t=ll(),n=cl(e);ul(e,n,t),Jl(e,n)}},nt=function(e,t){return t()},Ee=function(e,t,n){switch(t){case"input":if(ne(e,n),t=n.name,"radio"===n.type&&null!=t){for(n=e;n.parentNode;)n=n.parentNode;for(n=n.querySelectorAll("input[name="+JSON.stringify(""+t)+'][type="radio"]'),t=0;t<n.length;t++){var r=n[t];if(r!==e&&r.form===e.form){var o=ro(r);if(!o)throw Error(a(90));X(r),ne(r,o)}}}break;case"textarea":ce(e,n);break;case"select":null!=(t=n.value)&&ae(e,!!n.multiple,t,!1)}},je=gl,Te=function(e,t,n,r,o){var i=As;As|=4;try{return Wo(98,e.bind(null,t,n,r,o))}finally{0===(As=i)&&(Bs(),Yo())}},Ie=function(){0==(49&As)&&(function(){if(null!==el){var e=el;el=null,e.forEach((function(e){e.expiredLanes|=24&e.pendingLanes,dl(e,Vo())}))}Yo()}(),Rl())},Ne=function(e,t){var n=As;As|=2;try{return e(t)}finally{0===(As=n)&&(Bs(),Yo())}};var nc={findFiberByHostInstance:eo,bundleType:0,version:"17.0.2",rendererPackageName:"react-dom"},rc={bundleType:nc.bundleType,version:nc.version,rendererPackageName:nc.rendererPackageName,rendererConfig:nc.rendererConfig,overrideHookState:null,overrideHookStateDeletePath:null,overrideHookStateRenamePath:null,overrideProps:null,overridePropsDeletePath:null,overridePropsRenamePath:null,setSuspenseHandler:null,scheduleUpdate:null,currentDispatcherRef:x.ReactCurrentDispatcher,findHostInstanceByFiber:function(e){return null===(e=function(e){if(e=function(e){var t=e.alternate;if(!t){if(null===(t=Ge(e)))throw Error(a(188));return t!==e?null:e}for(var n=e,r=t;;){var o=n.return;if(null===o)break;var i=o.alternate;if(null===i){if(null!==(r=o.return)){n=r;continue}break}if(o.child===i.child){for(i=o.child;i;){if(i===n)return Xe(o),e;if(i===r)return Xe(o),t;i=i.sibling}throw Error(a(188))}if(n.return!==r.return)n=o,r=i;else{for(var s=!1,l=o.child;l;){if(l===n){s=!0,n=o,r=i;break}if(l===r){s=!0,r=o,n=i;break}l=l.sibling}if(!s){for(l=i.child;l;){if(l===n){s=!0,n=i,r=o;break}if(l===r){s=!0,r=i,n=o;break}l=l.sibling}if(!s)throw Error(a(189))}}if(n.alternate!==r)throw Error(a(190))}if(3!==n.tag)throw Error(a(188));return n.stateNode.current===n?e:t}(e),!e)return null;for(var t=e;;){if(5===t.tag||6===t.tag)return t;if(t.child)t.child.return=t,t=t.child;else{if(t===e)break;for(;!t.sibling;){if(!t.return||t.return===e)return null;t=t.return}t.sibling.return=t.return,t=t.sibling}}return null}(e))?null:e.stateNode},findFiberByHostInstance:nc.findFiberByHostInstance||function(){return null},findHostInstancesForRefresh:null,scheduleRefresh:null,scheduleRoot:null,setRefreshHandler:null,getCurrentFiber:null};if("undefined"!=typeof __REACT_DEVTOOLS_GLOBAL_HOOK__){var oc=__REACT_DEVTOOLS_GLOBAL_HOOK__;if(!oc.isDisabled&&oc.supportsFiber)try{ko=oc.inject(rc),_o=oc}catch(me){}}t.hydrate=function(e,t,n){if(!ec(t))throw Error(a(200));return tc(null,e,t,!0,n)},t.render=function(e,t,n){if(!ec(t))throw Error(a(200));return tc(null,e,t,!1,n)},t.unmountComponentAtNode=function(e){if(!ec(e))throw Error(a(40));return!!e._reactRootContainer&&(yl((function(){tc(null,null,e,!1,(function(){e._reactRootContainer=null,e[Jr]=null}))})),!0)},t.unstable_batchedUpdates=gl},3935:function(e,t,n){"use strict";!function e(){if("undefined"!=typeof __REACT_DEVTOOLS_GLOBAL_HOOK__&&"function"==typeof __REACT_DEVTOOLS_GLOBAL_HOOK__.checkDCE)try{__REACT_DEVTOOLS_GLOBAL_HOOK__.checkDCE(e)}catch(e){console.error(e)}}(),e.exports=n(4448)},9921:function(e,t){"use strict";var n=60103,r=60106,o=60107,i=60108,a=60114,s=60109,l=60110,c=60112,u=60113,p=60120,d=60115,f=60116,h=60121,m=60122,g=60117,y=60129,v=60131;if("function"==typeof Symbol&&Symbol.for){var b=Symbol.for;n=b("react.element"),r=b("react.portal"),o=b("react.fragment"),i=b("react.strict_mode"),a=b("react.profiler"),s=b("react.provider"),l=b("react.context"),c=b("react.forward_ref"),u=b("react.suspense"),p=b("react.suspense_list"),d=b("react.memo"),f=b("react.lazy"),h=b("react.block"),m=b("react.server.block"),g=b("react.fundamental"),y=b("react.debug_trace_mode"),v=b("react.legacy_hidden")}t.isValidElementType=function(e){return"string"==typeof e||"function"==typeof e||e===o||e===a||e===y||e===i||e===u||e===p||e===v||"object"==typeof e&&null!==e&&(e.$$typeof===f||e.$$typeof===d||e.$$typeof===s||e.$$typeof===l||e.$$typeof===c||e.$$typeof===g||e.$$typeof===h||e[0]===m)},t.typeOf=function(e){if("object"==typeof e&&null!==e){var t=e.$$typeof;switch(t){case n:switch(e=e.type){case o:case a:case i:case u:case p:return e;default:switch(e=e&&e.$$typeof){case l:case c:case f:case d:case s:return e;default:return t}}case r:return t}}}},9864:function(e,t,n){"use strict";e.exports=n(9921)},2408:function(e,t,n){"use strict";var r=n(7418),o=60103,i=60106;t.Fragment=60107,t.StrictMode=60108,t.Profiler=60114;var a=60109,s=60110,l=60112;t.Suspense=60113;var c=60115,u=60116;if("function"==typeof Symbol&&Symbol.for){var p=Symbol.for;o=p("react.element"),i=p("react.portal"),t.Fragment=p("react.fragment"),t.StrictMode=p("react.strict_mode"),t.Profiler=p("react.profiler"),a=p("react.provider"),s=p("react.context"),l=p("react.forward_ref"),t.Suspense=p("react.suspense"),c=p("react.memo"),u=p("react.lazy")}var d="function"==typeof Symbol&&Symbol.iterator;function f(e){for(var t="https://reactjs.org/docs/error-decoder.html?invariant="+e,n=1;n<arguments.length;n++)t+="&args[]="+encodeURIComponent(arguments[n]);return"Minified React error #"+e+"; visit "+t+" for the full message or use the non-minified dev environment for full errors and additional helpful warnings."}var h={isMounted:function(){return!1},enqueueForceUpdate:function(){},enqueueReplaceState:function(){},enqueueSetState:function(){}},m={};function g(e,t,n){this.props=e,this.context=t,this.refs=m,this.updater=n||h}function y(){}function v(e,t,n){this.props=e,this.context=t,this.refs=m,this.updater=n||h}g.prototype.isReactComponent={},g.prototype.setState=function(e,t){if("object"!=typeof e&&"function"!=typeof e&&null!=e)throw Error(f(85));this.updater.enqueueSetState(this,e,t,"setState")},g.prototype.forceUpdate=function(e){this.updater.enqueueForceUpdate(this,e,"forceUpdate")},y.prototype=g.prototype;var b=v.prototype=new y;b.constructor=v,r(b,g.prototype),b.isPureReactComponent=!0;var w={current:null},x=Object.prototype.hasOwnProperty,k={key:!0,ref:!0,__self:!0,__source:!0};function _(e,t,n){var r,i={},a=null,s=null;if(null!=t)for(r in void 0!==t.ref&&(s=t.ref),void 0!==t.key&&(a=""+t.key),t)x.call(t,r)&&!k.hasOwnProperty(r)&&(i[r]=t[r]);var l=arguments.length-2;if(1===l)i.children=n;else if(1<l){for(var c=Array(l),u=0;u<l;u++)c[u]=arguments[u+2];i.children=c}if(e&&e.defaultProps)for(r in l=e.defaultProps)void 0===i[r]&&(i[r]=l[r]);return{$$typeof:o,type:e,key:a,ref:s,props:i,_owner:w.current}}function O(e){return"object"==typeof e&&null!==e&&e.$$typeof===o}var S=/\/+/g;function E(e,t){return"object"==typeof e&&null!==e&&null!=e.key?function(e){var t={"=":"=0",":":"=2"};return"$"+e.replace(/[=:]/g,(function(e){return t[e]}))}(""+e.key):t.toString(36)}function P(e,t,n,r,a){var s=typeof e;"undefined"!==s&&"boolean"!==s||(e=null);var l=!1;if(null===e)l=!0;else switch(s){case"string":case"number":l=!0;break;case"object":switch(e.$$typeof){case o:case i:l=!0}}if(l)return a=a(l=e),e=""===r?"."+E(l,0):r,Array.isArray(a)?(n="",null!=e&&(n=e.replace(S,"$&/")+"/"),P(a,t,n,"",(function(e){return e}))):null!=a&&(O(a)&&(a=function(e,t){return{$$typeof:o,type:e.type,key:t,ref:e.ref,props:e.props,_owner:e._owner}}(a,n+(!a.key||l&&l.key===a.key?"":(""+a.key).replace(S,"$&/")+"/")+e)),t.push(a)),1;if(l=0,r=""===r?".":r+":",Array.isArray(e))for(var c=0;c<e.length;c++){var u=r+E(s=e[c],c);l+=P(s,t,n,u,a)}else if(u=function(e){return null===e||"object"!=typeof e?null:"function"==typeof(e=d&&e[d]||e["@@iterator"])?e:null}(e),"function"==typeof u)for(e=u.call(e),c=0;!(s=e.next()).done;)l+=P(s=s.value,t,n,u=r+E(s,c++),a);else if("object"===s)throw t=""+e,Error(f(31,"[object Object]"===t?"object with keys {"+Object.keys(e).join(", ")+"}":t));return l}function A(e,t,n){if(null==e)return e;var r=[],o=0;return P(e,r,"","",(function(e){return t.call(n,e,o++)})),r}function $(e){if(-1===e._status){var t=e._result;t=t(),e._status=0,e._result=t,t.then((function(t){0===e._status&&(t=t.default,e._status=1,e._result=t)}),(function(t){0===e._status&&(e._status=2,e._result=t)}))}if(1===e._status)return e._result;throw e._result}var C={current:null};function R(){var e=C.current;if(null===e)throw Error(f(321));return e}var j={ReactCurrentDispatcher:C,ReactCurrentBatchConfig:{transition:0},ReactCurrentOwner:w,IsSomeRendererActing:{current:!1},assign:r};t.Children={map:A,forEach:function(e,t,n){A(e,(function(){t.apply(this,arguments)}),n)},count:function(e){var t=0;return A(e,(function(){t++})),t},toArray:function(e){return A(e,(function(e){return e}))||[]},only:function(e){if(!O(e))throw Error(f(143));return e}},t.Component=g,t.PureComponent=v,t.__SECRET_INTERNALS_DO_NOT_USE_OR_YOU_WILL_BE_FIRED=j,t.cloneElement=function(e,t,n){if(null==e)throw Error(f(267,e));var i=r({},e.props),a=e.key,s=e.ref,l=e._owner;if(null!=t){if(void 0!==t.ref&&(s=t.ref,l=w.current),void 0!==t.key&&(a=""+t.key),e.type&&e.type.defaultProps)var c=e.type.defaultProps;for(u in t)x.call(t,u)&&!k.hasOwnProperty(u)&&(i[u]=void 0===t[u]&&void 0!==c?c[u]:t[u])}var u=arguments.length-2;if(1===u)i.children=n;else if(1<u){c=Array(u);for(var p=0;p<u;p++)c[p]=arguments[p+2];i.children=c}return{$$typeof:o,type:e.type,key:a,ref:s,props:i,_owner:l}},t.createContext=function(e,t){return void 0===t&&(t=null),(e={$$typeof:s,_calculateChangedBits:t,_currentValue:e,_currentValue2:e,_threadCount:0,Provider:null,Consumer:null}).Provider={$$typeof:a,_context:e},e.Consumer=e},t.createElement=_,t.createFactory=function(e){var t=_.bind(null,e);return t.type=e,t},t.createRef=function(){return{current:null}},t.forwardRef=function(e){return{$$typeof:l,render:e}},t.isValidElement=O,t.lazy=function(e){return{$$typeof:u,_payload:{_status:-1,_result:e},_init:$}},t.memo=function(e,t){return{$$typeof:c,type:e,compare:void 0===t?null:t}},t.useCallback=function(e,t){return R().useCallback(e,t)},t.useContext=function(e,t){return R().useContext(e,t)},t.useDebugValue=function(){},t.useEffect=function(e,t){return R().useEffect(e,t)},t.useImperativeHandle=function(e,t,n){return R().useImperativeHandle(e,t,n)},t.useLayoutEffect=function(e,t){return R().useLayoutEffect(e,t)},t.useMemo=function(e,t){return R().useMemo(e,t)},t.useReducer=function(e,t,n){return R().useReducer(e,t,n)},t.useRef=function(e){return R().useRef(e)},t.useState=function(e){return R().useState(e)},t.version="17.0.2"},7294:function(e,t,n){"use strict";e.exports=n(2408)},4683:function(e){"use strict";e.exports={nop:function(e){return e},clone:function(e){return JSON.parse(JSON.stringify(e))},shallowClone:function(e){let t={};for(let n in e)e.hasOwnProperty(n)&&(t[n]=e[n]);return t},deepClone:function e(t){let n=Array.isArray(t)?[]:{};for(let r in t)(t.hasOwnProperty(r)||Array.isArray(t))&&(n[r]="object"==typeof t[r]?e(t[r]):t[r]);return n},fastClone:function(e){return Object.assign({},e)},circularClone:function e(t,n){if(n||(n=new WeakMap),Object(t)!==t||t instanceof Function)return t;if(n.has(t))return n.get(t);try{var r=new t.constructor}catch(e){r=Object.create(Object.getPrototypeOf(t))}return n.set(t,r),Object.assign(r,...Object.keys(t).map((r=>({[r]:e(t[r],n)}))))}}},4593:function(e,t,n){"use strict";const r=n(8401).recurse,o=n(4683).shallowClone,i=n(7053).jptr,a=n(2592).isRef;e.exports={dereference:function e(t,n,s){s||(s={}),s.cache||(s.cache={}),s.state||(s.state={}),s.state.identityDetection=!0,s.depth=s.depth?s.depth+1:1;let l=s.depth>1?t:o(t),c={data:l},u=s.depth>1?n:o(n);s.master||(s.master=l);let p=function(e){return e&&e.verbose?{warn:function(){var e=Array.prototype.slice.call(arguments);console.warn.apply(console,e)}}:{warn:function(){}}}(s),d=1;for(;d>0;)d=0,r(c,s.state,(function(t,n,r){if(a(t,n)){let o=t[n];if(d++,s.cache[o]){let e=s.cache[o];if(e.resolved)p.warn("Patching %s for %s",o,e.path),r.parent[r.pkey]=e.data,s.$ref&&"object"==typeof r.parent[r.pkey]&&(r.parent[r.pkey][s.$ref]=o);else{if(o===e.path)throw new Error(`Tight circle at ${e.path}`);p.warn("Unresolved ref"),r.parent[r.pkey]=i(e.source,e.path),!1===r.parent[r.pkey]&&(r.parent[r.pkey]=i(e.source,e.key)),s.$ref&&"object"==typeof r.parent[r.pkey]&&(r.parent[s.$ref]=o)}}else{let t={};t.path=r.path.split("/$ref")[0],t.key=o,p.warn("Dereffing %s at %s",o,t.path),t.source=u,t.data=i(t.source,t.key),!1===t.data&&(t.data=i(s.master,t.key),t.source=s.master),!1===t.data&&p.warn("Missing $ref target",t.key),s.cache[o]=t,t.data=r.parent[r.pkey]=e(i(t.source,t.key),t.source,s),s.$ref&&"object"==typeof r.parent[r.pkey]&&(r.parent[r.pkey][s.$ref]=o),t.resolved=!0}}}));return c.data}}},2592:function(e){"use strict";e.exports={isRef:function(e,t){return"$ref"===t&&!!e&&"string"==typeof e[t]}}},7053:function(e){"use strict";function t(e){return e.replace(/\~1/g,"/").replace(/~0/g,"~")}e.exports={jptr:function(e,n,r){if(void 0===e)return!1;if(!n||"string"!=typeof n||"#"===n)return void 0!==r?r:e;if(n.indexOf("#")>=0){let e=n.split("#");if(e[0])return!1;n=e[1],n=decodeURIComponent(n.slice(1).split("+").join(" "))}n.startsWith("/")&&(n=n.slice(1));let o=n.split("/");for(let n=0;n<o.length;n++){o[n]=t(o[n]);let i=void 0!==r&&n==o.length-1,a=parseInt(o[n],10);if(!Array.isArray(e)||isNaN(a)||a.toString()!==o[n]?a=Array.isArray(e)&&"-"===o[n]?-2:-1:o[n]=n>0?o[n-1]:"",-1!=a||e&&e.hasOwnProperty(o[n]))if(a>=0)i&&(e[a]=r),e=e[a];else{if(-2===a)return i?(Array.isArray(e)&&e.push(r),r):void 0;i&&(e[o[n]]=r),e=e[o[n]]}else{if(void 0===r||"object"!=typeof e||Array.isArray(e))return!1;e[o[n]]=i?r:"0"===o[n+1]||"-"===o[n+1]?[]:{},e=e[o[n]]}}return e},jpescape:function(e){return e.replace(/\~/g,"~0").replace(/\//g,"~1")},jpunescape:t}},8401:function(e,t,n){"use strict";const r=n(7053).jpescape;e.exports={recurse:function e(t,n,o){if(n||(n={depth:0}),n.depth||(n=Object.assign({},{path:"#",depth:0,pkey:"",parent:{},payload:{},seen:new WeakMap,identity:!1,identityDetection:!1},n)),"object"!=typeof t)return;let i=n.path;for(let a in t){if(n.key=a,n.path=n.path+"/"+encodeURIComponent(r(a)),n.identityPath=n.seen.get(t[a]),n.identity=void 0!==n.identityPath,t.hasOwnProperty(a)&&o(t,a,n),"object"==typeof t[a]&&!n.identity){n.identityDetection&&!Array.isArray(t[a])&&null!==t[a]&&n.seen.set(t[a],n.path);let r={};r.parent=t,r.path=n.path,r.depth=n.depth?n.depth+1:1,r.pkey=a,r.payload=n.payload,r.seen=n.seen,r.identity=!1,r.identityDetection=n.identityDetection,e(t[a],r,o)}n.path=i}}}},53:function(e,t){"use strict";var n,r,o,i;if("object"==typeof performance&&"function"==typeof performance.now){var a=performance;t.unstable_now=function(){return a.now()}}else{var s=Date,l=s.now();t.unstable_now=function(){return s.now()-l}}if("undefined"==typeof window||"function"!=typeof MessageChannel){var c=null,u=null,p=function(){if(null!==c)try{var e=t.unstable_now();c(!0,e),c=null}catch(e){throw setTimeout(p,0),e}};n=function(e){null!==c?setTimeout(n,0,e):(c=e,setTimeout(p,0))},r=function(e,t){u=setTimeout(e,t)},o=function(){clearTimeout(u)},t.unstable_shouldYield=function(){return!1},i=t.unstable_forceFrameRate=function(){}}else{var d=window.setTimeout,f=window.clearTimeout;if("undefined"!=typeof console){var h=window.cancelAnimationFrame;"function"!=typeof window.requestAnimationFrame&&console.error("This browser doesn't support requestAnimationFrame. Make sure that you load a polyfill in older browsers. https://reactjs.org/link/react-polyfills"),"function"!=typeof h&&console.error("This browser doesn't support cancelAnimationFrame. Make sure that you load a polyfill in older browsers. https://reactjs.org/link/react-polyfills")}var m=!1,g=null,y=-1,v=5,b=0;t.unstable_shouldYield=function(){return t.unstable_now()>=b},i=function(){},t.unstable_forceFrameRate=function(e){0>e||125<e?console.error("forceFrameRate takes a positive int between 0 and 125, forcing frame rates higher than 125 fps is not supported"):v=0<e?Math.floor(1e3/e):5};var w=new MessageChannel,x=w.port2;w.port1.onmessage=function(){if(null!==g){var e=t.unstable_now();b=e+v;try{g(!0,e)?x.postMessage(null):(m=!1,g=null)}catch(e){throw x.postMessage(null),e}}else m=!1},n=function(e){g=e,m||(m=!0,x.postMessage(null))},r=function(e,n){y=d((function(){e(t.unstable_now())}),n)},o=function(){f(y),y=-1}}function k(e,t){var n=e.length;e.push(t);e:for(;;){var r=n-1>>>1,o=e[r];if(!(void 0!==o&&0<S(o,t)))break e;e[r]=t,e[n]=o,n=r}}function _(e){return void 0===(e=e[0])?null:e}function O(e){var t=e[0];if(void 0!==t){var n=e.pop();if(n!==t){e[0]=n;e:for(var r=0,o=e.length;r<o;){var i=2*(r+1)-1,a=e[i],s=i+1,l=e[s];if(void 0!==a&&0>S(a,n))void 0!==l&&0>S(l,a)?(e[r]=l,e[s]=n,r=s):(e[r]=a,e[i]=n,r=i);else{if(!(void 0!==l&&0>S(l,n)))break e;e[r]=l,e[s]=n,r=s}}}return t}return null}function S(e,t){var n=e.sortIndex-t.sortIndex;return 0!==n?n:e.id-t.id}var E=[],P=[],A=1,$=null,C=3,R=!1,j=!1,T=!1;function I(e){for(var t=_(P);null!==t;){if(null===t.callback)O(P);else{if(!(t.startTime<=e))break;O(P),t.sortIndex=t.expirationTime,k(E,t)}t=_(P)}}function N(e){if(T=!1,I(e),!j)if(null!==_(E))j=!0,n(D);else{var t=_(P);null!==t&&r(N,t.startTime-e)}}function D(e,n){j=!1,T&&(T=!1,o()),R=!0;var i=C;try{for(I(n),$=_(E);null!==$&&(!($.expirationTime>n)||e&&!t.unstable_shouldYield());){var a=$.callback;if("function"==typeof a){$.callback=null,C=$.priorityLevel;var s=a($.expirationTime<=n);n=t.unstable_now(),"function"==typeof s?$.callback=s:$===_(E)&&O(E),I(n)}else O(E);$=_(E)}if(null!==$)var l=!0;else{var c=_(P);null!==c&&r(N,c.startTime-n),l=!1}return l}finally{$=null,C=i,R=!1}}var L=i;t.unstable_IdlePriority=5,t.unstable_ImmediatePriority=1,t.unstable_LowPriority=4,t.unstable_NormalPriority=3,t.unstable_Profiling=null,t.unstable_UserBlockingPriority=2,t.unstable_cancelCallback=function(e){e.callback=null},t.unstable_continueExecution=function(){j||R||(j=!0,n(D))},t.unstable_getCurrentPriorityLevel=function(){return C},t.unstable_getFirstCallbackNode=function(){return _(E)},t.unstable_next=function(e){switch(C){case 1:case 2:case 3:var t=3;break;default:t=C}var n=C;C=t;try{return e()}finally{C=n}},t.unstable_pauseExecution=function(){},t.unstable_requestPaint=L,t.unstable_runWithPriority=function(e,t){switch(e){case 1:case 2:case 3:case 4:case 5:break;default:e=3}var n=C;C=e;try{return t()}finally{C=n}},t.unstable_scheduleCallback=function(e,i,a){var s=t.unstable_now();switch(a="object"==typeof a&&null!==a&&"number"==typeof(a=a.delay)&&0<a?s+a:s,e){case 1:var l=-1;break;case 2:l=250;break;case 5:l=1073741823;break;case 4:l=1e4;break;default:l=5e3}return e={id:A++,callback:i,priorityLevel:e,startTime:a,expirationTime:l=a+l,sortIndex:-1},a>s?(e.sortIndex=a,k(P,e),null===_(E)&&e===_(P)&&(T?o():T=!0,r(N,a-s))):(e.sortIndex=l,k(E,e),j||R||(j=!0,n(D))),e},t.unstable_wrapCallback=function(e){var t=C;return function(){var n=C;C=t;try{return e.apply(this,arguments)}finally{C=n}}}},3840:function(e,t,n){"use strict";e.exports=n(53)},6774:function(e){e.exports=function(e,t,n,r){var o=n?n.call(r,e,t):void 0;if(void 0!==o)return!!o;if(e===t)return!0;if("object"!=typeof e||!e||"object"!=typeof t||!t)return!1;var i=Object.keys(e),a=Object.keys(t);if(i.length!==a.length)return!1;for(var s=Object.prototype.hasOwnProperty.bind(t),l=0;l<i.length;l++){var c=i[l];if(!s(c))return!1;var u=e[c],p=t[c];if(!1===(o=n?n.call(r,u,p,c):void 0)||void 0===o&&u!==p)return!1}return!0}},1304:function(e){var t;t=function(){var e=JSON.parse('{"$":"dollar","%":"percent","&":"and","<":"less",">":"greater","|":"or","¢":"cent","£":"pound","¤":"currency","¥":"yen","©":"(c)","ª":"a","®":"(r)","º":"o","À":"A","Á":"A","Â":"A","Ã":"A","Ä":"A","Å":"A","Æ":"AE","Ç":"C","È":"E","É":"E","Ê":"E","Ë":"E","Ì":"I","Í":"I","Î":"I","Ï":"I","Ð":"D","Ñ":"N","Ò":"O","Ó":"O","Ô":"O","Õ":"O","Ö":"O","Ø":"O","Ù":"U","Ú":"U","Û":"U","Ü":"U","Ý":"Y","Þ":"TH","ß":"ss","à":"a","á":"a","â":"a","ã":"a","ä":"a","å":"a","æ":"ae","ç":"c","è":"e","é":"e","ê":"e","ë":"e","ì":"i","í":"i","î":"i","ï":"i","ð":"d","ñ":"n","ò":"o","ó":"o","ô":"o","õ":"o","ö":"o","ø":"o","ù":"u","ú":"u","û":"u","ü":"u","ý":"y","þ":"th","ÿ":"y","Ā":"A","ā":"a","Ă":"A","ă":"a","Ą":"A","ą":"a","Ć":"C","ć":"c","Č":"C","č":"c","Ď":"D","ď":"d","Đ":"DJ","đ":"dj","Ē":"E","ē":"e","Ė":"E","ė":"e","Ę":"e","ę":"e","Ě":"E","ě":"e","Ğ":"G","ğ":"g","Ģ":"G","ģ":"g","Ĩ":"I","ĩ":"i","Ī":"i","ī":"i","Į":"I","į":"i","İ":"I","ı":"i","Ķ":"k","ķ":"k","Ļ":"L","ļ":"l","Ľ":"L","ľ":"l","Ł":"L","ł":"l","Ń":"N","ń":"n","Ņ":"N","ņ":"n","Ň":"N","ň":"n","Ō":"O","ō":"o","Ő":"O","ő":"o","Œ":"OE","œ":"oe","Ŕ":"R","ŕ":"r","Ř":"R","ř":"r","Ś":"S","ś":"s","Ş":"S","ş":"s","Š":"S","š":"s","Ţ":"T","ţ":"t","Ť":"T","ť":"t","Ũ":"U","ũ":"u","Ū":"u","ū":"u","Ů":"U","ů":"u","Ű":"U","ű":"u","Ų":"U","ų":"u","Ŵ":"W","ŵ":"w","Ŷ":"Y","ŷ":"y","Ÿ":"Y","Ź":"Z","ź":"z","Ż":"Z","ż":"z","Ž":"Z","ž":"z","Ə":"E","ƒ":"f","Ơ":"O","ơ":"o","Ư":"U","ư":"u","Lj":"LJ","lj":"lj","Nj":"NJ","nj":"nj","Ș":"S","ș":"s","Ț":"T","ț":"t","ə":"e","˚":"o","Ά":"A","Έ":"E","Ή":"H","Ί":"I","Ό":"O","Ύ":"Y","Ώ":"W","ΐ":"i","Α":"A","Β":"B","Γ":"G","Δ":"D","Ε":"E","Ζ":"Z","Η":"H","Θ":"8","Ι":"I","Κ":"K","Λ":"L","Μ":"M","Ν":"N","Ξ":"3","Ο":"O","Π":"P","Ρ":"R","Σ":"S","Τ":"T","Υ":"Y","Φ":"F","Χ":"X","Ψ":"PS","Ω":"W","Ϊ":"I","Ϋ":"Y","ά":"a","έ":"e","ή":"h","ί":"i","ΰ":"y","α":"a","β":"b","γ":"g","δ":"d","ε":"e","ζ":"z","η":"h","θ":"8","ι":"i","κ":"k","λ":"l","μ":"m","ν":"n","ξ":"3","ο":"o","π":"p","ρ":"r","ς":"s","σ":"s","τ":"t","υ":"y","φ":"f","χ":"x","ψ":"ps","ω":"w","ϊ":"i","ϋ":"y","ό":"o","ύ":"y","ώ":"w","Ё":"Yo","Ђ":"DJ","Є":"Ye","І":"I","Ї":"Yi","Ј":"J","Љ":"LJ","Њ":"NJ","Ћ":"C","Џ":"DZ","А":"A","Б":"B","В":"V","Г":"G","Д":"D","Е":"E","Ж":"Zh","З":"Z","И":"I","Й":"J","К":"K","Л":"L","М":"M","Н":"N","О":"O","П":"P","Р":"R","С":"S","Т":"T","У":"U","Ф":"F","Х":"H","Ц":"C","Ч":"Ch","Ш":"Sh","Щ":"Sh","Ъ":"U","Ы":"Y","Ь":"","Э":"E","Ю":"Yu","Я":"Ya","а":"a","б":"b","в":"v","г":"g","д":"d","е":"e","ж":"zh","з":"z","и":"i","й":"j","к":"k","л":"l","м":"m","н":"n","о":"o","п":"p","р":"r","с":"s","т":"t","у":"u","ф":"f","х":"h","ц":"c","ч":"ch","ш":"sh","щ":"sh","ъ":"u","ы":"y","ь":"","э":"e","ю":"yu","я":"ya","ё":"yo","ђ":"dj","є":"ye","і":"i","ї":"yi","ј":"j","љ":"lj","њ":"nj","ћ":"c","ѝ":"u","џ":"dz","Ґ":"G","ґ":"g","Ғ":"GH","ғ":"gh","Қ":"KH","қ":"kh","Ң":"NG","ң":"ng","Ү":"UE","ү":"ue","Ұ":"U","ұ":"u","Һ":"H","һ":"h","Ә":"AE","ә":"ae","Ө":"OE","ө":"oe","฿":"baht","ა":"a","ბ":"b","გ":"g","დ":"d","ე":"e","ვ":"v","ზ":"z","თ":"t","ი":"i","კ":"k","ლ":"l","მ":"m","ნ":"n","ო":"o","პ":"p","ჟ":"zh","რ":"r","ს":"s","ტ":"t","უ":"u","ფ":"f","ქ":"k","ღ":"gh","ყ":"q","შ":"sh","ჩ":"ch","ც":"ts","ძ":"dz","წ":"ts","ჭ":"ch","ხ":"kh","ჯ":"j","ჰ":"h","Ẁ":"W","ẁ":"w","Ẃ":"W","ẃ":"w","Ẅ":"W","ẅ":"w","ẞ":"SS","Ạ":"A","ạ":"a","Ả":"A","ả":"a","Ấ":"A","ấ":"a","Ầ":"A","ầ":"a","Ẩ":"A","ẩ":"a","Ẫ":"A","ẫ":"a","Ậ":"A","ậ":"a","Ắ":"A","ắ":"a","Ằ":"A","ằ":"a","Ẳ":"A","ẳ":"a","Ẵ":"A","ẵ":"a","Ặ":"A","ặ":"a","Ẹ":"E","ẹ":"e","Ẻ":"E","ẻ":"e","Ẽ":"E","ẽ":"e","Ế":"E","ế":"e","Ề":"E","ề":"e","Ể":"E","ể":"e","Ễ":"E","ễ":"e","Ệ":"E","ệ":"e","Ỉ":"I","ỉ":"i","Ị":"I","ị":"i","Ọ":"O","ọ":"o","Ỏ":"O","ỏ":"o","Ố":"O","ố":"o","Ồ":"O","ồ":"o","Ổ":"O","ổ":"o","Ỗ":"O","ỗ":"o","Ộ":"O","ộ":"o","Ớ":"O","ớ":"o","Ờ":"O","ờ":"o","Ở":"O","ở":"o","Ỡ":"O","ỡ":"o","Ợ":"O","ợ":"o","Ụ":"U","ụ":"u","Ủ":"U","ủ":"u","Ứ":"U","ứ":"u","Ừ":"U","ừ":"u","Ử":"U","ử":"u","Ữ":"U","ữ":"u","Ự":"U","ự":"u","Ỳ":"Y","ỳ":"y","Ỵ":"Y","ỵ":"y","Ỷ":"Y","ỷ":"y","Ỹ":"Y","ỹ":"y","‘":"\'","’":"\'","“":"\\"","”":"\\"","†":"+","•":"*","…":"...","₠":"ecu","₢":"cruzeiro","₣":"french franc","₤":"lira","₥":"mill","₦":"naira","₧":"peseta","₨":"rupee","₩":"won","₪":"new shequel","₫":"dong","€":"euro","₭":"kip","₮":"tugrik","₯":"drachma","₰":"penny","₱":"peso","₲":"guarani","₳":"austral","₴":"hryvnia","₵":"cedi","₸":"kazakhstani tenge","₹":"indian rupee","₺":"turkish lira","₽":"russian ruble","₿":"bitcoin","℠":"sm","™":"tm","∂":"d","∆":"delta","∑":"sum","∞":"infinity","♥":"love","元":"yuan","円":"yen","﷼":"rial"}'),t=JSON.parse('{"de":{"Ä":"AE","ä":"ae","Ö":"OE","ö":"oe","Ü":"UE","ü":"ue","%":"prozent","&":"und","|":"oder","∑":"summe","∞":"unendlich","♥":"liebe"},"vi":{"Đ":"D","đ":"d"},"fr":{"%":"pourcent","&":"et","<":"plus petit",">":"plus grand","|":"ou","¢":"centime","£":"livre","¤":"devise","₣":"franc","∑":"somme","∞":"infini","♥":"amour"}}');function n(n,r){if("string"!=typeof n)throw new Error("slugify: string argument expected");var o=t[(r="string"==typeof r?{replacement:r}:r||{}).locale]||{},i=void 0===r.replacement?"-":r.replacement,a=n.split("").reduce((function(t,n){return t+(o[n]||e[n]||n).replace(r.remove||/[^\w\s$*_+~.()'"!\-:@]+/g,"")}),"").trim().replace(new RegExp("[\\s"+i+"]+","g"),i);return r.lower&&(a=a.toLowerCase()),r.strict&&(a=a.replace(new RegExp("[^a-zA-Z0-9"+i+"]","g"),"").replace(new RegExp("[\\s"+i+"]+","g"),i)),a}return n.extend=function(t){for(var n in t)e[n]=t[n]},n},e.exports=t(),e.exports.default=t()},5114:function(e){e.exports=function(e,t){e||(e=document),t||(t=window);var n,r,o=[],i=!1,a=e.documentElement,s=function(){},l="hidden",c="visibilitychange";void 0!==e.webkitHidden&&(l="webkitHidden",c="webkitvisibilitychange"),t.getComputedStyle||f();for(var u=["","-webkit-","-moz-","-ms-"],p=document.createElement("div"),d=u.length-1;d>=0;d--){try{p.style.position=u[d]+"sticky"}catch(e){}""!=p.style.position&&f()}function f(){C=N=R=j=T=I=s}function h(e){return parseFloat(e)||0}function m(){n={top:t.pageYOffset,left:t.pageXOffset}}function g(){if(t.pageXOffset!=n.left)return m(),void R();t.pageYOffset!=n.top&&(m(),v())}function y(e){setTimeout((function(){t.pageYOffset!=n.top&&(n.top=t.pageYOffset,v())}),0)}function v(){for(var e=o.length-1;e>=0;e--)b(o[e])}function b(e){if(e.inited){var t=n.top<=e.limit.start?0:n.top>=e.limit.end?2:1;e.mode!=t&&function(e,t){var n=e.node.style;switch(t){case 0:n.position="absolute",n.left=e.offset.left+"px",n.right=e.offset.right+"px",n.top=e.offset.top+"px",n.bottom="auto",n.width="auto",n.marginLeft=0,n.marginRight=0,n.marginTop=0;break;case 1:n.position="fixed",n.left=e.box.left+"px",n.right=e.box.right+"px",n.top=e.css.top,n.bottom="auto",n.width="auto",n.marginLeft=0,n.marginRight=0,n.marginTop=0;break;case 2:n.position="absolute",n.left=e.offset.left+"px",n.right=e.offset.right+"px",n.top="auto",n.bottom=0,n.width="auto",n.marginLeft=0,n.marginRight=0}e.mode=t}(e,t)}}function w(e){isNaN(parseFloat(e.computed.top))||e.isCell||(e.inited=!0,e.clone||function(e){e.clone=document.createElement("div");var t=e.node.nextSibling||e.node,n=e.clone.style;n.height=e.height+"px",n.width=e.width+"px",n.marginTop=e.computed.marginTop,n.marginBottom=e.computed.marginBottom,n.marginLeft=e.computed.marginLeft,n.marginRight=e.computed.marginRight,n.padding=n.border=n.borderSpacing=0,n.fontSize="1em",n.position="static",n.cssFloat=e.computed.cssFloat,e.node.parentNode.insertBefore(e.clone,t)}(e),"absolute"!=e.parent.computed.position&&"relative"!=e.parent.computed.position&&(e.parent.node.style.position="relative"),b(e),e.parent.height=e.parent.node.offsetHeight,e.docOffsetTop=S(e.clone))}function x(e){var t=!0;e.clone&&function(e){e.clone.parentNode.removeChild(e.clone),e.clone=void 0}(e),function(e,t){for(key in t)t.hasOwnProperty(key)&&(e[key]=t[key])}(e.node.style,e.css);for(var n=o.length-1;n>=0;n--)if(o[n].node!==e.node&&o[n].parent.node===e.parent.node){t=!1;break}t&&(e.parent.node.style.position=e.parent.css.position),e.mode=-1}function k(){for(var e=o.length-1;e>=0;e--)w(o[e])}function _(){for(var e=o.length-1;e>=0;e--)x(o[e])}function O(e){var t=getComputedStyle(e),n=e.parentNode,r=getComputedStyle(n),o=e.style.position;e.style.position="relative";var i={top:t.top,marginTop:t.marginTop,marginBottom:t.marginBottom,marginLeft:t.marginLeft,marginRight:t.marginRight,cssFloat:t.cssFloat},s={top:h(t.top),marginBottom:h(t.marginBottom),paddingLeft:h(t.paddingLeft),paddingRight:h(t.paddingRight),borderLeftWidth:h(t.borderLeftWidth),borderRightWidth:h(t.borderRightWidth)};e.style.position=o;var l={position:e.style.position,top:e.style.top,bottom:e.style.bottom,left:e.style.left,right:e.style.right,width:e.style.width,marginTop:e.style.marginTop,marginLeft:e.style.marginLeft,marginRight:e.style.marginRight},c=E(e),u=E(n),p={node:n,css:{position:n.style.position},computed:{position:r.position},numeric:{borderLeftWidth:h(r.borderLeftWidth),borderRightWidth:h(r.borderRightWidth),borderTopWidth:h(r.borderTopWidth),borderBottomWidth:h(r.borderBottomWidth)}};return{node:e,box:{left:c.win.left,right:a.clientWidth-c.win.right},offset:{top:c.win.top-u.win.top-p.numeric.borderTopWidth,left:c.win.left-u.win.left-p.numeric.borderLeftWidth,right:-c.win.right+u.win.right-p.numeric.borderRightWidth},css:l,isCell:"table-cell"==t.display,computed:i,numeric:s,width:c.win.right-c.win.left,height:c.win.bottom-c.win.top,mode:-1,inited:!1,parent:p,limit:{start:c.doc.top-s.top,end:u.doc.top+n.offsetHeight-p.numeric.borderBottomWidth-e.offsetHeight-s.top-s.marginBottom}}}function S(e){for(var t=0;e;)t+=e.offsetTop,e=e.offsetParent;return t}function E(e){var n=e.getBoundingClientRect();return{doc:{top:n.top+t.pageYOffset,left:n.left+t.pageXOffset},win:n}}function P(){r=setInterval((function(){!function(){for(var e=o.length-1;e>=0;e--)if(o[e].inited){var t=Math.abs(S(o[e].clone)-o[e].docOffsetTop),n=Math.abs(o[e].parent.node.offsetHeight-o[e].parent.height);if(t>=2||n>=2)return!1}return!0}()&&R()}),500)}function A(){clearInterval(r)}function $(){i&&(document[l]?A():P())}function C(){i||(m(),k(),t.addEventListener("scroll",g),t.addEventListener("wheel",y),t.addEventListener("resize",R),t.addEventListener("orientationchange",R),e.addEventListener(c,$),P(),i=!0)}function R(){if(i){_();for(var e=o.length-1;e>=0;e--)o[e]=O(o[e].node);k()}}function j(){t.removeEventListener("scroll",g),t.removeEventListener("wheel",y),t.removeEventListener("resize",R),t.removeEventListener("orientationchange",R),e.removeEventListener(c,$),A(),i=!1}function T(){j(),_()}function I(){for(T();o.length;)o.pop()}function N(e){for(var t=o.length-1;t>=0;t--)if(o[t].node===e)return;var n=O(e);o.push(n),i?w(n):C()}return m(),{stickies:o,add:N,remove:function(e){for(var t=o.length-1;t>=0;t--)o[t].node===e&&(x(o[t]),o.splice(t,1))},init:C,rebuild:R,pause:j,stop:T,kill:I}}},3433:function(e,t,n){"use strict";n.r(t);var r=n(3379),o=n.n(r),i=n(7795),a=n.n(i),s=n(569),l=n.n(s),c=n(3565),u=n.n(c),p=n(9216),d=n.n(p),f=n(4589),h=n.n(f),m=n(2295),g={};g.styleTagTransform=h(),g.setAttributes=u(),g.insert=l().bind(null,"head"),g.domAPI=a(),g.insertStyleElement=d(),o()(m.Z,g),t.default=m.Z&&m.Z.locals?m.Z.locals:void 0},3379:function(e){"use strict";var t=[];function n(e){for(var n=-1,r=0;r<t.length;r++)if(t[r].identifier===e){n=r;break}return n}function r(e,r){for(var i={},a=[],s=0;s<e.length;s++){var l=e[s],c=r.base?l[0]+r.base:l[0],u=i[c]||0,p="".concat(c," ").concat(u);i[c]=u+1;var d=n(p),f={css:l[1],media:l[2],sourceMap:l[3],supports:l[4],layer:l[5]};if(-1!==d)t[d].references++,t[d].updater(f);else{var h=o(f,r);r.byIndex=s,t.splice(s,0,{identifier:p,updater:h,references:1})}a.push(p)}return a}function o(e,t){var n=t.domAPI(t);return n.update(e),function(t){if(t){if(t.css===e.css&&t.media===e.media&&t.sourceMap===e.sourceMap&&t.supports===e.supports&&t.layer===e.layer)return;n.update(e=t)}else n.remove()}}e.exports=function(e,o){var i=r(e=e||[],o=o||{});return function(e){e=e||[];for(var a=0;a<i.length;a++){var s=n(i[a]);t[s].references--}for(var l=r(e,o),c=0;c<i.length;c++){var u=n(i[c]);0===t[u].references&&(t[u].updater(),t.splice(u,1))}i=l}}},569:function(e){"use strict";var t={};e.exports=function(e,n){var r=function(e){if(void 0===t[e]){var n=document.querySelector(e);if(window.HTMLIFrameElement&&n instanceof window.HTMLIFrameElement)try{n=n.contentDocument.head}catch(e){n=null}t[e]=n}return t[e]}(e);if(!r)throw new Error("Couldn't find a style target. This probably means that the value for the 'insert' parameter is invalid.");r.appendChild(n)}},9216:function(e){"use strict";e.exports=function(e){var t=document.createElement("style");return e.setAttributes(t,e.attributes),e.insert(t,e.options),t}},3565:function(e,t,n){"use strict";e.exports=function(e){var t=n.nc;t&&e.setAttribute("nonce",t)}},7795:function(e){"use strict";e.exports=function(e){var t=e.insertStyleElement(e);return{update:function(n){!function(e,t,n){var r="";n.supports&&(r+="@supports (".concat(n.supports,") {")),n.media&&(r+="@media ".concat(n.media," {"));var o=void 0!==n.layer;o&&(r+="@layer".concat(n.layer.length>0?" ".concat(n.layer):""," {")),r+=n.css,o&&(r+="}"),n.media&&(r+="}"),n.supports&&(r+="}");var i=n.sourceMap;i&&"undefined"!=typeof btoa&&(r+="\n/*# sourceMappingURL=data:application/json;base64,".concat(btoa(unescape(encodeURIComponent(JSON.stringify(i))))," */")),t.styleTagTransform(r,e,t.options)}(t,e,n)},remove:function(){!function(e){if(null===e.parentNode)return!1;e.parentNode.removeChild(e)}(t)}}}},4589:function(e){"use strict";e.exports=function(e,t){if(t.styleSheet)t.styleSheet.cssText=e;else{for(;t.firstChild;)t.removeChild(t.firstChild);t.appendChild(document.createTextNode(e))}}},8925:function(e,t,n){"use strict";const r=n(9045),o=n(8150),i=(n(6470),n(4480)),a=n(8150),s=n(8150),l=n(7053),c=l.jptr,u=n(2592).isRef,p=n(4683).clone,d=n(4683).circularClone,f=n(8401).recurse,h=n(4856),m=n(1804),g=n(3342),y=n(2711).statusCodes,v=n(4109).i8,b="3.0.0";let w;class x extends Error{constructor(e){super(e),this.name="S2OError"}}function k(e,t){let n=new x(e);if(n.options=t,!t.promise)throw n;t.promise.reject(n)}function _(e,t,n){n.warnOnly?t[n.warnProperty||"x-s2o-warning"]=e:k(e,n)}function O(e,t){m.walkSchema(e,{},{},(function(e,n,r){!function(e,t){if(e["x-required"]&&Array.isArray(e["x-required"])&&(e.required||(e.required=[]),e.required=e.required.concat(e["x-required"]),delete e["x-required"]),e["x-anyOf"]&&(e.anyOf=e["x-anyOf"],delete e["x-anyOf"]),e["x-oneOf"]&&(e.oneOf=e["x-oneOf"],delete e["x-oneOf"]),e["x-not"]&&(e.not=e["x-not"],delete e["x-not"]),"boolean"==typeof e["x-nullable"]&&(e.nullable=e["x-nullable"],delete e["x-nullable"]),"object"==typeof e["x-discriminator"]&&"string"==typeof e["x-discriminator"].propertyName){e.discriminator=e["x-discriminator"],delete e["x-discriminator"];for(let t in e.discriminator.mapping){let n=e.discriminator.mapping[t];n.startsWith("#/definitions/")&&(e.discriminator.mapping[t]=n.replace("#/definitions/","#/components/schemas/"))}}}(e),function(e,t,n){if(e.nullable&&n.patches++,e.discriminator&&"string"==typeof e.discriminator&&(e.discriminator={propertyName:e.discriminator}),e.items&&Array.isArray(e.items)&&(0===e.items.length?e.items={}:1===e.items.length?e.items=e.items[0]:e.items={anyOf:e.items}),e.type&&Array.isArray(e.type))if(n.patch){if(n.patches++,0===e.type.length)delete e.type;else{e.oneOf||(e.oneOf=[]);for(let t of e.type){let n={};if("null"===t)e.nullable=!0;else{n.type=t;for(let t of g.arrayProperties)void 0!==e.prop&&(n[t]=e[t],delete e[t])}n.type&&e.oneOf.push(n)}delete e.type,0===e.oneOf.length?delete e.oneOf:e.oneOf.length<2&&(e.type=e.oneOf[0].type,Object.keys(e.oneOf[0]).length>1&&_("Lost properties from oneOf",e,n),delete e.oneOf)}e.type&&Array.isArray(e.type)&&1===e.type.length&&(e.type=e.type[0])}else k("(Patchable) schema type must not be an array",n);e.type&&"null"===e.type&&(delete e.type,e.nullable=!0),"array"!==e.type||e.items||(e.items={}),"file"===e.type&&(e.type="string",e.format="binary"),"boolean"==typeof e.required&&(e.required&&e.name&&(void 0===t.required&&(t.required=[]),Array.isArray(t.required)&&t.required.push(e.name)),delete e.required),e.xml&&"string"==typeof e.xml.namespace&&(e.xml.namespace||delete e.xml.namespace),void 0!==e.allowEmptyValue&&(n.patches++,delete e.allowEmptyValue)}(e,n,t)}))}function S(e,t,n){let r=n.payload.options;if(u(e,t)){if(e[t].startsWith("#/components/"));else if("#/consumes"===e[t])delete e[t],n.parent[n.pkey]=p(r.openapi.consumes);else if("#/produces"===e[t])delete e[t],n.parent[n.pkey]=p(r.openapi.produces);else if(e[t].startsWith("#/definitions/")){let n=e[t].replace("#/definitions/","").split("/");const o=l.jpunescape(n[0]);let i=w.schemas[decodeURIComponent(o)];i?n[0]=i:_("Could not resolve reference "+e[t],e,r),e[t]="#/components/schemas/"+n.join("/")}else if(e[t].startsWith("#/parameters/"))e[t]="#/components/parameters/"+g.sanitise(e[t].replace("#/parameters/",""));else if(e[t].startsWith("#/responses/"))e[t]="#/components/responses/"+g.sanitise(e[t].replace("#/responses/",""));else if(e[t].startsWith("#")){let n=p(l.jptr(r.openapi,e[t]));if(!1===n)_("direct $ref not found "+e[t],e,r);else if(r.refmap[e[t]])e[t]=r.refmap[e[t]];else{let i=e[t];i=i.replace("/properties/headers/",""),i=i.replace("/properties/responses/",""),i=i.replace("/properties/parameters/",""),i=i.replace("/properties/schemas/","");let a="schemas",s=i.lastIndexOf("/schema");if(a=i.indexOf("/headers/")>s?"headers":i.indexOf("/responses/")>s?"responses":i.indexOf("/example")>s?"examples":i.indexOf("/x-")>s?"extensions":i.indexOf("/parameters/")>s?"parameters":"schemas","schemas"===a&&O(n,r),"responses"!==a&&"extensions"!==a){let i=a.substr(0,a.length-1);"parameter"===i&&n.name&&n.name===g.sanitise(n.name)&&(i=encodeURIComponent(n.name));let s=1;for(e["x-miro"]&&(o=(o=e["x-miro"]).indexOf("#")>=0?o.split("#")[1].split("/").pop():o.split("/").pop().split(".")[0],i=encodeURIComponent(g.sanitise(o)),s="");l.jptr(r.openapi,"#/components/"+a+"/"+i+s);)s=""===s?2:++s;let c="#/components/"+a+"/"+i+s,u="";"examples"===a&&(n={value:n},u="/value"),l.jptr(r.openapi,c,n),r.refmap[e[t]]=c+u,e[t]=c+u}}}if(delete e["x-miro"],Object.keys(e).length>1){const o=e[t],i=n.path.indexOf("/schema")>=0;"preserve"===r.refSiblings||(i&&"allOf"===r.refSiblings?(delete e.$ref,n.parent[n.pkey]={allOf:[{$ref:o},e]}):n.parent[n.pkey]={$ref:o})}}var o;if("x-ms-odata"===t&&"string"==typeof e[t]&&e[t].startsWith("#/")){let n=e[t].replace("#/definitions/","").replace("#/components/schemas/","").split("/"),o=w.schemas[decodeURIComponent(n[0])];o?n[0]=o:_("Could not resolve reference "+e[t],e,r),e[t]="#/components/schemas/"+n.join("/")}}function E(e){for(let t in e)for(let n in e[t]){let r=g.sanitise(n);n!==r&&(e[t][r]=e[t][n],delete e[t][n])}}function P(e,t){if("basic"===e.type&&(e.type="http",e.scheme="basic"),"oauth2"===e.type){let n={},r=e.flow;"application"===e.flow&&(r="clientCredentials"),"accessCode"===e.flow&&(r="authorizationCode"),void 0!==e.authorizationUrl&&(n.authorizationUrl=e.authorizationUrl.split("?")[0].trim()||"/"),"string"==typeof e.tokenUrl&&(n.tokenUrl=e.tokenUrl.split("?")[0].trim()||"/"),n.scopes=e.scopes||{},e.flows={},e.flows[r]=n,delete e.flow,delete e.authorizationUrl,delete e.tokenUrl,delete e.scopes,void 0!==e.name&&(t.patch?(t.patches++,delete e.name):k("(Patchable) oauth2 securitySchemes should not have name property",t))}}function A(e){return e&&!e["x-s2o-delete"]}function $(e,t){if(e.$ref)e.$ref=e.$ref.replace("#/responses/","#/components/responses/");else{e.type&&!e.schema&&(e.schema={}),e.type&&(e.schema.type=e.type),e.items&&"array"!==e.items.type&&(e.items.collectionFormat!==e.collectionFormat&&_("Nested collectionFormats are not supported",e,t),delete e.items.collectionFormat),"array"===e.type?("ssv"===e.collectionFormat?_("collectionFormat:ssv is no longer supported for headers",e,t):"pipes"===e.collectionFormat?_("collectionFormat:pipes is no longer supported for headers",e,t):"multi"===e.collectionFormat?e.explode=!0:"tsv"===e.collectionFormat?(_("collectionFormat:tsv is no longer supported",e,t),e["x-collectionFormat"]="tsv"):e.style="simple",delete e.collectionFormat):e.collectionFormat&&(t.patch?(t.patches++,delete e.collectionFormat):k("(Patchable) collectionFormat is only applicable to header.type array",t)),delete e.type;for(let t of g.parameterTypeProperties)void 0!==e[t]&&(e.schema[t]=e[t],delete e[t]);for(let t of g.arrayProperties)void 0!==e[t]&&(e.schema[t]=e[t],delete e[t])}}function C(e,t){if(e.$ref.indexOf("#/parameters/")>=0){let t=e.$ref.split("#/parameters/");e.$ref=t[0]+"#/components/parameters/"+g.sanitise(t[1])}e.$ref.indexOf("#/definitions/")>=0&&_("Definition used as parameter",e,t)}function R(e,t,n,r,o,i,a){let s,l={},u=!0;if(t&&t.consumes&&"string"==typeof t.consumes){if(!a.patch)return k("(Patchable) operation.consumes must be an array",a);a.patches++,t.consumes=[t.consumes]}Array.isArray(i.consumes)||delete i.consumes;let d=((t?t.consumes:null)||i.consumes||[]).filter(g.uniqueOnly);if(e&&e.$ref&&"string"==typeof e.$ref){C(e,a);let t=decodeURIComponent(e.$ref.replace("#/components/parameters/","")),n=!1,r=i.components.parameters[t];if(r&&!r["x-s2o-delete"]||!e.$ref.startsWith("#/")||(e["x-s2o-delete"]=!0,n=!0),n){let t=e.$ref,n=c(i,e.$ref);!n&&t.startsWith("#/")?_("Could not resolve reference "+t,e,a):n&&(e=n)}}if(e&&(e.name||e.in)){"boolean"==typeof e["x-deprecated"]&&(e.deprecated=e["x-deprecated"],delete e["x-deprecated"]),void 0!==e["x-example"]&&(e.example=e["x-example"],delete e["x-example"]),"body"===e.in||e.type||(a.patch?(a.patches++,e.type="string"):k("(Patchable) parameter.type is mandatory for non-body parameters",a)),e.type&&"object"==typeof e.type&&e.type.$ref&&(e.type=c(i,e.type.$ref)),"file"===e.type&&(e["x-s2o-originalType"]=e.type,s=e.type),e.description&&"object"==typeof e.description&&e.description.$ref&&(e.description=c(i,e.description.$ref)),null===e.description&&delete e.description;let t=e.collectionFormat;if("array"!==e.type||t||(t="csv"),t&&("array"!==e.type&&(a.patch?(a.patches++,delete e.collectionFormat):k("(Patchable) collectionFormat is only applicable to param.type array",a)),"csv"!==t||"query"!==e.in&&"cookie"!==e.in||(e.style="form",e.explode=!1),"csv"!==t||"path"!==e.in&&"header"!==e.in||(e.style="simple"),"ssv"===t&&("query"===e.in?e.style="spaceDelimited":_("collectionFormat:ssv is no longer supported except for in:query parameters",e,a)),"pipes"===t&&("query"===e.in?e.style="pipeDelimited":_("collectionFormat:pipes is no longer supported except for in:query parameters",e,a)),"multi"===t&&(e.explode=!0),"tsv"===t&&(_("collectionFormat:tsv is no longer supported",e,a),e["x-collectionFormat"]="tsv"),delete e.collectionFormat),e.type&&"body"!==e.type&&"formData"!==e.in)if(e.items&&e.schema)_("parameter has array,items and schema",e,a);else{e.schema&&a.patches++,e.schema&&"object"==typeof e.schema||(e.schema={}),e.schema.type=e.type,e.items&&(e.schema.items=e.items,delete e.items,f(e.schema.items,null,(function(n,r,o){"collectionFormat"===r&&"string"==typeof n[r]&&(t&&n[r]!==t&&_("Nested collectionFormats are not supported",e,a),delete n[r])})));for(let t of g.parameterTypeProperties)void 0!==e[t]&&(e.schema[t]=e[t]),delete e[t]}e.schema&&O(e.schema,a),e["x-ms-skip-url-encoding"]&&"query"===e.in&&(e.allowReserved=!0,delete e["x-ms-skip-url-encoding"])}if(e&&"formData"===e.in){u=!1,l.content={};let t="application/x-www-form-urlencoded";if(d.length&&d.indexOf("multipart/form-data")>=0&&(t="multipart/form-data"),l.content[t]={},e.schema)l.content[t].schema=e.schema,e.schema.$ref&&(l["x-s2o-name"]=decodeURIComponent(e.schema.$ref.replace("#/components/schemas/","")));else{l.content[t].schema={},l.content[t].schema.type="object",l.content[t].schema.properties={},l.content[t].schema.properties[e.name]={};let n=l.content[t].schema,r=l.content[t].schema.properties[e.name];e.description&&(r.description=e.description),e.example&&(r.example=e.example),e.type&&(r.type=e.type);for(let t of g.parameterTypeProperties)void 0!==e[t]&&(r[t]=e[t]);!0===e.required&&(n.required||(n.required=[]),n.required.push(e.name),l.required=!0),void 0!==e.default&&(r.default=e.default),r.properties&&(r.properties=e.properties),e.allOf&&(r.allOf=e.allOf),"array"===e.type&&e.items&&(r.items=e.items,r.items.collectionFormat&&delete r.items.collectionFormat),"file"!==s&&"file"!==e["x-s2o-originalType"]||(r.type="string",r.format="binary"),j(e,r)}}else e&&"file"===e.type&&(e.required&&(l.required=e.required),l.content={},l.content["application/octet-stream"]={},l.content["application/octet-stream"].schema={},l.content["application/octet-stream"].schema.type="string",l.content["application/octet-stream"].schema.format="binary",j(e,l));if(e&&"body"===e.in){l.content={},e.name&&(l["x-s2o-name"]=(t&&t.operationId?g.sanitiseAll(t.operationId):"")+("_"+e.name).toCamelCase()),e.description&&(l.description=e.description),e.required&&(l.required=e.required),t&&a.rbname&&e.name&&(t[a.rbname]=e.name),e.schema&&e.schema.$ref?l["x-s2o-name"]=decodeURIComponent(e.schema.$ref.replace("#/components/schemas/","")):e.schema&&"array"===e.schema.type&&e.schema.items&&e.schema.items.$ref&&(l["x-s2o-name"]=decodeURIComponent(e.schema.items.$ref.replace("#/components/schemas/",""))+"Array"),d.length||d.push("application/json");for(let t of d)l.content[t]={},l.content[t].schema=p(e.schema||{}),O(l.content[t].schema,a);j(e,l)}if(Object.keys(l).length>0&&(e["x-s2o-delete"]=!0,t)&&(t.requestBody&&u?(t.requestBody["x-s2o-overloaded"]=!0,_("Operation "+(t.operationId||o)+" has multiple requestBodies",t,a)):(t.requestBody||(t=n[r]=function(e,t){let n={};for(let r of Object.keys(e))n[r]=e[r],"parameters"===r&&(n.requestBody={},t.rbname&&(n[t.rbname]=""));return n.requestBody={},n}(t,a)),t.requestBody.content&&t.requestBody.content["multipart/form-data"]&&t.requestBody.content["multipart/form-data"].schema&&t.requestBody.content["multipart/form-data"].schema.properties&&l.content["multipart/form-data"]&&l.content["multipart/form-data"].schema&&l.content["multipart/form-data"].schema.properties?(t.requestBody.content["multipart/form-data"].schema.properties=Object.assign(t.requestBody.content["multipart/form-data"].schema.properties,l.content["multipart/form-data"].schema.properties),t.requestBody.content["multipart/form-data"].schema.required=(t.requestBody.content["multipart/form-data"].schema.required||[]).concat(l.content["multipart/form-data"].schema.required||[]),t.requestBody.content["multipart/form-data"].schema.required.length||delete t.requestBody.content["multipart/form-data"].schema.required):t.requestBody.content&&t.requestBody.content["application/x-www-form-urlencoded"]&&t.requestBody.content["application/x-www-form-urlencoded"].schema&&t.requestBody.content["application/x-www-form-urlencoded"].schema.properties&&l.content["application/x-www-form-urlencoded"]&&l.content["application/x-www-form-urlencoded"].schema&&l.content["application/x-www-form-urlencoded"].schema.properties?(t.requestBody.content["application/x-www-form-urlencoded"].schema.properties=Object.assign(t.requestBody.content["application/x-www-form-urlencoded"].schema.properties,l.content["application/x-www-form-urlencoded"].schema.properties),t.requestBody.content["application/x-www-form-urlencoded"].schema.required=(t.requestBody.content["application/x-www-form-urlencoded"].schema.required||[]).concat(l.content["application/x-www-form-urlencoded"].schema.required||[]),t.requestBody.content["application/x-www-form-urlencoded"].schema.required.length||delete t.requestBody.content["application/x-www-form-urlencoded"].schema.required):(t.requestBody=Object.assign(t.requestBody,l),t.requestBody["x-s2o-name"]||(t.requestBody.schema&&t.requestBody.schema.$ref?t.requestBody["x-s2o-name"]=decodeURIComponent(t.requestBody.schema.$ref.replace("#/components/schemas/","")).split("/").join(""):t.operationId&&(t.requestBody["x-s2o-name"]=g.sanitiseAll(t.operationId)))))),e&&!e["x-s2o-delete"]){delete e.type;for(let t of g.parameterTypeProperties)delete e[t];"path"!==e.in||void 0!==e.required&&!0===e.required||(a.patch?(a.patches++,e.required=!0):k("(Patchable) path parameters must be required:true ["+e.name+" in "+o+"]",a))}return t}function j(e,t){for(let n in e)n.startsWith("x-")&&!n.startsWith("x-s2o")&&(t[n]=e[n])}function T(e,t,n,r,o){if(!e)return!1;if(e.$ref&&"string"==typeof e.$ref)e.$ref.indexOf("#/definitions/")>=0?_("definition used as response: "+e.$ref,e,o):e.$ref.startsWith("#/responses/")&&(e.$ref="#/components/responses/"+g.sanitise(decodeURIComponent(e.$ref.replace("#/responses/",""))));else{if((void 0===e.description||null===e.description||""===e.description&&o.patch)&&(o.patch?"object"!=typeof e||Array.isArray(e)||(o.patches++,e.description=y[e]||""):k("(Patchable) response.description is mandatory",o)),void 0!==e.schema){if(O(e.schema,o),e.schema.$ref&&"string"==typeof e.schema.$ref&&e.schema.$ref.startsWith("#/responses/")&&(e.schema.$ref="#/components/responses/"+g.sanitise(decodeURIComponent(e.schema.$ref.replace("#/responses/","")))),n&&n.produces&&"string"==typeof n.produces){if(!o.patch)return k("(Patchable) operation.produces must be an array",o);o.patches++,n.produces=[n.produces]}r.produces&&!Array.isArray(r.produces)&&delete r.produces;let t=((n?n.produces:null)||r.produces||[]).filter(g.uniqueOnly);t.length||t.push("*/*"),e.content={};for(let n of t){if(e.content[n]={},e.content[n].schema=p(e.schema),e.examples&&e.examples[n]){let t={};t.value=e.examples[n],e.content[n].examples={},e.content[n].examples.response=t,delete e.examples[n]}"file"===e.content[n].schema.type&&(e.content[n].schema={type:"string",format:"binary"})}delete e.schema}for(let t in e.examples)e.content||(e.content={}),e.content[t]||(e.content[t]={}),e.content[t].examples={},e.content[t].examples.response={},e.content[t].examples.response.value=e.examples[t];if(delete e.examples,e.headers)for(let t in e.headers)"status code"===t.toLowerCase()?o.patch?(o.patches++,delete e.headers[t]):k('(Patchable) "Status Code" is not a valid header',o):$(e.headers[t],o)}}function I(e,t,n,r,i){for(let a in e){let s=e[a];s&&s["x-trace"]&&"object"==typeof s["x-trace"]&&(s.trace=s["x-trace"],delete s["x-trace"]),s&&s["x-summary"]&&"string"==typeof s["x-summary"]&&(s.summary=s["x-summary"],delete s["x-summary"]),s&&s["x-description"]&&"string"==typeof s["x-description"]&&(s.description=s["x-description"],delete s["x-description"]),s&&s["x-servers"]&&Array.isArray(s["x-servers"])&&(s.servers=s["x-servers"],delete s["x-servers"]);for(let e in s)if(g.httpMethods.indexOf(e)>=0||"x-amazon-apigateway-any-method"===e){let u=s[e];if(u&&u.parameters&&Array.isArray(u.parameters)){if(s.parameters)for(let t of s.parameters)"string"==typeof t.$ref&&(C(t,n),t=c(i,t.$ref)),u.parameters.find((function(e,n,r){return e.name===t.name&&e.in===t.in}))||"formData"!==t.in&&"body"!==t.in&&"file"!==t.type||(u=R(t,u,s,e,a,i,n),n.rbname&&""===u[n.rbname]&&delete u[n.rbname]);for(let t of u.parameters)u=R(t,u,s,e,e+":"+a,i,n);n.rbname&&""===u[n.rbname]&&delete u[n.rbname],n.debug||u.parameters&&(u.parameters=u.parameters.filter(A))}if(u&&u.security&&E(u.security),"object"==typeof u){if(!u.responses){let e={description:"Default response"};u.responses={default:e}}for(let e in u.responses)T(u.responses[e],0,u,i,n)}if(u&&u["x-servers"]&&Array.isArray(u["x-servers"]))u.servers=u["x-servers"],delete u["x-servers"];else if(u&&u.schemes&&u.schemes.length)for(let e of u.schemes)if((!i.schemes||i.schemes.indexOf(e)<0)&&(u.servers||(u.servers=[]),Array.isArray(i.servers)))for(let t of i.servers){let n=p(t),r=o.parse(n.url);r.protocol=e,n.url=r.format(),u.servers.push(n)}if(n.debug&&(u["x-s2o-consumes"]=u.consumes||[],u["x-s2o-produces"]=u.produces||[]),u){if(delete u.consumes,delete u.produces,delete u.schemes,u["x-ms-examples"]){for(let e in u["x-ms-examples"]){let t=u["x-ms-examples"][e],n=g.sanitiseAll(e);if(t.parameters)for(let n in t.parameters){let r=t.parameters[n];for(let t of(u.parameters||[]).concat(s.parameters||[]))t.$ref&&(t=l.jptr(i,t.$ref)),t.name!==n||t.example||(t.examples||(t.examples={}),t.examples[e]={value:r})}if(t.responses)for(let r in t.responses){if(t.responses[r].headers)for(let e in t.responses[r].headers){let n=t.responses[r].headers[e];for(let t in u.responses[r].headers)t===e&&(u.responses[r].headers[t].example=n)}if(t.responses[r].body&&(i.components.examples[n]={value:p(t.responses[r].body)},u.responses[r]&&u.responses[r].content))for(let t in u.responses[r].content){let o=u.responses[r].content[t];o.examples||(o.examples={}),o.examples[e]={$ref:"#/components/examples/"+n}}}}delete u["x-ms-examples"]}if(u.parameters&&0===u.parameters.length&&delete u.parameters,u.requestBody){let n=u.operationId?g.sanitiseAll(u.operationId):g.sanitiseAll(e+a).toCamelCase(),o=g.sanitise(u.requestBody["x-s2o-name"]||n||"");delete u.requestBody["x-s2o-name"];let i=JSON.stringify(u.requestBody),s=g.hash(i);if(!r[s]){let e={};e.name=o,e.body=u.requestBody,e.refs=[],r[s]=e}let c="#/"+t+"/"+encodeURIComponent(l.jpescape(a))+"/"+e+"/requestBody";r[s].refs.push(c)}}}if(s&&s.parameters){for(let e in s.parameters)R(s.parameters[e],null,s,null,a,i,n);!n.debug&&Array.isArray(s.parameters)&&(s.parameters=s.parameters.filter(A))}}}function N(e){return e&&e.url&&"string"==typeof e.url?(e.url=e.url.split("{{").join("{"),e.url=e.url.split("}}").join("}"),e.url.replace(/\{(.+?)\}/g,(function(t,n){e.variables||(e.variables={}),e.variables[n]={default:"unknown"}})),e):e}function D(e,t,n){if(void 0===e.info||null===e.info){if(!t.patch)return n(new x("(Patchable) info object is mandatory"));t.patches++,e.info={version:"",title:""}}if("object"!=typeof e.info||Array.isArray(e.info))return n(new x("info must be an object"));if(void 0===e.info.title||null===e.info.title){if(!t.patch)return n(new x("(Patchable) info.title cannot be null"));t.patches++,e.info.title=""}if(void 0===e.info.version||null===e.info.version){if(!t.patch)return n(new x("(Patchable) info.version cannot be null"));t.patches++,e.info.version=""}if("string"!=typeof e.info.version){if(!t.patch)return n(new x("(Patchable) info.version must be a string"));t.patches++,e.info.version=e.info.version.toString()}if(void 0!==e.info.logo){if(!t.patch)return n(new x("(Patchable) info should not have logo property"));t.patches++,e.info["x-logo"]=e.info.logo,delete e.info.logo}if(void 0!==e.info.termsOfService){if(null===e.info.termsOfService){if(!t.patch)return n(new x("(Patchable) info.termsOfService cannot be null"));t.patches++,e.info.termsOfService=""}try{new URL(e.info.termsOfService)}catch(r){if(!t.patch)return n(new x("(Patchable) info.termsOfService must be a URL"));t.patches++,delete e.info.termsOfService}}}function L(e,t,n){if(void 0===e.paths){if(!t.patch)return n(new x("(Patchable) paths object is mandatory"));t.patches++,e.paths={}}}function M(e,t,n){return i(n,new Promise((function(n,r){if(e||(e={}),t.original=e,t.text||(t.text=s.stringify(e)),t.externals=[],t.externalRefs={},t.rewriteRefs=!0,t.preserveMiro=!0,t.promise={},t.promise.resolve=n,t.promise.reject=r,t.patches=0,t.cache||(t.cache={}),t.source&&(t.cache[t.source]=t.original),function(e,t){const n=new WeakSet;f(e,{identityDetection:!0},(function(e,r,o){"object"==typeof e[r]&&null!==e[r]&&(n.has(e[r])?t.anchors?e[r]=p(e[r]):k("YAML anchor or merge key at "+o.path,t):n.add(e[r]))}))}(e,t),e.openapi&&"string"==typeof e.openapi&&e.openapi.startsWith("3."))return t.openapi=d(e),D(t.openapi,t,r),L(t.openapi,t,r),void h.optionalResolve(t).then((function(){return t.direct?n(t.openapi):n(t)})).catch((function(e){console.warn(e),r(e)}));if(!e.swagger||"2.0"!=e.swagger)return r(new x("Unsupported swagger/OpenAPI version: "+(e.openapi?e.openapi:e.swagger)));let o=t.openapi={};if(o.openapi="string"==typeof t.targetVersion&&t.targetVersion.startsWith("3.")?t.targetVersion:b,t.origin){o["x-origin"]||(o["x-origin"]=[]);let n={};n.url=t.source||t.origin,n.format="swagger",n.version=e.swagger,n.converter={},n.converter.url="https://github.com/mermade/oas-kit",n.converter.version=v,o["x-origin"].push(n)}if(o=Object.assign(o,d(e)),delete o.swagger,f(o,{},(function(e,t,n){null===e[t]&&!t.startsWith("x-")&&"default"!==t&&n.path.indexOf("/example")<0&&delete e[t]})),e.host)for(let t of Array.isArray(e.schemes)?e.schemes:[""]){let n={},r=(e.basePath||"").replace(/\/$/,"");n.url=(t?t+":":"")+"//"+e.host+r,N(n),o.servers||(o.servers=[]),o.servers.push(n)}else if(e.basePath){let t={};t.url=e.basePath,N(t),o.servers||(o.servers=[]),o.servers.push(t)}if(delete o.host,delete o.basePath,o["x-servers"]&&Array.isArray(o["x-servers"])&&(o.servers=o["x-servers"],delete o["x-servers"]),e["x-ms-parameterized-host"]){let t=e["x-ms-parameterized-host"],n={};n.url=t.hostTemplate+(e.basePath?e.basePath:""),n.variables={};const r=n.url.match(/\{\w+\}/g);for(let e in t.parameters){let i=t.parameters[e];i.$ref&&(i=p(c(o,i.$ref))),e.startsWith("x-")||(delete i.required,delete i.type,delete i.in,void 0===i.default&&(i.enum?i.default=i.enum[0]:i.default="none"),i.name||(i.name=r[e].replace("{","").replace("}","")),n.variables[i.name]=i,delete i.name)}o.servers||(o.servers=[]),!1===t.useSchemePrefix?o.servers.push(n):e.schemes.forEach((e=>{o.servers.push(Object.assign({},n,{url:e+"://"+n.url}))})),delete o["x-ms-parameterized-host"]}D(o,t,r),L(o,t,r),"string"==typeof o.consumes&&(o.consumes=[o.consumes]),"string"==typeof o.produces&&(o.produces=[o.produces]),o.components={},o["x-callbacks"]&&(o.components.callbacks=o["x-callbacks"],delete o["x-callbacks"]),o.components.examples={},o.components.headers={},o["x-links"]&&(o.components.links=o["x-links"],delete o["x-links"]),o.components.parameters=o.parameters||{},o.components.responses=o.responses||{},o.components.requestBodies={},o.components.securitySchemes=o.securityDefinitions||{},o.components.schemas=o.definitions||{},delete o.definitions,delete o.responses,delete o.parameters,delete o.securityDefinitions,h.optionalResolve(t).then((function(){(function(e,t){let n={};w={schemas:{}},e.security&&E(e.security);for(let n in e.components.securitySchemes){let r=g.sanitise(n);n!==r&&(e.components.securitySchemes[r]&&k("Duplicate sanitised securityScheme name "+r,t),e.components.securitySchemes[r]=e.components.securitySchemes[n],delete e.components.securitySchemes[n]),P(e.components.securitySchemes[r],t)}for(let n in e.components.schemas){let r=g.sanitiseAll(n),o="";if(n!==r){for(;e.components.schemas[r+o];)o=o?++o:2;e.components.schemas[r+o]=e.components.schemas[n],delete e.components.schemas[n]}w.schemas[n]=r+o,O(e.components.schemas[r+o],t)}t.refmap={},f(e,{payload:{options:t}},S),function(e,t){for(let n in t.refmap)l.jptr(e,n,{$ref:t.refmap[n]})}(e,t);for(let n in e.components.parameters){let r=g.sanitise(n);n!==r&&(e.components.parameters[r]&&k("Duplicate sanitised parameter name "+r,t),e.components.parameters[r]=e.components.parameters[n],delete e.components.parameters[n]),R(e.components.parameters[r],null,null,null,r,e,t)}for(let n in e.components.responses){let r=g.sanitise(n);n!==r&&(e.components.responses[r]&&k("Duplicate sanitised response name "+r,t),e.components.responses[r]=e.components.responses[n],delete e.components.responses[n]);let o=e.components.responses[r];if(T(o,0,null,e,t),o.headers)for(let e in o.headers)"status code"===e.toLowerCase()?t.patch?(t.patches++,delete o.headers[e]):k('(Patchable) "Status Code" is not a valid header',t):$(o.headers[e],t)}for(let t in e.components.requestBodies){let r=e.components.requestBodies[t],o=JSON.stringify(r),i=g.hash(o),a={};a.name=t,a.body=r,a.refs=[],n[i]=a}if(I(e.paths,"paths",t,n,e),e["x-ms-paths"]&&I(e["x-ms-paths"],"x-ms-paths",t,n,e),!t.debug)for(let t in e.components.parameters)e.components.parameters[t]["x-s2o-delete"]&&delete e.components.parameters[t];t.debug&&(e["x-s2o-consumes"]=e.consumes||[],e["x-s2o-produces"]=e.produces||[]),delete e.consumes,delete e.produces,delete e.schemes;let r=[];if(e.components.requestBodies={},!t.resolveInternal){let t=1;for(let o in n){let i=n[o];if(i.refs.length>1){let n="";for(i.name||(i.name="requestBody",n=t++);r.indexOf(i.name+n)>=0;)n=n?++n:2;i.name=i.name+n,r.push(i.name),e.components.requestBodies[i.name]=p(i.body);for(let t in i.refs){let n={};n.$ref="#/components/requestBodies/"+i.name,l.jptr(e,i.refs[t],n)}}}}e.components.responses&&0===Object.keys(e.components.responses).length&&delete e.components.responses,e.components.parameters&&0===Object.keys(e.components.parameters).length&&delete e.components.parameters,e.components.examples&&0===Object.keys(e.components.examples).length&&delete e.components.examples,e.components.requestBodies&&0===Object.keys(e.components.requestBodies).length&&delete e.components.requestBodies,e.components.securitySchemes&&0===Object.keys(e.components.securitySchemes).length&&delete e.components.securitySchemes,e.components.headers&&0===Object.keys(e.components.headers).length&&delete e.components.headers,e.components.schemas&&0===Object.keys(e.components.schemas).length&&delete e.components.schemas,e.components&&0===Object.keys(e.components).length&&delete e.components})(t.openapi,t),t.direct?n(t.openapi):n(t)})).catch((function(e){console.warn(e),r(e)}))})))}function F(e,t,n){return i(n,new Promise((function(n,r){let o=null,i=null;try{o=JSON.parse(e),t.text=JSON.stringify(o,null,2)}catch(n){i=n;try{o=s.parse(e,{schema:"core",prettyErrors:!0}),t.sourceYaml=!0,t.text=e}catch(e){i=e}}o?M(o,t).then((e=>n(e))).catch((e=>r(e))):r(new x(i?i.message:"Could not parse string"))})))}e.exports={S2OError:x,targetVersion:b,convert:M,convertObj:M,convertUrl:function(e,t,n){return i(n,new Promise((function(n,r){t.origin=!0,t.source||(t.source=e),t.verbose&&console.warn("GET "+e),t.fetch||(t.fetch=a);const o=Object.assign({},t.fetchOptions,{agent:t.agent});t.fetch(e,o).then((function(t){if(200!==t.status)throw new x(`Received status code ${t.status}: ${e}`);return t.text()})).then((function(e){F(e,t).then((e=>n(e))).catch((e=>r(e)))})).catch((function(e){r(e)}))})))},convertStr:F,convertFile:function(e,t,n){return i(n,new Promise((function(n,o){r.readFile(e,t.encoding||"utf8",(function(r,i){r?o(r):(t.sourceFile=e,F(i,t).then((e=>n(e))).catch((e=>o(e))))}))})))},convertStream:function(e,t,n){return i(n,new Promise((function(n,r){let o="";e.on("data",(function(e){o+=e})).on("end",(function(){F(o,t).then((e=>n(e))).catch((e=>r(e)))}))})))}}},2711:function(e,t,n){"use strict";const r=n(6177);e.exports={statusCodes:Object.assign({},{default:"Default response","1XX":"Informational",103:"Early hints","2XX":"Successful","3XX":"Redirection","4XX":"Client Error","5XX":"Server Error","7XX":"Developer Error"},r.STATUS_CODES)}},4609:function(){self.fetch||(self.fetch=function(e,t){return t=t||{},new Promise((function(n,r){var o=new XMLHttpRequest,i=[],a=[],s={},l=function(){return{ok:2==(o.status/100|0),statusText:o.statusText,status:o.status,url:o.responseURL,text:function(){return Promise.resolve(o.responseText)},json:function(){return Promise.resolve(o.responseText).then(JSON.parse)},blob:function(){return Promise.resolve(new Blob([o.response]))},clone:l,headers:{keys:function(){return i},entries:function(){return a},get:function(e){return s[e.toLowerCase()]},has:function(e){return e.toLowerCase()in s}}}};for(var c in o.open(t.method||"get",e,!0),o.onload=function(){o.getAllResponseHeaders().replace(/^(.*?):[^\S\n]*([\s\S]*?)$/gm,(function(e,t,n){i.push(t=t.toLowerCase()),a.push([t,n]),s[t]=s[t]?s[t]+","+n:n})),n(l())},o.onerror=r,o.withCredentials="include"==t.credentials,t.headers)o.setRequestHeader(c,t.headers[c]);o.send(t.body||null)}))})},540:function(e,t){!function(e){"use strict";function t(){for(var e=arguments.length,t=Array(e),n=0;n<e;n++)t[n]=arguments[n];if(t.length>1){t[0]=t[0].slice(0,-1);for(var r=t.length-1,o=1;o<r;++o)t[o]=t[o].slice(1,-1);return t[r]=t[r].slice(1),t.join("")}return t[0]}function n(e){return"(?:"+e+")"}function r(e){return void 0===e?"undefined":null===e?"null":Object.prototype.toString.call(e).split(" ").pop().split("]").shift().toLowerCase()}function o(e){return e.toUpperCase()}function i(e){var r="[A-Za-z]",o="[0-9]",i=t(o,"[A-Fa-f]"),a=n(n("%[EFef]"+i+"%"+i+i+"%"+i+i)+"|"+n("%[89A-Fa-f]"+i+"%"+i+i)+"|"+n("%"+i+i)),s="[\\!\\$\\&\\'\\(\\)\\*\\+\\,\\;\\=]",l=t("[\\:\\/\\?\\#\\[\\]\\@]",s),c=e?"[\\uE000-\\uF8FF]":"[]",u=t(r,o,"[\\-\\.\\_\\~]",e?"[\\xA0-\\u200D\\u2010-\\u2029\\u202F-\\uD7FF\\uF900-\\uFDCF\\uFDF0-\\uFFEF]":"[]"),p=n(r+t(r,o,"[\\+\\-\\.]")+"*"),d=n(n(a+"|"+t(u,s,"[\\:]"))+"*"),f=(n(n("25[0-5]")+"|"+n("2[0-4][0-9]")+"|"+n("1[0-9][0-9]")+"|"+n("[1-9][0-9]")+"|"+o),n(n("25[0-5]")+"|"+n("2[0-4][0-9]")+"|"+n("1[0-9][0-9]")+"|"+n("0?[1-9][0-9]")+"|0?0?"+o)),h=n(f+"\\."+f+"\\."+f+"\\."+f),m=n(i+"{1,4}"),g=n(n(m+"\\:"+m)+"|"+h),y=n(n(m+"\\:")+"{6}"+g),v=n("\\:\\:"+n(m+"\\:")+"{5}"+g),b=n(n(m)+"?\\:\\:"+n(m+"\\:")+"{4}"+g),w=n(n(n(m+"\\:")+"{0,1}"+m)+"?\\:\\:"+n(m+"\\:")+"{3}"+g),x=n(n(n(m+"\\:")+"{0,2}"+m)+"?\\:\\:"+n(m+"\\:")+"{2}"+g),k=n(n(n(m+"\\:")+"{0,3}"+m)+"?\\:\\:"+m+"\\:"+g),_=n(n(n(m+"\\:")+"{0,4}"+m)+"?\\:\\:"+g),O=n(n(n(m+"\\:")+"{0,5}"+m)+"?\\:\\:"+m),S=n(n(n(m+"\\:")+"{0,6}"+m)+"?\\:\\:"),E=n([y,v,b,w,x,k,_,O,S].join("|")),P=n(n(u+"|"+a)+"+"),A=(n(E+"\\%25"+P),n(E+n("\\%25|\\%(?!"+i+"{2})")+P)),$=n("[vV]"+i+"+\\."+t(u,s,"[\\:]")+"+"),C=n("\\["+n(A+"|"+E+"|"+$)+"\\]"),R=n(n(a+"|"+t(u,s))+"*"),j=n(C+"|"+h+"(?!"+R+")|"+R),T=n("[0-9]*"),I=n(n(d+"@")+"?"+j+n("\\:"+T)+"?"),N=n(a+"|"+t(u,s,"[\\:\\@]")),D=n(N+"*"),L=n(N+"+"),M=n(n(a+"|"+t(u,s,"[\\@]"))+"+"),F=n(n("\\/"+D)+"*"),z=n("\\/"+n(L+F)+"?"),U=n(M+F),V=n(L+F),B="(?!"+N+")",q=(n(F+"|"+z+"|"+U+"|"+V+"|"+B),n(n(N+"|"+t("[\\/\\?]",c))+"*")),W=n(n(N+"|[\\/\\?]")+"*"),H=n(n("\\/\\/"+I+F)+"|"+z+"|"+V+"|"+B),Y=n(p+"\\:"+H+n("\\?"+q)+"?"+n("\\#"+W)+"?"),K=n(n("\\/\\/"+I+F)+"|"+z+"|"+U+"|"+B),G=n(K+n("\\?"+q)+"?"+n("\\#"+W)+"?");return n(Y+"|"+G),n(p+"\\:"+H+n("\\?"+q)+"?"),n(n("\\/\\/("+n("("+d+")@")+"?("+j+")"+n("\\:("+T+")")+"?)")+"?("+F+"|"+z+"|"+V+"|"+B+")"),n("\\?("+q+")"),n("\\#("+W+")"),n(n("\\/\\/("+n("("+d+")@")+"?("+j+")"+n("\\:("+T+")")+"?)")+"?("+F+"|"+z+"|"+U+"|"+B+")"),n("\\?("+q+")"),n("\\#("+W+")"),n(n("\\/\\/("+n("("+d+")@")+"?("+j+")"+n("\\:("+T+")")+"?)")+"?("+F+"|"+z+"|"+V+"|"+B+")"),n("\\?("+q+")"),n("\\#("+W+")"),n("("+d+")@"),n("\\:("+T+")"),{NOT_SCHEME:new RegExp(t("[^]",r,o,"[\\+\\-\\.]"),"g"),NOT_USERINFO:new RegExp(t("[^\\%\\:]",u,s),"g"),NOT_HOST:new RegExp(t("[^\\%\\[\\]\\:]",u,s),"g"),NOT_PATH:new RegExp(t("[^\\%\\/\\:\\@]",u,s),"g"),NOT_PATH_NOSCHEME:new RegExp(t("[^\\%\\/\\@]",u,s),"g"),NOT_QUERY:new RegExp(t("[^\\%]",u,s,"[\\:\\@\\/\\?]",c),"g"),NOT_FRAGMENT:new RegExp(t("[^\\%]",u,s,"[\\:\\@\\/\\?]"),"g"),ESCAPE:new RegExp(t("[^]",u,s),"g"),UNRESERVED:new RegExp(u,"g"),OTHER_CHARS:new RegExp(t("[^\\%]",u,l),"g"),PCT_ENCODED:new RegExp(a,"g"),IPV4ADDRESS:new RegExp("^("+h+")$"),IPV6ADDRESS:new RegExp("^\\[?("+E+")"+n(n("\\%25|\\%(?!"+i+"{2})")+"("+P+")")+"?\\]?$")}}var a=i(!1),s=i(!0),l=function(e,t){if(Array.isArray(e))return e;if(Symbol.iterator in Object(e))return function(e,t){var n=[],r=!0,o=!1,i=void 0;try{for(var a,s=e[Symbol.iterator]();!(r=(a=s.next()).done)&&(n.push(a.value),!t||n.length!==t);r=!0);}catch(e){o=!0,i=e}finally{try{!r&&s.return&&s.return()}finally{if(o)throw i}}return n}(e,t);throw new TypeError("Invalid attempt to destructure non-iterable instance")},c=2147483647,u=36,p=/^xn--/,d=/[^\0-\x7E]/,f=/[\x2E\u3002\uFF0E\uFF61]/g,h={overflow:"Overflow: input needs wider integers to process","not-basic":"Illegal input >= 0x80 (not a basic code point)","invalid-input":"Invalid input"},m=Math.floor,g=String.fromCharCode;function y(e){throw new RangeError(h[e])}function v(e,t){var n=e.split("@"),r="";return n.length>1&&(r=n[0]+"@",e=n[1]),r+function(e,t){for(var n=[],r=e.length;r--;)n[r]=t(e[r]);return n}((e=e.replace(f,".")).split("."),t).join(".")}function b(e){for(var t=[],n=0,r=e.length;n<r;){var o=e.charCodeAt(n++);if(o>=55296&&o<=56319&&n<r){var i=e.charCodeAt(n++);56320==(64512&i)?t.push(((1023&o)<<10)+(1023&i)+65536):(t.push(o),n--)}else t.push(o)}return t}var w=function(e,t){return e+22+75*(e<26)-((0!=t)<<5)},x=function(e,t,n){var r=0;for(e=n?m(e/700):e>>1,e+=m(e/t);e>455;r+=u)e=m(e/35);return m(r+36*e/(e+38))},k=function(e){var t,n=[],r=e.length,o=0,i=128,a=72,s=e.lastIndexOf("-");s<0&&(s=0);for(var l=0;l<s;++l)e.charCodeAt(l)>=128&&y("not-basic"),n.push(e.charCodeAt(l));for(var p=s>0?s+1:0;p<r;){for(var d=o,f=1,h=u;;h+=u){p>=r&&y("invalid-input");var g=(t=e.charCodeAt(p++))-48<10?t-22:t-65<26?t-65:t-97<26?t-97:u;(g>=u||g>m((c-o)/f))&&y("overflow"),o+=g*f;var v=h<=a?1:h>=a+26?26:h-a;if(g<v)break;var b=u-v;f>m(c/b)&&y("overflow"),f*=b}var w=n.length+1;a=x(o-d,w,0==d),m(o/w)>c-i&&y("overflow"),i+=m(o/w),o%=w,n.splice(o++,0,i)}return String.fromCodePoint.apply(String,n)},_=function(e){var t=[],n=(e=b(e)).length,r=128,o=0,i=72,a=!0,s=!1,l=void 0;try{for(var p,d=e[Symbol.iterator]();!(a=(p=d.next()).done);a=!0){var f=p.value;f<128&&t.push(g(f))}}catch(e){s=!0,l=e}finally{try{!a&&d.return&&d.return()}finally{if(s)throw l}}var h=t.length,v=h;for(h&&t.push("-");v<n;){var k=c,_=!0,O=!1,S=void 0;try{for(var E,P=e[Symbol.iterator]();!(_=(E=P.next()).done);_=!0){var A=E.value;A>=r&&A<k&&(k=A)}}catch(e){O=!0,S=e}finally{try{!_&&P.return&&P.return()}finally{if(O)throw S}}var $=v+1;k-r>m((c-o)/$)&&y("overflow"),o+=(k-r)*$,r=k;var C=!0,R=!1,j=void 0;try{for(var T,I=e[Symbol.iterator]();!(C=(T=I.next()).done);C=!0){var N=T.value;if(N<r&&++o>c&&y("overflow"),N==r){for(var D=o,L=u;;L+=u){var M=L<=i?1:L>=i+26?26:L-i;if(D<M)break;var F=D-M,z=u-M;t.push(g(w(M+F%z,0))),D=m(F/z)}t.push(g(w(D,0))),i=x(o,$,v==h),o=0,++v}}}catch(e){R=!0,j=e}finally{try{!C&&I.return&&I.return()}finally{if(R)throw j}}++o,++r}return t.join("")},O=function(e){return v(e,(function(e){return d.test(e)?"xn--"+_(e):e}))},S=function(e){return v(e,(function(e){return p.test(e)?k(e.slice(4).toLowerCase()):e}))},E={};function P(e){var t=e.charCodeAt(0);return t<16?"%0"+t.toString(16).toUpperCase():t<128?"%"+t.toString(16).toUpperCase():t<2048?"%"+(t>>6|192).toString(16).toUpperCase()+"%"+(63&t|128).toString(16).toUpperCase():"%"+(t>>12|224).toString(16).toUpperCase()+"%"+(t>>6&63|128).toString(16).toUpperCase()+"%"+(63&t|128).toString(16).toUpperCase()}function A(e){for(var t="",n=0,r=e.length;n<r;){var o=parseInt(e.substr(n+1,2),16);if(o<128)t+=String.fromCharCode(o),n+=3;else if(o>=194&&o<224){if(r-n>=6){var i=parseInt(e.substr(n+4,2),16);t+=String.fromCharCode((31&o)<<6|63&i)}else t+=e.substr(n,6);n+=6}else if(o>=224){if(r-n>=9){var a=parseInt(e.substr(n+4,2),16),s=parseInt(e.substr(n+7,2),16);t+=String.fromCharCode((15&o)<<12|(63&a)<<6|63&s)}else t+=e.substr(n,9);n+=9}else t+=e.substr(n,3),n+=3}return t}function $(e,t){function n(e){var n=A(e);return n.match(t.UNRESERVED)?n:e}return e.scheme&&(e.scheme=String(e.scheme).replace(t.PCT_ENCODED,n).toLowerCase().replace(t.NOT_SCHEME,"")),void 0!==e.userinfo&&(e.userinfo=String(e.userinfo).replace(t.PCT_ENCODED,n).replace(t.NOT_USERINFO,P).replace(t.PCT_ENCODED,o)),void 0!==e.host&&(e.host=String(e.host).replace(t.PCT_ENCODED,n).toLowerCase().replace(t.NOT_HOST,P).replace(t.PCT_ENCODED,o)),void 0!==e.path&&(e.path=String(e.path).replace(t.PCT_ENCODED,n).replace(e.scheme?t.NOT_PATH:t.NOT_PATH_NOSCHEME,P).replace(t.PCT_ENCODED,o)),void 0!==e.query&&(e.query=String(e.query).replace(t.PCT_ENCODED,n).replace(t.NOT_QUERY,P).replace(t.PCT_ENCODED,o)),void 0!==e.fragment&&(e.fragment=String(e.fragment).replace(t.PCT_ENCODED,n).replace(t.NOT_FRAGMENT,P).replace(t.PCT_ENCODED,o)),e}function C(e){return e.replace(/^0*(.*)/,"$1")||"0"}function R(e,t){var n=e.match(t.IPV4ADDRESS)||[],r=l(n,2)[1];return r?r.split(".").map(C).join("."):e}function j(e,t){var n=e.match(t.IPV6ADDRESS)||[],r=l(n,3),o=r[1],i=r[2];if(o){for(var a=o.toLowerCase().split("::").reverse(),s=l(a,2),c=s[0],u=s[1],p=u?u.split(":").map(C):[],d=c.split(":").map(C),f=t.IPV4ADDRESS.test(d[d.length-1]),h=f?7:8,m=d.length-h,g=Array(h),y=0;y<h;++y)g[y]=p[y]||d[m+y]||"";f&&(g[h-1]=R(g[h-1],t));var v=g.reduce((function(e,t,n){if(!t||"0"===t){var r=e[e.length-1];r&&r.index+r.length===n?r.length++:e.push({index:n,length:1})}return e}),[]).sort((function(e,t){return t.length-e.length}))[0],b=void 0;if(v&&v.length>1){var w=g.slice(0,v.index),x=g.slice(v.index+v.length);b=w.join(":")+"::"+x.join(":")}else b=g.join(":");return i&&(b+="%"+i),b}return e}var T=/^(?:([^:\/?#]+):)?(?:\/\/((?:([^\/?#@]*)@)?(\[[^\/?#\]]+\]|[^\/?#:]*)(?:\:(\d*))?))?([^?#]*)(?:\?([^#]*))?(?:#((?:.|\n|\r)*))?/i,I=void 0==="".match(/(){0}/)[1];function N(e){var t=arguments.length>1&&void 0!==arguments[1]?arguments[1]:{},n={},r=!1!==t.iri?s:a;"suffix"===t.reference&&(e=(t.scheme?t.scheme+":":"")+"//"+e);var o=e.match(T);if(o){I?(n.scheme=o[1],n.userinfo=o[3],n.host=o[4],n.port=parseInt(o[5],10),n.path=o[6]||"",n.query=o[7],n.fragment=o[8],isNaN(n.port)&&(n.port=o[5])):(n.scheme=o[1]||void 0,n.userinfo=-1!==e.indexOf("@")?o[3]:void 0,n.host=-1!==e.indexOf("//")?o[4]:void 0,n.port=parseInt(o[5],10),n.path=o[6]||"",n.query=-1!==e.indexOf("?")?o[7]:void 0,n.fragment=-1!==e.indexOf("#")?o[8]:void 0,isNaN(n.port)&&(n.port=e.match(/\/\/(?:.|\n)*\:(?:\/|\?|\#|$)/)?o[4]:void 0)),n.host&&(n.host=j(R(n.host,r),r)),void 0!==n.scheme||void 0!==n.userinfo||void 0!==n.host||void 0!==n.port||n.path||void 0!==n.query?void 0===n.scheme?n.reference="relative":void 0===n.fragment?n.reference="absolute":n.reference="uri":n.reference="same-document",t.reference&&"suffix"!==t.reference&&t.reference!==n.reference&&(n.error=n.error||"URI is not a "+t.reference+" reference.");var i=E[(t.scheme||n.scheme||"").toLowerCase()];if(t.unicodeSupport||i&&i.unicodeSupport)$(n,r);else{if(n.host&&(t.domainHost||i&&i.domainHost))try{n.host=O(n.host.replace(r.PCT_ENCODED,A).toLowerCase())}catch(e){n.error=n.error||"Host's domain name can not be converted to ASCII via punycode: "+e}$(n,a)}i&&i.parse&&i.parse(n,t)}else n.error=n.error||"URI can not be parsed.";return n}function D(e,t){var n=!1!==t.iri?s:a,r=[];return void 0!==e.userinfo&&(r.push(e.userinfo),r.push("@")),void 0!==e.host&&r.push(j(R(String(e.host),n),n).replace(n.IPV6ADDRESS,(function(e,t,n){return"["+t+(n?"%25"+n:"")+"]"}))),"number"!=typeof e.port&&"string"!=typeof e.port||(r.push(":"),r.push(String(e.port))),r.length?r.join(""):void 0}var L=/^\.\.?\//,M=/^\/\.(\/|$)/,F=/^\/\.\.(\/|$)/,z=/^\/?(?:.|\n)*?(?=\/|$)/;function U(e){for(var t=[];e.length;)if(e.match(L))e=e.replace(L,"");else if(e.match(M))e=e.replace(M,"/");else if(e.match(F))e=e.replace(F,"/"),t.pop();else if("."===e||".."===e)e="";else{var n=e.match(z);if(!n)throw new Error("Unexpected dot segment condition");var r=n[0];e=e.slice(r.length),t.push(r)}return t.join("")}function V(e){var t=arguments.length>1&&void 0!==arguments[1]?arguments[1]:{},n=t.iri?s:a,r=[],o=E[(t.scheme||e.scheme||"").toLowerCase()];if(o&&o.serialize&&o.serialize(e,t),e.host)if(n.IPV6ADDRESS.test(e.host));else if(t.domainHost||o&&o.domainHost)try{e.host=t.iri?S(e.host):O(e.host.replace(n.PCT_ENCODED,A).toLowerCase())}catch(n){e.error=e.error||"Host's domain name can not be converted to "+(t.iri?"Unicode":"ASCII")+" via punycode: "+n}$(e,n),"suffix"!==t.reference&&e.scheme&&(r.push(e.scheme),r.push(":"));var i=D(e,t);if(void 0!==i&&("suffix"!==t.reference&&r.push("//"),r.push(i),e.path&&"/"!==e.path.charAt(0)&&r.push("/")),void 0!==e.path){var l=e.path;t.absolutePath||o&&o.absolutePath||(l=U(l)),void 0===i&&(l=l.replace(/^\/\//,"/%2F")),r.push(l)}return void 0!==e.query&&(r.push("?"),r.push(e.query)),void 0!==e.fragment&&(r.push("#"),r.push(e.fragment)),r.join("")}function B(e,t){var n=arguments.length>2&&void 0!==arguments[2]?arguments[2]:{},r={};return arguments[3]||(e=N(V(e,n),n),t=N(V(t,n),n)),!(n=n||{}).tolerant&&t.scheme?(r.scheme=t.scheme,r.userinfo=t.userinfo,r.host=t.host,r.port=t.port,r.path=U(t.path||""),r.query=t.query):(void 0!==t.userinfo||void 0!==t.host||void 0!==t.port?(r.userinfo=t.userinfo,r.host=t.host,r.port=t.port,r.path=U(t.path||""),r.query=t.query):(t.path?("/"===t.path.charAt(0)?r.path=U(t.path):(void 0===e.userinfo&&void 0===e.host&&void 0===e.port||e.path?e.path?r.path=e.path.slice(0,e.path.lastIndexOf("/")+1)+t.path:r.path=t.path:r.path="/"+t.path,r.path=U(r.path)),r.query=t.query):(r.path=e.path,void 0!==t.query?r.query=t.query:r.query=e.query),r.userinfo=e.userinfo,r.host=e.host,r.port=e.port),r.scheme=e.scheme),r.fragment=t.fragment,r}function q(e,t){return e&&e.toString().replace(t&&t.iri?s.PCT_ENCODED:a.PCT_ENCODED,A)}var W={scheme:"http",domainHost:!0,parse:function(e,t){return e.host||(e.error=e.error||"HTTP URIs must have a host."),e},serialize:function(e,t){var n="https"===String(e.scheme).toLowerCase();return e.port!==(n?443:80)&&""!==e.port||(e.port=void 0),e.path||(e.path="/"),e}},H={scheme:"https",domainHost:W.domainHost,parse:W.parse,serialize:W.serialize};function Y(e){return"boolean"==typeof e.secure?e.secure:"wss"===String(e.scheme).toLowerCase()}var K={scheme:"ws",domainHost:!0,parse:function(e,t){var n=e;return n.secure=Y(n),n.resourceName=(n.path||"/")+(n.query?"?"+n.query:""),n.path=void 0,n.query=void 0,n},serialize:function(e,t){if(e.port!==(Y(e)?443:80)&&""!==e.port||(e.port=void 0),"boolean"==typeof e.secure&&(e.scheme=e.secure?"wss":"ws",e.secure=void 0),e.resourceName){var n=e.resourceName.split("?"),r=l(n,2),o=r[0],i=r[1];e.path=o&&"/"!==o?o:void 0,e.query=i,e.resourceName=void 0}return e.fragment=void 0,e}},G={scheme:"wss",domainHost:K.domainHost,parse:K.parse,serialize:K.serialize},Q={},X="[A-Za-z0-9\\-\\.\\_\\~\\xA0-\\u200D\\u2010-\\u2029\\u202F-\\uD7FF\\uF900-\\uFDCF\\uFDF0-\\uFFEF]",J="[0-9A-Fa-f]",Z=n(n("%[EFef][0-9A-Fa-f]%"+J+J+"%"+J+J)+"|"+n("%[89A-Fa-f][0-9A-Fa-f]%"+J+J)+"|"+n("%"+J+J)),ee=t("[\\!\\$\\%\\'\\(\\)\\*\\+\\,\\-\\.0-9\\<\\>A-Z\\x5E-\\x7E]",'[\\"\\\\]'),te=new RegExp(X,"g"),ne=new RegExp(Z,"g"),re=new RegExp(t("[^]","[A-Za-z0-9\\!\\$\\%\\'\\*\\+\\-\\^\\_\\`\\{\\|\\}\\~]","[\\.]",'[\\"]',ee),"g"),oe=new RegExp(t("[^]",X,"[\\!\\$\\'\\(\\)\\*\\+\\,\\;\\:\\@]"),"g"),ie=oe;function ae(e){var t=A(e);return t.match(te)?t:e}var se={scheme:"mailto",parse:function(e,t){var n=e,r=n.to=n.path?n.path.split(","):[];if(n.path=void 0,n.query){for(var o=!1,i={},a=n.query.split("&"),s=0,l=a.length;s<l;++s){var c=a[s].split("=");switch(c[0]){case"to":for(var u=c[1].split(","),p=0,d=u.length;p<d;++p)r.push(u[p]);break;case"subject":n.subject=q(c[1],t);break;case"body":n.body=q(c[1],t);break;default:o=!0,i[q(c[0],t)]=q(c[1],t)}}o&&(n.headers=i)}n.query=void 0;for(var f=0,h=r.length;f<h;++f){var m=r[f].split("@");if(m[0]=q(m[0]),t.unicodeSupport)m[1]=q(m[1],t).toLowerCase();else try{m[1]=O(q(m[1],t).toLowerCase())}catch(e){n.error=n.error||"Email address's domain name can not be converted to ASCII via punycode: "+e}r[f]=m.join("@")}return n},serialize:function(e,t){var n,r=e,i=null!=(n=e.to)?n instanceof Array?n:"number"!=typeof n.length||n.split||n.setInterval||n.call?[n]:Array.prototype.slice.call(n):[];if(i){for(var a=0,s=i.length;a<s;++a){var l=String(i[a]),c=l.lastIndexOf("@"),u=l.slice(0,c).replace(ne,ae).replace(ne,o).replace(re,P),p=l.slice(c+1);try{p=t.iri?S(p):O(q(p,t).toLowerCase())}catch(e){r.error=r.error||"Email address's domain name can not be converted to "+(t.iri?"Unicode":"ASCII")+" via punycode: "+e}i[a]=u+"@"+p}r.path=i.join(",")}var d=e.headers=e.headers||{};e.subject&&(d.subject=e.subject),e.body&&(d.body=e.body);var f=[];for(var h in d)d[h]!==Q[h]&&f.push(h.replace(ne,ae).replace(ne,o).replace(oe,P)+"="+d[h].replace(ne,ae).replace(ne,o).replace(ie,P));return f.length&&(r.query=f.join("&")),r}},le=/^([^\:]+)\:(.*)/,ce={scheme:"urn",parse:function(e,t){var n=e.path&&e.path.match(le),r=e;if(n){var o=t.scheme||r.scheme||"urn",i=n[1].toLowerCase(),a=n[2],s=o+":"+(t.nid||i),l=E[s];r.nid=i,r.nss=a,r.path=void 0,l&&(r=l.parse(r,t))}else r.error=r.error||"URN can not be parsed.";return r},serialize:function(e,t){var n=t.scheme||e.scheme||"urn",r=e.nid,o=n+":"+(t.nid||r),i=E[o];i&&(e=i.serialize(e,t));var a=e,s=e.nss;return a.path=(r||t.nid)+":"+s,a}},ue=/^[0-9A-Fa-f]{8}(?:\-[0-9A-Fa-f]{4}){3}\-[0-9A-Fa-f]{12}$/,pe={scheme:"urn:uuid",parse:function(e,t){var n=e;return n.uuid=n.nss,n.nss=void 0,t.tolerant||n.uuid&&n.uuid.match(ue)||(n.error=n.error||"UUID is not valid."),n},serialize:function(e,t){var n=e;return n.nss=(e.uuid||"").toLowerCase(),n}};E[W.scheme]=W,E[H.scheme]=H,E[K.scheme]=K,E[G.scheme]=G,E[se.scheme]=se,E[ce.scheme]=ce,E[pe.scheme]=pe,e.SCHEMES=E,e.pctEncChar=P,e.pctDecChars=A,e.parse=N,e.removeDotSegments=U,e.serialize=V,e.resolveComponents=B,e.resolve=function(e,t,n){var r=function(e,t){var n=e;if(t)for(var r in t)n[r]=t[r];return n}({scheme:"null"},n);return V(B(N(e,r),N(t,r),r,!0),r)},e.normalize=function(e,t){return"string"==typeof e?e=V(N(e,t),t):"object"===r(e)&&(e=N(V(e,t),t)),e},e.equal=function(e,t,n){return"string"==typeof e?e=V(N(e,n),n):"object"===r(e)&&(e=V(e,n)),"string"==typeof t?t=V(N(t,n),n):"object"===r(t)&&(t=V(t,n)),e===t},e.escapeComponent=function(e,t){return e&&e.toString().replace(t&&t.iri?s.ESCAPE:a.ESCAPE,P)},e.unescapeComponent=q,Object.defineProperty(e,"__esModule",{value:!0})}(t)},3578:function(e){e.exports=function(){function e(){}return e.prototype.encodeReserved=function(e){return e.split(/(%[0-9A-Fa-f]{2})/g).map((function(e){return/%[0-9A-Fa-f]/.test(e)||(e=encodeURI(e).replace(/%5B/g,"[").replace(/%5D/g,"]")),e})).join("")},e.prototype.encodeUnreserved=function(e){return encodeURIComponent(e).replace(/[!'()*]/g,(function(e){return"%"+e.charCodeAt(0).toString(16).toUpperCase()}))},e.prototype.encodeValue=function(e,t,n){return t="+"===e||"#"===e?this.encodeReserved(t):this.encodeUnreserved(t),n?this.encodeUnreserved(n)+"="+t:t},e.prototype.isDefined=function(e){return null!=e},e.prototype.isKeyOperator=function(e){return";"===e||"&"===e||"?"===e},e.prototype.getValues=function(e,t,n,r){var o=e[n],i=[];if(this.isDefined(o)&&""!==o)if("string"==typeof o||"number"==typeof o||"boolean"==typeof o)o=o.toString(),r&&"*"!==r&&(o=o.substring(0,parseInt(r,10))),i.push(this.encodeValue(t,o,this.isKeyOperator(t)?n:null));else if("*"===r)Array.isArray(o)?o.filter(this.isDefined).forEach((function(e){i.push(this.encodeValue(t,e,this.isKeyOperator(t)?n:null))}),this):Object.keys(o).forEach((function(e){this.isDefined(o[e])&&i.push(this.encodeValue(t,o[e],e))}),this);else{var a=[];Array.isArray(o)?o.filter(this.isDefined).forEach((function(e){a.push(this.encodeValue(t,e))}),this):Object.keys(o).forEach((function(e){this.isDefined(o[e])&&(a.push(this.encodeUnreserved(e)),a.push(this.encodeValue(t,o[e].toString())))}),this),this.isKeyOperator(t)?i.push(this.encodeUnreserved(n)+"="+a.join(",")):0!==a.length&&i.push(a.join(","))}else";"===t?this.isDefined(o)&&i.push(this.encodeUnreserved(n)):""!==o||"&"!==t&&"?"!==t?""===o&&i.push(""):i.push(this.encodeUnreserved(n)+"=");return i},e.prototype.parse=function(e){var t=this,n=["+","#",".","/",";","?","&"];return{expand:function(r){return e.replace(/\{([^\{\}]+)\}|([^\{\}]+)/g,(function(e,o,i){if(o){var a=null,s=[];if(-1!==n.indexOf(o.charAt(0))&&(a=o.charAt(0),o=o.substr(1)),o.split(/,/g).forEach((function(e){var n=/([^:\*]*)(?::(\d+)|(\*))?/.exec(e);s.push.apply(s,t.getValues(r,a,n[1],n[2]||n[3]))})),a&&"+"!==a){var l=",";return"?"===a?l="&":"#"!==a&&(l=a),(0!==s.length?a:"")+s.join(l)}return s.join(",")}return t.encodeReserved(i)}))}}},new e}()},6980:function(e,t,n){var r=n(6314),o=["add","done","toJS","fromExternalJS","load","dispose","search","Worker"];e.exports=function(){var e=new Worker(URL.createObjectURL(new Blob(['/*! For license information please see 0a6ad30060afff00cb34.worker.js.LICENSE.txt */\n!function(){var e={336:function(e,t,r){var n,i;!function(){var s,o,a,u,l,c,h,d,f,p,y,m,g,x,v,w,Q,k,S,E,L,P,b,T,O,I,R=function(e){var t=new R.Builder;return t.pipeline.add(R.trimmer,R.stopWordFilter,R.stemmer),t.searchPipeline.add(R.stemmer),e.call(t,t),t.build()};R.version="2.3.9",R.utils={},R.utils.warn=(s=this,function(e){s.console&&console.warn&&console.warn(e)}),R.utils.asString=function(e){return null==e?"":e.toString()},R.utils.clone=function(e){if(null==e)return e;for(var t=Object.create(null),r=Object.keys(e),n=0;n<r.length;n++){var i=r[n],s=e[i];if(Array.isArray(s))t[i]=s.slice();else{if("string"!=typeof s&&"number"!=typeof s&&"boolean"!=typeof s)throw new TypeError("clone is not deep and does not support nested objects");t[i]=s}}return t},R.FieldRef=function(e,t,r){this.docRef=e,this.fieldName=t,this._stringValue=r},R.FieldRef.joiner="/",R.FieldRef.fromString=function(e){var t=e.indexOf(R.FieldRef.joiner);if(-1===t)throw"malformed field ref string";var r=e.slice(0,t),n=e.slice(t+1);return new R.FieldRef(n,r,e)},R.FieldRef.prototype.toString=function(){return null==this._stringValue&&(this._stringValue=this.fieldName+R.FieldRef.joiner+this.docRef),this._stringValue},R.Set=function(e){if(this.elements=Object.create(null),e){this.length=e.length;for(var t=0;t<this.length;t++)this.elements[e[t]]=!0}else this.length=0},R.Set.complete={intersect:function(e){return e},union:function(){return this},contains:function(){return!0}},R.Set.empty={intersect:function(){return this},union:function(e){return e},contains:function(){return!1}},R.Set.prototype.contains=function(e){return!!this.elements[e]},R.Set.prototype.intersect=function(e){var t,r,n,i=[];if(e===R.Set.complete)return this;if(e===R.Set.empty)return e;this.length<e.length?(t=this,r=e):(t=e,r=this),n=Object.keys(t.elements);for(var s=0;s<n.length;s++){var o=n[s];o in r.elements&&i.push(o)}return new R.Set(i)},R.Set.prototype.union=function(e){return e===R.Set.complete?R.Set.complete:e===R.Set.empty?this:new R.Set(Object.keys(this.elements).concat(Object.keys(e.elements)))},R.idf=function(e,t){var r=0;for(var n in e)"_index"!=n&&(r+=Object.keys(e[n]).length);var i=(t-r+.5)/(r+.5);return Math.log(1+Math.abs(i))},R.Token=function(e,t){this.str=e||"",this.metadata=t||{}},R.Token.prototype.toString=function(){return this.str},R.Token.prototype.update=function(e){return this.str=e(this.str,this.metadata),this},R.Token.prototype.clone=function(e){return e=e||function(e){return e},new R.Token(e(this.str,this.metadata),this.metadata)},R.tokenizer=function(e,t){if(null==e||null==e)return[];if(Array.isArray(e))return e.map((function(e){return new R.Token(R.utils.asString(e).toLowerCase(),R.utils.clone(t))}));for(var r=e.toString().toLowerCase(),n=r.length,i=[],s=0,o=0;s<=n;s++){var a=s-o;if(r.charAt(s).match(R.tokenizer.separator)||s==n){if(a>0){var u=R.utils.clone(t)||{};u.position=[o,a],u.index=i.length,i.push(new R.Token(r.slice(o,s),u))}o=s+1}}return i},R.tokenizer.separator=/[\\s\\-]+/,R.Pipeline=function(){this._stack=[]},R.Pipeline.registeredFunctions=Object.create(null),R.Pipeline.registerFunction=function(e,t){t in this.registeredFunctions&&R.utils.warn("Overwriting existing registered function: "+t),e.label=t,R.Pipeline.registeredFunctions[e.label]=e},R.Pipeline.warnIfFunctionNotRegistered=function(e){e.label&&e.label in this.registeredFunctions||R.utils.warn("Function is not registered with pipeline. This may cause problems when serialising the index.\\n",e)},R.Pipeline.load=function(e){var t=new R.Pipeline;return e.forEach((function(e){var r=R.Pipeline.registeredFunctions[e];if(!r)throw new Error("Cannot load unregistered function: "+e);t.add(r)})),t},R.Pipeline.prototype.add=function(){var e=Array.prototype.slice.call(arguments);e.forEach((function(e){R.Pipeline.warnIfFunctionNotRegistered(e),this._stack.push(e)}),this)},R.Pipeline.prototype.after=function(e,t){R.Pipeline.warnIfFunctionNotRegistered(t);var r=this._stack.indexOf(e);if(-1==r)throw new Error("Cannot find existingFn");r+=1,this._stack.splice(r,0,t)},R.Pipeline.prototype.before=function(e,t){R.Pipeline.warnIfFunctionNotRegistered(t);var r=this._stack.indexOf(e);if(-1==r)throw new Error("Cannot find existingFn");this._stack.splice(r,0,t)},R.Pipeline.prototype.remove=function(e){var t=this._stack.indexOf(e);-1!=t&&this._stack.splice(t,1)},R.Pipeline.prototype.run=function(e){for(var t=this._stack.length,r=0;r<t;r++){for(var n=this._stack[r],i=[],s=0;s<e.length;s++){var o=n(e[s],s,e);if(null!=o&&""!==o)if(Array.isArray(o))for(var a=0;a<o.length;a++)i.push(o[a]);else i.push(o)}e=i}return e},R.Pipeline.prototype.runString=function(e,t){var r=new R.Token(e,t);return this.run([r]).map((function(e){return e.toString()}))},R.Pipeline.prototype.reset=function(){this._stack=[]},R.Pipeline.prototype.toJSON=function(){return this._stack.map((function(e){return R.Pipeline.warnIfFunctionNotRegistered(e),e.label}))},R.Vector=function(e){this._magnitude=0,this.elements=e||[]},R.Vector.prototype.positionForIndex=function(e){if(0==this.elements.length)return 0;for(var t=0,r=this.elements.length/2,n=r-t,i=Math.floor(n/2),s=this.elements[2*i];n>1&&(s<e&&(t=i),s>e&&(r=i),s!=e);)n=r-t,i=t+Math.floor(n/2),s=this.elements[2*i];return s==e||s>e?2*i:s<e?2*(i+1):void 0},R.Vector.prototype.insert=function(e,t){this.upsert(e,t,(function(){throw"duplicate index"}))},R.Vector.prototype.upsert=function(e,t,r){this._magnitude=0;var n=this.positionForIndex(e);this.elements[n]==e?this.elements[n+1]=r(this.elements[n+1],t):this.elements.splice(n,0,e,t)},R.Vector.prototype.magnitude=function(){if(this._magnitude)return this._magnitude;for(var e=0,t=this.elements.length,r=1;r<t;r+=2){var n=this.elements[r];e+=n*n}return this._magnitude=Math.sqrt(e)},R.Vector.prototype.dot=function(e){for(var t=0,r=this.elements,n=e.elements,i=r.length,s=n.length,o=0,a=0,u=0,l=0;u<i&&l<s;)(o=r[u])<(a=n[l])?u+=2:o>a?l+=2:o==a&&(t+=r[u+1]*n[l+1],u+=2,l+=2);return t},R.Vector.prototype.similarity=function(e){return this.dot(e)/this.magnitude()||0},R.Vector.prototype.toArray=function(){for(var e=new Array(this.elements.length/2),t=1,r=0;t<this.elements.length;t+=2,r++)e[r]=this.elements[t];return e},R.Vector.prototype.toJSON=function(){return this.elements},R.stemmer=(o={ational:"ate",tional:"tion",enci:"ence",anci:"ance",izer:"ize",bli:"ble",alli:"al",entli:"ent",eli:"e",ousli:"ous",ization:"ize",ation:"ate",ator:"ate",alism:"al",iveness:"ive",fulness:"ful",ousness:"ous",aliti:"al",iviti:"ive",biliti:"ble",logi:"log"},a={icate:"ic",ative:"",alize:"al",iciti:"ic",ical:"ic",ful:"",ness:""},u="[aeiouy]",l="[^aeiou][^aeiouy]*",c=new RegExp("^([^aeiou][^aeiouy]*)?[aeiouy][aeiou]*[^aeiou][^aeiouy]*"),h=new RegExp("^([^aeiou][^aeiouy]*)?[aeiouy][aeiou]*[^aeiou][^aeiouy]*[aeiouy][aeiou]*[^aeiou][^aeiouy]*"),d=new RegExp("^([^aeiou][^aeiouy]*)?[aeiouy][aeiou]*[^aeiou][^aeiouy]*([aeiouy][aeiou]*)?$"),f=new RegExp("^([^aeiou][^aeiouy]*)?[aeiouy]"),p=/^(.+?)(ss|i)es$/,y=/^(.+?)([^s])s$/,m=/^(.+?)eed$/,g=/^(.+?)(ed|ing)$/,x=/.$/,v=/(at|bl|iz)$/,w=new RegExp("([^aeiouylsz])\\\\1$"),Q=new RegExp("^"+l+u+"[^aeiouwxy]$"),k=/^(.+?[^aeiou])y$/,S=/^(.+?)(ational|tional|enci|anci|izer|bli|alli|entli|eli|ousli|ization|ation|ator|alism|iveness|fulness|ousness|aliti|iviti|biliti|logi)$/,E=/^(.+?)(icate|ative|alize|iciti|ical|ful|ness)$/,L=/^(.+?)(al|ance|ence|er|ic|able|ible|ant|ement|ment|ent|ou|ism|ate|iti|ous|ive|ize)$/,P=/^(.+?)(s|t)(ion)$/,b=/^(.+?)e$/,T=/ll$/,O=new RegExp("^"+l+u+"[^aeiouwxy]$"),I=function(e){var t,r,n,i,s,u,l;if(e.length<3)return e;if("y"==(n=e.substr(0,1))&&(e=n.toUpperCase()+e.substr(1)),s=y,(i=p).test(e)?e=e.replace(i,"$1$2"):s.test(e)&&(e=e.replace(s,"$1$2")),s=g,(i=m).test(e)){var I=i.exec(e);(i=c).test(I[1])&&(i=x,e=e.replace(i,""))}else s.test(e)&&(t=(I=s.exec(e))[1],(s=f).test(t)&&(u=w,l=Q,(s=v).test(e=t)?e+="e":u.test(e)?(i=x,e=e.replace(i,"")):l.test(e)&&(e+="e")));return(i=k).test(e)&&(e=(t=(I=i.exec(e))[1])+"i"),(i=S).test(e)&&(t=(I=i.exec(e))[1],r=I[2],(i=c).test(t)&&(e=t+o[r])),(i=E).test(e)&&(t=(I=i.exec(e))[1],r=I[2],(i=c).test(t)&&(e=t+a[r])),s=P,(i=L).test(e)?(t=(I=i.exec(e))[1],(i=h).test(t)&&(e=t)):s.test(e)&&(t=(I=s.exec(e))[1]+I[2],(s=h).test(t)&&(e=t)),(i=b).test(e)&&(t=(I=i.exec(e))[1],s=d,u=O,((i=h).test(t)||s.test(t)&&!u.test(t))&&(e=t)),s=h,(i=T).test(e)&&s.test(e)&&(i=x,e=e.replace(i,"")),"y"==n&&(e=n.toLowerCase()+e.substr(1)),e},function(e){return e.update(I)}),R.Pipeline.registerFunction(R.stemmer,"stemmer"),R.generateStopWordFilter=function(e){var t=e.reduce((function(e,t){return e[t]=t,e}),{});return function(e){if(e&&t[e.toString()]!==e.toString())return e}},R.stopWordFilter=R.generateStopWordFilter(["a","able","about","across","after","all","almost","also","am","among","an","and","any","are","as","at","be","because","been","but","by","can","cannot","could","dear","did","do","does","either","else","ever","every","for","from","get","got","had","has","have","he","her","hers","him","his","how","however","i","if","in","into","is","it","its","just","least","let","like","likely","may","me","might","most","must","my","neither","no","nor","not","of","off","often","on","only","or","other","our","own","rather","said","say","says","she","should","since","so","some","than","that","the","their","them","then","there","these","they","this","tis","to","too","twas","us","wants","was","we","were","what","when","where","which","while","who","whom","why","will","with","would","yet","you","your"]),R.Pipeline.registerFunction(R.stopWordFilter,"stopWordFilter"),R.trimmer=function(e){return e.update((function(e){return e.replace(/^\\W+/,"").replace(/\\W+$/,"")}))},R.Pipeline.registerFunction(R.trimmer,"trimmer"),R.TokenSet=function(){this.final=!1,this.edges={},this.id=R.TokenSet._nextId,R.TokenSet._nextId+=1},R.TokenSet._nextId=1,R.TokenSet.fromArray=function(e){for(var t=new R.TokenSet.Builder,r=0,n=e.length;r<n;r++)t.insert(e[r]);return t.finish(),t.root},R.TokenSet.fromClause=function(e){return"editDistance"in e?R.TokenSet.fromFuzzyString(e.term,e.editDistance):R.TokenSet.fromString(e.term)},R.TokenSet.fromFuzzyString=function(e,t){for(var r=new R.TokenSet,n=[{node:r,editsRemaining:t,str:e}];n.length;){var i=n.pop();if(i.str.length>0){var s,o=i.str.charAt(0);o in i.node.edges?s=i.node.edges[o]:(s=new R.TokenSet,i.node.edges[o]=s),1==i.str.length&&(s.final=!0),n.push({node:s,editsRemaining:i.editsRemaining,str:i.str.slice(1)})}if(0!=i.editsRemaining){if("*"in i.node.edges)var a=i.node.edges["*"];else a=new R.TokenSet,i.node.edges["*"]=a;if(0==i.str.length&&(a.final=!0),n.push({node:a,editsRemaining:i.editsRemaining-1,str:i.str}),i.str.length>1&&n.push({node:i.node,editsRemaining:i.editsRemaining-1,str:i.str.slice(1)}),1==i.str.length&&(i.node.final=!0),i.str.length>=1){if("*"in i.node.edges)var u=i.node.edges["*"];else u=new R.TokenSet,i.node.edges["*"]=u;1==i.str.length&&(u.final=!0),n.push({node:u,editsRemaining:i.editsRemaining-1,str:i.str.slice(1)})}if(i.str.length>1){var l,c=i.str.charAt(0),h=i.str.charAt(1);h in i.node.edges?l=i.node.edges[h]:(l=new R.TokenSet,i.node.edges[h]=l),1==i.str.length&&(l.final=!0),n.push({node:l,editsRemaining:i.editsRemaining-1,str:c+i.str.slice(2)})}}}return r},R.TokenSet.fromString=function(e){for(var t=new R.TokenSet,r=t,n=0,i=e.length;n<i;n++){var s=e[n],o=n==i-1;if("*"==s)t.edges[s]=t,t.final=o;else{var a=new R.TokenSet;a.final=o,t.edges[s]=a,t=a}}return r},R.TokenSet.prototype.toArray=function(){for(var e=[],t=[{prefix:"",node:this}];t.length;){var r=t.pop(),n=Object.keys(r.node.edges),i=n.length;r.node.final&&(r.prefix.charAt(0),e.push(r.prefix));for(var s=0;s<i;s++){var o=n[s];t.push({prefix:r.prefix.concat(o),node:r.node.edges[o]})}}return e},R.TokenSet.prototype.toString=function(){if(this._str)return this._str;for(var e=this.final?"1":"0",t=Object.keys(this.edges).sort(),r=t.length,n=0;n<r;n++){var i=t[n];e=e+i+this.edges[i].id}return e},R.TokenSet.prototype.intersect=function(e){for(var t=new R.TokenSet,r=void 0,n=[{qNode:e,output:t,node:this}];n.length;){r=n.pop();for(var i=Object.keys(r.qNode.edges),s=i.length,o=Object.keys(r.node.edges),a=o.length,u=0;u<s;u++)for(var l=i[u],c=0;c<a;c++){var h=o[c];if(h==l||"*"==l){var d=r.node.edges[h],f=r.qNode.edges[l],p=d.final&&f.final,y=void 0;h in r.output.edges?(y=r.output.edges[h]).final=y.final||p:((y=new R.TokenSet).final=p,r.output.edges[h]=y),n.push({qNode:f,output:y,node:d})}}}return t},R.TokenSet.Builder=function(){this.previousWord="",this.root=new R.TokenSet,this.uncheckedNodes=[],this.minimizedNodes={}},R.TokenSet.Builder.prototype.insert=function(e){var t,r=0;if(e<this.previousWord)throw new Error("Out of order word insertion");for(var n=0;n<e.length&&n<this.previousWord.length&&e[n]==this.previousWord[n];n++)r++;for(this.minimize(r),t=0==this.uncheckedNodes.length?this.root:this.uncheckedNodes[this.uncheckedNodes.length-1].child,n=r;n<e.length;n++){var i=new R.TokenSet,s=e[n];t.edges[s]=i,this.uncheckedNodes.push({parent:t,char:s,child:i}),t=i}t.final=!0,this.previousWord=e},R.TokenSet.Builder.prototype.finish=function(){this.minimize(0)},R.TokenSet.Builder.prototype.minimize=function(e){for(var t=this.uncheckedNodes.length-1;t>=e;t--){var r=this.uncheckedNodes[t],n=r.child.toString();n in this.minimizedNodes?r.parent.edges[r.char]=this.minimizedNodes[n]:(r.child._str=n,this.minimizedNodes[n]=r.child),this.uncheckedNodes.pop()}},R.Index=function(e){this.invertedIndex=e.invertedIndex,this.fieldVectors=e.fieldVectors,this.tokenSet=e.tokenSet,this.fields=e.fields,this.pipeline=e.pipeline},R.Index.prototype.search=function(e){return this.query((function(t){new R.QueryParser(e,t).parse()}))},R.Index.prototype.query=function(e){for(var t=new R.Query(this.fields),r=Object.create(null),n=Object.create(null),i=Object.create(null),s=Object.create(null),o=Object.create(null),a=0;a<this.fields.length;a++)n[this.fields[a]]=new R.Vector;for(e.call(t,t),a=0;a<t.clauses.length;a++){var u,l=t.clauses[a],c=R.Set.empty;u=l.usePipeline?this.pipeline.runString(l.term,{fields:l.fields}):[l.term];for(var h=0;h<u.length;h++){var d=u[h];l.term=d;var f=R.TokenSet.fromClause(l),p=this.tokenSet.intersect(f).toArray();if(0===p.length&&l.presence===R.Query.presence.REQUIRED){for(var y=0;y<l.fields.length;y++)s[F=l.fields[y]]=R.Set.empty;break}for(var m=0;m<p.length;m++){var g=p[m],x=this.invertedIndex[g],v=x._index;for(y=0;y<l.fields.length;y++){var w=x[F=l.fields[y]],Q=Object.keys(w),k=g+"/"+F,S=new R.Set(Q);if(l.presence==R.Query.presence.REQUIRED&&(c=c.union(S),void 0===s[F]&&(s[F]=R.Set.complete)),l.presence!=R.Query.presence.PROHIBITED){if(n[F].upsert(v,l.boost,(function(e,t){return e+t})),!i[k]){for(var E=0;E<Q.length;E++){var L,P=Q[E],b=new R.FieldRef(P,F),T=w[P];void 0===(L=r[b])?r[b]=new R.MatchData(g,F,T):L.add(g,F,T)}i[k]=!0}}else void 0===o[F]&&(o[F]=R.Set.empty),o[F]=o[F].union(S)}}}if(l.presence===R.Query.presence.REQUIRED)for(y=0;y<l.fields.length;y++)s[F=l.fields[y]]=s[F].intersect(c)}var O=R.Set.complete,I=R.Set.empty;for(a=0;a<this.fields.length;a++){var F;s[F=this.fields[a]]&&(O=O.intersect(s[F])),o[F]&&(I=I.union(o[F]))}var C=Object.keys(r),N=[],j=Object.create(null);if(t.isNegated())for(C=Object.keys(this.fieldVectors),a=0;a<C.length;a++){b=C[a];var _=R.FieldRef.fromString(b);r[b]=new R.MatchData}for(a=0;a<C.length;a++){var D=(_=R.FieldRef.fromString(C[a])).docRef;if(O.contains(D)&&!I.contains(D)){var A,B=this.fieldVectors[_],z=n[_.fieldName].similarity(B);if(void 0!==(A=j[D]))A.score+=z,A.matchData.combine(r[_]);else{var V={ref:D,score:z,matchData:r[_]};j[D]=V,N.push(V)}}}return N.sort((function(e,t){return t.score-e.score}))},R.Index.prototype.toJSON=function(){var e=Object.keys(this.invertedIndex).sort().map((function(e){return[e,this.invertedIndex[e]]}),this),t=Object.keys(this.fieldVectors).map((function(e){return[e,this.fieldVectors[e].toJSON()]}),this);return{version:R.version,fields:this.fields,fieldVectors:t,invertedIndex:e,pipeline:this.pipeline.toJSON()}},R.Index.load=function(e){var t={},r={},n=e.fieldVectors,i=Object.create(null),s=e.invertedIndex,o=new R.TokenSet.Builder,a=R.Pipeline.load(e.pipeline);e.version!=R.version&&R.utils.warn("Version mismatch when loading serialised index. Current version of lunr \'"+R.version+"\' does not match serialized index \'"+e.version+"\'");for(var u=0;u<n.length;u++){var l=(h=n[u])[0],c=h[1];r[l]=new R.Vector(c)}for(u=0;u<s.length;u++){var h,d=(h=s[u])[0],f=h[1];o.insert(d),i[d]=f}return o.finish(),t.fields=e.fields,t.fieldVectors=r,t.invertedIndex=i,t.tokenSet=o.root,t.pipeline=a,new R.Index(t)},R.Builder=function(){this._ref="id",this._fields=Object.create(null),this._documents=Object.create(null),this.invertedIndex=Object.create(null),this.fieldTermFrequencies={},this.fieldLengths={},this.tokenizer=R.tokenizer,this.pipeline=new R.Pipeline,this.searchPipeline=new R.Pipeline,this.documentCount=0,this._b=.75,this._k1=1.2,this.termIndex=0,this.metadataWhitelist=[]},R.Builder.prototype.ref=function(e){this._ref=e},R.Builder.prototype.field=function(e,t){if(/\\//.test(e))throw new RangeError("Field \'"+e+"\' contains illegal character \'/\'");this._fields[e]=t||{}},R.Builder.prototype.b=function(e){this._b=e<0?0:e>1?1:e},R.Builder.prototype.k1=function(e){this._k1=e},R.Builder.prototype.add=function(e,t){var r=e[this._ref],n=Object.keys(this._fields);this._documents[r]=t||{},this.documentCount+=1;for(var i=0;i<n.length;i++){var s=n[i],o=this._fields[s].extractor,a=o?o(e):e[s],u=this.tokenizer(a,{fields:[s]}),l=this.pipeline.run(u),c=new R.FieldRef(r,s),h=Object.create(null);this.fieldTermFrequencies[c]=h,this.fieldLengths[c]=0,this.fieldLengths[c]+=l.length;for(var d=0;d<l.length;d++){var f=l[d];if(null==h[f]&&(h[f]=0),h[f]+=1,null==this.invertedIndex[f]){var p=Object.create(null);p._index=this.termIndex,this.termIndex+=1;for(var y=0;y<n.length;y++)p[n[y]]=Object.create(null);this.invertedIndex[f]=p}null==this.invertedIndex[f][s][r]&&(this.invertedIndex[f][s][r]=Object.create(null));for(var m=0;m<this.metadataWhitelist.length;m++){var g=this.metadataWhitelist[m],x=f.metadata[g];null==this.invertedIndex[f][s][r][g]&&(this.invertedIndex[f][s][r][g]=[]),this.invertedIndex[f][s][r][g].push(x)}}}},R.Builder.prototype.calculateAverageFieldLengths=function(){for(var e=Object.keys(this.fieldLengths),t=e.length,r={},n={},i=0;i<t;i++){var s=R.FieldRef.fromString(e[i]),o=s.fieldName;n[o]||(n[o]=0),n[o]+=1,r[o]||(r[o]=0),r[o]+=this.fieldLengths[s]}var a=Object.keys(this._fields);for(i=0;i<a.length;i++){var u=a[i];r[u]=r[u]/n[u]}this.averageFieldLength=r},R.Builder.prototype.createFieldVectors=function(){for(var e={},t=Object.keys(this.fieldTermFrequencies),r=t.length,n=Object.create(null),i=0;i<r;i++){for(var s=R.FieldRef.fromString(t[i]),o=s.fieldName,a=this.fieldLengths[s],u=new R.Vector,l=this.fieldTermFrequencies[s],c=Object.keys(l),h=c.length,d=this._fields[o].boost||1,f=this._documents[s.docRef].boost||1,p=0;p<h;p++){var y,m,g,x=c[p],v=l[x],w=this.invertedIndex[x]._index;void 0===n[x]?(y=R.idf(this.invertedIndex[x],this.documentCount),n[x]=y):y=n[x],m=y*((this._k1+1)*v)/(this._k1*(1-this._b+this._b*(a/this.averageFieldLength[o]))+v),m*=d,m*=f,g=Math.round(1e3*m)/1e3,u.insert(w,g)}e[s]=u}this.fieldVectors=e},R.Builder.prototype.createTokenSet=function(){this.tokenSet=R.TokenSet.fromArray(Object.keys(this.invertedIndex).sort())},R.Builder.prototype.build=function(){return this.calculateAverageFieldLengths(),this.createFieldVectors(),this.createTokenSet(),new R.Index({invertedIndex:this.invertedIndex,fieldVectors:this.fieldVectors,tokenSet:this.tokenSet,fields:Object.keys(this._fields),pipeline:this.searchPipeline})},R.Builder.prototype.use=function(e){var t=Array.prototype.slice.call(arguments,1);t.unshift(this),e.apply(this,t)},R.MatchData=function(e,t,r){for(var n=Object.create(null),i=Object.keys(r||{}),s=0;s<i.length;s++){var o=i[s];n[o]=r[o].slice()}this.metadata=Object.create(null),void 0!==e&&(this.metadata[e]=Object.create(null),this.metadata[e][t]=n)},R.MatchData.prototype.combine=function(e){for(var t=Object.keys(e.metadata),r=0;r<t.length;r++){var n=t[r],i=Object.keys(e.metadata[n]);null==this.metadata[n]&&(this.metadata[n]=Object.create(null));for(var s=0;s<i.length;s++){var o=i[s],a=Object.keys(e.metadata[n][o]);null==this.metadata[n][o]&&(this.metadata[n][o]=Object.create(null));for(var u=0;u<a.length;u++){var l=a[u];null==this.metadata[n][o][l]?this.metadata[n][o][l]=e.metadata[n][o][l]:this.metadata[n][o][l]=this.metadata[n][o][l].concat(e.metadata[n][o][l])}}}},R.MatchData.prototype.add=function(e,t,r){if(!(e in this.metadata))return this.metadata[e]=Object.create(null),void(this.metadata[e][t]=r);if(t in this.metadata[e])for(var n=Object.keys(r),i=0;i<n.length;i++){var s=n[i];s in this.metadata[e][t]?this.metadata[e][t][s]=this.metadata[e][t][s].concat(r[s]):this.metadata[e][t][s]=r[s]}else this.metadata[e][t]=r},R.Query=function(e){this.clauses=[],this.allFields=e},R.Query.wildcard=new String("*"),R.Query.wildcard.NONE=0,R.Query.wildcard.LEADING=1,R.Query.wildcard.TRAILING=2,R.Query.presence={OPTIONAL:1,REQUIRED:2,PROHIBITED:3},R.Query.prototype.clause=function(e){return"fields"in e||(e.fields=this.allFields),"boost"in e||(e.boost=1),"usePipeline"in e||(e.usePipeline=!0),"wildcard"in e||(e.wildcard=R.Query.wildcard.NONE),e.wildcard&R.Query.wildcard.LEADING&&e.term.charAt(0)!=R.Query.wildcard&&(e.term="*"+e.term),e.wildcard&R.Query.wildcard.TRAILING&&e.term.slice(-1)!=R.Query.wildcard&&(e.term=e.term+"*"),"presence"in e||(e.presence=R.Query.presence.OPTIONAL),this.clauses.push(e),this},R.Query.prototype.isNegated=function(){for(var e=0;e<this.clauses.length;e++)if(this.clauses[e].presence!=R.Query.presence.PROHIBITED)return!1;return!0},R.Query.prototype.term=function(e,t){if(Array.isArray(e))return e.forEach((function(e){this.term(e,R.utils.clone(t))}),this),this;var r=t||{};return r.term=e.toString(),this.clause(r),this},R.QueryParseError=function(e,t,r){this.name="QueryParseError",this.message=e,this.start=t,this.end=r},R.QueryParseError.prototype=new Error,R.QueryLexer=function(e){this.lexemes=[],this.str=e,this.length=e.length,this.pos=0,this.start=0,this.escapeCharPositions=[]},R.QueryLexer.prototype.run=function(){for(var e=R.QueryLexer.lexText;e;)e=e(this)},R.QueryLexer.prototype.sliceString=function(){for(var e=[],t=this.start,r=this.pos,n=0;n<this.escapeCharPositions.length;n++)r=this.escapeCharPositions[n],e.push(this.str.slice(t,r)),t=r+1;return e.push(this.str.slice(t,this.pos)),this.escapeCharPositions.length=0,e.join("")},R.QueryLexer.prototype.emit=function(e){this.lexemes.push({type:e,str:this.sliceString(),start:this.start,end:this.pos}),this.start=this.pos},R.QueryLexer.prototype.escapeCharacter=function(){this.escapeCharPositions.push(this.pos-1),this.pos+=1},R.QueryLexer.prototype.next=function(){if(this.pos>=this.length)return R.QueryLexer.EOS;var e=this.str.charAt(this.pos);return this.pos+=1,e},R.QueryLexer.prototype.width=function(){return this.pos-this.start},R.QueryLexer.prototype.ignore=function(){this.start==this.pos&&(this.pos+=1),this.start=this.pos},R.QueryLexer.prototype.backup=function(){this.pos-=1},R.QueryLexer.prototype.acceptDigitRun=function(){var e,t;do{t=(e=this.next()).charCodeAt(0)}while(t>47&&t<58);e!=R.QueryLexer.EOS&&this.backup()},R.QueryLexer.prototype.more=function(){return this.pos<this.length},R.QueryLexer.EOS="EOS",R.QueryLexer.FIELD="FIELD",R.QueryLexer.TERM="TERM",R.QueryLexer.EDIT_DISTANCE="EDIT_DISTANCE",R.QueryLexer.BOOST="BOOST",R.QueryLexer.PRESENCE="PRESENCE",R.QueryLexer.lexField=function(e){return e.backup(),e.emit(R.QueryLexer.FIELD),e.ignore(),R.QueryLexer.lexText},R.QueryLexer.lexTerm=function(e){if(e.width()>1&&(e.backup(),e.emit(R.QueryLexer.TERM)),e.ignore(),e.more())return R.QueryLexer.lexText},R.QueryLexer.lexEditDistance=function(e){return e.ignore(),e.acceptDigitRun(),e.emit(R.QueryLexer.EDIT_DISTANCE),R.QueryLexer.lexText},R.QueryLexer.lexBoost=function(e){return e.ignore(),e.acceptDigitRun(),e.emit(R.QueryLexer.BOOST),R.QueryLexer.lexText},R.QueryLexer.lexEOS=function(e){e.width()>0&&e.emit(R.QueryLexer.TERM)},R.QueryLexer.termSeparator=R.tokenizer.separator,R.QueryLexer.lexText=function(e){for(;;){var t=e.next();if(t==R.QueryLexer.EOS)return R.QueryLexer.lexEOS;if(92!=t.charCodeAt(0)){if(":"==t)return R.QueryLexer.lexField;if("~"==t)return e.backup(),e.width()>0&&e.emit(R.QueryLexer.TERM),R.QueryLexer.lexEditDistance;if("^"==t)return e.backup(),e.width()>0&&e.emit(R.QueryLexer.TERM),R.QueryLexer.lexBoost;if("+"==t&&1===e.width())return e.emit(R.QueryLexer.PRESENCE),R.QueryLexer.lexText;if("-"==t&&1===e.width())return e.emit(R.QueryLexer.PRESENCE),R.QueryLexer.lexText;if(t.match(R.QueryLexer.termSeparator))return R.QueryLexer.lexTerm}else e.escapeCharacter()}},R.QueryParser=function(e,t){this.lexer=new R.QueryLexer(e),this.query=t,this.currentClause={},this.lexemeIdx=0},R.QueryParser.prototype.parse=function(){this.lexer.run(),this.lexemes=this.lexer.lexemes;for(var e=R.QueryParser.parseClause;e;)e=e(this);return this.query},R.QueryParser.prototype.peekLexeme=function(){return this.lexemes[this.lexemeIdx]},R.QueryParser.prototype.consumeLexeme=function(){var e=this.peekLexeme();return this.lexemeIdx+=1,e},R.QueryParser.prototype.nextClause=function(){var e=this.currentClause;this.query.clause(e),this.currentClause={}},R.QueryParser.parseClause=function(e){var t=e.peekLexeme();if(null!=t)switch(t.type){case R.QueryLexer.PRESENCE:return R.QueryParser.parsePresence;case R.QueryLexer.FIELD:return R.QueryParser.parseField;case R.QueryLexer.TERM:return R.QueryParser.parseTerm;default:var r="expected either a field or a term, found "+t.type;throw t.str.length>=1&&(r+=" with value \'"+t.str+"\'"),new R.QueryParseError(r,t.start,t.end)}},R.QueryParser.parsePresence=function(e){var t=e.consumeLexeme();if(null!=t){switch(t.str){case"-":e.currentClause.presence=R.Query.presence.PROHIBITED;break;case"+":e.currentClause.presence=R.Query.presence.REQUIRED;break;default:var r="unrecognised presence operator\'"+t.str+"\'";throw new R.QueryParseError(r,t.start,t.end)}var n=e.peekLexeme();if(null==n)throw r="expecting term or field, found nothing",new R.QueryParseError(r,t.start,t.end);switch(n.type){case R.QueryLexer.FIELD:return R.QueryParser.parseField;case R.QueryLexer.TERM:return R.QueryParser.parseTerm;default:throw r="expecting term or field, found \'"+n.type+"\'",new R.QueryParseError(r,n.start,n.end)}}},R.QueryParser.parseField=function(e){var t=e.consumeLexeme();if(null!=t){if(-1==e.query.allFields.indexOf(t.str)){var r=e.query.allFields.map((function(e){return"\'"+e+"\'"})).join(", "),n="unrecognised field \'"+t.str+"\', possible fields: "+r;throw new R.QueryParseError(n,t.start,t.end)}e.currentClause.fields=[t.str];var i=e.peekLexeme();if(null==i)throw n="expecting term, found nothing",new R.QueryParseError(n,t.start,t.end);if(i.type===R.QueryLexer.TERM)return R.QueryParser.parseTerm;throw n="expecting term, found \'"+i.type+"\'",new R.QueryParseError(n,i.start,i.end)}},R.QueryParser.parseTerm=function(e){var t=e.consumeLexeme();if(null!=t){e.currentClause.term=t.str.toLowerCase(),-1!=t.str.indexOf("*")&&(e.currentClause.usePipeline=!1);var r=e.peekLexeme();if(null!=r)switch(r.type){case R.QueryLexer.TERM:return e.nextClause(),R.QueryParser.parseTerm;case R.QueryLexer.FIELD:return e.nextClause(),R.QueryParser.parseField;case R.QueryLexer.EDIT_DISTANCE:return R.QueryParser.parseEditDistance;case R.QueryLexer.BOOST:return R.QueryParser.parseBoost;case R.QueryLexer.PRESENCE:return e.nextClause(),R.QueryParser.parsePresence;default:var n="Unexpected lexeme type \'"+r.type+"\'";throw new R.QueryParseError(n,r.start,r.end)}else e.nextClause()}},R.QueryParser.parseEditDistance=function(e){var t=e.consumeLexeme();if(null!=t){var r=parseInt(t.str,10);if(isNaN(r)){var n="edit distance must be numeric";throw new R.QueryParseError(n,t.start,t.end)}e.currentClause.editDistance=r;var i=e.peekLexeme();if(null!=i)switch(i.type){case R.QueryLexer.TERM:return e.nextClause(),R.QueryParser.parseTerm;case R.QueryLexer.FIELD:return e.nextClause(),R.QueryParser.parseField;case R.QueryLexer.EDIT_DISTANCE:return R.QueryParser.parseEditDistance;case R.QueryLexer.BOOST:return R.QueryParser.parseBoost;case R.QueryLexer.PRESENCE:return e.nextClause(),R.QueryParser.parsePresence;default:throw n="Unexpected lexeme type \'"+i.type+"\'",new R.QueryParseError(n,i.start,i.end)}else e.nextClause()}},R.QueryParser.parseBoost=function(e){var t=e.consumeLexeme();if(null!=t){var r=parseInt(t.str,10);if(isNaN(r)){var n="boost must be numeric";throw new R.QueryParseError(n,t.start,t.end)}e.currentClause.boost=r;var i=e.peekLexeme();if(null!=i)switch(i.type){case R.QueryLexer.TERM:return e.nextClause(),R.QueryParser.parseTerm;case R.QueryLexer.FIELD:return e.nextClause(),R.QueryParser.parseField;case R.QueryLexer.EDIT_DISTANCE:return R.QueryParser.parseEditDistance;case R.QueryLexer.BOOST:return R.QueryParser.parseBoost;case R.QueryLexer.PRESENCE:return e.nextClause(),R.QueryParser.parsePresence;default:throw n="Unexpected lexeme type \'"+i.type+"\'",new R.QueryParseError(n,i.start,i.end)}else e.nextClause()}},void 0===(i="function"==typeof(n=function(){return R})?n.call(t,r,t,e):n)||(e.exports=i)}()}},t={};function r(n){var i=t[n];if(void 0!==i)return i.exports;var s=t[n]={exports:{}};return e[n](s,s.exports,r),s.exports}r.n=function(e){var t=e&&e.__esModule?function(){return e.default}:function(){return e};return r.d(t,{a:t}),t},r.d=function(e,t){for(var n in t)r.o(t,n)&&!r.o(e,n)&&Object.defineProperty(e,n,{enumerable:!0,get:t[n]})},r.o=function(e,t){return Object.prototype.hasOwnProperty.call(e,t)};var n={};!function(){"use strict";r.d(n,{add:function(){return l},dispose:function(){return p},done:function(){return c},fromExternalJS:function(){return d},load:function(){return f},search:function(){return y},toJS:function(){return h}});var e=r(336),t=(e,t,r)=>new Promise(((n,i)=>{var s=e=>{try{a(r.next(e))}catch(e){i(e)}},o=e=>{try{a(r.throw(e))}catch(e){i(e)}},a=e=>e.done?n(e.value):Promise.resolve(e.value).then(s,o);a((r=r.apply(e,t)).next())}));let i,s,o,a=[];function u(){i=new e.Builder,i.field("title"),i.field("description"),i.ref("ref"),i.pipeline.add(e.trimmer,e.stopWordFilter,e.stemmer),o=new Promise((e=>{s=e}))}function l(e,t,r){const n=a.push(r)-1,s={title:e.toLowerCase(),description:t.toLowerCase(),ref:n};i.add(s)}function c(){return t(this,null,(function*(){s(i.build())}))}function h(){return t(this,null,(function*(){return{store:a,index:(yield o).toJSON()}}))}function d(e,r){return t(this,null,(function*(){try{if(importScripts(e),!self[r])throw new Error("Broken index file format");f(self[r])}catch(e){console.error("Failed to load search index: "+e.message)}}))}function f(r){return t(this,null,(function*(){a=r.store,s(e.Index.load(r.index))}))}function p(){return t(this,null,(function*(){a=[],u()}))}function y(r,n=0){return t(this,null,(function*(){if(0===r.trim().length)return[];let t=(yield o).query((t=>{r.trim().toLowerCase().split(/\\s+/).forEach((r=>{if(1===r.length)return;const n=(t=>{const r=e.trimmer(new e.Token(t,{}));return"*"+e.stemmer(r)+"*"})(r);t.term(n,{})}))}));return n>0&&(t=t.slice(0,n)),t.map((e=>({meta:a[e.ref],score:e.score})))}))}e.tokenizer.separator=/\\s+/,u(),addEventListener("message",(function(e){var t,r=e.data,i=r.type,s=r.method,o=r.id,a=r.params;"RPC"===i&&s&&((t=n[s])?Promise.resolve().then((function(){return t.apply(n,a)})):Promise.reject("No such method")).then((function(e){postMessage({type:"RPC",id:o,result:e})})).catch((function(e){var t={message:e};e.stack&&(t.message=e.message,t.stack=e.stack,t.name=e.name),postMessage({type:"RPC",id:o,error:t})}))})),postMessage({type:"RPC",method:"ready"})}()}();\n//# sourceMappingURL=0a6ad30060afff00cb34.worker.js.map'])),{name:"[fullhash].worker.js"});return r(e,o),e}},6314:function(e){e.exports=function(e,t){var n=0,r={};e.addEventListener("message",(function(t){var n=t.data;if("RPC"===n.type)if(n.id){var o=r[n.id];o&&(delete r[n.id],n.error?o[1](Object.assign(Error(n.error.message),n.error)):o[0](n.result))}else{var i=document.createEvent("Event");i.initEvent(n.method,!1,!1),i.data=n.params,e.dispatchEvent(i)}})),t.forEach((function(t){e[t]=function(){var o=arguments;return new Promise((function(i,a){var s=++n;r[s]=[i,a],e.postMessage({type:"RPC",id:s,method:t,params:[].slice.call(o)})}))}}))}},8150:function(t){"use strict";t.exports=e},6212:function(){},5101:function(){},8836:function(){},2116:function(){},6918:function(){},3197:function(){},6177:function(){},425:function(e){"use strict";e.exports=JSON.parse('{"$id":"https://raw.githubusercontent.com/ajv-validator/ajv/master/lib/refs/data.json#","description":"Meta-schema for $data reference (JSON AnySchema extension proposal)","type":"object","required":["$data"],"properties":{"$data":{"type":"string","anyOf":[{"format":"relative-json-pointer"},{"format":"json-pointer"}]}},"additionalProperties":false}')},1603:function(e){"use strict";e.exports=JSON.parse('{"$schema":"http://json-schema.org/draft-07/schema#","$id":"http://json-schema.org/draft-07/schema#","title":"Core schema meta-schema","definitions":{"schemaArray":{"type":"array","minItems":1,"items":{"$ref":"#"}},"nonNegativeInteger":{"type":"integer","minimum":0},"nonNegativeIntegerDefault0":{"allOf":[{"$ref":"#/definitions/nonNegativeInteger"},{"default":0}]},"simpleTypes":{"enum":["array","boolean","integer","null","number","object","string"]},"stringArray":{"type":"array","items":{"type":"string"},"uniqueItems":true,"default":[]}},"type":["object","boolean"],"properties":{"$id":{"type":"string","format":"uri-reference"},"$schema":{"type":"string","format":"uri"},"$ref":{"type":"string","format":"uri-reference"},"$comment":{"type":"string"},"title":{"type":"string"},"description":{"type":"string"},"default":true,"readOnly":{"type":"boolean","default":false},"examples":{"type":"array","items":true},"multipleOf":{"type":"number","exclusiveMinimum":0},"maximum":{"type":"number"},"exclusiveMaximum":{"type":"number"},"minimum":{"type":"number"},"exclusiveMinimum":{"type":"number"},"maxLength":{"$ref":"#/definitions/nonNegativeInteger"},"minLength":{"$ref":"#/definitions/nonNegativeIntegerDefault0"},"pattern":{"type":"string","format":"regex"},"additionalItems":{"$ref":"#"},"items":{"anyOf":[{"$ref":"#"},{"$ref":"#/definitions/schemaArray"}],"default":true},"maxItems":{"$ref":"#/definitions/nonNegativeInteger"},"minItems":{"$ref":"#/definitions/nonNegativeIntegerDefault0"},"uniqueItems":{"type":"boolean","default":false},"contains":{"$ref":"#"},"maxProperties":{"$ref":"#/definitions/nonNegativeInteger"},"minProperties":{"$ref":"#/definitions/nonNegativeIntegerDefault0"},"required":{"$ref":"#/definitions/stringArray"},"additionalProperties":{"$ref":"#"},"definitions":{"type":"object","additionalProperties":{"$ref":"#"},"default":{}},"properties":{"type":"object","additionalProperties":{"$ref":"#"},"default":{}},"patternProperties":{"type":"object","additionalProperties":{"$ref":"#"},"propertyNames":{"format":"regex"},"default":{}},"dependencies":{"type":"object","additionalProperties":{"anyOf":[{"$ref":"#"},{"$ref":"#/definitions/stringArray"}]}},"propertyNames":{"$ref":"#"},"const":true,"enum":{"type":"array","items":true,"minItems":1,"uniqueItems":true},"type":{"anyOf":[{"$ref":"#/definitions/simpleTypes"},{"type":"array","items":{"$ref":"#/definitions/simpleTypes"},"minItems":1,"uniqueItems":true}]},"format":{"type":"string"},"contentMediaType":{"type":"string"},"contentEncoding":{"type":"string"},"if":{"$ref":"#"},"then":{"$ref":"#"},"else":{"$ref":"#"},"allOf":{"$ref":"#/definitions/schemaArray"},"anyOf":{"$ref":"#/definitions/schemaArray"},"oneOf":{"$ref":"#/definitions/schemaArray"},"not":{"$ref":"#"}},"default":true}')},3244:function(e){"use strict";e.exports=JSON.parse('{"i8":"1.0.0-beta.104"}')},4109:function(e){"use strict";e.exports={i8:"7.0.6"}}},n={};function r(e){var o=n[e];if(void 0!==o)return o.exports;var i=n[e]={id:e,loaded:!1,exports:{}};return t[e].call(i.exports,i,i.exports,r),i.loaded=!0,i.exports}r.n=function(e){var t=e&&e.__esModule?function(){return e.default}:function(){return e};return r.d(t,{a:t}),t},r.d=function(e,t){for(var n in t)r.o(t,n)&&!r.o(e,n)&&Object.defineProperty(e,n,{enumerable:!0,get:t[n]})},r.g=function(){if("object"==typeof globalThis)return globalThis;try{return this||new Function("return this")()}catch(e){if("object"==typeof window)return window}}(),r.o=function(e,t){return Object.prototype.hasOwnProperty.call(e,t)},r.r=function(e){"undefined"!=typeof Symbol&&Symbol.toStringTag&&Object.defineProperty(e,Symbol.toStringTag,{value:"Module"}),Object.defineProperty(e,"__esModule",{value:!0})},r.nmd=function(e){return e.paths=[],e.children||(e.children=[]),e},r.nc=void 0;var o={};return function(){"use strict";r(4609),r(9266)}(),function(){"use strict";r.r(o),r.d(o,{AppStore:function(){return ey},Redoc:function(){return Gb},destroy:function(){return sw},hydrate:function(){return lw},init:function(){return aw},revision:function(){return ow},version:function(){return rw}});var e={};r.r(e),r.d(e,{ServerStyleSheet:function(){return ia},StyleSheetConsumer:function(){return Oi},StyleSheetContext:function(){return _i},StyleSheetManager:function(){return Ci},ThemeConsumer:function(){return Xi},ThemeContext:function(){return Qi},ThemeProvider:function(){return Ji},__PRIVATE__:function(){return la},createGlobalStyle:function(){return ra},css:function(){return Fi},default:function(){return ca},isStyledComponent:function(){return zo},keyframes:function(){return oa},useTheme:function(){return sa},version:function(){return Vo},withTheme:function(){return aa}});var t={};r.r(t),r.d(t,{default:function(){return gd}});var n=r(7294),i=r(3935);function a(e){for(var t=arguments.length,n=new Array(t>1?t-1:0),r=1;r<t;r++)n[r-1]=arguments[r];throw new Error("number"==typeof e?"[MobX] minified error nr: "+e+(n.length?" "+n.map(String).join(","):"")+". Find the full error at: https://github.com/mobxjs/mobx/blob/main/packages/mobx/src/errors.ts":"[MobX] "+e)}var s={};function l(){return"undefined"!=typeof globalThis?globalThis:"undefined"!=typeof window?window:void 0!==r.g?r.g:"undefined"!=typeof self?self:s}var c=Object.assign,u=Object.getOwnPropertyDescriptor,p=Object.defineProperty,d=Object.prototype,f=[];Object.freeze(f);var h={};Object.freeze(h);var m="undefined"!=typeof Proxy,g=Object.toString();function y(){m||a("Proxy not available")}function v(e){var t=!1;return function(){if(!t)return t=!0,e.apply(this,arguments)}}var b=function(){};function w(e){return"function"==typeof e}function x(e){switch(typeof e){case"string":case"symbol":case"number":return!0}return!1}function k(e){return null!==e&&"object"==typeof e}function _(e){var t;if(!k(e))return!1;var n=Object.getPrototypeOf(e);return null==n||(null==(t=n.constructor)?void 0:t.toString())===g}function O(e){var t=null==e?void 0:e.constructor;return!!t&&("GeneratorFunction"===t.name||"GeneratorFunction"===t.displayName)}function S(e,t,n){p(e,t,{enumerable:!1,writable:!0,configurable:!0,value:n})}function E(e,t,n){p(e,t,{enumerable:!1,writable:!1,configurable:!0,value:n})}function P(e,t){var n="isMobX"+e;return t.prototype[n]=!0,function(e){return k(e)&&!0===e[n]}}function A(e){return e instanceof Map}function $(e){return e instanceof Set}var C=void 0!==Object.getOwnPropertySymbols,R="undefined"!=typeof Reflect&&Reflect.ownKeys?Reflect.ownKeys:C?function(e){return Object.getOwnPropertyNames(e).concat(Object.getOwnPropertySymbols(e))}:Object.getOwnPropertyNames;function j(e){return null===e?null:"object"==typeof e?""+e:e}function T(e,t){return d.hasOwnProperty.call(e,t)}var I=Object.getOwnPropertyDescriptors||function(e){var t={};return R(e).forEach((function(n){t[n]=u(e,n)})),t};function N(e,t){for(var n=0;n<t.length;n++){var r=t[n];r.enumerable=r.enumerable||!1,r.configurable=!0,"value"in r&&(r.writable=!0),Object.defineProperty(e,r.key,r)}}function D(e,t,n){return t&&N(e.prototype,t),n&&N(e,n),e}function L(){return L=Object.assign||function(e){for(var t=1;t<arguments.length;t++){var n=arguments[t];for(var r in n)Object.prototype.hasOwnProperty.call(n,r)&&(e[r]=n[r])}return e},L.apply(this,arguments)}function M(e,t){e.prototype=Object.create(t.prototype),e.prototype.constructor=e,e.__proto__=t}function F(e){if(void 0===e)throw new ReferenceError("this hasn't been initialised - super() hasn't been called");return e}function z(e,t){(null==t||t>e.length)&&(t=e.length);for(var n=0,r=new Array(t);n<t;n++)r[n]=e[n];return r}function U(e,t){var n;if("undefined"==typeof Symbol||null==e[Symbol.iterator]){if(Array.isArray(e)||(n=function(e,t){if(e){if("string"==typeof e)return z(e,t);var n=Object.prototype.toString.call(e).slice(8,-1);return"Object"===n&&e.constructor&&(n=e.constructor.name),"Map"===n||"Set"===n?Array.from(e):"Arguments"===n||/^(?:Ui|I)nt(?:8|16|32)(?:Clamped)?Array$/.test(n)?z(e,t):void 0}}(e))||t&&e&&"number"==typeof e.length){n&&(e=n);var r=0;return function(){return r>=e.length?{done:!0}:{done:!1,value:e[r++]}}}throw new TypeError("Invalid attempt to iterate non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method.")}return(n=e[Symbol.iterator]()).next.bind(n)}var V=Symbol("mobx-stored-annotations");function B(e){return Object.assign((function(t,n){q(t,n,e)}),e)}function q(e,t,n){T(e,V)||S(e,V,L({},e[V])),function(e){return e.annotationType_===J}(n)||(e[V][t]=n)}var W=Symbol("mobx administration"),H=function(){function e(e){void 0===e&&(e="Atom"),this.name_=void 0,this.isPendingUnobservation_=!1,this.isBeingObserved_=!1,this.observers_=new Set,this.diffValue_=0,this.lastAccessedBy_=0,this.lowestObserverState_=qe.NOT_TRACKING_,this.onBOL=void 0,this.onBUOL=void 0,this.name_=e}var t=e.prototype;return t.onBO=function(){this.onBOL&&this.onBOL.forEach((function(e){return e()}))},t.onBUO=function(){this.onBUOL&&this.onBUOL.forEach((function(e){return e()}))},t.reportObserved=function(){return ft(this)},t.reportChanged=function(){pt(),ht(this),dt()},t.toString=function(){return this.name_},e}(),Y=P("Atom",H);function K(e,t,n){void 0===t&&(t=b),void 0===n&&(n=b);var r=new H(e);return t!==b&&Tt(Rt,r,t,undefined),n!==b&&jt(r,n),r}var G={identity:function(e,t){return e===t},structural:function(e,t){return Yn(e,t)},default:function(e,t){return Object.is(e,t)},shallow:function(e,t){return Yn(e,t,1)}};function Q(e,t,n){return qt(e)?e:Array.isArray(e)?Ae.array(e,{name:n}):_(e)?Ae.object(e,void 0,{name:n}):A(e)?Ae.map(e,{name:n}):$(e)?Ae.set(e,{name:n}):"function"!=typeof e||$t(e)||Bt(e)?e:O(e)?Ut(e):At(n,e)}function X(e){return e}var J="override";function Z(e,t){return{annotationType_:e,options_:t,make_:ee,extend_:te}}function ee(e,t,n,r){var o;if(null==(o=this.options_)?void 0:o.bound)return null===this.extend_(e,t,n,!1)?0:1;if(r===e.target_)return null===this.extend_(e,t,n,!1)?0:2;if($t(n.value))return 1;var i=ne(e,this,t,n,!1);return p(r,t,i),2}function te(e,t,n,r){var o=ne(e,this,t,n);return e.defineProperty_(t,o,r)}function ne(e,t,n,r,o){var i,a,s,l,c,u;void 0===o&&(o=lt.safeDescriptors),u=r,t.annotationType_,u.value;var p,d=r.value;return(null==(i=t.options_)?void 0:i.bound)&&(d=d.bind(null!=(p=e.proxy_)?p:e.target_)),{value:Me(null!=(a=null==(s=t.options_)?void 0:s.name)?a:n.toString(),d,null!=(l=null==(c=t.options_)?void 0:c.autoAction)&&l),configurable:!o||e.isPlainObject_,enumerable:!1,writable:!o}}function re(e,t){return{annotationType_:e,options_:t,make_:oe,extend_:ie}}function oe(e,t,n,r){var o;if(r===e.target_)return null===this.extend_(e,t,n,!1)?0:2;if((null==(o=this.options_)?void 0:o.bound)&&!Bt(e.target_[t])&&null===this.extend_(e,t,n,!1))return 0;if(Bt(n.value))return 1;var i=ae(e,this,0,n,!1,!1);return p(r,t,i),2}function ie(e,t,n,r){var o,i=ae(e,this,0,n,null==(o=this.options_)?void 0:o.bound);return e.defineProperty_(t,i,r)}function ae(e,t,n,r,o,i){var a;void 0===i&&(i=lt.safeDescriptors),a=r,t.annotationType_,a.value;var s,l=r.value;return o&&(l=l.bind(null!=(s=e.proxy_)?s:e.target_)),{value:Ut(l),configurable:!i||e.isPlainObject_,enumerable:!1,writable:!i}}function se(e,t){return{annotationType_:e,options_:t,make_:le,extend_:ce}}function le(e,t,n){return null===this.extend_(e,t,n,!1)?0:1}function ce(e,t,n,r){return o=n,this.annotationType_,o.get,e.defineComputedProperty_(t,L({},this.options_,{get:n.get,set:n.set}),r);var o}function ue(e,t){return{annotationType_:e,options_:t,make_:pe,extend_:de}}function pe(e,t,n){return null===this.extend_(e,t,n,!1)?0:1}function de(e,t,n,r){var o,i;return this.annotationType_,e.defineObservableProperty_(t,n.value,null!=(o=null==(i=this.options_)?void 0:i.enhancer)?o:Q,r)}var fe=he();function he(e){return{annotationType_:"true",options_:e,make_:me,extend_:ge}}function me(e,t,n,r){var o,i,a,s;if(n.get)return je.make_(e,t,n,r);if(n.set){var l=Me(t.toString(),n.set);return r===e.target_?null===e.defineProperty_(t,{configurable:!lt.safeDescriptors||e.isPlainObject_,set:l})?0:2:(p(r,t,{configurable:!0,set:l}),2)}if(r!==e.target_&&"function"==typeof n.value)return O(n.value)?((null==(s=this.options_)?void 0:s.autoBind)?Ut.bound:Ut).make_(e,t,n,r):((null==(a=this.options_)?void 0:a.autoBind)?At.bound:At).make_(e,t,n,r);var c,u=!1===(null==(o=this.options_)?void 0:o.deep)?Ae.ref:Ae;return"function"==typeof n.value&&(null==(i=this.options_)?void 0:i.autoBind)&&(n.value=n.value.bind(null!=(c=e.proxy_)?c:e.target_)),u.make_(e,t,n,r)}function ge(e,t,n,r){var o,i,a;return n.get?je.extend_(e,t,n,r):n.set?e.defineProperty_(t,{configurable:!lt.safeDescriptors||e.isPlainObject_,set:Me(t.toString(),n.set)},r):("function"==typeof n.value&&(null==(o=this.options_)?void 0:o.autoBind)&&(n.value=n.value.bind(null!=(a=e.proxy_)?a:e.target_)),(!1===(null==(i=this.options_)?void 0:i.deep)?Ae.ref:Ae).extend_(e,t,n,r))}var ye={deep:!0,name:void 0,defaultDecorator:void 0,proxy:!0};function ve(e){return e||ye}Object.freeze(ye);var be=ue("observable"),we=ue("observable.ref",{enhancer:X}),xe=ue("observable.shallow",{enhancer:function(e,t,n){return null==e||Tn(e)||gn(e)||_n(e)||En(e)?e:Array.isArray(e)?Ae.array(e,{name:n,deep:!1}):_(e)?Ae.object(e,void 0,{name:n,deep:!1}):A(e)?Ae.map(e,{name:n,deep:!1}):$(e)?Ae.set(e,{name:n,deep:!1}):void 0}}),ke=ue("observable.struct",{enhancer:function(e,t){return Yn(e,t)?t:e}}),_e=B(be);function Oe(e){return!0===e.deep?Q:!1===e.deep?X:(t=e.defaultDecorator)&&null!=(n=null==(r=t.options_)?void 0:r.enhancer)?n:Q;var t,n,r}function Se(e,t,n){if(!x(t))return qt(e)?e:_(e)?Ae.object(e,t,n):Array.isArray(e)?Ae.array(e,t):A(e)?Ae.map(e,t):$(e)?Ae.set(e,t):"object"==typeof e&&null!==e?e:Ae.box(e,t);q(e,t,be)}Object.assign(Se,_e);var Ee,Pe,Ae=c(Se,{box:function(e,t){var n=ve(t);return new Be(e,Oe(n),n.name,!0,n.equals)},array:function(e,t){var n=ve(t);return(!1===lt.useProxies||!1===n.proxy?Vn:sn)(e,Oe(n),n.name)},map:function(e,t){var n=ve(t);return new kn(e,Oe(n),n.name)},set:function(e,t){var n=ve(t);return new Sn(e,Oe(n),n.name)},object:function(e,t,n){return function(e,t,n,r){var o=I(t),i=Cn(e,r)[W];pt();try{R(o).forEach((function(e){i.extend_(e,o[e],!n||!(e in n)||n[e])}))}finally{dt()}return e}(!1===lt.useProxies||!1===(null==n?void 0:n.proxy)?Cn({},n):function(e,t){var n,r;return y(),null!=(r=(n=(e=Cn(e,t))[W]).proxy_)?r:n.proxy_=new Proxy(e,Kt)}({},n),e,t)},ref:B(we),shallow:B(xe),deep:_e,struct:B(ke)}),$e="computed",Ce=se($e),Re=se("computed.struct",{equals:G.structural}),je=function(e,t){if(x(t))return q(e,t,Ce);if(_(e))return B(se($e,e));var n=_(t)?t:{};return n.get=e,n.name||(n.name=e.name||""),new He(n)};Object.assign(je,Ce),je.struct=B(Re);var Te,Ie=0,Ne=1,De=null!=(Ee=null==(Pe=u((function(){}),"name"))?void 0:Pe.configurable)&&Ee,Le={value:"action",configurable:!0,writable:!1,enumerable:!1};function Me(e,t,n,r){function o(){return Fe(0,n,t,r||this,arguments)}return void 0===n&&(n=!1),o.isMobxAction=!0,De&&(Le.value=e,Object.defineProperty(o,"name",Le)),o}function Fe(e,t,n,r,o){var i=function(e,t,n,r){var o=lt.trackingDerivation,i=!t||!o;pt();var a=lt.allowStateChanges;i&&(et(),a=ze(!0));var s={runAsAction_:i,prevDerivation_:o,prevAllowStateChanges_:a,prevAllowStateReads_:nt(!0),notifySpy_:!1,startTime_:0,actionId_:Ne++,parentActionId_:Ie};return Ie=s.actionId_,s}(0,t);try{return n.apply(r,o)}catch(e){throw i.error_=e,e}finally{!function(e){Ie!==e.actionId_&&a(30),Ie=e.parentActionId_,void 0!==e.error_&&(lt.suppressReactionErrors=!0),Ue(e.prevAllowStateChanges_),rt(e.prevAllowStateReads_),dt(),e.runAsAction_&&tt(e.prevDerivation_),lt.suppressReactionErrors=!1}(i)}}function ze(e){var t=lt.allowStateChanges;return lt.allowStateChanges=e,t}function Ue(e){lt.allowStateChanges=e}Te=Symbol.toPrimitive;var Ve,Be=function(e){function t(t,n,r,o,i){var a;return void 0===r&&(r="ObservableValue"),void 0===o&&(o=!0),void 0===i&&(i=G.default),(a=e.call(this,r)||this).enhancer=void 0,a.name_=void 0,a.equals=void 0,a.hasUnreportedChange_=!1,a.interceptors_=void 0,a.changeListeners_=void 0,a.value_=void 0,a.dehancer=void 0,a.enhancer=n,a.name_=r,a.equals=i,a.value_=n(t,void 0,r),a}M(t,e);var n=t.prototype;return n.dehanceValue=function(e){return void 0!==this.dehancer?this.dehancer(e):e},n.set=function(e){this.value_,(e=this.prepareNewValue_(e))!==lt.UNCHANGED&&this.setNewValue_(e)},n.prepareNewValue_=function(e){if(Gt(this)){var t=Xt(this,{object:this,type:rn,newValue:e});if(!t)return lt.UNCHANGED;e=t.newValue}return e=this.enhancer(e,this.value_,this.name_),this.equals(this.value_,e)?lt.UNCHANGED:e},n.setNewValue_=function(e){var t=this.value_;this.value_=e,this.reportChanged(),Jt(this)&&en(this,{type:rn,object:this,newValue:e,oldValue:t})},n.get=function(){return this.reportObserved(),this.dehanceValue(this.value_)},n.intercept_=function(e){return Qt(this,e)},n.observe_=function(e,t){return t&&e({observableKind:"value",debugObjectName:this.name_,object:this,type:rn,newValue:this.value_,oldValue:void 0}),Zt(this,e)},n.raw=function(){return this.value_},n.toJSON=function(){return this.get()},n.toString=function(){return this.name_+"["+this.value_+"]"},n.valueOf=function(){return j(this.get())},n[Te]=function(){return this.valueOf()},t}(H);Ve=Symbol.toPrimitive;var qe,We,He=function(){function e(e){this.dependenciesState_=qe.NOT_TRACKING_,this.observing_=[],this.newObserving_=null,this.isBeingObserved_=!1,this.isPendingUnobservation_=!1,this.observers_=new Set,this.diffValue_=0,this.runId_=0,this.lastAccessedBy_=0,this.lowestObserverState_=qe.UP_TO_DATE_,this.unboundDepsCount_=0,this.value_=new Ke(null),this.name_=void 0,this.triggeredBy_=void 0,this.isComputing_=!1,this.isRunningSetter_=!1,this.derivation=void 0,this.setter_=void 0,this.isTracing_=We.NONE,this.scope_=void 0,this.equals_=void 0,this.requiresReaction_=void 0,this.keepAlive_=void 0,this.onBOL=void 0,this.onBUOL=void 0,e.get||a(31),this.derivation=e.get,this.name_=e.name||"ComputedValue",e.set&&(this.setter_=Me("ComputedValue-setter",e.set)),this.equals_=e.equals||(e.compareStructural||e.struct?G.structural:G.default),this.scope_=e.context,this.requiresReaction_=!!e.requiresReaction,this.keepAlive_=!!e.keepAlive}var t=e.prototype;return t.onBecomeStale_=function(){var e;(e=this).lowestObserverState_===qe.UP_TO_DATE_&&(e.lowestObserverState_=qe.POSSIBLY_STALE_,e.observers_.forEach((function(e){e.dependenciesState_===qe.UP_TO_DATE_&&(e.dependenciesState_=qe.POSSIBLY_STALE_,e.onBecomeStale_())})))},t.onBO=function(){this.onBOL&&this.onBOL.forEach((function(e){return e()}))},t.onBUO=function(){this.onBUOL&&this.onBUOL.forEach((function(e){return e()}))},t.get=function(){if(this.isComputing_&&a(32,this.name_,this.derivation),0!==lt.inBatch||0!==this.observers_.size||this.keepAlive_){if(ft(this),Qe(this)){var e=lt.trackingContext;this.keepAlive_&&!e&&(lt.trackingContext=this),this.trackAndCompute()&&((t=this).lowestObserverState_!==qe.STALE_&&(t.lowestObserverState_=qe.STALE_,t.observers_.forEach((function(e){e.dependenciesState_===qe.POSSIBLY_STALE_?e.dependenciesState_=qe.STALE_:e.dependenciesState_===qe.UP_TO_DATE_&&(t.lowestObserverState_=qe.UP_TO_DATE_)})))),lt.trackingContext=e}}else Qe(this)&&(this.warnAboutUntrackedRead_(),pt(),this.value_=this.computeValue_(!1),dt());var t,n=this.value_;if(Ge(n))throw n.cause;return n},t.set=function(e){if(this.setter_){this.isRunningSetter_&&a(33,this.name_),this.isRunningSetter_=!0;try{this.setter_.call(this.scope_,e)}finally{this.isRunningSetter_=!1}}else a(34,this.name_)},t.trackAndCompute=function(){var e=this.value_,t=this.dependenciesState_===qe.NOT_TRACKING_,n=this.computeValue_(!0),r=t||Ge(e)||Ge(n)||!this.equals_(e,n);return r&&(this.value_=n),r},t.computeValue_=function(e){this.isComputing_=!0;var t,n=ze(!1);if(e)t=Xe(this,this.derivation,this.scope_);else if(!0===lt.disableErrorBoundaries)t=this.derivation.call(this.scope_);else try{t=this.derivation.call(this.scope_)}catch(e){t=new Ke(e)}return Ue(n),this.isComputing_=!1,t},t.suspend_=function(){this.keepAlive_||(Je(this),this.value_=void 0)},t.observe_=function(e,t){var n=this,r=!0,o=void 0;return function(e,t){var n,r;void 0===t&&(t=h);var o,i=null!=(n=null==(r=t)?void 0:r.name)?n:"Autorun";if(t.scheduler||t.delay){var a=function(e){return e.scheduler?e.scheduler:e.delay?function(t){return setTimeout(t,e.delay)}:Ct}(t),s=!1;o=new mt(i,(function(){s||(s=!0,a((function(){s=!1,o.isDisposed_||o.track(l)})))}),t.onError,t.requiresObservable)}else o=new mt(i,(function(){this.track(l)}),t.onError,t.requiresObservable);function l(){e(o)}return o.schedule_(),o.getDisposer_()}((function(){var i=n.get();if(!r||t){var a=et();e({observableKind:"computed",debugObjectName:n.name_,type:rn,object:n,newValue:i,oldValue:o}),tt(a)}r=!1,o=i}))},t.warnAboutUntrackedRead_=function(){},t.toString=function(){return this.name_+"["+this.derivation.toString()+"]"},t.valueOf=function(){return j(this.get())},t[Ve]=function(){return this.valueOf()},e}(),Ye=P("ComputedValue",He);!function(e){e[e.NOT_TRACKING_=-1]="NOT_TRACKING_",e[e.UP_TO_DATE_=0]="UP_TO_DATE_",e[e.POSSIBLY_STALE_=1]="POSSIBLY_STALE_",e[e.STALE_=2]="STALE_"}(qe||(qe={})),function(e){e[e.NONE=0]="NONE",e[e.LOG=1]="LOG",e[e.BREAK=2]="BREAK"}(We||(We={}));var Ke=function(e){this.cause=void 0,this.cause=e};function Ge(e){return e instanceof Ke}function Qe(e){switch(e.dependenciesState_){case qe.UP_TO_DATE_:return!1;case qe.NOT_TRACKING_:case qe.STALE_:return!0;case qe.POSSIBLY_STALE_:for(var t=nt(!0),n=et(),r=e.observing_,o=r.length,i=0;i<o;i++){var a=r[i];if(Ye(a)){if(lt.disableErrorBoundaries)a.get();else try{a.get()}catch(e){return tt(n),rt(t),!0}if(e.dependenciesState_===qe.STALE_)return tt(n),rt(t),!0}}return ot(e),tt(n),rt(t),!1}}function Xe(e,t,n){var r=nt(!0);ot(e),e.newObserving_=new Array(e.observing_.length+100),e.unboundDepsCount_=0,e.runId_=++lt.runId;var o,i=lt.trackingDerivation;if(lt.trackingDerivation=e,lt.inBatch++,!0===lt.disableErrorBoundaries)o=t.call(n);else try{o=t.call(n)}catch(e){o=new Ke(e)}return lt.inBatch--,lt.trackingDerivation=i,function(e){for(var t=e.observing_,n=e.observing_=e.newObserving_,r=qe.UP_TO_DATE_,o=0,i=e.unboundDepsCount_,a=0;a<i;a++){var s=n[a];0===s.diffValue_&&(s.diffValue_=1,o!==a&&(n[o]=s),o++),s.dependenciesState_>r&&(r=s.dependenciesState_)}for(n.length=o,e.newObserving_=null,i=t.length;i--;){var l=t[i];0===l.diffValue_&&ct(l,e),l.diffValue_=0}for(;o--;){var c=n[o];1===c.diffValue_&&(c.diffValue_=0,p=e,(u=c).observers_.add(p),u.lowestObserverState_>p.dependenciesState_&&(u.lowestObserverState_=p.dependenciesState_))}var u,p;r!==qe.UP_TO_DATE_&&(e.dependenciesState_=r,e.onBecomeStale_())}(e),rt(r),o}function Je(e){var t=e.observing_;e.observing_=[];for(var n=t.length;n--;)ct(t[n],e);e.dependenciesState_=qe.NOT_TRACKING_}function Ze(e){var t=et();try{return e()}finally{tt(t)}}function et(){var e=lt.trackingDerivation;return lt.trackingDerivation=null,e}function tt(e){lt.trackingDerivation=e}function nt(e){var t=lt.allowStateReads;return lt.allowStateReads=e,t}function rt(e){lt.allowStateReads=e}function ot(e){if(e.dependenciesState_!==qe.UP_TO_DATE_){e.dependenciesState_=qe.UP_TO_DATE_;for(var t=e.observing_,n=t.length;n--;)t[n].lowestObserverState_=qe.UP_TO_DATE_}}var it=function(){this.version=6,this.UNCHANGED={},this.trackingDerivation=null,this.trackingContext=null,this.runId=0,this.mobxGuid=0,this.inBatch=0,this.pendingUnobservations=[],this.pendingReactions=[],this.isRunningReactions=!1,this.allowStateChanges=!1,this.allowStateReads=!0,this.enforceActions=!0,this.spyListeners=[],this.globalReactionErrorHandlers=[],this.computedRequiresReaction=!1,this.reactionRequiresObservable=!1,this.observableRequiresReaction=!1,this.disableErrorBoundaries=!1,this.suppressReactionErrors=!1,this.useProxies=!0,this.verifyProxies=!1,this.safeDescriptors=!0},at=!0,st=!1,lt=function(){var e=l();return e.__mobxInstanceCount>0&&!e.__mobxGlobals&&(at=!1),e.__mobxGlobals&&e.__mobxGlobals.version!==(new it).version&&(at=!1),at?e.__mobxGlobals?(e.__mobxInstanceCount+=1,e.__mobxGlobals.UNCHANGED||(e.__mobxGlobals.UNCHANGED={}),e.__mobxGlobals):(e.__mobxInstanceCount=1,e.__mobxGlobals=new it):(setTimeout((function(){st||a(35)}),1),new it)}();function ct(e,t){e.observers_.delete(t),0===e.observers_.size&&ut(e)}function ut(e){!1===e.isPendingUnobservation_&&(e.isPendingUnobservation_=!0,lt.pendingUnobservations.push(e))}function pt(){lt.inBatch++}function dt(){if(0==--lt.inBatch){yt();for(var e=lt.pendingUnobservations,t=0;t<e.length;t++){var n=e[t];n.isPendingUnobservation_=!1,0===n.observers_.size&&(n.isBeingObserved_&&(n.isBeingObserved_=!1,n.onBUO()),n instanceof He&&n.suspend_())}lt.pendingUnobservations=[]}}function ft(e){var t=lt.trackingDerivation;return null!==t?(t.runId_!==e.lastAccessedBy_&&(e.lastAccessedBy_=t.runId_,t.newObserving_[t.unboundDepsCount_++]=e,!e.isBeingObserved_&<.trackingContext&&(e.isBeingObserved_=!0,e.onBO())),!0):(0===e.observers_.size&<.inBatch>0&&ut(e),!1)}function ht(e){e.lowestObserverState_!==qe.STALE_&&(e.lowestObserverState_=qe.STALE_,e.observers_.forEach((function(e){e.dependenciesState_===qe.UP_TO_DATE_&&e.onBecomeStale_(),e.dependenciesState_=qe.STALE_})))}var mt=function(){function e(e,t,n,r){void 0===e&&(e="Reaction"),void 0===r&&(r=!1),this.name_=void 0,this.onInvalidate_=void 0,this.errorHandler_=void 0,this.requiresObservable_=void 0,this.observing_=[],this.newObserving_=[],this.dependenciesState_=qe.NOT_TRACKING_,this.diffValue_=0,this.runId_=0,this.unboundDepsCount_=0,this.isDisposed_=!1,this.isScheduled_=!1,this.isTrackPending_=!1,this.isRunning_=!1,this.isTracing_=We.NONE,this.name_=e,this.onInvalidate_=t,this.errorHandler_=n,this.requiresObservable_=r}var t=e.prototype;return t.onBecomeStale_=function(){this.schedule_()},t.schedule_=function(){this.isScheduled_||(this.isScheduled_=!0,lt.pendingReactions.push(this),yt())},t.isScheduled=function(){return this.isScheduled_},t.runReaction_=function(){if(!this.isDisposed_){pt(),this.isScheduled_=!1;var e=lt.trackingContext;if(lt.trackingContext=this,Qe(this)){this.isTrackPending_=!0;try{this.onInvalidate_()}catch(e){this.reportExceptionInDerivation_(e)}}lt.trackingContext=e,dt()}},t.track=function(e){if(!this.isDisposed_){pt(),this.isRunning_=!0;var t=lt.trackingContext;lt.trackingContext=this;var n=Xe(this,e,void 0);lt.trackingContext=t,this.isRunning_=!1,this.isTrackPending_=!1,this.isDisposed_&&Je(this),Ge(n)&&this.reportExceptionInDerivation_(n.cause),dt()}},t.reportExceptionInDerivation_=function(e){var t=this;if(this.errorHandler_)this.errorHandler_(e,this);else{if(lt.disableErrorBoundaries)throw e;var n="[mobx] uncaught error in '"+this+"'";lt.suppressReactionErrors||console.error(n,e),lt.globalReactionErrorHandlers.forEach((function(n){return n(e,t)}))}},t.dispose=function(){this.isDisposed_||(this.isDisposed_=!0,this.isRunning_||(pt(),Je(this),dt()))},t.getDisposer_=function(){var e=this.dispose.bind(this);return e[W]=this,e},t.toString=function(){return"Reaction["+this.name_+"]"},t.trace=function(e){void 0===e&&(e=!1),function(){a("trace() is not available in production builds");for(var e=!1,t=arguments.length,n=new Array(t),r=0;r<t;r++)n[r]=arguments[r];"boolean"==typeof n[n.length-1]&&(e=n.pop());var o=Wt(n);if(!o)return a("'trace(break?)' can only be used inside a tracked computed value or a Reaction. Consider passing in the computed value or reaction explicitly");o.isTracing_===We.NONE&&console.log("[mobx.trace] '"+o.name_+"' tracing enabled"),o.isTracing_=e?We.BREAK:We.LOG}(this,e)},e}(),gt=function(e){return e()};function yt(){lt.inBatch>0||lt.isRunningReactions||gt(vt)}function vt(){lt.isRunningReactions=!0;for(var e=lt.pendingReactions,t=0;e.length>0;){100==++t&&(console.error("[mobx] cycle in reaction: "+e[0]),e.splice(0));for(var n=e.splice(0),r=0,o=n.length;r<o;r++)n[r].runReaction_()}lt.isRunningReactions=!1}var bt=P("Reaction",mt),wt="action",xt="autoAction",kt=Z(wt),_t=Z("action.bound",{bound:!0}),Ot=Z(xt,{autoAction:!0}),St=Z("autoAction.bound",{autoAction:!0,bound:!0});function Et(e){return function(t,n){return w(t)?Me(t.name||"<unnamed action>",t,e):w(n)?Me(t,n,e):x(n)?q(t,n,e?Ot:kt):x(t)?B(Z(e?xt:wt,{name:t,autoAction:e})):void 0}}var Pt=Et(!1);Object.assign(Pt,kt);var At=Et(!0);function $t(e){return w(e)&&!0===e.isMobxAction}Object.assign(At,Ot),Pt.bound=B(_t),At.bound=B(St);var Ct=function(e){return e()};var Rt="onBO";function jt(e,t,n){return Tt("onBUO",e,t,n)}function Tt(e,t,n,r){var o="function"==typeof r?Bn(t,n):Bn(t),i=w(r)?r:n,a=e+"L";return o[a]?o[a].add(i):o[a]=new Set([i]),function(){var e=o[a];e&&(e.delete(i),0===e.size&&delete o[a])}}var It="always";function Nt(e){!0===e.isolateGlobalState&&function(){if((lt.pendingReactions.length||lt.inBatch||lt.isRunningReactions)&&a(36),st=!0,at){var e=l();0==--e.__mobxInstanceCount&&(e.__mobxGlobals=void 0),lt=new it}}();var t,n,r=e.useProxies,o=e.enforceActions;if(void 0!==r&&(lt.useProxies=r===It||"never"!==r&&"undefined"!=typeof Proxy),"ifavailable"===r&&(lt.verifyProxies=!0),void 0!==o){var i=o===It?It:"observed"===o;lt.enforceActions=i,lt.allowStateChanges=!0!==i&&i!==It}["computedRequiresReaction","reactionRequiresObservable","observableRequiresReaction","disableErrorBoundaries","safeDescriptors"].forEach((function(t){t in e&&(lt[t]=!!e[t])})),lt.allowStateReads=!lt.observableRequiresReaction,e.reactionScheduler&&(t=e.reactionScheduler,n=gt,gt=function(e){return t((function(){return n(e)}))})}function Dt(e){var t,n={name:e.name_};return e.observing_&&e.observing_.length>0&&(n.dependencies=(t=e.observing_,Array.from(new Set(t))).map(Dt)),n}var Lt=0;function Mt(){this.message="FLOW_CANCELLED"}Mt.prototype=Object.create(Error.prototype);var Ft=re("flow"),zt=re("flow.bound",{bound:!0}),Ut=Object.assign((function(e,t){if(x(t))return q(e,t,Ft);var n=e,r=n.name||"<unnamed flow>",o=function(){var e,t=this,o=arguments,i=++Lt,a=Pt(r+" - runid: "+i+" - init",n).apply(t,o),s=void 0,l=new Promise((function(t,n){var o=0;function l(e){var t;s=void 0;try{t=Pt(r+" - runid: "+i+" - yield "+o++,a.next).call(a,e)}catch(e){return n(e)}u(t)}function c(e){var t;s=void 0;try{t=Pt(r+" - runid: "+i+" - yield "+o++,a.throw).call(a,e)}catch(e){return n(e)}u(t)}function u(e){if(!w(null==e?void 0:e.then))return e.done?t(e.value):(s=Promise.resolve(e.value)).then(l,c);e.then(u,n)}e=n,l(void 0)}));return l.cancel=Pt(r+" - runid: "+i+" - cancel",(function(){try{s&&Vt(s);var t=a.return(void 0),n=Promise.resolve(t.value);n.then(b,b),Vt(n),e(new Mt)}catch(t){e(t)}})),l};return o.isMobXFlow=!0,o}),Ft);function Vt(e){w(e.cancel)&&e.cancel()}function Bt(e){return!0===(null==e?void 0:e.isMobXFlow)}function qt(e){return function(e,t){return!!e&&(void 0!==t?!!Tn(e)&&e[W].values_.has(t):Tn(e)||!!e[W]||Y(e)||bt(e)||Ye(e))}(e)}function Wt(e){switch(e.length){case 0:return lt.trackingDerivation;case 1:return Bn(e[0]);case 2:return Bn(e[0],e[1])}}function Ht(e,t){void 0===t&&(t=void 0),pt();try{return e.apply(t)}finally{dt()}}function Yt(e){return e[W]}Ut.bound=B(zt);var Kt={has:function(e,t){return Yt(e).has_(t)},get:function(e,t){return Yt(e).get_(t)},set:function(e,t,n){var r;return!!x(t)&&(null==(r=Yt(e).set_(t,n,!0))||r)},deleteProperty:function(e,t){var n;return!!x(t)&&(null==(n=Yt(e).delete_(t,!0))||n)},defineProperty:function(e,t,n){var r;return null==(r=Yt(e).defineProperty_(t,n))||r},ownKeys:function(e){return Yt(e).ownKeys_()},preventExtensions:function(e){a(13)}};function Gt(e){return void 0!==e.interceptors_&&e.interceptors_.length>0}function Qt(e,t){var n=e.interceptors_||(e.interceptors_=[]);return n.push(t),v((function(){var e=n.indexOf(t);-1!==e&&n.splice(e,1)}))}function Xt(e,t){var n=et();try{for(var r=[].concat(e.interceptors_||[]),o=0,i=r.length;o<i&&((t=r[o](t))&&!t.type&&a(14),t);o++);return t}finally{tt(n)}}function Jt(e){return void 0!==e.changeListeners_&&e.changeListeners_.length>0}function Zt(e,t){var n=e.changeListeners_||(e.changeListeners_=[]);return n.push(t),v((function(){var e=n.indexOf(t);-1!==e&&n.splice(e,1)}))}function en(e,t){var n=et(),r=e.changeListeners_;if(r){for(var o=0,i=(r=r.slice()).length;o<i;o++)r[o](t);tt(n)}}function tn(e,t,n){var r=Cn(e,n)[W];pt();try{null!=t||(t=function(e){return T(e,V)||S(e,V,L({},e[V])),e[V]}(e)),R(t).forEach((function(e){return r.make_(e,t[e])}))}finally{dt()}return e}var nn="splice",rn="update",on={get:function(e,t){var n=e[W];return t===W?n:"length"===t?n.getArrayLength_():"string"!=typeof t||isNaN(t)?T(ln,t)?ln[t]:e[t]:n.get_(parseInt(t))},set:function(e,t,n){var r=e[W];return"length"===t&&r.setArrayLength_(n),"symbol"==typeof t||isNaN(t)?e[t]=n:r.set_(parseInt(t),n),!0},preventExtensions:function(){a(15)}},an=function(){function e(e,t,n,r){void 0===e&&(e="ObservableArray"),this.owned_=void 0,this.legacyMode_=void 0,this.atom_=void 0,this.values_=[],this.interceptors_=void 0,this.changeListeners_=void 0,this.enhancer_=void 0,this.dehancer=void 0,this.proxy_=void 0,this.lastKnownLength_=0,this.owned_=n,this.legacyMode_=r,this.atom_=new H(e),this.enhancer_=function(e,n){return t(e,n,"ObservableArray[..]")}}var t=e.prototype;return t.dehanceValue_=function(e){return void 0!==this.dehancer?this.dehancer(e):e},t.dehanceValues_=function(e){return void 0!==this.dehancer&&e.length>0?e.map(this.dehancer):e},t.intercept_=function(e){return Qt(this,e)},t.observe_=function(e,t){return void 0===t&&(t=!1),t&&e({observableKind:"array",object:this.proxy_,debugObjectName:this.atom_.name_,type:"splice",index:0,added:this.values_.slice(),addedCount:this.values_.length,removed:[],removedCount:0}),Zt(this,e)},t.getArrayLength_=function(){return this.atom_.reportObserved(),this.values_.length},t.setArrayLength_=function(e){("number"!=typeof e||e<0)&&a("Out of range: "+e);var t=this.values_.length;if(e!==t)if(e>t){for(var n=new Array(e-t),r=0;r<e-t;r++)n[r]=void 0;this.spliceWithArray_(t,0,n)}else this.spliceWithArray_(e,t-e)},t.updateArrayLength_=function(e,t){e!==this.lastKnownLength_&&a(16),this.lastKnownLength_+=t,this.legacyMode_&&t>0&&Un(e+t+1)},t.spliceWithArray_=function(e,t,n){var r=this;this.atom_;var o=this.values_.length;if(void 0===e?e=0:e>o?e=o:e<0&&(e=Math.max(0,o+e)),t=1===arguments.length?o-e:null==t?0:Math.max(0,Math.min(t,o-e)),void 0===n&&(n=f),Gt(this)){var i=Xt(this,{object:this.proxy_,type:nn,index:e,removedCount:t,added:n});if(!i)return f;t=i.removedCount,n=i.added}if(n=0===n.length?n:n.map((function(e){return r.enhancer_(e,void 0)})),this.legacyMode_){var a=n.length-t;this.updateArrayLength_(o,a)}var s=this.spliceItemsIntoValues_(e,t,n);return 0===t&&0===n.length||this.notifyArraySplice_(e,n,s),this.dehanceValues_(s)},t.spliceItemsIntoValues_=function(e,t,n){var r;if(n.length<1e4)return(r=this.values_).splice.apply(r,[e,t].concat(n));var o=this.values_.slice(e,e+t),i=this.values_.slice(e+t);this.values_.length=e+n.length-t;for(var a=0;a<n.length;a++)this.values_[e+a]=n[a];for(var s=0;s<i.length;s++)this.values_[e+n.length+s]=i[s];return o},t.notifyArrayChildUpdate_=function(e,t,n){var r=!this.owned_&&!1,o=Jt(this),i=o||r?{observableKind:"array",object:this.proxy_,type:rn,debugObjectName:this.atom_.name_,index:e,newValue:t,oldValue:n}:null;this.atom_.reportChanged(),o&&en(this,i)},t.notifyArraySplice_=function(e,t,n){var r=!this.owned_&&!1,o=Jt(this),i=o||r?{observableKind:"array",object:this.proxy_,debugObjectName:this.atom_.name_,type:nn,index:e,removed:n,added:t,removedCount:n.length,addedCount:t.length}:null;this.atom_.reportChanged(),o&&en(this,i)},t.get_=function(e){if(e<this.values_.length)return this.atom_.reportObserved(),this.dehanceValue_(this.values_[e]);console.warn("[mobx.array] Attempt to read an array index ("+e+") that is out of bounds ("+this.values_.length+"). Please check length first. Out of bound indices will not be tracked by MobX")},t.set_=function(e,t){var n=this.values_;if(e<n.length){this.atom_;var r=n[e];if(Gt(this)){var o=Xt(this,{type:rn,object:this.proxy_,index:e,newValue:t});if(!o)return;t=o.newValue}(t=this.enhancer_(t,r))!==r&&(n[e]=t,this.notifyArrayChildUpdate_(e,t,r))}else e===n.length?this.spliceWithArray_(e,0,[t]):a(17,e,n.length)},e}();function sn(e,t,n,r){void 0===n&&(n="ObservableArray"),void 0===r&&(r=!1),y();var o=new an(n,t,r,!1);E(o.values_,W,o);var i=new Proxy(o.values_,on);if(o.proxy_=i,e&&e.length){var a=ze(!0);o.spliceWithArray_(0,0,e),Ue(a)}return i}var ln={clear:function(){return this.splice(0)},replace:function(e){var t=this[W];return t.spliceWithArray_(0,t.values_.length,e)},toJSON:function(){return this.slice()},splice:function(e,t){for(var n=arguments.length,r=new Array(n>2?n-2:0),o=2;o<n;o++)r[o-2]=arguments[o];var i=this[W];switch(arguments.length){case 0:return[];case 1:return i.spliceWithArray_(e);case 2:return i.spliceWithArray_(e,t)}return i.spliceWithArray_(e,t,r)},spliceWithArray:function(e,t,n){return this[W].spliceWithArray_(e,t,n)},push:function(){for(var e=this[W],t=arguments.length,n=new Array(t),r=0;r<t;r++)n[r]=arguments[r];return e.spliceWithArray_(e.values_.length,0,n),e.values_.length},pop:function(){return this.splice(Math.max(this[W].values_.length-1,0),1)[0]},shift:function(){return this.splice(0,1)[0]},unshift:function(){for(var e=this[W],t=arguments.length,n=new Array(t),r=0;r<t;r++)n[r]=arguments[r];return e.spliceWithArray_(0,0,n),e.values_.length},reverse:function(){return lt.trackingDerivation&&a(37,"reverse"),this.replace(this.slice().reverse()),this},sort:function(){lt.trackingDerivation&&a(37,"sort");var e=this.slice();return e.sort.apply(e,arguments),this.replace(e),this},remove:function(e){var t=this[W],n=t.dehanceValues_(t.values_).indexOf(e);return n>-1&&(this.splice(n,1),!0)}};function cn(e,t){"function"==typeof Array.prototype[e]&&(ln[e]=t(e))}function un(e){return function(){var t=this[W];t.atom_.reportObserved();var n=t.dehanceValues_(t.values_);return n[e].apply(n,arguments)}}function pn(e){return function(t,n){var r=this,o=this[W];return o.atom_.reportObserved(),o.dehanceValues_(o.values_)[e]((function(e,o){return t.call(n,e,o,r)}))}}function dn(e){return function(){var t=this,n=this[W];n.atom_.reportObserved();var r=n.dehanceValues_(n.values_),o=arguments[0];return arguments[0]=function(e,n,r){return o(e,n,r,t)},r[e].apply(r,arguments)}}cn("concat",un),cn("flat",un),cn("includes",un),cn("indexOf",un),cn("join",un),cn("lastIndexOf",un),cn("slice",un),cn("toString",un),cn("toLocaleString",un),cn("every",pn),cn("filter",pn),cn("find",pn),cn("findIndex",pn),cn("flatMap",pn),cn("forEach",pn),cn("map",pn),cn("some",pn),cn("reduce",dn),cn("reduceRight",dn);var fn,hn,mn=P("ObservableArrayAdministration",an);function gn(e){return k(e)&&mn(e[W])}var yn={},vn="add",bn="delete";fn=Symbol.iterator,hn=Symbol.toStringTag;var wn,xn,kn=function(){function e(e,t,n){void 0===t&&(t=Q),void 0===n&&(n="ObservableMap"),this.enhancer_=void 0,this.name_=void 0,this[W]=yn,this.data_=void 0,this.hasMap_=void 0,this.keysAtom_=void 0,this.interceptors_=void 0,this.changeListeners_=void 0,this.dehancer=void 0,this.enhancer_=t,this.name_=n,w(Map)||a(18),this.keysAtom_=K("ObservableMap.keys()"),this.data_=new Map,this.hasMap_=new Map,this.merge(e)}var t=e.prototype;return t.has_=function(e){return this.data_.has(e)},t.has=function(e){var t=this;if(!lt.trackingDerivation)return this.has_(e);var n=this.hasMap_.get(e);if(!n){var r=n=new Be(this.has_(e),X,"ObservableMap.key?",!1);this.hasMap_.set(e,r),jt(r,(function(){return t.hasMap_.delete(e)}))}return n.get()},t.set=function(e,t){var n=this.has_(e);if(Gt(this)){var r=Xt(this,{type:n?rn:vn,object:this,newValue:t,name:e});if(!r)return this;t=r.newValue}return n?this.updateValue_(e,t):this.addValue_(e,t),this},t.delete=function(e){var t=this;if(this.keysAtom_,Gt(this)&&!Xt(this,{type:bn,object:this,name:e}))return!1;if(this.has_(e)){var n=Jt(this),r=n?{observableKind:"map",debugObjectName:this.name_,type:bn,object:this,oldValue:this.data_.get(e).value_,name:e}:null;return Ht((function(){t.keysAtom_.reportChanged(),t.updateHasMapEntry_(e,!1),t.data_.get(e).setNewValue_(void 0),t.data_.delete(e)})),n&&en(this,r),!0}return!1},t.updateHasMapEntry_=function(e,t){var n=this.hasMap_.get(e);n&&n.setNewValue_(t)},t.updateValue_=function(e,t){var n=this.data_.get(e);if((t=n.prepareNewValue_(t))!==lt.UNCHANGED){var r=Jt(this),o=r?{observableKind:"map",debugObjectName:this.name_,type:rn,object:this,oldValue:n.value_,name:e,newValue:t}:null;n.setNewValue_(t),r&&en(this,o)}},t.addValue_=function(e,t){var n=this;this.keysAtom_,Ht((function(){var r=new Be(t,n.enhancer_,"ObservableMap.key",!1);n.data_.set(e,r),t=r.value_,n.updateHasMapEntry_(e,!0),n.keysAtom_.reportChanged()}));var r=Jt(this),o=r?{observableKind:"map",debugObjectName:this.name_,type:vn,object:this,name:e,newValue:t}:null;r&&en(this,o)},t.get=function(e){return this.has(e)?this.dehanceValue_(this.data_.get(e).get()):this.dehanceValue_(void 0)},t.dehanceValue_=function(e){return void 0!==this.dehancer?this.dehancer(e):e},t.keys=function(){return this.keysAtom_.reportObserved(),this.data_.keys()},t.values=function(){var e=this,t=this.keys();return Qn({next:function(){var n=t.next(),r=n.done,o=n.value;return{done:r,value:r?void 0:e.get(o)}}})},t.entries=function(){var e=this,t=this.keys();return Qn({next:function(){var n=t.next(),r=n.done,o=n.value;return{done:r,value:r?void 0:[o,e.get(o)]}}})},t[fn]=function(){return this.entries()},t.forEach=function(e,t){for(var n,r=U(this);!(n=r()).done;){var o=n.value,i=o[0],a=o[1];e.call(t,a,i,this)}},t.merge=function(e){var t=this;return _n(e)&&(e=new Map(e)),Ht((function(){_(e)?function(e){var t=Object.keys(e);if(!C)return t;var n=Object.getOwnPropertySymbols(e);return n.length?[].concat(t,n.filter((function(t){return d.propertyIsEnumerable.call(e,t)}))):t}(e).forEach((function(n){return t.set(n,e[n])})):Array.isArray(e)?e.forEach((function(e){var n=e[0],r=e[1];return t.set(n,r)})):A(e)?(e.constructor!==Map&&a(19,e),e.forEach((function(e,n){return t.set(n,e)}))):null!=e&&a(20,e)})),this},t.clear=function(){var e=this;Ht((function(){Ze((function(){for(var t,n=U(e.keys());!(t=n()).done;){var r=t.value;e.delete(r)}}))}))},t.replace=function(e){var t=this;return Ht((function(){for(var n,r=function(e){if(A(e)||_n(e))return e;if(Array.isArray(e))return new Map(e);if(_(e)){var t=new Map;for(var n in e)t.set(n,e[n]);return t}return a(21,e)}(e),o=new Map,i=!1,s=U(t.data_.keys());!(n=s()).done;){var l=n.value;if(!r.has(l))if(t.delete(l))i=!0;else{var c=t.data_.get(l);o.set(l,c)}}for(var u,p=U(r.entries());!(u=p()).done;){var d=u.value,f=d[0],h=d[1],m=t.data_.has(f);if(t.set(f,h),t.data_.has(f)){var g=t.data_.get(f);o.set(f,g),m||(i=!0)}}if(!i)if(t.data_.size!==o.size)t.keysAtom_.reportChanged();else for(var y=t.data_.keys(),v=o.keys(),b=y.next(),w=v.next();!b.done;){if(b.value!==w.value){t.keysAtom_.reportChanged();break}b=y.next(),w=v.next()}t.data_=o})),this},t.toString=function(){return"[object ObservableMap]"},t.toJSON=function(){return Array.from(this)},t.observe_=function(e,t){return Zt(this,e)},t.intercept_=function(e){return Qt(this,e)},D(e,[{key:"size",get:function(){return this.keysAtom_.reportObserved(),this.data_.size}},{key:hn,get:function(){return"Map"}}]),e}(),_n=P("ObservableMap",kn),On={};wn=Symbol.iterator,xn=Symbol.toStringTag;var Sn=function(){function e(e,t,n){void 0===t&&(t=Q),void 0===n&&(n="ObservableSet"),this.name_=void 0,this[W]=On,this.data_=new Set,this.atom_=void 0,this.changeListeners_=void 0,this.interceptors_=void 0,this.dehancer=void 0,this.enhancer_=void 0,this.name_=n,w(Set)||a(22),this.atom_=K(this.name_),this.enhancer_=function(e,r){return t(e,r,n)},e&&this.replace(e)}var t=e.prototype;return t.dehanceValue_=function(e){return void 0!==this.dehancer?this.dehancer(e):e},t.clear=function(){var e=this;Ht((function(){Ze((function(){for(var t,n=U(e.data_.values());!(t=n()).done;){var r=t.value;e.delete(r)}}))}))},t.forEach=function(e,t){for(var n,r=U(this);!(n=r()).done;){var o=n.value;e.call(t,o,o,this)}},t.add=function(e){var t=this;if(this.atom_,Gt(this)&&!Xt(this,{type:vn,object:this,newValue:e}))return this;if(!this.has(e)){Ht((function(){t.data_.add(t.enhancer_(e,void 0)),t.atom_.reportChanged()}));var n=Jt(this),r=n?{observableKind:"set",debugObjectName:this.name_,type:vn,object:this,newValue:e}:null;n&&en(this,r)}return this},t.delete=function(e){var t=this;if(Gt(this)&&!Xt(this,{type:bn,object:this,oldValue:e}))return!1;if(this.has(e)){var n=Jt(this),r=n?{observableKind:"set",debugObjectName:this.name_,type:bn,object:this,oldValue:e}:null;return Ht((function(){t.atom_.reportChanged(),t.data_.delete(e)})),n&&en(this,r),!0}return!1},t.has=function(e){return this.atom_.reportObserved(),this.data_.has(this.dehanceValue_(e))},t.entries=function(){var e=0,t=Array.from(this.keys()),n=Array.from(this.values());return Qn({next:function(){var r=e;return e+=1,r<n.length?{value:[t[r],n[r]],done:!1}:{done:!0}}})},t.keys=function(){return this.values()},t.values=function(){this.atom_.reportObserved();var e=this,t=0,n=Array.from(this.data_.values());return Qn({next:function(){return t<n.length?{value:e.dehanceValue_(n[t++]),done:!1}:{done:!0}}})},t.replace=function(e){var t=this;return En(e)&&(e=new Set(e)),Ht((function(){Array.isArray(e)||$(e)?(t.clear(),e.forEach((function(e){return t.add(e)}))):null!=e&&a("Cannot initialize set from "+e)})),this},t.observe_=function(e,t){return Zt(this,e)},t.intercept_=function(e){return Qt(this,e)},t.toJSON=function(){return Array.from(this)},t.toString=function(){return"[object ObservableSet]"},t[wn]=function(){return this.values()},D(e,[{key:"size",get:function(){return this.atom_.reportObserved(),this.data_.size}},{key:xn,get:function(){return"Set"}}]),e}(),En=P("ObservableSet",Sn),Pn=Object.create(null),An="remove",$n=function(){function e(e,t,n,r){void 0===t&&(t=new Map),void 0===r&&(r=fe),this.target_=void 0,this.values_=void 0,this.name_=void 0,this.defaultAnnotation_=void 0,this.keysAtom_=void 0,this.changeListeners_=void 0,this.interceptors_=void 0,this.proxy_=void 0,this.isPlainObject_=void 0,this.appliedAnnotations_=void 0,this.pendingKeys_=void 0,this.target_=e,this.values_=t,this.name_=n,this.defaultAnnotation_=r,this.keysAtom_=new H("ObservableObject.keys"),this.isPlainObject_=_(this.target_)}var t=e.prototype;return t.getObservablePropValue_=function(e){return this.values_.get(e).get()},t.setObservablePropValue_=function(e,t){var n=this.values_.get(e);if(n instanceof He)return n.set(t),!0;if(Gt(this)){var r=Xt(this,{type:rn,object:this.proxy_||this.target_,name:e,newValue:t});if(!r)return null;t=r.newValue}if((t=n.prepareNewValue_(t))!==lt.UNCHANGED){var o=Jt(this),i=o?{type:rn,observableKind:"object",debugObjectName:this.name_,object:this.proxy_||this.target_,oldValue:n.value_,name:e,newValue:t}:null;n.setNewValue_(t),o&&en(this,i)}return!0},t.get_=function(e){return lt.trackingDerivation&&!T(this.target_,e)&&this.has_(e),this.target_[e]},t.set_=function(e,t,n){return void 0===n&&(n=!1),T(this.target_,e)?this.values_.has(e)?this.setObservablePropValue_(e,t):n?Reflect.set(this.target_,e,t):(this.target_[e]=t,!0):this.extend_(e,{value:t,enumerable:!0,writable:!0,configurable:!0},this.defaultAnnotation_,n)},t.has_=function(e){if(!lt.trackingDerivation)return e in this.target_;this.pendingKeys_||(this.pendingKeys_=new Map);var t=this.pendingKeys_.get(e);return t||(t=new Be(e in this.target_,X,"ObservableObject.key?",!1),this.pendingKeys_.set(e,t)),t.get()},t.make_=function(e,t){if(!0===t&&(t=this.defaultAnnotation_),!1!==t){if(!(e in this.target_)){var n;if(null==(n=this.target_[V])?void 0:n[e])return;a(1,t.annotationType_,this.name_+"."+e.toString())}for(var r=this.target_;r&&r!==d;){var o=u(r,e);if(o){var i=t.make_(this,e,o,r);if(0===i)return;if(1===i)break}r=Object.getPrototypeOf(r)}In(this,0,e)}},t.extend_=function(e,t,n,r){if(void 0===r&&(r=!1),!0===n&&(n=this.defaultAnnotation_),!1===n)return this.defineProperty_(e,t,r);var o=n.extend_(this,e,t,r);return o&&In(this,0,e),o},t.defineProperty_=function(e,t,n){void 0===n&&(n=!1);try{pt();var r=this.delete_(e);if(!r)return r;if(Gt(this)){var o=Xt(this,{object:this.proxy_||this.target_,name:e,type:vn,newValue:t.value});if(!o)return null;var i=o.newValue;t.value!==i&&(t=L({},t,{value:i}))}if(n){if(!Reflect.defineProperty(this.target_,e,t))return!1}else p(this.target_,e,t);this.notifyPropertyAddition_(e,t.value)}finally{dt()}return!0},t.defineObservableProperty_=function(e,t,n,r){void 0===r&&(r=!1);try{pt();var o=this.delete_(e);if(!o)return o;if(Gt(this)){var i=Xt(this,{object:this.proxy_||this.target_,name:e,type:vn,newValue:t});if(!i)return null;t=i.newValue}var a=jn(e),s={configurable:!lt.safeDescriptors||this.isPlainObject_,enumerable:!0,get:a.get,set:a.set};if(r){if(!Reflect.defineProperty(this.target_,e,s))return!1}else p(this.target_,e,s);var l=new Be(t,n,"ObservableObject.key",!1);this.values_.set(e,l),this.notifyPropertyAddition_(e,l.value_)}finally{dt()}return!0},t.defineComputedProperty_=function(e,t,n){void 0===n&&(n=!1);try{pt();var r=this.delete_(e);if(!r)return r;if(Gt(this)&&!Xt(this,{object:this.proxy_||this.target_,name:e,type:vn,newValue:void 0}))return null;t.name||(t.name="ObservableObject.key"),t.context=this.proxy_||this.target_;var o=jn(e),i={configurable:!lt.safeDescriptors||this.isPlainObject_,enumerable:!1,get:o.get,set:o.set};if(n){if(!Reflect.defineProperty(this.target_,e,i))return!1}else p(this.target_,e,i);this.values_.set(e,new He(t)),this.notifyPropertyAddition_(e,void 0)}finally{dt()}return!0},t.delete_=function(e,t){if(void 0===t&&(t=!1),!T(this.target_,e))return!0;if(Gt(this)&&!Xt(this,{object:this.proxy_||this.target_,name:e,type:An}))return null;try{var n,r;pt();var o,i=Jt(this),a=this.values_.get(e),s=void 0;if(!a&&i&&(s=null==(o=u(this.target_,e))?void 0:o.value),t){if(!Reflect.deleteProperty(this.target_,e))return!1}else delete this.target_[e];if(a&&(this.values_.delete(e),a instanceof Be&&(s=a.value_),ht(a)),this.keysAtom_.reportChanged(),null==(n=this.pendingKeys_)||null==(r=n.get(e))||r.set(e in this.target_),i){var l={type:An,observableKind:"object",object:this.proxy_||this.target_,debugObjectName:this.name_,oldValue:s,name:e};i&&en(this,l)}}finally{dt()}return!0},t.observe_=function(e,t){return Zt(this,e)},t.intercept_=function(e){return Qt(this,e)},t.notifyPropertyAddition_=function(e,t){var n,r,o=Jt(this);if(o){var i=o?{type:vn,observableKind:"object",debugObjectName:this.name_,object:this.proxy_||this.target_,name:e,newValue:t}:null;o&&en(this,i)}null==(n=this.pendingKeys_)||null==(r=n.get(e))||r.set(!0),this.keysAtom_.reportChanged()},t.ownKeys_=function(){return this.keysAtom_.reportObserved(),R(this.target_)},t.keys_=function(){return this.keysAtom_.reportObserved(),Object.keys(this.target_)},e}();function Cn(e,t){var n;if(T(e,W))return e;var r=null!=(n=null==t?void 0:t.name)?n:"ObservableObject",o=new $n(e,new Map,String(r),function(e){var t;return e?null!=(t=e.defaultDecorator)?t:he(e):void 0}(t));return S(e,W,o),e}var Rn=P("ObservableObjectAdministration",$n);function jn(e){return Pn[e]||(Pn[e]={get:function(){return this[W].getObservablePropValue_(e)},set:function(t){return this[W].setObservablePropValue_(e,t)}})}function Tn(e){return!!k(e)&&Rn(e[W])}function In(e,t,n){var r;null==(r=e.target_[V])||delete r[n]}var Nn,Dn,Ln=0,Mn=function(){};Nn=Mn,Dn=Array.prototype,Object.setPrototypeOf?Object.setPrototypeOf(Nn.prototype,Dn):void 0!==Nn.prototype.__proto__?Nn.prototype.__proto__=Dn:Nn.prototype=Dn;var Fn=function(e){function t(t,n,r,o){var i;void 0===r&&(r="ObservableArray"),void 0===o&&(o=!1),i=e.call(this)||this;var a=new an(r,n,o,!0);if(a.proxy_=F(i),E(F(i),W,a),t&&t.length){var s=ze(!0);i.spliceWithArray(0,0,t),Ue(s)}return i}M(t,e);var n=t.prototype;return n.concat=function(){this[W].atom_.reportObserved();for(var e=arguments.length,t=new Array(e),n=0;n<e;n++)t[n]=arguments[n];return Array.prototype.concat.apply(this.slice(),t.map((function(e){return gn(e)?e.slice():e})))},n[Symbol.iterator]=function(){var e=this,t=0;return Qn({next:function(){return t<e.length?{value:e[t++],done:!1}:{done:!0,value:void 0}}})},D(t,[{key:"length",get:function(){return this[W].getArrayLength_()},set:function(e){this[W].setArrayLength_(e)}},{key:Symbol.toStringTag,get:function(){return"Array"}}]),t}(Mn);function zn(e){p(Fn.prototype,""+e,function(e){return{enumerable:!1,configurable:!0,get:function(){return this[W].get_(e)},set:function(t){this[W].set_(e,t)}}}(e))}function Un(e){if(e>Ln){for(var t=Ln;t<e+100;t++)zn(t);Ln=e}}function Vn(e,t,n){return new Fn(e,t,n)}function Bn(e,t){if("object"==typeof e&&null!==e){if(gn(e))return void 0!==t&&a(23),e[W].atom_;if(En(e))return e[W];if(_n(e)){if(void 0===t)return e.keysAtom_;var n=e.data_.get(t)||e.hasMap_.get(t);return n||a(25,t,Wn(e)),n}if(Tn(e)){if(!t)return a(26);var r=e[W].values_.get(t);return r||a(27,t,Wn(e)),r}if(Y(e)||Ye(e)||bt(e))return e}else if(w(e)&&bt(e[W]))return e[W];a(28)}function qn(e,t){return e||a(29),void 0!==t?qn(Bn(e,t)):Y(e)||Ye(e)||bt(e)||_n(e)||En(e)?e:e[W]?e[W]:void a(24,e)}function Wn(e,t){var n;if(void 0!==t)n=Bn(e,t);else{if($t(e))return e.name;n=Tn(e)||_n(e)||En(e)?qn(e):Bn(e)}return n.name_}Object.entries(ln).forEach((function(e){var t=e[0],n=e[1];"concat"!==t&&S(Fn.prototype,t,n)})),Un(1e3);var Hn=d.toString;function Yn(e,t,n){return void 0===n&&(n=-1),Kn(e,t,n)}function Kn(e,t,n,r,o){if(e===t)return 0!==e||1/e==1/t;if(null==e||null==t)return!1;if(e!=e)return t!=t;var i=typeof e;if(!w(i)&&"object"!==i&&"object"!=typeof t)return!1;var a=Hn.call(e);if(a!==Hn.call(t))return!1;switch(a){case"[object RegExp]":case"[object String]":return""+e==""+t;case"[object Number]":return+e!=+e?+t!=+t:0==+e?1/+e==1/t:+e==+t;case"[object Date]":case"[object Boolean]":return+e==+t;case"[object Symbol]":return"undefined"!=typeof Symbol&&Symbol.valueOf.call(e)===Symbol.valueOf.call(t);case"[object Map]":case"[object Set]":n>=0&&n++}e=Gn(e),t=Gn(t);var s="[object Array]"===a;if(!s){if("object"!=typeof e||"object"!=typeof t)return!1;var l=e.constructor,c=t.constructor;if(l!==c&&!(w(l)&&l instanceof l&&w(c)&&c instanceof c)&&"constructor"in e&&"constructor"in t)return!1}if(0===n)return!1;n<0&&(n=-1),o=o||[];for(var u=(r=r||[]).length;u--;)if(r[u]===e)return o[u]===t;if(r.push(e),o.push(t),s){if((u=e.length)!==t.length)return!1;for(;u--;)if(!Kn(e[u],t[u],n-1,r,o))return!1}else{var p,d=Object.keys(e);if(u=d.length,Object.keys(t).length!==u)return!1;for(;u--;)if(!T(t,p=d[u])||!Kn(e[p],t[p],n-1,r,o))return!1}return r.pop(),o.pop(),!0}function Gn(e){return gn(e)?e.slice():A(e)||_n(e)||$(e)||En(e)?Array.from(e.entries()):e}function Qn(e){return e[Symbol.iterator]=Xn,e}function Xn(){return this}function Jn(){return Jn=Object.assign||function(e){for(var t=1;t<arguments.length;t++){var n=arguments[t];for(var r in n)Object.prototype.hasOwnProperty.call(n,r)&&(e[r]=n[r])}return e},Jn.apply(this,arguments)}function Zn(e,t){return Zn=Object.setPrototypeOf||function(e,t){return e.__proto__=t,e},Zn(e,t)}function er(e){return er=Object.setPrototypeOf?Object.getPrototypeOf:function(e){return e.__proto__||Object.getPrototypeOf(e)},er(e)}function tr(){if("undefined"==typeof Reflect||!Reflect.construct)return!1;if(Reflect.construct.sham)return!1;if("function"==typeof Proxy)return!0;try{return Boolean.prototype.valueOf.call(Reflect.construct(Boolean,[],(function(){}))),!0}catch(e){return!1}}function nr(e,t,n){return nr=tr()?Reflect.construct:function(e,t,n){var r=[null];r.push.apply(r,t);var o=new(Function.bind.apply(e,r));return n&&Zn(o,n.prototype),o},nr.apply(null,arguments)}function rr(e){var t="function"==typeof Map?new Map:void 0;return rr=function(e){if(null===e||(n=e,-1===Function.toString.call(n).indexOf("[native code]")))return e;var n;if("function"!=typeof e)throw new TypeError("Super expression must either be null or a function");if(void 0!==t){if(t.has(e))return t.get(e);t.set(e,r)}function r(){return nr(e,arguments,er(this).constructor)}return r.prototype=Object.create(e.prototype,{constructor:{value:r,enumerable:!1,writable:!0,configurable:!0}}),Zn(r,e)},rr(e)}["Symbol","Map","Set","Symbol"].forEach((function(e){void 0===l()[e]&&a("MobX requires global '"+e+"' to be available or polyfilled")})),"object"==typeof __MOBX_DEVTOOLS_GLOBAL_HOOK__&&__MOBX_DEVTOOLS_GLOBAL_HOOK__.injectMobx({spy:function(e){return console.warn("[mobx.spy] Is a no-op in production builds"),function(){}},extras:{getDebugName:Wn},$mobx:W});var or=function(e){var t,n;function r(t){return function(e){if(void 0===e)throw new ReferenceError("this hasn't been initialised - super() hasn't been called");return e}(e.call(this,"An error occurred. See https://github.com/styled-components/polished/blob/main/src/internalHelpers/errors.md#"+t+" for more information.")||this)}return n=e,(t=r).prototype=Object.create(n.prototype),t.prototype.constructor=t,Zn(t,n),r}(rr(Error));function ir(e){return Math.round(255*e)}function ar(e,t,n){return ir(e)+","+ir(t)+","+ir(n)}function sr(e,t,n,r){if(void 0===r&&(r=ar),0===t)return r(n,n,n);var o=(e%360+360)%360/60,i=(1-Math.abs(2*n-1))*t,a=i*(1-Math.abs(o%2-1)),s=0,l=0,c=0;o>=0&&o<1?(s=i,l=a):o>=1&&o<2?(s=a,l=i):o>=2&&o<3?(l=i,c=a):o>=3&&o<4?(l=a,c=i):o>=4&&o<5?(s=a,c=i):o>=5&&o<6&&(s=i,c=a);var u=n-i/2;return r(s+u,l+u,c+u)}var lr={aliceblue:"f0f8ff",antiquewhite:"faebd7",aqua:"00ffff",aquamarine:"7fffd4",azure:"f0ffff",beige:"f5f5dc",bisque:"ffe4c4",black:"000",blanchedalmond:"ffebcd",blue:"0000ff",blueviolet:"8a2be2",brown:"a52a2a",burlywood:"deb887",cadetblue:"5f9ea0",chartreuse:"7fff00",chocolate:"d2691e",coral:"ff7f50",cornflowerblue:"6495ed",cornsilk:"fff8dc",crimson:"dc143c",cyan:"00ffff",darkblue:"00008b",darkcyan:"008b8b",darkgoldenrod:"b8860b",darkgray:"a9a9a9",darkgreen:"006400",darkgrey:"a9a9a9",darkkhaki:"bdb76b",darkmagenta:"8b008b",darkolivegreen:"556b2f",darkorange:"ff8c00",darkorchid:"9932cc",darkred:"8b0000",darksalmon:"e9967a",darkseagreen:"8fbc8f",darkslateblue:"483d8b",darkslategray:"2f4f4f",darkslategrey:"2f4f4f",darkturquoise:"00ced1",darkviolet:"9400d3",deeppink:"ff1493",deepskyblue:"00bfff",dimgray:"696969",dimgrey:"696969",dodgerblue:"1e90ff",firebrick:"b22222",floralwhite:"fffaf0",forestgreen:"228b22",fuchsia:"ff00ff",gainsboro:"dcdcdc",ghostwhite:"f8f8ff",gold:"ffd700",goldenrod:"daa520",gray:"808080",green:"008000",greenyellow:"adff2f",grey:"808080",honeydew:"f0fff0",hotpink:"ff69b4",indianred:"cd5c5c",indigo:"4b0082",ivory:"fffff0",khaki:"f0e68c",lavender:"e6e6fa",lavenderblush:"fff0f5",lawngreen:"7cfc00",lemonchiffon:"fffacd",lightblue:"add8e6",lightcoral:"f08080",lightcyan:"e0ffff",lightgoldenrodyellow:"fafad2",lightgray:"d3d3d3",lightgreen:"90ee90",lightgrey:"d3d3d3",lightpink:"ffb6c1",lightsalmon:"ffa07a",lightseagreen:"20b2aa",lightskyblue:"87cefa",lightslategray:"789",lightslategrey:"789",lightsteelblue:"b0c4de",lightyellow:"ffffe0",lime:"0f0",limegreen:"32cd32",linen:"faf0e6",magenta:"f0f",maroon:"800000",mediumaquamarine:"66cdaa",mediumblue:"0000cd",mediumorchid:"ba55d3",mediumpurple:"9370db",mediumseagreen:"3cb371",mediumslateblue:"7b68ee",mediumspringgreen:"00fa9a",mediumturquoise:"48d1cc",mediumvioletred:"c71585",midnightblue:"191970",mintcream:"f5fffa",mistyrose:"ffe4e1",moccasin:"ffe4b5",navajowhite:"ffdead",navy:"000080",oldlace:"fdf5e6",olive:"808000",olivedrab:"6b8e23",orange:"ffa500",orangered:"ff4500",orchid:"da70d6",palegoldenrod:"eee8aa",palegreen:"98fb98",paleturquoise:"afeeee",palevioletred:"db7093",papayawhip:"ffefd5",peachpuff:"ffdab9",peru:"cd853f",pink:"ffc0cb",plum:"dda0dd",powderblue:"b0e0e6",purple:"800080",rebeccapurple:"639",red:"f00",rosybrown:"bc8f8f",royalblue:"4169e1",saddlebrown:"8b4513",salmon:"fa8072",sandybrown:"f4a460",seagreen:"2e8b57",seashell:"fff5ee",sienna:"a0522d",silver:"c0c0c0",skyblue:"87ceeb",slateblue:"6a5acd",slategray:"708090",slategrey:"708090",snow:"fffafa",springgreen:"00ff7f",steelblue:"4682b4",tan:"d2b48c",teal:"008080",thistle:"d8bfd8",tomato:"ff6347",turquoise:"40e0d0",violet:"ee82ee",wheat:"f5deb3",white:"fff",whitesmoke:"f5f5f5",yellow:"ff0",yellowgreen:"9acd32"},cr=/^#[a-fA-F0-9]{6}$/,ur=/^#[a-fA-F0-9]{8}$/,pr=/^#[a-fA-F0-9]{3}$/,dr=/^#[a-fA-F0-9]{4}$/,fr=/^rgb\(\s*(\d{1,3})\s*,\s*(\d{1,3})\s*,\s*(\d{1,3})\s*\)$/i,hr=/^rgba\(\s*(\d{1,3})\s*,\s*(\d{1,3})\s*,\s*(\d{1,3})\s*,\s*([-+]?[0-9]*[.]?[0-9]+)\s*\)$/i,mr=/^hsl\(\s*(\d{0,3}[.]?[0-9]+)\s*,\s*(\d{1,3}[.]?[0-9]?)%\s*,\s*(\d{1,3}[.]?[0-9]?)%\s*\)$/i,gr=/^hsla\(\s*(\d{0,3}[.]?[0-9]+)\s*,\s*(\d{1,3}[.]?[0-9]?)%\s*,\s*(\d{1,3}[.]?[0-9]?)%\s*,\s*([-+]?[0-9]*[.]?[0-9]+)\s*\)$/i;function yr(e){if("string"!=typeof e)throw new or(3);var t=function(e){if("string"!=typeof e)return e;var t=e.toLowerCase();return lr[t]?"#"+lr[t]:e}(e);if(t.match(cr))return{red:parseInt(""+t[1]+t[2],16),green:parseInt(""+t[3]+t[4],16),blue:parseInt(""+t[5]+t[6],16)};if(t.match(ur)){var n=parseFloat((parseInt(""+t[7]+t[8],16)/255).toFixed(2));return{red:parseInt(""+t[1]+t[2],16),green:parseInt(""+t[3]+t[4],16),blue:parseInt(""+t[5]+t[6],16),alpha:n}}if(t.match(pr))return{red:parseInt(""+t[1]+t[1],16),green:parseInt(""+t[2]+t[2],16),blue:parseInt(""+t[3]+t[3],16)};if(t.match(dr)){var r=parseFloat((parseInt(""+t[4]+t[4],16)/255).toFixed(2));return{red:parseInt(""+t[1]+t[1],16),green:parseInt(""+t[2]+t[2],16),blue:parseInt(""+t[3]+t[3],16),alpha:r}}var o=fr.exec(t);if(o)return{red:parseInt(""+o[1],10),green:parseInt(""+o[2],10),blue:parseInt(""+o[3],10)};var i=hr.exec(t.substring(0,50));if(i)return{red:parseInt(""+i[1],10),green:parseInt(""+i[2],10),blue:parseInt(""+i[3],10),alpha:parseFloat(""+i[4])};var a=mr.exec(t);if(a){var s="rgb("+sr(parseInt(""+a[1],10),parseInt(""+a[2],10)/100,parseInt(""+a[3],10)/100)+")",l=fr.exec(s);if(!l)throw new or(4,t,s);return{red:parseInt(""+l[1],10),green:parseInt(""+l[2],10),blue:parseInt(""+l[3],10)}}var c=gr.exec(t.substring(0,50));if(c){var u="rgb("+sr(parseInt(""+c[1],10),parseInt(""+c[2],10)/100,parseInt(""+c[3],10)/100)+")",p=fr.exec(u);if(!p)throw new or(4,t,u);return{red:parseInt(""+p[1],10),green:parseInt(""+p[2],10),blue:parseInt(""+p[3],10),alpha:parseFloat(""+c[4])}}throw new or(5)}function vr(e){return function(e){var t,n=e.red/255,r=e.green/255,o=e.blue/255,i=Math.max(n,r,o),a=Math.min(n,r,o),s=(i+a)/2;if(i===a)return void 0!==e.alpha?{hue:0,saturation:0,lightness:s,alpha:e.alpha}:{hue:0,saturation:0,lightness:s};var l=i-a,c=s>.5?l/(2-i-a):l/(i+a);switch(i){case n:t=(r-o)/l+(r<o?6:0);break;case r:t=(o-n)/l+2;break;default:t=(n-r)/l+4}return t*=60,void 0!==e.alpha?{hue:t,saturation:c,lightness:s,alpha:e.alpha}:{hue:t,saturation:c,lightness:s}}(yr(e))}var br=function(e){return 7===e.length&&e[1]===e[2]&&e[3]===e[4]&&e[5]===e[6]?"#"+e[1]+e[3]+e[5]:e};function wr(e){var t=e.toString(16);return 1===t.length?"0"+t:t}function xr(e){return wr(Math.round(255*e))}function kr(e,t,n){return br("#"+xr(e)+xr(t)+xr(n))}function _r(e,t,n){return sr(e,t,n,kr)}function Or(e,t,n){if("number"==typeof e&&"number"==typeof t&&"number"==typeof n)return br("#"+wr(e)+wr(t)+wr(n));if("object"==typeof e&&void 0===t&&void 0===n)return br("#"+wr(e.red)+wr(e.green)+wr(e.blue));throw new or(6)}function Sr(e,t,n,r){if("string"==typeof e&&"number"==typeof t){var o=yr(e);return"rgba("+o.red+","+o.green+","+o.blue+","+t+")"}if("number"==typeof e&&"number"==typeof t&&"number"==typeof n&&"number"==typeof r)return r>=1?Or(e,t,n):"rgba("+e+","+t+","+n+","+r+")";if("object"==typeof e&&void 0===t&&void 0===n&&void 0===r)return e.alpha>=1?Or(e.red,e.green,e.blue):"rgba("+e.red+","+e.green+","+e.blue+","+e.alpha+")";throw new or(7)}function Er(e){if("object"!=typeof e)throw new or(8);if(function(e){return"number"==typeof e.red&&"number"==typeof e.green&&"number"==typeof e.blue&&"number"==typeof e.alpha}(e))return Sr(e);if(function(e){return"number"==typeof e.red&&"number"==typeof e.green&&"number"==typeof e.blue&&("number"!=typeof e.alpha||void 0===e.alpha)}(e))return Or(e);if(function(e){return"number"==typeof e.hue&&"number"==typeof e.saturation&&"number"==typeof e.lightness&&"number"==typeof e.alpha}(e))return function(e,t,n,r){if("number"==typeof e&&"number"==typeof t&&"number"==typeof n&&"number"==typeof r)return r>=1?_r(e,t,n):"rgba("+sr(e,t,n)+","+r+")";if("object"==typeof e&&void 0===t&&void 0===n&&void 0===r)return e.alpha>=1?_r(e.hue,e.saturation,e.lightness):"rgba("+sr(e.hue,e.saturation,e.lightness)+","+e.alpha+")";throw new or(2)}(e);if(function(e){return"number"==typeof e.hue&&"number"==typeof e.saturation&&"number"==typeof e.lightness&&("number"!=typeof e.alpha||void 0===e.alpha)}(e))return function(e,t,n){if("number"==typeof e&&"number"==typeof t&&"number"==typeof n)return _r(e,t,n);if("object"==typeof e&&void 0===t&&void 0===n)return _r(e.hue,e.saturation,e.lightness);throw new or(1)}(e);throw new or(8)}function Pr(e,t,n){return function(){var r=n.concat(Array.prototype.slice.call(arguments));return r.length>=t?e.apply(this,r):Pr(e,t,r)}}function Ar(e){return Pr(e,e.length,[])}function $r(e,t,n){return Math.max(e,Math.min(t,n))}function Cr(e,t){if("transparent"===t)return t;var n=vr(t);return Er(Jn({},n,{lightness:$r(0,1,n.lightness-parseFloat(e))}))}var Rr=Ar(Cr);function jr(e,t){if("transparent"===t)return t;var n=vr(t);return Er(Jn({},n,{saturation:$r(0,1,n.saturation-parseFloat(e))}))}var Tr=Ar(jr);function Ir(e){if("transparent"===e)return 0;var t=yr(e),n=Object.keys(t).map((function(e){var n=t[e]/255;return n<=.03928?n/12.92:Math.pow((n+.055)/1.055,2.4)})),r=n[0],o=n[1],i=n[2];return parseFloat((.2126*r+.7152*o+.0722*i).toFixed(3))}function Nr(e,t){if("transparent"===t)return t;var n=vr(t);return Er(Jn({},n,{lightness:$r(0,1,n.lightness+parseFloat(e))}))}var Dr=Ar(Nr),Lr="#000",Mr="#fff";function Fr(e,t,n,r){void 0===t&&(t=Lr),void 0===n&&(n=Mr),void 0===r&&(r=!0);var o,i,a,s=Ir(e)>.179,l=s?t:n;return!r||(o=l,i=Ir(e),a=Ir(o),parseFloat((i>a?(i+.05)/(a+.05):(a+.05)/(i+.05)).toFixed(2))>=4.5)?l:s?Lr:Mr}function zr(e,t){if("transparent"===t)return t;var n=yr(t);return Sr(Jn({},n,{alpha:$r(0,1,+(100*("number"==typeof n.alpha?n.alpha:1)-100*parseFloat(e)).toFixed(2)/100)}))}var Ur=Ar(zr);const Vr={spacing:{unit:5,sectionHorizontal:({spacing:e})=>8*e.unit,sectionVertical:({spacing:e})=>8*e.unit},breakpoints:{small:"50rem",medium:"75rem",large:"105rem"},colors:{tonalOffset:.2,primary:{main:"#32329f",light:({colors:e})=>Dr(e.tonalOffset,e.primary.main),dark:({colors:e})=>Rr(e.tonalOffset,e.primary.main),contrastText:({colors:e})=>Fr(e.primary.main)},success:{main:"#1d8127",light:({colors:e})=>Dr(2*e.tonalOffset,e.success.main),dark:({colors:e})=>Rr(e.tonalOffset,e.success.main),contrastText:({colors:e})=>Fr(e.success.main)},warning:{main:"#ffa500",light:({colors:e})=>Dr(e.tonalOffset,e.warning.main),dark:({colors:e})=>Rr(e.tonalOffset,e.warning.main),contrastText:"#ffffff"},error:{main:"#d41f1c",light:({colors:e})=>Dr(e.tonalOffset,e.error.main),dark:({colors:e})=>Rr(e.tonalOffset,e.error.main),contrastText:({colors:e})=>Fr(e.error.main)},gray:{50:"#FAFAFA",100:"#F5F5F5"},text:{primary:"#333333",secondary:({colors:e})=>Dr(e.tonalOffset,e.text.primary)},border:{dark:"rgba(0,0,0, 0.1)",light:"#ffffff"},responses:{success:{color:({colors:e})=>e.success.main,backgroundColor:({colors:e})=>Ur(.93,e.success.main),tabTextColor:({colors:e})=>e.responses.success.color},error:{color:({colors:e})=>e.error.main,backgroundColor:({colors:e})=>Ur(.93,e.error.main),tabTextColor:({colors:e})=>e.responses.error.color},redirect:{color:({colors:e})=>e.warning.main,backgroundColor:({colors:e})=>Ur(.9,e.responses.redirect.color),tabTextColor:({colors:e})=>e.responses.redirect.color},info:{color:"#87ceeb",backgroundColor:({colors:e})=>Ur(.9,e.responses.info.color),tabTextColor:({colors:e})=>e.responses.info.color}},http:{get:"#2F8132",post:"#186FAF",put:"#95507c",options:"#947014",patch:"#bf581d",delete:"#cc3333",basic:"#707070",link:"#07818F",head:"#A23DAD"}},schema:{linesColor:e=>Dr(e.colors.tonalOffset,Tr(e.colors.tonalOffset,e.colors.primary.main)),defaultDetailsWidth:"75%",typeNameColor:e=>e.colors.text.secondary,typeTitleColor:e=>e.schema.typeNameColor,requireLabelColor:e=>e.colors.error.main,labelsTextSize:"0.9em",nestingSpacing:"1em",nestedBackground:"#fafafa",arrow:{size:"1.1em",color:e=>e.colors.text.secondary}},typography:{fontSize:"14px",lineHeight:"1.5em",fontWeightRegular:"400",fontWeightBold:"600",fontWeightLight:"300",fontFamily:"Roboto, sans-serif",smoothing:"antialiased",optimizeSpeed:!0,headings:{fontFamily:"Montserrat, sans-serif",fontWeight:"400",lineHeight:"1.6em"},code:{fontSize:"13px",fontFamily:"Courier, monospace",lineHeight:({typography:e})=>e.lineHeight,fontWeight:({typography:e})=>e.fontWeightRegular,color:"#e53935",backgroundColor:"rgba(38, 50, 56, 0.05)",wrap:!1},links:{color:({colors:e})=>e.primary.main,visited:({typography:e})=>e.links.color,hover:({typography:e})=>Dr(.2,e.links.color),textDecoration:"auto",hoverTextDecoration:"auto"}},sidebar:{width:"260px",backgroundColor:"#fafafa",textColor:"#333333",activeTextColor:e=>e.sidebar.textColor!==Vr.sidebar.textColor?e.sidebar.textColor:e.colors.primary.main,groupItems:{activeBackgroundColor:e=>Rr(.1,e.sidebar.backgroundColor),activeTextColor:e=>e.sidebar.activeTextColor,textTransform:"uppercase"},level1Items:{activeBackgroundColor:e=>Rr(.05,e.sidebar.backgroundColor),activeTextColor:e=>e.sidebar.activeTextColor,textTransform:"none"},arrow:{size:"1.5em",color:e=>e.sidebar.textColor}},logo:{maxHeight:({sidebar:e})=>e.width,maxWidth:({sidebar:e})=>e.width,gutter:"2px"},rightPanel:{backgroundColor:"#263238",width:"40%",textColor:"#ffffff",servers:{overlay:{backgroundColor:"#fafafa",textColor:"#263238"},url:{backgroundColor:"#fff"}}},codeBlock:{backgroundColor:({rightPanel:e})=>Rr(.1,e.backgroundColor)},fab:{backgroundColor:"#f2f2f2",color:"#0065FB"}};var Br=Vr;const qr="undefined"!=typeof window&&"HTMLElement"in window;function Wr(e){return"undefined"!=typeof document?document.querySelector(e):null}function Hr(e,t=!0){const n=e.parentNode;if(!n)return;const r=window.getComputedStyle(n,void 0),o=parseInt(r.getPropertyValue("border-top-width"),10),i=parseInt(r.getPropertyValue("border-left-width"),10),a=e.offsetTop-n.offsetTop<n.scrollTop,s=e.offsetTop-n.offsetTop+e.clientHeight-o>n.scrollTop+n.clientHeight,l=e.offsetLeft-n.offsetLeft<n.scrollLeft,c=e.offsetLeft-n.offsetLeft+e.clientWidth-i>n.scrollLeft+n.clientWidth,u=a&&!s;(a||s)&&t&&(n.scrollTop=e.offsetTop-n.offsetTop-n.clientHeight/2-o+e.clientHeight/2),(l||c)&&t&&(n.scrollLeft=e.offsetLeft-n.offsetLeft-n.clientWidth/2-i+e.clientWidth/2),(a||s||l||c)&&!t&&e.scrollIntoView(u)}var Yr=r(1304),Kr=r.n(Yr);function Gr(e,t){const n=[];for(let r=0;r<e.length-1;r++)n.push(t(e[r],!1));return 0!==e.length&&n.push(t(e[e.length-1],!0)),n}function Qr(e,t){const n={};for(const r in e)e.hasOwnProperty(r)&&(n[r]=t(e[r],r,e));return n}function Xr(e){return e.endsWith("/")?e.substring(0,e.length-1):e}function Jr(e){return!isNaN(parseFloat(e))&&isFinite(e)}const Zr=(e,...t)=>{if(!t.length)return e;const n=t.shift();return void 0===n?e:(to(e)&&to(n)&&Object.keys(n).forEach((t=>{to(n[t])?(e[t]||(e[t]={}),Zr(e[t],n[t])):e[t]=n[t]})),Zr(e,...t))},eo=e=>null!==e&&"object"==typeof e,to=e=>eo(e)&&!io(e);function no(e){return Kr()(e)||e.toString().toLowerCase().replace(/\s+/g,"-").replace(/&/g,"-and-").replace(/\--+/g,"-").replace(/^-+/,"").replace(/-+$/,"")}function ro(e){return"undefined"==typeof URL?new(r(8150).URL)(e):new URL(e)}function oo(e){return e.replace(/["\\]/g,"\\$&")}function io(e){return Array.isArray(e)}function ao(e){return"boolean"==typeof e}const so={enum:"Enum",enumSingleValue:"Value",enumArray:"Items",default:"Default",deprecated:"Deprecated",example:"Example",examples:"Examples",recursive:"Recursive",arrayOf:"Array of ",webhook:"Event",const:"Value",noResultsFound:"No results found",download:"Download",downloadSpecification:"Download OpenAPI specification",responses:"Responses",callbackResponses:"Callback responses",requestSamples:"Request samples",responseSamples:"Response samples"};function lo(e,t){const n=so[e];return void 0!==t?n[t]:n}var co=(e=>(e.SummaryOnly="summary-only",e.PathOnly="path-only",e.IdOnly="id-only",e))(co||{}),uo=Object.defineProperty,po=Object.defineProperties,fo=Object.getOwnPropertyDescriptors,ho=Object.getOwnPropertySymbols,mo=Object.prototype.hasOwnProperty,go=Object.prototype.propertyIsEnumerable,yo=(e,t,n)=>t in e?uo(e,t,{enumerable:!0,configurable:!0,writable:!0,value:n}):e[t]=n,vo=(e,t)=>{for(var n in t||(t={}))mo.call(t,n)&&yo(e,n,t[n]);if(ho)for(var n of ho(t))go.call(t,n)&&yo(e,n,t[n]);return e};function bo(e,t){return void 0===e?t||!1:"string"==typeof e?"false"!==e:e}function wo(e){return"string"==typeof e?parseInt(e,10):"number"==typeof e?e:void 0}class xo{static normalizeExpandResponses(e){if("all"===e)return"all";if("string"==typeof e){const t={};return e.split(",").forEach((e=>{t[e.trim()]=!0})),t}return void 0!==e&&console.warn(`expandResponses must be a string but received value "${e}" of type ${typeof e}`),{}}static normalizeHideHostname(e){return!!e}static normalizeScrollYOffset(e){if("string"==typeof e&&!Jr(e)){const t=Wr(e);t||console.warn("scrollYOffset value is a selector to non-existing element. Using offset 0 by default");const n=t&&t.getBoundingClientRect().bottom||0;return()=>n}return"number"==typeof e||Jr(e)?()=>"number"==typeof e?e:parseFloat(e):"function"==typeof e?()=>{const t=e();return"number"!=typeof t&&console.warn(`scrollYOffset should return number but returned value "${t}" of type ${typeof t}`),t}:(void 0!==e&&console.warn("Wrong value for scrollYOffset ReDoc option: should be string, number or function"),()=>0)}static normalizeShowExtensions(e){if(void 0===e)return!1;if(""===e)return!0;if("string"!=typeof e)return e;switch(e){case"true":return!0;case"false":return!1;default:return e.split(",").map((e=>e.trim()))}}static normalizeSideNavStyle(e){const t=co.SummaryOnly;if("string"!=typeof e)return t;switch(e){case t:return e;case co.PathOnly:return co.PathOnly;case co.IdOnly:return co.IdOnly;default:return t}}static normalizePayloadSampleIdx(e){return"number"==typeof e?Math.max(0,e):"string"==typeof e&&isFinite(e)?parseInt(e,10):0}static normalizeJsonSampleExpandLevel(e){return"all"===e?1/0:isNaN(Number(e))?2:Math.ceil(Number(e))}static normalizeGeneratedPayloadSamplesMaxDepth(e){return isNaN(Number(e))?10:Math.max(0,Number(e))}constructor(e,t={}){var n,r,o,i,a;const s=(e=vo(vo({},t),e)).theme&&e.theme.extensionsHook;var l,c;(null==(n=e.theme)?void 0:n.menu)&&!(null==(r=e.theme)?void 0:r.sidebar)&&(console.warn('Theme setting "menu" is deprecated. Rename to "sidebar"'),e.theme.sidebar=e.theme.menu),(null==(o=e.theme)?void 0:o.codeSample)&&!(null==(i=e.theme)?void 0:i.codeBlock)&&(console.warn('Theme setting "codeSample" is deprecated. Rename to "codeBlock"'),e.theme.codeBlock=e.theme.codeSample),this.theme=function(e){const t={};let n=0;const r=(o,i)=>{Object.keys(o).forEach((a=>{const s=(i?i+".":"")+a,l=o[a];"function"==typeof l?Object.defineProperty(o,a,{get(){if(!t[s]){if(n++,n>1e3)throw new Error(`Theme probably contains circular dependency at ${s}: ${l.toString()}`);t[s]=l(e)}return t[s]},enumerable:!0}):"object"==typeof l&&r(l,s)}))};return r(e,""),JSON.parse(JSON.stringify(e))}(Zr({},Br,(c=vo({},e.theme),po(c,fo({extensionsHook:void 0}))))),this.theme.extensionsHook=s,l=e.labels,Object.assign(so,l),this.scrollYOffset=xo.normalizeScrollYOffset(e.scrollYOffset),this.hideHostname=xo.normalizeHideHostname(e.hideHostname),this.expandResponses=xo.normalizeExpandResponses(e.expandResponses),this.requiredPropsFirst=bo(e.requiredPropsFirst),this.sortPropsAlphabetically=bo(e.sortPropsAlphabetically),this.sortEnumValuesAlphabetically=bo(e.sortEnumValuesAlphabetically),this.sortOperationsAlphabetically=bo(e.sortOperationsAlphabetically),this.sortTagsAlphabetically=bo(e.sortTagsAlphabetically),this.nativeScrollbars=bo(e.nativeScrollbars),this.pathInMiddlePanel=bo(e.pathInMiddlePanel),this.untrustedSpec=bo(e.untrustedSpec),this.hideDownloadButton=bo(e.hideDownloadButton),this.downloadFileName=e.downloadFileName,this.downloadDefinitionUrl=e.downloadDefinitionUrl,this.disableSearch=bo(e.disableSearch),this.onlyRequiredInSamples=bo(e.onlyRequiredInSamples),this.showExtensions=xo.normalizeShowExtensions(e.showExtensions),this.sideNavStyle=xo.normalizeSideNavStyle(e.sideNavStyle),this.hideSingleRequestSampleTab=bo(e.hideSingleRequestSampleTab),this.menuToggle=bo(e.menuToggle,!0),this.jsonSampleExpandLevel=xo.normalizeJsonSampleExpandLevel(e.jsonSampleExpandLevel),this.enumSkipQuotes=bo(e.enumSkipQuotes),this.hideSchemaTitles=bo(e.hideSchemaTitles),this.simpleOneOfTypeLabel=bo(e.simpleOneOfTypeLabel),this.payloadSampleIdx=xo.normalizePayloadSampleIdx(e.payloadSampleIdx),this.expandSingleSchemaField=bo(e.expandSingleSchemaField),this.schemaExpansionLevel=function(e,t=0){return"all"===e?1/0:wo(e)||t}(e.schemaExpansionLevel),this.showObjectSchemaExamples=bo(e.showObjectSchemaExamples),this.showSecuritySchemeType=bo(e.showSecuritySchemeType),this.hideSecuritySection=bo(e.hideSecuritySection),this.unstable_ignoreMimeParameters=bo(e.unstable_ignoreMimeParameters),this.allowedMdComponents=e.allowedMdComponents||{},this.expandDefaultServerVariables=bo(e.expandDefaultServerVariables),this.maxDisplayedEnumValues=wo(e.maxDisplayedEnumValues);const u=io(e.ignoreNamedSchemas)?e.ignoreNamedSchemas:null==(a=e.ignoreNamedSchemas)?void 0:a.split(",").map((e=>e.trim()));this.ignoreNamedSchemas=new Set(u),this.hideSchemaPattern=bo(e.hideSchemaPattern),this.generatedPayloadSamplesMaxDepth=xo.normalizeGeneratedPayloadSamplesMaxDepth(e.generatedPayloadSamplesMaxDepth),this.nonce=e.nonce,this.hideFab=bo(e.hideFab),this.minCharacterLengthToInitSearch=wo(e.minCharacterLengthToInitSearch)||3,this.showWebhookVerb=bo(e.showWebhookVerb)}}var ko,_o,Oo=r(9864),So=r(6774),Eo=r.n(So),Po=function(e){function t(e,r,l,c,d){for(var f,h,m,g,w,k=0,_=0,O=0,S=0,E=0,j=0,I=m=f=0,D=0,L=0,M=0,F=0,z=l.length,U=z-1,V="",B="",q="",W="";D<z;){if(h=l.charCodeAt(D),D===U&&0!==_+S+O+k&&(0!==_&&(h=47===_?10:47),S=O=k=0,z++,U++),0===_+S+O+k){if(D===U&&(0<L&&(V=V.replace(p,"")),0<V.trim().length)){switch(h){case 32:case 9:case 59:case 13:case 10:break;default:V+=l.charAt(D)}h=59}switch(h){case 123:for(f=(V=V.trim()).charCodeAt(0),m=1,F=++D;D<z;){switch(h=l.charCodeAt(D)){case 123:m++;break;case 125:m--;break;case 47:switch(h=l.charCodeAt(D+1)){case 42:case 47:e:{for(I=D+1;I<U;++I)switch(l.charCodeAt(I)){case 47:if(42===h&&42===l.charCodeAt(I-1)&&D+2!==I){D=I+1;break e}break;case 10:if(47===h){D=I+1;break e}}D=I}}break;case 91:h++;case 40:h++;case 34:case 39:for(;D++<U&&l.charCodeAt(D)!==h;);}if(0===m)break;D++}if(m=l.substring(F,D),0===f&&(f=(V=V.replace(u,"").trim()).charCodeAt(0)),64===f){switch(0<L&&(V=V.replace(p,"")),h=V.charCodeAt(1)){case 100:case 109:case 115:case 45:L=r;break;default:L=R}if(F=(m=t(r,L,m,h,d+1)).length,0<T&&(w=s(3,m,L=n(R,V,M),r,A,P,F,h,d,c),V=L.join(""),void 0!==w&&0===(F=(m=w.trim()).length)&&(h=0,m="")),0<F)switch(h){case 115:V=V.replace(x,a);case 100:case 109:case 45:m=V+"{"+m+"}";break;case 107:m=(V=V.replace(y,"$1 $2"))+"{"+m+"}",m=1===C||2===C&&i("@"+m,3)?"@-webkit-"+m+"@"+m:"@"+m;break;default:m=V+m,112===c&&(B+=m,m="")}else m=""}else m=t(r,n(r,V,M),m,c,d+1);q+=m,m=M=L=I=f=0,V="",h=l.charCodeAt(++D);break;case 125:case 59:if(1<(F=(V=(0<L?V.replace(p,""):V).trim()).length))switch(0===I&&(f=V.charCodeAt(0),45===f||96<f&&123>f)&&(F=(V=V.replace(" ",":")).length),0<T&&void 0!==(w=s(1,V,r,e,A,P,B.length,c,d,c))&&0===(F=(V=w.trim()).length)&&(V="\0\0"),f=V.charCodeAt(0),h=V.charCodeAt(1),f){case 0:break;case 64:if(105===h||99===h){W+=V+l.charAt(D);break}default:58!==V.charCodeAt(F-1)&&(B+=o(V,f,h,V.charCodeAt(2)))}M=L=I=f=0,V="",h=l.charCodeAt(++D)}}switch(h){case 13:case 10:47===_?_=0:0===1+f&&107!==c&&0<V.length&&(L=1,V+="\0"),0<T*N&&s(0,V,r,e,A,P,B.length,c,d,c),P=1,A++;break;case 59:case 125:if(0===_+S+O+k){P++;break}default:switch(P++,g=l.charAt(D),h){case 9:case 32:if(0===S+k+_)switch(E){case 44:case 58:case 9:case 32:g="";break;default:32!==h&&(g=" ")}break;case 0:g="\\0";break;case 12:g="\\f";break;case 11:g="\\v";break;case 38:0===S+_+k&&(L=M=1,g="\f"+g);break;case 108:if(0===S+_+k+$&&0<I)switch(D-I){case 2:112===E&&58===l.charCodeAt(D-3)&&($=E);case 8:111===j&&($=j)}break;case 58:0===S+_+k&&(I=D);break;case 44:0===_+O+S+k&&(L=1,g+="\r");break;case 34:case 39:0===_&&(S=S===h?0:0===S?h:S);break;case 91:0===S+_+O&&k++;break;case 93:0===S+_+O&&k--;break;case 41:0===S+_+k&&O--;break;case 40:0===S+_+k&&(0===f&&(2*E+3*j==533||(f=1)),O++);break;case 64:0===_+O+S+k+I+m&&(m=1);break;case 42:case 47:if(!(0<S+k+O))switch(_){case 0:switch(2*h+3*l.charCodeAt(D+1)){case 235:_=47;break;case 220:F=D,_=42}break;case 42:47===h&&42===E&&F+2!==D&&(33===l.charCodeAt(F+2)&&(B+=l.substring(F,D+1)),g="",_=0)}}0===_&&(V+=g)}j=E,E=h,D++}if(0<(F=B.length)){if(L=r,0<T&&void 0!==(w=s(2,B,L,e,A,P,F,c,d,c))&&0===(B=w).length)return W+B+q;if(B=L.join(",")+"{"+B+"}",0!=C*$){switch(2!==C||i(B,2)||($=0),$){case 111:B=B.replace(b,":-moz-$1")+B;break;case 112:B=B.replace(v,"::-webkit-input-$1")+B.replace(v,"::-moz-$1")+B.replace(v,":-ms-input-$1")+B}$=0}}return W+B+q}function n(e,t,n){var o=t.trim().split(m);t=o;var i=o.length,a=e.length;switch(a){case 0:case 1:var s=0;for(e=0===a?"":e[0]+" ";s<i;++s)t[s]=r(e,t[s],n).trim();break;default:var l=s=0;for(t=[];s<i;++s)for(var c=0;c<a;++c)t[l++]=r(e[c]+" ",o[s],n).trim()}return t}function r(e,t,n){var r=t.charCodeAt(0);switch(33>r&&(r=(t=t.trim()).charCodeAt(0)),r){case 38:return t.replace(g,"$1"+e.trim());case 58:return e.trim()+t.replace(g,"$1"+e.trim());default:if(0<1*n&&0<t.indexOf("\f"))return t.replace(g,(58===e.charCodeAt(0)?"":"$1")+e.trim())}return e+t}function o(e,t,n,r){var a=e+";",s=2*t+3*n+4*r;if(944===s){e=a.indexOf(":",9)+1;var l=a.substring(e,a.length-1).trim();return l=a.substring(0,e).trim()+l+";",1===C||2===C&&i(l,1)?"-webkit-"+l+l:l}if(0===C||2===C&&!i(a,1))return a;switch(s){case 1015:return 97===a.charCodeAt(10)?"-webkit-"+a+a:a;case 951:return 116===a.charCodeAt(3)?"-webkit-"+a+a:a;case 963:return 110===a.charCodeAt(5)?"-webkit-"+a+a:a;case 1009:if(100!==a.charCodeAt(4))break;case 969:case 942:return"-webkit-"+a+a;case 978:return"-webkit-"+a+"-moz-"+a+a;case 1019:case 983:return"-webkit-"+a+"-moz-"+a+"-ms-"+a+a;case 883:if(45===a.charCodeAt(8))return"-webkit-"+a+a;if(0<a.indexOf("image-set(",11))return a.replace(E,"$1-webkit-$2")+a;break;case 932:if(45===a.charCodeAt(4))switch(a.charCodeAt(5)){case 103:return"-webkit-box-"+a.replace("-grow","")+"-webkit-"+a+"-ms-"+a.replace("grow","positive")+a;case 115:return"-webkit-"+a+"-ms-"+a.replace("shrink","negative")+a;case 98:return"-webkit-"+a+"-ms-"+a.replace("basis","preferred-size")+a}return"-webkit-"+a+"-ms-"+a+a;case 964:return"-webkit-"+a+"-ms-flex-"+a+a;case 1023:if(99!==a.charCodeAt(8))break;return"-webkit-box-pack"+(l=a.substring(a.indexOf(":",15)).replace("flex-","").replace("space-between","justify"))+"-webkit-"+a+"-ms-flex-pack"+l+a;case 1005:return f.test(a)?a.replace(d,":-webkit-")+a.replace(d,":-moz-")+a:a;case 1e3:switch(t=(l=a.substring(13).trim()).indexOf("-")+1,l.charCodeAt(0)+l.charCodeAt(t)){case 226:l=a.replace(w,"tb");break;case 232:l=a.replace(w,"tb-rl");break;case 220:l=a.replace(w,"lr");break;default:return a}return"-webkit-"+a+"-ms-"+l+a;case 1017:if(-1===a.indexOf("sticky",9))break;case 975:switch(t=(a=e).length-10,s=(l=(33===a.charCodeAt(t)?a.substring(0,t):a).substring(e.indexOf(":",7)+1).trim()).charCodeAt(0)+(0|l.charCodeAt(7))){case 203:if(111>l.charCodeAt(8))break;case 115:a=a.replace(l,"-webkit-"+l)+";"+a;break;case 207:case 102:a=a.replace(l,"-webkit-"+(102<s?"inline-":"")+"box")+";"+a.replace(l,"-webkit-"+l)+";"+a.replace(l,"-ms-"+l+"box")+";"+a}return a+";";case 938:if(45===a.charCodeAt(5))switch(a.charCodeAt(6)){case 105:return l=a.replace("-items",""),"-webkit-"+a+"-webkit-box-"+l+"-ms-flex-"+l+a;case 115:return"-webkit-"+a+"-ms-flex-item-"+a.replace(_,"")+a;default:return"-webkit-"+a+"-ms-flex-line-pack"+a.replace("align-content","").replace(_,"")+a}break;case 973:case 989:if(45!==a.charCodeAt(3)||122===a.charCodeAt(4))break;case 931:case 953:if(!0===S.test(e))return 115===(l=e.substring(e.indexOf(":")+1)).charCodeAt(0)?o(e.replace("stretch","fill-available"),t,n,r).replace(":fill-available",":stretch"):a.replace(l,"-webkit-"+l)+a.replace(l,"-moz-"+l.replace("fill-",""))+a;break;case 962:if(a="-webkit-"+a+(102===a.charCodeAt(5)?"-ms-"+a:"")+a,211===n+r&&105===a.charCodeAt(13)&&0<a.indexOf("transform",10))return a.substring(0,a.indexOf(";",27)+1).replace(h,"$1-webkit-$2")+a}return a}function i(e,t){var n=e.indexOf(1===t?":":"{"),r=e.substring(0,3!==t?n:10);return n=e.substring(n+1,e.length-1),I(2!==t?r:r.replace(O,"$1"),n,t)}function a(e,t){var n=o(t,t.charCodeAt(0),t.charCodeAt(1),t.charCodeAt(2));return n!==t+";"?n.replace(k," or ($1)").substring(4):"("+t+")"}function s(e,t,n,r,o,i,a,s,l,u){for(var p,d=0,f=t;d<T;++d)switch(p=j[d].call(c,e,f,n,r,o,i,a,s,l,u)){case void 0:case!1:case!0:case null:break;default:f=p}if(f!==t)return f}function l(e){return void 0!==(e=e.prefix)&&(I=null,e?"function"!=typeof e?C=1:(C=2,I=e):C=0),l}function c(e,n){var r=e;if(33>r.charCodeAt(0)&&(r=r.trim()),r=[r],0<T){var o=s(-1,n,r,r,A,P,0,0,0,0);void 0!==o&&"string"==typeof o&&(n=o)}var i=t(R,r,n,0,0);return 0<T&&void 0!==(o=s(-2,i,r,r,A,P,i.length,0,0,0))&&(i=o),$=0,P=A=1,i}var u=/^\0+/g,p=/[\0\r\f]/g,d=/: */g,f=/zoo|gra/,h=/([,: ])(transform)/g,m=/,\r+?/g,g=/([\t\r\n ])*\f?&/g,y=/@(k\w+)\s*(\S*)\s*/,v=/::(place)/g,b=/:(read-only)/g,w=/[svh]\w+-[tblr]{2}/,x=/\(\s*(.*)\s*\)/g,k=/([\s\S]*?);/g,_=/-self|flex-/g,O=/[^]*?(:[rp][el]a[\w-]+)[^]*/,S=/stretch|:\s*\w+\-(?:conte|avail)/,E=/([^-])(image-set\()/,P=1,A=1,$=0,C=1,R=[],j=[],T=0,I=null,N=0;return c.use=function e(t){switch(t){case void 0:case null:T=j.length=0;break;default:if("function"==typeof t)j[T++]=t;else if("object"==typeof t)for(var n=0,r=t.length;n<r;++n)e(t[n]);else N=0|!!t}return e},c.set=l,void 0!==e&&l(e),c},Ao={animationIterationCount:1,borderImageOutset:1,borderImageSlice:1,borderImageWidth:1,boxFlex:1,boxFlexGroup:1,boxOrdinalGroup:1,columnCount:1,columns:1,flex:1,flexGrow:1,flexPositive:1,flexShrink:1,flexNegative:1,flexOrder:1,gridRow:1,gridRowEnd:1,gridRowSpan:1,gridRowStart:1,gridColumn:1,gridColumnEnd:1,gridColumnSpan:1,gridColumnStart:1,msGridRow:1,msGridRowSpan:1,msGridColumn:1,msGridColumnSpan:1,fontWeight:1,lineHeight:1,opacity:1,order:1,orphans:1,tabSize:1,widows:1,zIndex:1,zoom:1,WebkitLineClamp:1,fillOpacity:1,floodOpacity:1,stopOpacity:1,strokeDasharray:1,strokeDashoffset:1,strokeMiterlimit:1,strokeOpacity:1,strokeWidth:1},$o=/^((children|dangerouslySetInnerHTML|key|ref|autoFocus|defaultValue|defaultChecked|innerHTML|suppressContentEditableWarning|suppressHydrationWarning|valueLink|accept|acceptCharset|accessKey|action|allow|allowUserMedia|allowPaymentRequest|allowFullScreen|allowTransparency|alt|async|autoComplete|autoPlay|capture|cellPadding|cellSpacing|challenge|charSet|checked|cite|classID|className|cols|colSpan|content|contentEditable|contextMenu|controls|controlsList|coords|crossOrigin|data|dateTime|decoding|default|defer|dir|disabled|disablePictureInPicture|download|draggable|encType|form|formAction|formEncType|formMethod|formNoValidate|formTarget|frameBorder|headers|height|hidden|high|href|hrefLang|htmlFor|httpEquiv|id|inputMode|integrity|is|keyParams|keyType|kind|label|lang|list|loading|loop|low|marginHeight|marginWidth|max|maxLength|media|mediaGroup|method|min|minLength|multiple|muted|name|nonce|noValidate|open|optimum|pattern|placeholder|playsInline|poster|preload|profile|radioGroup|readOnly|referrerPolicy|rel|required|reversed|role|rows|rowSpan|sandbox|scope|scoped|scrolling|seamless|selected|shape|size|sizes|slot|span|spellCheck|src|srcDoc|srcLang|srcSet|start|step|style|summary|tabIndex|target|title|type|useMap|value|width|wmode|wrap|about|datatype|inlist|prefix|property|resource|typeof|vocab|autoCapitalize|autoCorrect|autoSave|color|inert|itemProp|itemScope|itemType|itemID|itemRef|on|results|security|unselectable|accentHeight|accumulate|additive|alignmentBaseline|allowReorder|alphabetic|amplitude|arabicForm|ascent|attributeName|attributeType|autoReverse|azimuth|baseFrequency|baselineShift|baseProfile|bbox|begin|bias|by|calcMode|capHeight|clip|clipPathUnits|clipPath|clipRule|colorInterpolation|colorInterpolationFilters|colorProfile|colorRendering|contentScriptType|contentStyleType|cursor|cx|cy|d|decelerate|descent|diffuseConstant|direction|display|divisor|dominantBaseline|dur|dx|dy|edgeMode|elevation|enableBackground|end|exponent|externalResourcesRequired|fill|fillOpacity|fillRule|filter|filterRes|filterUnits|floodColor|floodOpacity|focusable|fontFamily|fontSize|fontSizeAdjust|fontStretch|fontStyle|fontVariant|fontWeight|format|from|fr|fx|fy|g1|g2|glyphName|glyphOrientationHorizontal|glyphOrientationVertical|glyphRef|gradientTransform|gradientUnits|hanging|horizAdvX|horizOriginX|ideographic|imageRendering|in|in2|intercept|k|k1|k2|k3|k4|kernelMatrix|kernelUnitLength|kerning|keyPoints|keySplines|keyTimes|lengthAdjust|letterSpacing|lightingColor|limitingConeAngle|local|markerEnd|markerMid|markerStart|markerHeight|markerUnits|markerWidth|mask|maskContentUnits|maskUnits|mathematical|mode|numOctaves|offset|opacity|operator|order|orient|orientation|origin|overflow|overlinePosition|overlineThickness|panose1|paintOrder|pathLength|patternContentUnits|patternTransform|patternUnits|pointerEvents|points|pointsAtX|pointsAtY|pointsAtZ|preserveAlpha|preserveAspectRatio|primitiveUnits|r|radius|refX|refY|renderingIntent|repeatCount|repeatDur|requiredExtensions|requiredFeatures|restart|result|rotate|rx|ry|scale|seed|shapeRendering|slope|spacing|specularConstant|specularExponent|speed|spreadMethod|startOffset|stdDeviation|stemh|stemv|stitchTiles|stopColor|stopOpacity|strikethroughPosition|strikethroughThickness|string|stroke|strokeDasharray|strokeDashoffset|strokeLinecap|strokeLinejoin|strokeMiterlimit|strokeOpacity|strokeWidth|surfaceScale|systemLanguage|tableValues|targetX|targetY|textAnchor|textDecoration|textRendering|textLength|to|transform|u1|u2|underlinePosition|underlineThickness|unicode|unicodeBidi|unicodeRange|unitsPerEm|vAlphabetic|vHanging|vIdeographic|vMathematical|values|vectorEffect|version|vertAdvY|vertOriginX|vertOriginY|viewBox|viewTarget|visibility|widths|wordSpacing|writingMode|x|xHeight|x1|x2|xChannelSelector|xlinkActuate|xlinkArcrole|xlinkHref|xlinkRole|xlinkShow|xlinkTitle|xlinkType|xmlBase|xmlns|xmlnsXlink|xmlLang|xmlSpace|y|y1|y2|yChannelSelector|z|zoomAndPan|for|class|autofocus)|(([Dd][Aa][Tt][Aa]|[Aa][Rr][Ii][Aa]|x)-.*))$/,Co=(ko=function(e){return $o.test(e)||111===e.charCodeAt(0)&&110===e.charCodeAt(1)&&e.charCodeAt(2)<91},_o={},function(e){return void 0===_o[e]&&(_o[e]=ko(e)),_o[e]}),Ro=r(8679),jo=r.n(Ro);function To(){return(To=Object.assign||function(e){for(var t=1;t<arguments.length;t++){var n=arguments[t];for(var r in n)Object.prototype.hasOwnProperty.call(n,r)&&(e[r]=n[r])}return e}).apply(this,arguments)}var Io=function(e,t){for(var n=[e[0]],r=0,o=t.length;r<o;r+=1)n.push(t[r],e[r+1]);return n},No=function(e){return null!==e&&"object"==typeof e&&"[object Object]"===(e.toString?e.toString():Object.prototype.toString.call(e))&&!(0,Oo.typeOf)(e)},Do=Object.freeze([]),Lo=Object.freeze({});function Mo(e){return"function"==typeof e}function Fo(e){return e.displayName||e.name||"Component"}function zo(e){return e&&"string"==typeof e.styledComponentId}var Uo="undefined"!=typeof process&&({}.REACT_APP_SC_ATTR||{}.SC_ATTR)||"data-styled",Vo="5.3.0",Bo="undefined"!=typeof window&&"HTMLElement"in window,qo=Boolean("boolean"==typeof SC_DISABLE_SPEEDY?SC_DISABLE_SPEEDY:"undefined"!=typeof process&&void 0!=={}.REACT_APP_SC_DISABLE_SPEEDY&&""!=={}.REACT_APP_SC_DISABLE_SPEEDY?"false"!=={}.REACT_APP_SC_DISABLE_SPEEDY&&{}.REACT_APP_SC_DISABLE_SPEEDY:"undefined"!=typeof process&&void 0!=={}.SC_DISABLE_SPEEDY&&""!=={}.SC_DISABLE_SPEEDY&&"false"!=={}.SC_DISABLE_SPEEDY&&{}.SC_DISABLE_SPEEDY),Wo={};function Ho(e){for(var t=arguments.length,n=new Array(t>1?t-1:0),r=1;r<t;r++)n[r-1]=arguments[r];throw new Error("An error occurred. See https://git.io/JUIaE#"+e+" for more information."+(n.length>0?" Args: "+n.join(", "):""))}var Yo=function(){function e(e){this.groupSizes=new Uint32Array(512),this.length=512,this.tag=e}var t=e.prototype;return t.indexOfGroup=function(e){for(var t=0,n=0;n<e;n++)t+=this.groupSizes[n];return t},t.insertRules=function(e,t){if(e>=this.groupSizes.length){for(var n=this.groupSizes,r=n.length,o=r;e>=o;)(o<<=1)<0&&Ho(16,""+e);this.groupSizes=new Uint32Array(o),this.groupSizes.set(n),this.length=o;for(var i=r;i<o;i++)this.groupSizes[i]=0}for(var a=this.indexOfGroup(e+1),s=0,l=t.length;s<l;s++)this.tag.insertRule(a,t[s])&&(this.groupSizes[e]++,a++)},t.clearGroup=function(e){if(e<this.length){var t=this.groupSizes[e],n=this.indexOfGroup(e),r=n+t;this.groupSizes[e]=0;for(var o=n;o<r;o++)this.tag.deleteRule(n)}},t.getGroup=function(e){var t="";if(e>=this.length||0===this.groupSizes[e])return t;for(var n=this.groupSizes[e],r=this.indexOfGroup(e),o=r+n,i=r;i<o;i++)t+=this.tag.getRule(i)+"/*!sc*/\n";return t},e}(),Ko=new Map,Go=new Map,Qo=1,Xo=function(e){if(Ko.has(e))return Ko.get(e);for(;Go.has(Qo);)Qo++;var t=Qo++;return Ko.set(e,t),Go.set(t,e),t},Jo=function(e){return Go.get(e)},Zo=function(e,t){Ko.set(e,t),Go.set(t,e)},ei="style["+Uo+'][data-styled-version="5.3.0"]',ti=new RegExp("^"+Uo+'\\.g(\\d+)\\[id="([\\w\\d-]+)"\\].*?"([^"]*)'),ni=function(e,t,n){for(var r,o=n.split(","),i=0,a=o.length;i<a;i++)(r=o[i])&&e.registerName(t,r)},ri=function(e,t){for(var n=t.innerHTML.split("/*!sc*/\n"),r=[],o=0,i=n.length;o<i;o++){var a=n[o].trim();if(a){var s=a.match(ti);if(s){var l=0|parseInt(s[1],10),c=s[2];0!==l&&(Zo(c,l),ni(e,c,s[3]),e.getTag().insertRules(l,r)),r.length=0}else r.push(a)}}},oi=function(){return"undefined"!=typeof window&&void 0!==window.__webpack_nonce__?window.__webpack_nonce__:null},ii=function(e){var t=document.head,n=e||t,r=document.createElement("style"),o=function(e){for(var t=e.childNodes,n=t.length;n>=0;n--){var r=t[n];if(r&&1===r.nodeType&&r.hasAttribute(Uo))return r}}(n),i=void 0!==o?o.nextSibling:null;r.setAttribute(Uo,"active"),r.setAttribute("data-styled-version","5.3.0");var a=oi();return a&&r.setAttribute("nonce",a),n.insertBefore(r,i),r},ai=function(){function e(e){var t=this.element=ii(e);t.appendChild(document.createTextNode("")),this.sheet=function(e){if(e.sheet)return e.sheet;for(var t=document.styleSheets,n=0,r=t.length;n<r;n++){var o=t[n];if(o.ownerNode===e)return o}Ho(17)}(t),this.length=0}var t=e.prototype;return t.insertRule=function(e,t){try{return this.sheet.insertRule(t,e),this.length++,!0}catch(e){return!1}},t.deleteRule=function(e){this.sheet.deleteRule(e),this.length--},t.getRule=function(e){var t=this.sheet.cssRules[e];return void 0!==t&&"string"==typeof t.cssText?t.cssText:""},e}(),si=function(){function e(e){var t=this.element=ii(e);this.nodes=t.childNodes,this.length=0}var t=e.prototype;return t.insertRule=function(e,t){if(e<=this.length&&e>=0){var n=document.createTextNode(t),r=this.nodes[e];return this.element.insertBefore(n,r||null),this.length++,!0}return!1},t.deleteRule=function(e){this.element.removeChild(this.nodes[e]),this.length--},t.getRule=function(e){return e<this.length?this.nodes[e].textContent:""},e}(),li=function(){function e(e){this.rules=[],this.length=0}var t=e.prototype;return t.insertRule=function(e,t){return e<=this.length&&(this.rules.splice(e,0,t),this.length++,!0)},t.deleteRule=function(e){this.rules.splice(e,1),this.length--},t.getRule=function(e){return e<this.length?this.rules[e]:""},e}(),ci=Bo,ui={isServer:!Bo,useCSSOMInjection:!qo},pi=function(){function e(e,t,n){void 0===e&&(e=Lo),void 0===t&&(t={}),this.options=To({},ui,{},e),this.gs=t,this.names=new Map(n),!this.options.isServer&&Bo&&ci&&(ci=!1,function(e){for(var t=document.querySelectorAll(ei),n=0,r=t.length;n<r;n++){var o=t[n];o&&"active"!==o.getAttribute(Uo)&&(ri(e,o),o.parentNode&&o.parentNode.removeChild(o))}}(this))}e.registerId=function(e){return Xo(e)};var t=e.prototype;return t.reconstructWithOptions=function(t,n){return void 0===n&&(n=!0),new e(To({},this.options,{},t),this.gs,n&&this.names||void 0)},t.allocateGSInstance=function(e){return this.gs[e]=(this.gs[e]||0)+1},t.getTag=function(){return this.tag||(this.tag=(n=(t=this.options).isServer,r=t.useCSSOMInjection,o=t.target,e=n?new li(o):r?new ai(o):new si(o),new Yo(e)));var e,t,n,r,o},t.hasNameForId=function(e,t){return this.names.has(e)&&this.names.get(e).has(t)},t.registerName=function(e,t){if(Xo(e),this.names.has(e))this.names.get(e).add(t);else{var n=new Set;n.add(t),this.names.set(e,n)}},t.insertRules=function(e,t,n){this.registerName(e,t),this.getTag().insertRules(Xo(e),n)},t.clearNames=function(e){this.names.has(e)&&this.names.get(e).clear()},t.clearRules=function(e){this.getTag().clearGroup(Xo(e)),this.clearNames(e)},t.clearTag=function(){this.tag=void 0},t.toString=function(){return function(e){for(var t=e.getTag(),n=t.length,r="",o=0;o<n;o++){var i=Jo(o);if(void 0!==i){var a=e.names.get(i),s=t.getGroup(o);if(void 0!==a&&0!==s.length){var l=Uo+".g"+o+'[id="'+i+'"]',c="";void 0!==a&&a.forEach((function(e){e.length>0&&(c+=e+",")})),r+=""+s+l+'{content:"'+c+'"}/*!sc*/\n'}}}return r}(this)},e}(),di=/(a)(d)/gi,fi=function(e){return String.fromCharCode(e+(e>25?39:97))};function hi(e){var t,n="";for(t=Math.abs(e);t>52;t=t/52|0)n=fi(t%52)+n;return(fi(t%52)+n).replace(di,"$1-$2")}var mi=function(e,t){for(var n=t.length;n;)e=33*e^t.charCodeAt(--n);return e},gi=function(e){return mi(5381,e)};function yi(e){for(var t=0;t<e.length;t+=1){var n=e[t];if(Mo(n)&&!zo(n))return!1}return!0}var vi=gi("5.3.0"),bi=function(){function e(e,t,n){this.rules=e,this.staticRulesId="",this.isStatic=(void 0===n||n.isStatic)&&yi(e),this.componentId=t,this.baseHash=mi(vi,t),this.baseStyle=n,pi.registerId(t)}return e.prototype.generateAndInjectStyles=function(e,t,n){var r=this.componentId,o=[];if(this.baseStyle&&o.push(this.baseStyle.generateAndInjectStyles(e,t,n)),this.isStatic&&!n.hash)if(this.staticRulesId&&t.hasNameForId(r,this.staticRulesId))o.push(this.staticRulesId);else{var i=Mi(this.rules,e,t,n).join(""),a=hi(mi(this.baseHash,i.length)>>>0);if(!t.hasNameForId(r,a)){var s=n(i,"."+a,void 0,r);t.insertRules(r,a,s)}o.push(a),this.staticRulesId=a}else{for(var l=this.rules.length,c=mi(this.baseHash,n.hash),u="",p=0;p<l;p++){var d=this.rules[p];if("string"==typeof d)u+=d;else if(d){var f=Mi(d,e,t,n),h=Array.isArray(f)?f.join(""):f;c=mi(c,h+p),u+=h}}if(u){var m=hi(c>>>0);if(!t.hasNameForId(r,m)){var g=n(u,"."+m,void 0,r);t.insertRules(r,m,g)}o.push(m)}}return o.join(" ")},e}(),wi=/^\s*\/\/.*$/gm,xi=[":","[",".","#"];function ki(e){var t,n,r,o,i=void 0===e?Lo:e,a=i.options,s=void 0===a?Lo:a,l=i.plugins,c=void 0===l?Do:l,u=new Po(s),p=[],d=function(e){function t(t){if(t)try{e(t+"}")}catch(e){}}return function(n,r,o,i,a,s,l,c,u,p){switch(n){case 1:if(0===u&&64===r.charCodeAt(0))return e(r+";"),"";break;case 2:if(0===c)return r+"/*|*/";break;case 3:switch(c){case 102:case 112:return e(o[0]+r),"";default:return r+(0===p?"/*|*/":"")}case-2:r.split("/*|*/}").forEach(t)}}}((function(e){p.push(e)})),f=function(e,r,i){return 0===r&&-1!==xi.indexOf(i[n.length])||i.match(o)?e:"."+t};function h(e,i,a,s){void 0===s&&(s="&");var l=e.replace(wi,""),c=i&&a?a+" "+i+" { "+l+" }":l;return t=s,n=i,r=new RegExp("\\"+n+"\\b","g"),o=new RegExp("(\\"+n+"\\b){2,}"),u(a||!i?"":i,c)}return u.use([].concat(c,[function(e,t,o){2===e&&o.length&&o[0].lastIndexOf(n)>0&&(o[0]=o[0].replace(r,f))},d,function(e){if(-2===e){var t=p;return p=[],t}}])),h.hash=c.length?c.reduce((function(e,t){return t.name||Ho(15),mi(e,t.name)}),5381).toString():"",h}var _i=n.createContext(),Oi=_i.Consumer,Si=n.createContext(),Ei=(Si.Consumer,new pi),Pi=ki();function Ai(){return(0,n.useContext)(_i)||Ei}function $i(){return(0,n.useContext)(Si)||Pi}function Ci(e){var t=(0,n.useState)(e.stylisPlugins),r=t[0],o=t[1],i=Ai(),a=(0,n.useMemo)((function(){var t=i;return e.sheet?t=e.sheet:e.target&&(t=t.reconstructWithOptions({target:e.target},!1)),e.disableCSSOMInjection&&(t=t.reconstructWithOptions({useCSSOMInjection:!1})),t}),[e.disableCSSOMInjection,e.sheet,e.target]),s=(0,n.useMemo)((function(){return ki({options:{prefix:!e.disableVendorPrefixes},plugins:r})}),[e.disableVendorPrefixes,r]);return(0,n.useEffect)((function(){Eo()(r,e.stylisPlugins)||o(e.stylisPlugins)}),[e.stylisPlugins]),n.createElement(_i.Provider,{value:a},n.createElement(Si.Provider,{value:s},e.children))}var Ri=function(){function e(e,t){var n=this;this.inject=function(e,t){void 0===t&&(t=Pi);var r=n.name+t.hash;e.hasNameForId(n.id,r)||e.insertRules(n.id,r,t(n.rules,r,"@keyframes"))},this.toString=function(){return Ho(12,String(n.name))},this.name=e,this.id="sc-keyframes-"+e,this.rules=t}return e.prototype.getName=function(e){return void 0===e&&(e=Pi),this.name+e.hash},e}(),ji=/([A-Z])/,Ti=/([A-Z])/g,Ii=/^ms-/,Ni=function(e){return"-"+e.toLowerCase()};function Di(e){return ji.test(e)?e.replace(Ti,Ni).replace(Ii,"-ms-"):e}var Li=function(e){return null==e||!1===e||""===e};function Mi(e,t,n,r){if(Array.isArray(e)){for(var o,i=[],a=0,s=e.length;a<s;a+=1)""!==(o=Mi(e[a],t,n,r))&&(Array.isArray(o)?i.push.apply(i,o):i.push(o));return i}return Li(e)?"":zo(e)?"."+e.styledComponentId:Mo(e)?"function"!=typeof(l=e)||l.prototype&&l.prototype.isReactComponent||!t?e:Mi(e(t),t,n,r):e instanceof Ri?n?(e.inject(n,r),e.getName(r)):e:No(e)?function e(t,n){var r,o,i=[];for(var a in t)t.hasOwnProperty(a)&&!Li(t[a])&&(No(t[a])?i.push.apply(i,e(t[a],a)):Mo(t[a])?i.push(Di(a)+":",t[a],";"):i.push(Di(a)+": "+(r=a,(null==(o=t[a])||"boolean"==typeof o||""===o?"":"number"!=typeof o||0===o||r in Ao?String(o).trim():o+"px")+";")));return n?[n+" {"].concat(i,["}"]):i}(e):e.toString();var l}function Fi(e){for(var t=arguments.length,n=new Array(t>1?t-1:0),r=1;r<t;r++)n[r-1]=arguments[r];return Mo(e)||No(e)?Mi(Io(Do,[e].concat(n))):0===n.length&&1===e.length&&"string"==typeof e[0]?e:Mi(Io(e,n))}new Set;var zi=function(e,t,n){return void 0===n&&(n=Lo),e.theme!==n.theme&&e.theme||t||n.theme},Ui=/[!"#$%&'()*+,./:;<=>?@[\\\]^`{|}~-]+/g,Vi=/(^-|-$)/g;function Bi(e){return e.replace(Ui,"-").replace(Vi,"")}var qi=function(e){return hi(gi(e)>>>0)};function Wi(e){return"string"==typeof e&&!0}var Hi=function(e){return"function"==typeof e||"object"==typeof e&&null!==e&&!Array.isArray(e)},Yi=function(e){return"__proto__"!==e&&"constructor"!==e&&"prototype"!==e};function Ki(e,t,n){var r=e[n];Hi(t)&&Hi(r)?Gi(r,t):e[n]=t}function Gi(e){for(var t=arguments.length,n=new Array(t>1?t-1:0),r=1;r<t;r++)n[r-1]=arguments[r];for(var o=0,i=n;o<i.length;o++){var a=i[o];if(Hi(a))for(var s in a)Yi(s)&&Ki(e,a[s],s)}return e}var Qi=n.createContext(),Xi=Qi.Consumer;function Ji(e){var t=(0,n.useContext)(Qi),r=(0,n.useMemo)((function(){return function(e,t){return e?Mo(e)?e(t):Array.isArray(e)||"object"!=typeof e?Ho(8):t?To({},t,{},e):e:Ho(14)}(e.theme,t)}),[e.theme,t]);return e.children?n.createElement(Qi.Provider,{value:r},e.children):null}var Zi={};function ea(e,t,r){var o=zo(e),i=!Wi(e),a=t.attrs,s=void 0===a?Do:a,l=t.componentId,c=void 0===l?function(e,t){var n="string"!=typeof e?"sc":Bi(e);Zi[n]=(Zi[n]||0)+1;var r=n+"-"+qi("5.3.0"+n+Zi[n]);return t?t+"-"+r:r}(t.displayName,t.parentComponentId):l,u=t.displayName,p=void 0===u?function(e){return Wi(e)?"styled."+e:"Styled("+Fo(e)+")"}(e):u,d=t.displayName&&t.componentId?Bi(t.displayName)+"-"+t.componentId:t.componentId||c,f=o&&e.attrs?Array.prototype.concat(e.attrs,s).filter(Boolean):s,h=t.shouldForwardProp;o&&e.shouldForwardProp&&(h=t.shouldForwardProp?function(n,r,o){return e.shouldForwardProp(n,r,o)&&t.shouldForwardProp(n,r,o)}:e.shouldForwardProp);var m,g=new bi(r,d,o?e.componentStyle:void 0),y=g.isStatic&&0===s.length,v=function(e,t){return function(e,t,r,o){var i=e.attrs,a=e.componentStyle,s=e.defaultProps,l=e.foldedComponentIds,c=e.shouldForwardProp,u=e.styledComponentId,p=e.target,d=function(e,t,n){void 0===e&&(e=Lo);var r=To({},t,{theme:e}),o={};return n.forEach((function(e){var t,n,i,a=e;for(t in Mo(a)&&(a=a(r)),a)r[t]=o[t]="className"===t?(n=o[t],i=a[t],n&&i?n+" "+i:n||i):a[t]})),[r,o]}(zi(t,(0,n.useContext)(Qi),s)||Lo,t,i),f=d[0],h=d[1],m=function(e,t,n,r){var o=Ai(),i=$i();return t?e.generateAndInjectStyles(Lo,o,i):e.generateAndInjectStyles(n,o,i)}(a,o,f),g=r,y=h.$as||t.$as||h.as||t.as||p,v=Wi(y),b=h!==t?To({},t,{},h):t,w={};for(var x in b)"$"!==x[0]&&"as"!==x&&("forwardedAs"===x?w.as=b[x]:(c?c(x,Co,y):!v||Co(x))&&(w[x]=b[x]));return t.style&&h.style!==t.style&&(w.style=To({},t.style,{},h.style)),w.className=Array.prototype.concat(l,u,m!==u?m:null,t.className,h.className).filter(Boolean).join(" "),w.ref=g,(0,n.createElement)(y,w)}(m,e,t,y)};return v.displayName=p,(m=n.forwardRef(v)).attrs=f,m.componentStyle=g,m.displayName=p,m.shouldForwardProp=h,m.foldedComponentIds=o?Array.prototype.concat(e.foldedComponentIds,e.styledComponentId):Do,m.styledComponentId=d,m.target=o?e.target:e,m.withComponent=function(e){var n=t.componentId,o=function(e,t){if(null==e)return{};var n,r,o={},i=Object.keys(e);for(r=0;r<i.length;r++)n=i[r],t.indexOf(n)>=0||(o[n]=e[n]);return o}(t,["componentId"]),i=n&&n+"-"+(Wi(e)?e:Bi(Fo(e)));return ea(e,To({},o,{attrs:f,componentId:i}),r)},Object.defineProperty(m,"defaultProps",{get:function(){return this._foldedDefaultProps},set:function(t){this._foldedDefaultProps=o?Gi({},e.defaultProps,t):t}}),m.toString=function(){return"."+m.styledComponentId},i&&jo()(m,e,{attrs:!0,componentStyle:!0,displayName:!0,foldedComponentIds:!0,shouldForwardProp:!0,styledComponentId:!0,target:!0,withComponent:!0}),m}var ta=function(e){return function e(t,n,r){if(void 0===r&&(r=Lo),!(0,Oo.isValidElementType)(n))return Ho(1,String(n));var o=function(){return t(n,r,Fi.apply(void 0,arguments))};return o.withConfig=function(o){return e(t,n,To({},r,{},o))},o.attrs=function(o){return e(t,n,To({},r,{attrs:Array.prototype.concat(r.attrs,o).filter(Boolean)}))},o}(ea,e)};["a","abbr","address","area","article","aside","audio","b","base","bdi","bdo","big","blockquote","body","br","button","canvas","caption","cite","code","col","colgroup","data","datalist","dd","del","details","dfn","dialog","div","dl","dt","em","embed","fieldset","figcaption","figure","footer","form","h1","h2","h3","h4","h5","h6","head","header","hgroup","hr","html","i","iframe","img","input","ins","kbd","keygen","label","legend","li","link","main","map","mark","marquee","menu","menuitem","meta","meter","nav","noscript","object","ol","optgroup","option","output","p","param","picture","pre","progress","q","rp","rt","ruby","s","samp","script","section","select","small","source","span","strong","style","sub","summary","sup","table","tbody","td","textarea","tfoot","th","thead","time","title","tr","track","u","ul","var","video","wbr","circle","clipPath","defs","ellipse","foreignObject","g","image","line","linearGradient","marker","mask","path","pattern","polygon","polyline","radialGradient","rect","stop","svg","text","textPath","tspan"].forEach((function(e){ta[e]=ta(e)}));var na=function(){function e(e,t){this.rules=e,this.componentId=t,this.isStatic=yi(e),pi.registerId(this.componentId+1)}var t=e.prototype;return t.createStyles=function(e,t,n,r){var o=r(Mi(this.rules,t,n,r).join(""),""),i=this.componentId+e;n.insertRules(i,i,o)},t.removeStyles=function(e,t){t.clearRules(this.componentId+e)},t.renderStyles=function(e,t,n,r){e>2&&pi.registerId(this.componentId+e),this.removeStyles(e,n),this.createStyles(e,t,n,r)},e}();function ra(e){for(var t=arguments.length,r=new Array(t>1?t-1:0),o=1;o<t;o++)r[o-1]=arguments[o];var i=Fi.apply(void 0,[e].concat(r)),a="sc-global-"+qi(JSON.stringify(i)),s=new na(i,a);function l(e){var t=Ai(),r=$i(),o=(0,n.useContext)(Qi),i=(0,n.useRef)(t.allocateGSInstance(a)).current;return(0,n.useLayoutEffect)((function(){return c(i,e,t,o,r),function(){return s.removeStyles(i,t)}}),[i,e,t,o,r]),null}function c(e,t,n,r,o){if(s.isStatic)s.renderStyles(e,Wo,n,o);else{var i=To({},t,{theme:zi(t,r,l.defaultProps)});s.renderStyles(e,i,n,o)}}return n.memo(l)}function oa(e){for(var t=arguments.length,n=new Array(t>1?t-1:0),r=1;r<t;r++)n[r-1]=arguments[r];var o=Fi.apply(void 0,[e].concat(n)).join(""),i=qi(o);return new Ri(i,o)}var ia=function(){function e(){var e=this;this._emitSheetCSS=function(){var t=e.instance.toString(),n=oi();return"<style "+[n&&'nonce="'+n+'"',Uo+'="true"','data-styled-version="5.3.0"'].filter(Boolean).join(" ")+">"+t+"</style>"},this.getStyleTags=function(){return e.sealed?Ho(2):e._emitSheetCSS()},this.getStyleElement=function(){var t;if(e.sealed)return Ho(2);var r=((t={})[Uo]="",t["data-styled-version"]="5.3.0",t.dangerouslySetInnerHTML={__html:e.instance.toString()},t),o=oi();return o&&(r.nonce=o),[n.createElement("style",To({},r,{key:"sc-0-0"}))]},this.seal=function(){e.sealed=!0},this.instance=new pi({isServer:!0}),this.sealed=!1}var t=e.prototype;return t.collectStyles=function(e){return this.sealed?Ho(2):n.createElement(Ci,{sheet:this.instance},e)},t.interleaveWithNodeStream=function(e){return Ho(3)},e}(),aa=function(e){var t=n.forwardRef((function(t,r){var o=(0,n.useContext)(Qi),i=e.defaultProps,a=zi(t,o,i);return n.createElement(e,To({},t,{theme:a,ref:r}))}));return jo()(t,e),t.displayName="WithTheme("+Fo(e)+")",t},sa=function(){return(0,n.useContext)(Qi)},la={StyleSheet:pi,masterSheet:Ei},ca=ta;const{default:ua,css:pa,createGlobalStyle:da,keyframes:fa,ThemeProvider:ha}=e,ma=(e,t,n)=>(...r)=>pa`
@media ${t?"print, ":""} screen and (max-width: ${t=>t.theme.breakpoints[e]}) ${n||""} {
${pa(...r)};
}
`;var ga=ua;function ya(e){return t=>{if(t.theme.extensionsHook)return t.theme.extensionsHook(e,t)}}const va=ga.div`
padding: 20px;
color: red;
`;class ba extends n.Component{constructor(e){super(e),this.state={error:void 0}}componentDidCatch(e){return this.setState({error:e}),!1}render(){return this.state.error?n.createElement(va,null,n.createElement("h1",null,"Something went wrong..."),n.createElement("small",null," ",this.state.error.message," "),n.createElement("p",null,n.createElement("details",null,n.createElement("summary",null,"Stack trace"),n.createElement("pre",null,this.state.error.stack))),n.createElement("small",null," ReDoc Version: ","2.0.0")," ",n.createElement("br",null),n.createElement("small",null," Commit: ","5fb4daa")):n.createElement(n.Fragment,null,n.Children.only(this.props.children))}}const wa=fa`
0% {
transform: rotate(0deg); }
100% {
transform: rotate(360deg);
}
`,xa=ga((e=>n.createElement("svg",{className:e.className,version:"1.1",width:"512",height:"512",viewBox:"0 0 512 512"},n.createElement("path",{d:"M275.682 147.999c0 10.864-8.837 19.661-19.682 19.661v0c-10.875 0-19.681-8.796-19.681-19.661v-96.635c0-10.885 8.806-19.661 19.681-19.661v0c10.844 0 19.682 8.776 19.682 19.661v96.635z"}),n.createElement("path",{d:"M275.682 460.615c0 10.865-8.837 19.682-19.682 19.682v0c-10.875 0-19.681-8.817-19.681-19.682v-96.604c0-10.885 8.806-19.681 19.681-19.681v0c10.844 0 19.682 8.796 19.682 19.682v96.604z"}),n.createElement("path",{d:"M147.978 236.339c10.885 0 19.681 8.755 19.681 19.641v0c0 10.885-8.796 19.702-19.681 19.702h-96.624c-10.864 0-19.661-8.817-19.661-19.702v0c0-10.885 8.796-19.641 19.661-19.641h96.624z"}),n.createElement("path",{d:"M460.615 236.339c10.865 0 19.682 8.755 19.682 19.641v0c0 10.885-8.817 19.702-19.682 19.702h-96.584c-10.885 0-19.722-8.817-19.722-19.702v0c0-10.885 8.837-19.641 19.722-19.641h96.584z"}),n.createElement("path",{d:"M193.546 165.703c7.69 7.66 7.68 20.142 0 27.822v0c-7.701 7.701-20.162 7.701-27.853 0.020l-68.311-68.322c-7.68-7.701-7.68-20.142 0-27.863v0c7.68-7.68 20.121-7.68 27.822 0l68.342 68.342z"}),n.createElement("path",{d:"M414.597 386.775c7.7 7.68 7.7 20.163 0.021 27.863v0c-7.7 7.659-20.142 7.659-27.843-0.062l-68.311-68.26c-7.68-7.7-7.68-20.204 0-27.863v0c7.68-7.7 20.163-7.7 27.842 0l68.291 68.322z"}),n.createElement("path",{d:"M165.694 318.464c7.69-7.7 20.153-7.7 27.853 0v0c7.68 7.659 7.69 20.163 0 27.863l-68.342 68.322c-7.67 7.659-20.142 7.659-27.822-0.062v0c-7.68-7.68-7.68-20.122 0-27.801l68.311-68.322z"}),n.createElement("path",{d:"M386.775 97.362c7.7-7.68 20.142-7.68 27.822 0v0c7.7 7.68 7.7 20.183 0.021 27.863l-68.322 68.311c-7.68 7.68-20.163 7.68-27.843-0.020v0c-7.68-7.68-7.68-20.162 0-27.822l68.322-68.332z"}))))`
animation: 2s ${wa} linear infinite;
width: 50px;
height: 50px;
content: '';
display: inline-block;
margin-left: -25px;
path {
fill: ${e=>e.color};
}
`,ka=ga.div`
font-family: helvetica, sans;
width: 100%;
text-align: center;
font-size: 25px;
margin: 30px 0 20px 0;
color: ${e=>e.color};
`;class _a extends n.PureComponent{render(){return n.createElement("div",{style:{textAlign:"center"}},n.createElement(ka,{color:this.props.color},"Loading ..."),n.createElement(xa,{color:this.props.color}))}}var Oa=r(5697);const Sa=n.createContext(new xo({})),Ea=Sa.Provider,Pa=Sa.Consumer;var Aa=r(3675),$a=r(3777),Ca=r(8925);var Ra=r(1851),ja=r(6729),Ta=r(3573),Ia=r.n(Ta);const Na=Ta.parse;class Da{static baseName(e,t=1){const n=Da.parse(e);return n[n.length-t]}static dirName(e,t=1){const n=Da.parse(e);return Ta.compile(n.slice(0,n.length-t))}static relative(e,t){const n=Da.parse(e);return Da.parse(t).slice(n.length)}static parse(e){let t=e;return"#"===t.charAt(0)&&(t=t.substring(1)),Na(t)}static join(e,t){const n=Da.parse(e).concat(t);return Ta.compile(n)}static get(e,t){return Ta.get(e,t)}static compile(e){return Ta.compile(e)}static escape(e){return Ta.escape(e)}}Ta.parse=Da.parse,Object.assign(Da,Ta);var La=r(6470),Ma=r(3578),Fa=Object.defineProperty,za=Object.defineProperties,Ua=Object.getOwnPropertyDescriptors,Va=Object.getOwnPropertySymbols,Ba=Object.prototype.hasOwnProperty,qa=Object.prototype.propertyIsEnumerable,Wa=(e,t,n)=>t in e?Fa(e,t,{enumerable:!0,configurable:!0,writable:!0,value:n}):e[t]=n,Ha=(e,t)=>{for(var n in t||(t={}))Ba.call(t,n)&&Wa(e,n,t[n]);if(Va)for(var n of Va(t))qa.call(t,n)&&Wa(e,n,t[n]);return e},Ya=(e,t)=>za(e,Ua(t));function Ka(e){return"string"==typeof e&&/\dxx/i.test(e)}function Ga(e,t=!1){if("default"===e)return t?"error":"success";let n="string"==typeof e?parseInt(e,10):e;if(Ka(e)&&(n*=100),n<100||n>599)throw new Error("invalid HTTP code");let r="success";return n>=300&&n<400?r="redirect":n>=400?r="error":n<200&&(r="info"),r}const Qa={get:!0,post:!0,put:!0,head:!0,patch:!0,delete:!0,options:!0,$ref:!0};function Xa(e){return e in Qa}const Ja={multipleOf:"number",maximum:"number",exclusiveMaximum:"number",minimum:"number",exclusiveMinimum:"number",maxLength:"string",minLength:"string",pattern:"string",contentEncoding:"string",contentMediaType:"string",items:"array",maxItems:"array",minItems:"array",uniqueItems:"array",maxProperties:"object",minProperties:"object",required:"object",additionalProperties:"object",unevaluatedProperties:"object",properties:"object",patternProperties:"object"};function Za(e,t=e.type){if(e["x-circular-ref"])return!0;if(void 0!==e.oneOf||void 0!==e.anyOf)return!1;if(e.if&&e.then||e.if&&e.else)return!1;let n=!0;const r=io(t);return("object"===t||r&&(null==t?void 0:t.includes("object")))&&(n=void 0!==e.properties?0===Object.keys(e.properties).length:void 0===e.additionalProperties&&void 0===e.unevaluatedProperties&&void 0===e.patternProperties),!io(e.items)&&!io(e.prefixItems)&&(void 0!==e.items&&!ao(e.items)&&("array"===t||r&&(null==t?void 0:t.includes("array")))&&(n=Za(e.items,e.items.type)),n)}function es(e){return-1!==e.search(/json/i)}function ts(e,t,n){return io(e)?e.map((e=>e.toString())).join(n):"object"==typeof e?Object.keys(e).map((t=>`${t}${n}${e[t]}`)).join(n):t+"="+e.toString()}function ns(e,t){return io(e)?(console.warn("deepObject style cannot be used with array value:"+e.toString()),""):"object"==typeof e?Object.keys(e).map((n=>`${t}[${n}]=${e[n]}`)).join("&"):(console.warn("deepObject style cannot be used with non-object value:"+e.toString()),"")}function rs(e,t,n){const r="__redoc_param_name__",o=t?"*":"";return Ma.parse(`{?${r}${o}}`).expand({[r]:n}).substring(1).replace(/__redoc_param_name__/g,e)}function os(e,t){return es(t)?JSON.stringify(e):(console.warn(`Parameter serialization as ${t} is not supported`),"")}function is(e,t){return e.in?decodeURIComponent(function(e,t){const{name:n,style:r,explode:o=!1,serializationMime:i}=e;if(i)switch(e.in){case"path":case"header":return os(t,i);case"cookie":case"query":return`${n}=${os(t,i)}`;default:return console.warn("Unexpected parameter location: "+e.in),""}if(!r)return console.warn(`Missing style attribute or content for parameter ${n}`),"";switch(e.in){case"path":return function(e,t,n,r){const o=n?"*":"";let i="";"label"===t?i=".":"matrix"===t&&(i=";");const a="__redoc_param_name__";return Ma.parse(`{${i}${a}${o}}`).expand({[a]:r}).replace(/__redoc_param_name__/g,e)}(n,r,o,t);case"query":return function(e,t,n,r){switch(t){case"form":return rs(e,n,r);case"spaceDelimited":return io(r)?n?rs(e,n,r):`${e}=${r.join("%20")}`:(console.warn("The style spaceDelimited is only applicable to arrays"),"");case"pipeDelimited":return io(r)?n?rs(e,n,r):`${e}=${r.join("|")}`:(console.warn("The style pipeDelimited is only applicable to arrays"),"");case"deepObject":return!n||io(r)||"object"!=typeof r?(console.warn("The style deepObject is only applicable for objects with explode=true"),""):ns(r,e);default:return console.warn("Unexpected style for query: "+t),""}}(n,r,o,t);case"header":return function(e,t,n){if("simple"===e){const e=t?"*":"",r="__redoc_param_name__",o=Ma.parse(`{${r}${e}}`);return decodeURIComponent(o.expand({[r]:n}))}return console.warn("Unexpected style for header: "+e),""}(r,o,t);case"cookie":return function(e,t,n,r){return"form"===t?rs(e,n,r):(console.warn("Unexpected style for cookie: "+t),"")}(n,r,o,t);default:return console.warn("Unexpected parameter location: "+e.in),""}}(e,t)):t}const as=/^#\/components\/(schemas|pathItems)\/([^/]+)$/;function ss(e){return as.test(e||"")}function ls(e){var t;const[n]=(null==(t=null==e?void 0:e.match(as))?void 0:t.reverse())||[];return n}function cs(e,t,n){let r;return void 0!==t&&void 0!==n?r=t===n?`= ${t} ${e}`:`[ ${t} .. ${n} ] ${e}`:void 0!==n?r=`<= ${n} ${e}`:void 0!==t&&(r=1===t?"non-empty":`>= ${t} ${e}`),r}function us(e){const t=[],n=cs("characters",e.minLength,e.maxLength);void 0!==n&&t.push(n);const r=cs("items",e.minItems,e.maxItems);void 0!==r&&t.push(r);const o=cs("properties",e.minProperties,e.maxProperties);void 0!==o&&t.push(o);const i=function(e){if(void 0===e)return;const t=e.toString(10);return/^0\.0*1$/.test(t)?`decimal places <= ${t.split(".")[1].length}`:`multiple of ${t}`}(e.multipleOf);void 0!==i&&t.push(i);const a=function(e){var t,n;const r="number"==typeof e.exclusiveMinimum?Math.min(e.exclusiveMinimum,null!=(t=e.minimum)?t:1/0):e.minimum,o="number"==typeof e.exclusiveMaximum?Math.max(e.exclusiveMaximum,null!=(n=e.maximum)?n:-1/0):e.maximum,i="number"==typeof e.exclusiveMinimum||e.exclusiveMinimum,a="number"==typeof e.exclusiveMaximum||e.exclusiveMaximum;return void 0!==r&&void 0!==o?`${i?"( ":"[ "}${r} .. ${o}${a?" )":" ]"}`:void 0!==o?`${a?"< ":"<= "}${o}`:void 0!==r?`${i?"> ":">= "}${r}`:void 0}(e);return void 0!==a&&t.push(a),e.uniqueItems&&t.push("unique"),t}function ps(e,t=[]){const n=[],r=[],o=[];return e.forEach((e=>{e.required?t.includes(e.name)?r.push(e):o.push(e):n.push(e)})),r.sort(((e,n)=>t.indexOf(e.name)-t.indexOf(n.name))),[...r,...o,...n]}function ds(e,t){return[...e].sort(((e,n)=>e[t].localeCompare(n[t])))}function fs(e,t){const n=void 0===e?function(e){try{const t=ro(e);return t.search="",t.hash="",t.toString()}catch(t){return e}}((()=>{if(!qr)return"";const e=window.location.href;return e.endsWith(".html")?(0,La.dirname)(e):e})()):(0,La.dirname)(e);return 0===t.length&&(t=[{url:"/"}]),t.map((e=>{return Ya(Ha({},e),{url:(t=e.url,function(e,t){let n;if(t.startsWith("//"))try{n=`${new URL(e).protocol||"https:"}${t}`}catch(e){n=`https:${t}`}else if(function(e){return/(?:^[a-z][a-z0-9+.-]*:|\/\/)/i.test(e)}(t))n=t;else if(t.startsWith("/"))try{const r=new URL(e);r.pathname=t,n=r.href}catch(e){n=t}else n=Xr(e)+"/"+t;return Xr(n)}(n,t)),description:e.description||""});var t}))}let hs="section/Authentication/";const ms=e=>({delete:"del",options:"opts"}[e]||e);function gs(e,t){return Object.keys(e).filter((e=>!0===t?e.startsWith("x-")&&!function(e){return e in{"x-circular-ref":!0,"x-parentRefs":!0,"x-refsStack":!0,"x-code-samples":!0,"x-codeSamples":!0,"x-displayName":!0,"x-examples":!0,"x-ignoredHeaderParameters":!0,"x-logo":!0,"x-nullable":!0,"x-servers":!0,"x-tagGroups":!0,"x-traitTag":!0,"x-additionalPropertiesName":!0,"x-explicitMappingOnly":!0}}(e):e.startsWith("x-")&&t.indexOf(e)>-1)).reduce(((t,n)=>(t[n]=e[n],t)),{})}var ys=r(5660);r(7874),r(4279),r(5433),r(6213),r(2731),r(3967),r(7046),r(57),r(2503),r(6841),r(6854),r(4335),r(1426),r(8246),r(9945),r(366),r(2939),r(9385),r(2886),r(5266),r(874),r(3358),r(8052);function vs(e,t="clike"){t=t.toLowerCase();let n=ys.languages[t];return n||(n=ys.languages[function(e){return{json:"js","c++":"cpp","c#":"csharp","objective-c":"objectivec",shell:"bash",viml:"vim"}[e]||"clike"}(t)]),ys.highlight(e.toString(),n,t)}ys.languages.insertBefore("javascript","string",{"property string":{pattern:/([{,]\s*)"(?:\\.|[^\\"\r\n])*"(?=\s*:)/i,lookbehind:!0}},void 0),ys.languages.insertBefore("javascript","punctuation",{property:{pattern:/([{,]\s*)[a-z]\w*(?=\s*:)/i,lookbehind:!0}},void 0);var bs=Object.defineProperty,ws=Object.defineProperties,xs=Object.getOwnPropertyDescriptors,ks=Object.getOwnPropertySymbols,_s=Object.prototype.hasOwnProperty,Os=Object.prototype.propertyIsEnumerable,Ss=(e,t,n)=>t in e?bs(e,t,{enumerable:!0,configurable:!0,writable:!0,value:n}):e[t]=n,Es=(e,t)=>{for(var n in t||(t={}))_s.call(t,n)&&Ss(e,n,t[n]);if(ks)for(var n of ks(t))Os.call(t,n)&&Ss(e,n,t[n]);return e},Ps=(e,t)=>ws(e,xs(t));const As={};function $s(e,t,n){if("function"==typeof n.value)return function(e,t,n){if(!n.value||n.value.length>0)throw new Error("@memoize decorator can only be applied to methods of zero arguments");const r=`_memoized_${t}`,o=n.value;return e[r]=As,Ps(Es({},n),{value(){return this[r]===As&&(this[r]=o.call(this)),this[r]}})}(e,t,n);if("function"==typeof n.get)return function(e,t,n){const r=`_memoized_${t}`,o=n.get;return e[r]=As,Ps(Es({},n),{get(){return this[r]===As&&(this[r]=o.call(this)),this[r]}})}(e,t,n);throw new Error("@memoize decorator can be applied to methods or getters, got "+String(n.value)+" instead")}function Cs(e){let t=1;return"-"===e[0]&&(t=-1,e=e.substr(1)),(n,r)=>-1==t?r[e].localeCompare(n[e]):n[e].localeCompare(r[e])}var Rs=Object.defineProperty,js=Object.getOwnPropertyDescriptor;const Ts="hashchange";class Is{constructor(){this.emit=()=>{this._emiter.emit(Ts,this.currentId)},this._emiter=new ja.EventEmitter,this.bind()}get currentId(){return qr?decodeURIComponent(window.location.hash.substring(1)):""}linkForId(e){return e?"#"+e:""}subscribe(e){const t=this._emiter.addListener(Ts,e);return()=>t.removeListener(Ts,e)}bind(){qr&&window.addEventListener("hashchange",this.emit,!1)}dispose(){qr&&window.removeEventListener("hashchange",this.emit)}replace(e,t=!1){qr&&null!=e&&e!==this.currentId&&(t?window.history.replaceState(null,"",window.location.href.split("#")[0]+this.linkForId(e)):(window.history.pushState(null,"",window.location.href.split("#")[0]+this.linkForId(e)),this.emit()))}}((e,t,n,r)=>{for(var o,i=js(t,n),a=e.length-1;a>=0;a--)(o=e[a])&&(i=o(t,n,i)||i);i&&Rs(t,n,i)})([Ra.bind,Ra.debounce],Is.prototype,"replace");const Ns=new Is;var Ds=r(813);class Ls{constructor(){this.map=new Map,this.prevTerm=""}add(e){this.map.set(e,new Ds(e))}delete(e){this.map.delete(e)}addOnly(e){this.map.forEach(((t,n)=>{-1===e.indexOf(n)&&(t.unmark(),this.map.delete(n))}));for(const t of e)this.map.has(t)||this.map.set(t,new Ds(t))}clearAll(){this.unmark(),this.map.clear()}mark(e){(e||this.prevTerm)&&(this.map.forEach((t=>{t.unmark(),t.mark(e||this.prevTerm)})),this.prevTerm=e||this.prevTerm)}unmark(){this.map.forEach((e=>e.unmark())),this.prevTerm=""}}let Ms={baseUrl:null,breaks:!1,extensions:null,gfm:!0,headerIds:!0,headerPrefix:"",highlight:null,langPrefix:"language-",mangle:!0,pedantic:!1,renderer:null,sanitize:!1,sanitizer:null,silent:!1,smartLists:!1,smartypants:!1,tokenizer:null,walkTokens:null,xhtml:!1};const Fs=/[&<>"']/,zs=/[&<>"']/g,Us=/[<>"']|&(?!#?\w+;)/,Vs=/[<>"']|&(?!#?\w+;)/g,Bs={"&":"&","<":"<",">":">",'"':""","'":"'"},qs=e=>Bs[e];function Ws(e,t){if(t){if(Fs.test(e))return e.replace(zs,qs)}else if(Us.test(e))return e.replace(Vs,qs);return e}const Hs=/&(#(?:\d+)|(?:#x[0-9A-Fa-f]+)|(?:\w+));?/gi;function Ys(e){return e.replace(Hs,((e,t)=>"colon"===(t=t.toLowerCase())?":":"#"===t.charAt(0)?"x"===t.charAt(1)?String.fromCharCode(parseInt(t.substring(2),16)):String.fromCharCode(+t.substring(1)):""))}const Ks=/(^|[^\[])\^/g;function Gs(e,t){e="string"==typeof e?e:e.source,t=t||"";const n={replace:(t,r)=>(r=(r=r.source||r).replace(Ks,"$1"),e=e.replace(t,r),n),getRegex:()=>new RegExp(e,t)};return n}const Qs=/[^\w:]/g,Xs=/^$|^[a-z][a-z0-9+.-]*:|^[?#]/i;function Js(e,t,n){if(e){let e;try{e=decodeURIComponent(Ys(n)).replace(Qs,"").toLowerCase()}catch(e){return null}if(0===e.indexOf("javascript:")||0===e.indexOf("vbscript:")||0===e.indexOf("data:"))return null}t&&!Xs.test(n)&&(n=function(e,t){Zs[" "+e]||(el.test(e)?Zs[" "+e]=e+"/":Zs[" "+e]=al(e,"/",!0));const n=-1===(e=Zs[" "+e]).indexOf(":");return"//"===t.substring(0,2)?n?t:e.replace(tl,"$1")+t:"/"===t.charAt(0)?n?t:e.replace(nl,"$1")+t:e+t}(t,n));try{n=encodeURI(n).replace(/%25/g,"%")}catch(e){return null}return n}const Zs={},el=/^[^:]+:\/*[^/]*$/,tl=/^([^:]+:)[\s\S]*$/,nl=/^([^:]+:\/*[^/]*)[\s\S]*$/,rl={exec:function(){}};function ol(e){let t,n,r=1;for(;r<arguments.length;r++)for(n in t=arguments[r],t)Object.prototype.hasOwnProperty.call(t,n)&&(e[n]=t[n]);return e}function il(e,t){const n=e.replace(/\|/g,((e,t,n)=>{let r=!1,o=t;for(;--o>=0&&"\\"===n[o];)r=!r;return r?"|":" |"})).split(/ \|/);let r=0;if(n[0].trim()||n.shift(),n.length>0&&!n[n.length-1].trim()&&n.pop(),n.length>t)n.splice(t);else for(;n.length<t;)n.push("");for(;r<n.length;r++)n[r]=n[r].trim().replace(/\\\|/g,"|");return n}function al(e,t,n){const r=e.length;if(0===r)return"";let o=0;for(;o<r;){const i=e.charAt(r-o-1);if(i!==t||n){if(i===t||!n)break;o++}else o++}return e.slice(0,r-o)}function sl(e){e&&e.sanitize&&!e.silent&&console.warn("marked(): sanitize and sanitizer parameters are deprecated since version 0.7.0, should not be used and will be removed in the future. Read more here: https://marked.js.org/#/USING_ADVANCED.md#options")}function ll(e,t){if(t<1)return"";let n="";for(;t>1;)1&t&&(n+=e),t>>=1,e+=e;return n+e}function cl(e,t,n,r){const o=t.href,i=t.title?Ws(t.title):null,a=e[1].replace(/\\([\[\]])/g,"$1");if("!"!==e[0].charAt(0)){r.state.inLink=!0;const e={type:"link",raw:n,href:o,title:i,text:a,tokens:r.inlineTokens(a,[])};return r.state.inLink=!1,e}return{type:"image",raw:n,href:o,title:i,text:Ws(a)}}class ul{constructor(e){this.options=e||Ms}space(e){const t=this.rules.block.newline.exec(e);if(t&&t[0].length>0)return{type:"space",raw:t[0]}}code(e){const t=this.rules.block.code.exec(e);if(t){const e=t[0].replace(/^ {1,4}/gm,"");return{type:"code",raw:t[0],codeBlockStyle:"indented",text:this.options.pedantic?e:al(e,"\n")}}}fences(e){const t=this.rules.block.fences.exec(e);if(t){const e=t[0],n=function(e,t){const n=e.match(/^(\s+)(?:```)/);if(null===n)return t;const r=n[1];return t.split("\n").map((e=>{const t=e.match(/^\s+/);if(null===t)return e;const[n]=t;return n.length>=r.length?e.slice(r.length):e})).join("\n")}(e,t[3]||"");return{type:"code",raw:e,lang:t[2]?t[2].trim():t[2],text:n}}}heading(e){const t=this.rules.block.heading.exec(e);if(t){let e=t[2].trim();if(/#$/.test(e)){const t=al(e,"#");this.options.pedantic?e=t.trim():t&&!/ $/.test(t)||(e=t.trim())}const n={type:"heading",raw:t[0],depth:t[1].length,text:e,tokens:[]};return this.lexer.inline(n.text,n.tokens),n}}hr(e){const t=this.rules.block.hr.exec(e);if(t)return{type:"hr",raw:t[0]}}blockquote(e){const t=this.rules.block.blockquote.exec(e);if(t){const e=t[0].replace(/^ *>[ \t]?/gm,"");return{type:"blockquote",raw:t[0],tokens:this.lexer.blockTokens(e,[]),text:e}}}list(e){let t=this.rules.block.list.exec(e);if(t){let n,r,o,i,a,s,l,c,u,p,d,f,h=t[1].trim();const m=h.length>1,g={type:"list",raw:"",ordered:m,start:m?+h.slice(0,-1):"",loose:!1,items:[]};h=m?`\\d{1,9}\\${h.slice(-1)}`:`\\${h}`,this.options.pedantic&&(h=m?h:"[*+-]");const y=new RegExp(`^( {0,3}${h})((?:[\t ][^\\n]*)?(?:\\n|$))`);for(;e&&(f=!1,t=y.exec(e))&&!this.rules.block.hr.test(e);){if(n=t[0],e=e.substring(n.length),c=t[2].split("\n",1)[0],u=e.split("\n",1)[0],this.options.pedantic?(i=2,d=c.trimLeft()):(i=t[2].search(/[^ ]/),i=i>4?1:i,d=c.slice(i),i+=t[1].length),s=!1,!c&&/^ *$/.test(u)&&(n+=u+"\n",e=e.substring(u.length+1),f=!0),!f){const t=new RegExp(`^ {0,${Math.min(3,i-1)}}(?:[*+-]|\\d{1,9}[.)])((?: [^\\n]*)?(?:\\n|$))`),r=new RegExp(`^ {0,${Math.min(3,i-1)}}((?:- *){3,}|(?:_ *){3,}|(?:\\* *){3,})(?:\\n+|$)`);for(;e&&(p=e.split("\n",1)[0],c=p,this.options.pedantic&&(c=c.replace(/^ {1,4}(?=( {4})*[^ ])/g," ")),!t.test(c))&&!r.test(e);){if(c.search(/[^ ]/)>=i||!c.trim())d+="\n"+c.slice(i);else{if(s)break;d+="\n"+c}s||c.trim()||(s=!0),n+=p+"\n",e=e.substring(p.length+1)}}g.loose||(l?g.loose=!0:/\n *\n *$/.test(n)&&(l=!0)),this.options.gfm&&(r=/^\[[ xX]\] /.exec(d),r&&(o="[ ] "!==r[0],d=d.replace(/^\[[ xX]\] +/,""))),g.items.push({type:"list_item",raw:n,task:!!r,checked:o,loose:!1,text:d}),g.raw+=n}g.items[g.items.length-1].raw=n.trimRight(),g.items[g.items.length-1].text=d.trimRight(),g.raw=g.raw.trimRight();const v=g.items.length;for(a=0;a<v;a++){this.lexer.state.top=!1,g.items[a].tokens=this.lexer.blockTokens(g.items[a].text,[]);const e=g.items[a].tokens.filter((e=>"space"===e.type)),t=e.every((e=>{const t=e.raw.split("");let n=0;for(const e of t)if("\n"===e&&(n+=1),n>1)return!0;return!1}));!g.loose&&e.length&&t&&(g.loose=!0,g.items[a].loose=!0)}return g}}html(e){const t=this.rules.block.html.exec(e);if(t){const e={type:"html",raw:t[0],pre:!this.options.sanitizer&&("pre"===t[1]||"script"===t[1]||"style"===t[1]),text:t[0]};return this.options.sanitize&&(e.type="paragraph",e.text=this.options.sanitizer?this.options.sanitizer(t[0]):Ws(t[0]),e.tokens=[],this.lexer.inline(e.text,e.tokens)),e}}def(e){const t=this.rules.block.def.exec(e);if(t)return t[3]&&(t[3]=t[3].substring(1,t[3].length-1)),{type:"def",tag:t[1].toLowerCase().replace(/\s+/g," "),raw:t[0],href:t[2],title:t[3]}}table(e){const t=this.rules.block.table.exec(e);if(t){const e={type:"table",header:il(t[1]).map((e=>({text:e}))),align:t[2].replace(/^ *|\| *$/g,"").split(/ *\| */),rows:t[3]&&t[3].trim()?t[3].replace(/\n[ \t]*$/,"").split("\n"):[]};if(e.header.length===e.align.length){e.raw=t[0];let n,r,o,i,a=e.align.length;for(n=0;n<a;n++)/^ *-+: *$/.test(e.align[n])?e.align[n]="right":/^ *:-+: *$/.test(e.align[n])?e.align[n]="center":/^ *:-+ *$/.test(e.align[n])?e.align[n]="left":e.align[n]=null;for(a=e.rows.length,n=0;n<a;n++)e.rows[n]=il(e.rows[n],e.header.length).map((e=>({text:e})));for(a=e.header.length,r=0;r<a;r++)e.header[r].tokens=[],this.lexer.inlineTokens(e.header[r].text,e.header[r].tokens);for(a=e.rows.length,r=0;r<a;r++)for(i=e.rows[r],o=0;o<i.length;o++)i[o].tokens=[],this.lexer.inlineTokens(i[o].text,i[o].tokens);return e}}}lheading(e){const t=this.rules.block.lheading.exec(e);if(t){const e={type:"heading",raw:t[0],depth:"="===t[2].charAt(0)?1:2,text:t[1],tokens:[]};return this.lexer.inline(e.text,e.tokens),e}}paragraph(e){const t=this.rules.block.paragraph.exec(e);if(t){const e={type:"paragraph",raw:t[0],text:"\n"===t[1].charAt(t[1].length-1)?t[1].slice(0,-1):t[1],tokens:[]};return this.lexer.inline(e.text,e.tokens),e}}text(e){const t=this.rules.block.text.exec(e);if(t){const e={type:"text",raw:t[0],text:t[0],tokens:[]};return this.lexer.inline(e.text,e.tokens),e}}escape(e){const t=this.rules.inline.escape.exec(e);if(t)return{type:"escape",raw:t[0],text:Ws(t[1])}}tag(e){const t=this.rules.inline.tag.exec(e);if(t)return!this.lexer.state.inLink&&/^<a /i.test(t[0])?this.lexer.state.inLink=!0:this.lexer.state.inLink&&/^<\/a>/i.test(t[0])&&(this.lexer.state.inLink=!1),!this.lexer.state.inRawBlock&&/^<(pre|code|kbd|script)(\s|>)/i.test(t[0])?this.lexer.state.inRawBlock=!0:this.lexer.state.inRawBlock&&/^<\/(pre|code|kbd|script)(\s|>)/i.test(t[0])&&(this.lexer.state.inRawBlock=!1),{type:this.options.sanitize?"text":"html",raw:t[0],inLink:this.lexer.state.inLink,inRawBlock:this.lexer.state.inRawBlock,text:this.options.sanitize?this.options.sanitizer?this.options.sanitizer(t[0]):Ws(t[0]):t[0]}}link(e){const t=this.rules.inline.link.exec(e);if(t){const e=t[2].trim();if(!this.options.pedantic&&/^</.test(e)){if(!/>$/.test(e))return;const t=al(e.slice(0,-1),"\\");if((e.length-t.length)%2==0)return}else{const e=function(e,t){if(-1===e.indexOf(t[1]))return-1;const n=e.length;let r=0,o=0;for(;o<n;o++)if("\\"===e[o])o++;else if(e[o]===t[0])r++;else if(e[o]===t[1]&&(r--,r<0))return o;return-1}(t[2],"()");if(e>-1){const n=(0===t[0].indexOf("!")?5:4)+t[1].length+e;t[2]=t[2].substring(0,e),t[0]=t[0].substring(0,n).trim(),t[3]=""}}let n=t[2],r="";if(this.options.pedantic){const e=/^([^'"]*[^\s])\s+(['"])(.*)\2/.exec(n);e&&(n=e[1],r=e[3])}else r=t[3]?t[3].slice(1,-1):"";return n=n.trim(),/^</.test(n)&&(n=this.options.pedantic&&!/>$/.test(e)?n.slice(1):n.slice(1,-1)),cl(t,{href:n?n.replace(this.rules.inline._escapes,"$1"):n,title:r?r.replace(this.rules.inline._escapes,"$1"):r},t[0],this.lexer)}}reflink(e,t){let n;if((n=this.rules.inline.reflink.exec(e))||(n=this.rules.inline.nolink.exec(e))){let e=(n[2]||n[1]).replace(/\s+/g," ");if(e=t[e.toLowerCase()],!e||!e.href){const e=n[0].charAt(0);return{type:"text",raw:e,text:e}}return cl(n,e,n[0],this.lexer)}}emStrong(e,t,n=""){let r=this.rules.inline.emStrong.lDelim.exec(e);if(!r)return;if(r[3]&&n.match(/[\p{L}\p{N}]/u))return;const o=r[1]||r[2]||"";if(!o||o&&(""===n||this.rules.inline.punctuation.exec(n))){const n=r[0].length-1;let o,i,a=n,s=0;const l="*"===r[0][0]?this.rules.inline.emStrong.rDelimAst:this.rules.inline.emStrong.rDelimUnd;for(l.lastIndex=0,t=t.slice(-1*e.length+n);null!=(r=l.exec(t));){if(o=r[1]||r[2]||r[3]||r[4]||r[5]||r[6],!o)continue;if(i=o.length,r[3]||r[4]){a+=i;continue}if((r[5]||r[6])&&n%3&&!((n+i)%3)){s+=i;continue}if(a-=i,a>0)continue;if(i=Math.min(i,i+a+s),Math.min(n,i)%2){const t=e.slice(1,n+r.index+i);return{type:"em",raw:e.slice(0,n+r.index+i+1),text:t,tokens:this.lexer.inlineTokens(t,[])}}const t=e.slice(2,n+r.index+i-1);return{type:"strong",raw:e.slice(0,n+r.index+i+1),text:t,tokens:this.lexer.inlineTokens(t,[])}}}}codespan(e){const t=this.rules.inline.code.exec(e);if(t){let e=t[2].replace(/\n/g," ");const n=/[^ ]/.test(e),r=/^ /.test(e)&&/ $/.test(e);return n&&r&&(e=e.substring(1,e.length-1)),e=Ws(e,!0),{type:"codespan",raw:t[0],text:e}}}br(e){const t=this.rules.inline.br.exec(e);if(t)return{type:"br",raw:t[0]}}del(e){const t=this.rules.inline.del.exec(e);if(t)return{type:"del",raw:t[0],text:t[2],tokens:this.lexer.inlineTokens(t[2],[])}}autolink(e,t){const n=this.rules.inline.autolink.exec(e);if(n){let e,r;return"@"===n[2]?(e=Ws(this.options.mangle?t(n[1]):n[1]),r="mailto:"+e):(e=Ws(n[1]),r=e),{type:"link",raw:n[0],text:e,href:r,tokens:[{type:"text",raw:e,text:e}]}}}url(e,t){let n;if(n=this.rules.inline.url.exec(e)){let e,r;if("@"===n[2])e=Ws(this.options.mangle?t(n[0]):n[0]),r="mailto:"+e;else{let t;do{t=n[0],n[0]=this.rules.inline._backpedal.exec(n[0])[0]}while(t!==n[0]);e=Ws(n[0]),r="www."===n[1]?"http://"+e:e}return{type:"link",raw:n[0],text:e,href:r,tokens:[{type:"text",raw:e,text:e}]}}}inlineText(e,t){const n=this.rules.inline.text.exec(e);if(n){let e;return e=this.lexer.state.inRawBlock?this.options.sanitize?this.options.sanitizer?this.options.sanitizer(n[0]):Ws(n[0]):n[0]:Ws(this.options.smartypants?t(n[0]):n[0]),{type:"text",raw:n[0],text:e}}}}const pl={newline:/^(?: *(?:\n|$))+/,code:/^( {4}[^\n]+(?:\n(?: *(?:\n|$))*)?)+/,fences:/^ {0,3}(`{3,}(?=[^`\n]*\n)|~{3,})([^\n]*)\n(?:|([\s\S]*?)\n)(?: {0,3}\1[~`]* *(?=\n|$)|$)/,hr:/^ {0,3}((?:-[\t ]*){3,}|(?:_[ \t]*){3,}|(?:\*[ \t]*){3,})(?:\n+|$)/,heading:/^ {0,3}(#{1,6})(?=\s|$)(.*)(?:\n+|$)/,blockquote:/^( {0,3}> ?(paragraph|[^\n]*)(?:\n|$))+/,list:/^( {0,3}bull)([ \t][^\n]+?)?(?:\n|$)/,html:"^ {0,3}(?:<(script|pre|style|textarea)[\\s>][\\s\\S]*?(?:</\\1>[^\\n]*\\n+|$)|comment[^\\n]*(\\n+|$)|<\\?[\\s\\S]*?(?:\\?>\\n*|$)|<![A-Z][\\s\\S]*?(?:>\\n*|$)|<!\\[CDATA\\[[\\s\\S]*?(?:\\]\\]>\\n*|$)|</?(tag)(?: +|\\n|/?>)[\\s\\S]*?(?:(?:\\n *)+\\n|$)|<(?!script|pre|style|textarea)([a-z][\\w-]*)(?:attribute)*? */?>(?=[ \\t]*(?:\\n|$))[\\s\\S]*?(?:(?:\\n *)+\\n|$)|</(?!script|pre|style|textarea)[a-z][\\w-]*\\s*>(?=[ \\t]*(?:\\n|$))[\\s\\S]*?(?:(?:\\n *)+\\n|$))",def:/^ {0,3}\[(label)\]: *(?:\n *)?<?([^\s>]+)>?(?:(?: +(?:\n *)?| *\n *)(title))? *(?:\n+|$)/,table:rl,lheading:/^([^\n]+)\n {0,3}(=+|-+) *(?:\n+|$)/,_paragraph:/^([^\n]+(?:\n(?!hr|heading|lheading|blockquote|fences|list|html|table| +\n)[^\n]+)*)/,text:/^[^\n]+/,_label:/(?!\s*\])(?:\\.|[^\[\]\\])+/,_title:/(?:"(?:\\"?|[^"\\])*"|'[^'\n]*(?:\n[^'\n]+)*\n?'|\([^()]*\))/};pl.def=Gs(pl.def).replace("label",pl._label).replace("title",pl._title).getRegex(),pl.bullet=/(?:[*+-]|\d{1,9}[.)])/,pl.listItemStart=Gs(/^( *)(bull) */).replace("bull",pl.bullet).getRegex(),pl.list=Gs(pl.list).replace(/bull/g,pl.bullet).replace("hr","\\n+(?=\\1?(?:(?:- *){3,}|(?:_ *){3,}|(?:\\* *){3,})(?:\\n+|$))").replace("def","\\n+(?="+pl.def.source+")").getRegex(),pl._tag="address|article|aside|base|basefont|blockquote|body|caption|center|col|colgroup|dd|details|dialog|dir|div|dl|dt|fieldset|figcaption|figure|footer|form|frame|frameset|h[1-6]|head|header|hr|html|iframe|legend|li|link|main|menu|menuitem|meta|nav|noframes|ol|optgroup|option|p|param|section|source|summary|table|tbody|td|tfoot|th|thead|title|tr|track|ul",pl._comment=/<!--(?!-?>)[\s\S]*?(?:-->|$)/,pl.html=Gs(pl.html,"i").replace("comment",pl._comment).replace("tag",pl._tag).replace("attribute",/ +[a-zA-Z:_][\w.:-]*(?: *= *"[^"\n]*"| *= *'[^'\n]*'| *= *[^\s"'=<>`]+)?/).getRegex(),pl.paragraph=Gs(pl._paragraph).replace("hr",pl.hr).replace("heading"," {0,3}#{1,6} ").replace("|lheading","").replace("|table","").replace("blockquote"," {0,3}>").replace("fences"," {0,3}(?:`{3,}(?=[^`\\n]*\\n)|~{3,})[^\\n]*\\n").replace("list"," {0,3}(?:[*+-]|1[.)]) ").replace("html","</?(?:tag)(?: +|\\n|/?>)|<(?:script|pre|style|textarea|!--)").replace("tag",pl._tag).getRegex(),pl.blockquote=Gs(pl.blockquote).replace("paragraph",pl.paragraph).getRegex(),pl.normal=ol({},pl),pl.gfm=ol({},pl.normal,{table:"^ *([^\\n ].*\\|.*)\\n {0,3}(?:\\| *)?(:?-+:? *(?:\\| *:?-+:? *)*)(?:\\| *)?(?:\\n((?:(?! *\\n|hr|heading|blockquote|code|fences|list|html).*(?:\\n|$))*)\\n*|$)"}),pl.gfm.table=Gs(pl.gfm.table).replace("hr",pl.hr).replace("heading"," {0,3}#{1,6} ").replace("blockquote"," {0,3}>").replace("code"," {4}[^\\n]").replace("fences"," {0,3}(?:`{3,}(?=[^`\\n]*\\n)|~{3,})[^\\n]*\\n").replace("list"," {0,3}(?:[*+-]|1[.)]) ").replace("html","</?(?:tag)(?: +|\\n|/?>)|<(?:script|pre|style|textarea|!--)").replace("tag",pl._tag).getRegex(),pl.gfm.paragraph=Gs(pl._paragraph).replace("hr",pl.hr).replace("heading"," {0,3}#{1,6} ").replace("|lheading","").replace("table",pl.gfm.table).replace("blockquote"," {0,3}>").replace("fences"," {0,3}(?:`{3,}(?=[^`\\n]*\\n)|~{3,})[^\\n]*\\n").replace("list"," {0,3}(?:[*+-]|1[.)]) ").replace("html","</?(?:tag)(?: +|\\n|/?>)|<(?:script|pre|style|textarea|!--)").replace("tag",pl._tag).getRegex(),pl.pedantic=ol({},pl.normal,{html:Gs("^ *(?:comment *(?:\\n|\\s*$)|<(tag)[\\s\\S]+?</\\1> *(?:\\n{2,}|\\s*$)|<tag(?:\"[^\"]*\"|'[^']*'|\\s[^'\"/>\\s]*)*?/?> *(?:\\n{2,}|\\s*$))").replace("comment",pl._comment).replace(/tag/g,"(?!(?:a|em|strong|small|s|cite|q|dfn|abbr|data|time|code|var|samp|kbd|sub|sup|i|b|u|mark|ruby|rt|rp|bdi|bdo|span|br|wbr|ins|del|img)\\b)\\w+(?!:|[^\\w\\s@]*@)\\b").getRegex(),def:/^ *\[([^\]]+)\]: *<?([^\s>]+)>?(?: +(["(][^\n]+[")]))? *(?:\n+|$)/,heading:/^(#{1,6})(.*)(?:\n+|$)/,fences:rl,paragraph:Gs(pl.normal._paragraph).replace("hr",pl.hr).replace("heading"," *#{1,6} *[^\n]").replace("lheading",pl.lheading).replace("blockquote"," {0,3}>").replace("|fences","").replace("|list","").replace("|html","").getRegex()});const dl={escape:/^\\([!"#$%&'()*+,\-./:;<=>?@\[\]\\^_`{|}~])/,autolink:/^<(scheme:[^\s\x00-\x1f<>]*|email)>/,url:rl,tag:"^comment|^</[a-zA-Z][\\w:-]*\\s*>|^<[a-zA-Z][\\w-]*(?:attribute)*?\\s*/?>|^<\\?[\\s\\S]*?\\?>|^<![a-zA-Z]+\\s[\\s\\S]*?>|^<!\\[CDATA\\[[\\s\\S]*?\\]\\]>",link:/^!?\[(label)\]\(\s*(href)(?:\s+(title))?\s*\)/,reflink:/^!?\[(label)\]\[(ref)\]/,nolink:/^!?\[(ref)\](?:\[\])?/,reflinkSearch:"reflink|nolink(?!\\()",emStrong:{lDelim:/^(?:\*+(?:([punct_])|[^\s*]))|^_+(?:([punct*])|([^\s_]))/,rDelimAst:/^[^_*]*?\_\_[^_*]*?\*[^_*]*?(?=\_\_)|[^*]+(?=[^*])|[punct_](\*+)(?=[\s]|$)|[^punct*_\s](\*+)(?=[punct_\s]|$)|[punct_\s](\*+)(?=[^punct*_\s])|[\s](\*+)(?=[punct_])|[punct_](\*+)(?=[punct_])|[^punct*_\s](\*+)(?=[^punct*_\s])/,rDelimUnd:/^[^_*]*?\*\*[^_*]*?\_[^_*]*?(?=\*\*)|[^_]+(?=[^_])|[punct*](\_+)(?=[\s]|$)|[^punct*_\s](\_+)(?=[punct*\s]|$)|[punct*\s](\_+)(?=[^punct*_\s])|[\s](\_+)(?=[punct*])|[punct*](\_+)(?=[punct*])/},code:/^(`+)([^`]|[^`][\s\S]*?[^`])\1(?!`)/,br:/^( {2,}|\\)\n(?!\s*$)/,del:rl,text:/^(`+|[^`])(?:(?= {2,}\n)|[\s\S]*?(?:(?=[\\<!\[`*_]|\b_|$)|[^ ](?= {2,}\n)))/,punctuation:/^([\spunctuation])/};function fl(e){return e.replace(/---/g,"—").replace(/--/g,"–").replace(/(^|[-\u2014/(\[{"\s])'/g,"$1‘").replace(/'/g,"’").replace(/(^|[-\u2014/(\[{\u2018\s])"/g,"$1“").replace(/"/g,"”").replace(/\.{3}/g,"…")}function hl(e){let t,n,r="";const o=e.length;for(t=0;t<o;t++)n=e.charCodeAt(t),Math.random()>.5&&(n="x"+n.toString(16)),r+="&#"+n+";";return r}dl._punctuation="!\"#$%&'()+\\-.,/:;<=>?@\\[\\]`^{|}~",dl.punctuation=Gs(dl.punctuation).replace(/punctuation/g,dl._punctuation).getRegex(),dl.blockSkip=/\[[^\]]*?\]\([^\)]*?\)|`[^`]*?`|<[^>]*?>/g,dl.escapedEmSt=/\\\*|\\_/g,dl._comment=Gs(pl._comment).replace("(?:--\x3e|$)","--\x3e").getRegex(),dl.emStrong.lDelim=Gs(dl.emStrong.lDelim).replace(/punct/g,dl._punctuation).getRegex(),dl.emStrong.rDelimAst=Gs(dl.emStrong.rDelimAst,"g").replace(/punct/g,dl._punctuation).getRegex(),dl.emStrong.rDelimUnd=Gs(dl.emStrong.rDelimUnd,"g").replace(/punct/g,dl._punctuation).getRegex(),dl._escapes=/\\([!"#$%&'()*+,\-./:;<=>?@\[\]\\^_`{|}~])/g,dl._scheme=/[a-zA-Z][a-zA-Z0-9+.-]{1,31}/,dl._email=/[a-zA-Z0-9.!#$%&'*+/=?^_`{|}~-]+(@)[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?(?:\.[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?)+(?![-_])/,dl.autolink=Gs(dl.autolink).replace("scheme",dl._scheme).replace("email",dl._email).getRegex(),dl._attribute=/\s+[a-zA-Z:_][\w.:-]*(?:\s*=\s*"[^"]*"|\s*=\s*'[^']*'|\s*=\s*[^\s"'=<>`]+)?/,dl.tag=Gs(dl.tag).replace("comment",dl._comment).replace("attribute",dl._attribute).getRegex(),dl._label=/(?:\[(?:\\.|[^\[\]\\])*\]|\\.|`[^`]*`|[^\[\]\\`])*?/,dl._href=/<(?:\\.|[^\n<>\\])+>|[^\s\x00-\x1f]*/,dl._title=/"(?:\\"?|[^"\\])*"|'(?:\\'?|[^'\\])*'|\((?:\\\)?|[^)\\])*\)/,dl.link=Gs(dl.link).replace("label",dl._label).replace("href",dl._href).replace("title",dl._title).getRegex(),dl.reflink=Gs(dl.reflink).replace("label",dl._label).replace("ref",pl._label).getRegex(),dl.nolink=Gs(dl.nolink).replace("ref",pl._label).getRegex(),dl.reflinkSearch=Gs(dl.reflinkSearch,"g").replace("reflink",dl.reflink).replace("nolink",dl.nolink).getRegex(),dl.normal=ol({},dl),dl.pedantic=ol({},dl.normal,{strong:{start:/^__|\*\*/,middle:/^__(?=\S)([\s\S]*?\S)__(?!_)|^\*\*(?=\S)([\s\S]*?\S)\*\*(?!\*)/,endAst:/\*\*(?!\*)/g,endUnd:/__(?!_)/g},em:{start:/^_|\*/,middle:/^()\*(?=\S)([\s\S]*?\S)\*(?!\*)|^_(?=\S)([\s\S]*?\S)_(?!_)/,endAst:/\*(?!\*)/g,endUnd:/_(?!_)/g},link:Gs(/^!?\[(label)\]\((.*?)\)/).replace("label",dl._label).getRegex(),reflink:Gs(/^!?\[(label)\]\s*\[([^\]]*)\]/).replace("label",dl._label).getRegex()}),dl.gfm=ol({},dl.normal,{escape:Gs(dl.escape).replace("])","~|])").getRegex(),_extended_email:/[A-Za-z0-9._+-]+(@)[a-zA-Z0-9-_]+(?:\.[a-zA-Z0-9-_]*[a-zA-Z0-9])+(?![-_])/,url:/^((?:ftp|https?):\/\/|www\.)(?:[a-zA-Z0-9\-]+\.?)+[^\s<]*|^email/,_backpedal:/(?:[^?!.,:;*_~()&]+|\([^)]*\)|&(?![a-zA-Z0-9]+;$)|[?!.,:;*_~)]+(?!$))+/,del:/^(~~?)(?=[^\s~])([\s\S]*?[^\s~])\1(?=[^~]|$)/,text:/^([`~]+|[^`~])(?:(?= {2,}\n)|(?=[a-zA-Z0-9.!#$%&'*+\/=?_`{\|}~-]+@)|[\s\S]*?(?:(?=[\\<!\[`*~_]|\b_|https?:\/\/|ftp:\/\/|www\.|$)|[^ ](?= {2,}\n)|[^a-zA-Z0-9.!#$%&'*+\/=?_`{\|}~-](?=[a-zA-Z0-9.!#$%&'*+\/=?_`{\|}~-]+@)))/}),dl.gfm.url=Gs(dl.gfm.url,"i").replace("email",dl.gfm._extended_email).getRegex(),dl.breaks=ol({},dl.gfm,{br:Gs(dl.br).replace("{2,}","*").getRegex(),text:Gs(dl.gfm.text).replace("\\b_","\\b_| {2,}\\n").replace(/\{2,\}/g,"*").getRegex()});class ml{constructor(e){this.tokens=[],this.tokens.links=Object.create(null),this.options=e||Ms,this.options.tokenizer=this.options.tokenizer||new ul,this.tokenizer=this.options.tokenizer,this.tokenizer.options=this.options,this.tokenizer.lexer=this,this.inlineQueue=[],this.state={inLink:!1,inRawBlock:!1,top:!0};const t={block:pl.normal,inline:dl.normal};this.options.pedantic?(t.block=pl.pedantic,t.inline=dl.pedantic):this.options.gfm&&(t.block=pl.gfm,this.options.breaks?t.inline=dl.breaks:t.inline=dl.gfm),this.tokenizer.rules=t}static get rules(){return{block:pl,inline:dl}}static lex(e,t){return new ml(t).lex(e)}static lexInline(e,t){return new ml(t).inlineTokens(e)}lex(e){let t;for(e=e.replace(/\r\n|\r/g,"\n"),this.blockTokens(e,this.tokens);t=this.inlineQueue.shift();)this.inlineTokens(t.src,t.tokens);return this.tokens}blockTokens(e,t=[]){let n,r,o,i;for(e=this.options.pedantic?e.replace(/\t/g," ").replace(/^ +$/gm,""):e.replace(/^( *)(\t+)/gm,((e,t,n)=>t+" ".repeat(n.length)));e;)if(!(this.options.extensions&&this.options.extensions.block&&this.options.extensions.block.some((r=>!!(n=r.call({lexer:this},e,t))&&(e=e.substring(n.raw.length),t.push(n),!0)))))if(n=this.tokenizer.space(e))e=e.substring(n.raw.length),1===n.raw.length&&t.length>0?t[t.length-1].raw+="\n":t.push(n);else if(n=this.tokenizer.code(e))e=e.substring(n.raw.length),r=t[t.length-1],!r||"paragraph"!==r.type&&"text"!==r.type?t.push(n):(r.raw+="\n"+n.raw,r.text+="\n"+n.text,this.inlineQueue[this.inlineQueue.length-1].src=r.text);else if(n=this.tokenizer.fences(e))e=e.substring(n.raw.length),t.push(n);else if(n=this.tokenizer.heading(e))e=e.substring(n.raw.length),t.push(n);else if(n=this.tokenizer.hr(e))e=e.substring(n.raw.length),t.push(n);else if(n=this.tokenizer.blockquote(e))e=e.substring(n.raw.length),t.push(n);else if(n=this.tokenizer.list(e))e=e.substring(n.raw.length),t.push(n);else if(n=this.tokenizer.html(e))e=e.substring(n.raw.length),t.push(n);else if(n=this.tokenizer.def(e))e=e.substring(n.raw.length),r=t[t.length-1],!r||"paragraph"!==r.type&&"text"!==r.type?this.tokens.links[n.tag]||(this.tokens.links[n.tag]={href:n.href,title:n.title}):(r.raw+="\n"+n.raw,r.text+="\n"+n.raw,this.inlineQueue[this.inlineQueue.length-1].src=r.text);else if(n=this.tokenizer.table(e))e=e.substring(n.raw.length),t.push(n);else if(n=this.tokenizer.lheading(e))e=e.substring(n.raw.length),t.push(n);else{if(o=e,this.options.extensions&&this.options.extensions.startBlock){let t=1/0;const n=e.slice(1);let r;this.options.extensions.startBlock.forEach((function(e){r=e.call({lexer:this},n),"number"==typeof r&&r>=0&&(t=Math.min(t,r))})),t<1/0&&t>=0&&(o=e.substring(0,t+1))}if(this.state.top&&(n=this.tokenizer.paragraph(o)))r=t[t.length-1],i&&"paragraph"===r.type?(r.raw+="\n"+n.raw,r.text+="\n"+n.text,this.inlineQueue.pop(),this.inlineQueue[this.inlineQueue.length-1].src=r.text):t.push(n),i=o.length!==e.length,e=e.substring(n.raw.length);else if(n=this.tokenizer.text(e))e=e.substring(n.raw.length),r=t[t.length-1],r&&"text"===r.type?(r.raw+="\n"+n.raw,r.text+="\n"+n.text,this.inlineQueue.pop(),this.inlineQueue[this.inlineQueue.length-1].src=r.text):t.push(n);else if(e){const t="Infinite loop on byte: "+e.charCodeAt(0);if(this.options.silent){console.error(t);break}throw new Error(t)}}return this.state.top=!0,t}inline(e,t){this.inlineQueue.push({src:e,tokens:t})}inlineTokens(e,t=[]){let n,r,o,i,a,s,l=e;if(this.tokens.links){const e=Object.keys(this.tokens.links);if(e.length>0)for(;null!=(i=this.tokenizer.rules.inline.reflinkSearch.exec(l));)e.includes(i[0].slice(i[0].lastIndexOf("[")+1,-1))&&(l=l.slice(0,i.index)+"["+ll("a",i[0].length-2)+"]"+l.slice(this.tokenizer.rules.inline.reflinkSearch.lastIndex))}for(;null!=(i=this.tokenizer.rules.inline.blockSkip.exec(l));)l=l.slice(0,i.index)+"["+ll("a",i[0].length-2)+"]"+l.slice(this.tokenizer.rules.inline.blockSkip.lastIndex);for(;null!=(i=this.tokenizer.rules.inline.escapedEmSt.exec(l));)l=l.slice(0,i.index)+"++"+l.slice(this.tokenizer.rules.inline.escapedEmSt.lastIndex);for(;e;)if(a||(s=""),a=!1,!(this.options.extensions&&this.options.extensions.inline&&this.options.extensions.inline.some((r=>!!(n=r.call({lexer:this},e,t))&&(e=e.substring(n.raw.length),t.push(n),!0)))))if(n=this.tokenizer.escape(e))e=e.substring(n.raw.length),t.push(n);else if(n=this.tokenizer.tag(e))e=e.substring(n.raw.length),r=t[t.length-1],r&&"text"===n.type&&"text"===r.type?(r.raw+=n.raw,r.text+=n.text):t.push(n);else if(n=this.tokenizer.link(e))e=e.substring(n.raw.length),t.push(n);else if(n=this.tokenizer.reflink(e,this.tokens.links))e=e.substring(n.raw.length),r=t[t.length-1],r&&"text"===n.type&&"text"===r.type?(r.raw+=n.raw,r.text+=n.text):t.push(n);else if(n=this.tokenizer.emStrong(e,l,s))e=e.substring(n.raw.length),t.push(n);else if(n=this.tokenizer.codespan(e))e=e.substring(n.raw.length),t.push(n);else if(n=this.tokenizer.br(e))e=e.substring(n.raw.length),t.push(n);else if(n=this.tokenizer.del(e))e=e.substring(n.raw.length),t.push(n);else if(n=this.tokenizer.autolink(e,hl))e=e.substring(n.raw.length),t.push(n);else if(this.state.inLink||!(n=this.tokenizer.url(e,hl))){if(o=e,this.options.extensions&&this.options.extensions.startInline){let t=1/0;const n=e.slice(1);let r;this.options.extensions.startInline.forEach((function(e){r=e.call({lexer:this},n),"number"==typeof r&&r>=0&&(t=Math.min(t,r))})),t<1/0&&t>=0&&(o=e.substring(0,t+1))}if(n=this.tokenizer.inlineText(o,fl))e=e.substring(n.raw.length),"_"!==n.raw.slice(-1)&&(s=n.raw.slice(-1)),a=!0,r=t[t.length-1],r&&"text"===r.type?(r.raw+=n.raw,r.text+=n.text):t.push(n);else if(e){const t="Infinite loop on byte: "+e.charCodeAt(0);if(this.options.silent){console.error(t);break}throw new Error(t)}}else e=e.substring(n.raw.length),t.push(n);return t}}class gl{constructor(e){this.options=e||Ms}code(e,t,n){const r=(t||"").match(/\S*/)[0];if(this.options.highlight){const t=this.options.highlight(e,r);null!=t&&t!==e&&(n=!0,e=t)}return e=e.replace(/\n$/,"")+"\n",r?'<pre><code class="'+this.options.langPrefix+Ws(r,!0)+'">'+(n?e:Ws(e,!0))+"</code></pre>\n":"<pre><code>"+(n?e:Ws(e,!0))+"</code></pre>\n"}blockquote(e){return`<blockquote>\n${e}</blockquote>\n`}html(e){return e}heading(e,t,n,r){return this.options.headerIds?`<h${t} id="${this.options.headerPrefix+r.slug(n)}">${e}</h${t}>\n`:`<h${t}>${e}</h${t}>\n`}hr(){return this.options.xhtml?"<hr/>\n":"<hr>\n"}list(e,t,n){const r=t?"ol":"ul";return"<"+r+(t&&1!==n?' start="'+n+'"':"")+">\n"+e+"</"+r+">\n"}listitem(e){return`<li>${e}</li>\n`}checkbox(e){return"<input "+(e?'checked="" ':"")+'disabled="" type="checkbox"'+(this.options.xhtml?" /":"")+"> "}paragraph(e){return`<p>${e}</p>\n`}table(e,t){return t&&(t=`<tbody>${t}</tbody>`),"<table>\n<thead>\n"+e+"</thead>\n"+t+"</table>\n"}tablerow(e){return`<tr>\n${e}</tr>\n`}tablecell(e,t){const n=t.header?"th":"td";return(t.align?`<${n} align="${t.align}">`:`<${n}>`)+e+`</${n}>\n`}strong(e){return`<strong>${e}</strong>`}em(e){return`<em>${e}</em>`}codespan(e){return`<code>${e}</code>`}br(){return this.options.xhtml?"<br/>":"<br>"}del(e){return`<del>${e}</del>`}link(e,t,n){if(null===(e=Js(this.options.sanitize,this.options.baseUrl,e)))return n;let r='<a href="'+Ws(e)+'"';return t&&(r+=' title="'+t+'"'),r+=">"+n+"</a>",r}image(e,t,n){if(null===(e=Js(this.options.sanitize,this.options.baseUrl,e)))return n;let r=`<img src="${e}" alt="${n}"`;return t&&(r+=` title="${t}"`),r+=this.options.xhtml?"/>":">",r}text(e){return e}}class yl{strong(e){return e}em(e){return e}codespan(e){return e}del(e){return e}html(e){return e}text(e){return e}link(e,t,n){return""+n}image(e,t,n){return""+n}br(){return""}}class vl{constructor(){this.seen={}}serialize(e){return e.toLowerCase().trim().replace(/<[!\/a-z].*?>/gi,"").replace(/[\u2000-\u206F\u2E00-\u2E7F\\'!"#$%&()*+,./:;<=>?@[\]^`{|}~]/g,"").replace(/\s/g,"-")}getNextSafeSlug(e,t){let n=e,r=0;if(this.seen.hasOwnProperty(n)){r=this.seen[e];do{r++,n=e+"-"+r}while(this.seen.hasOwnProperty(n))}return t||(this.seen[e]=r,this.seen[n]=0),n}slug(e,t={}){const n=this.serialize(e);return this.getNextSafeSlug(n,t.dryrun)}}class bl{constructor(e){this.options=e||Ms,this.options.renderer=this.options.renderer||new gl,this.renderer=this.options.renderer,this.renderer.options=this.options,this.textRenderer=new yl,this.slugger=new vl}static parse(e,t){return new bl(t).parse(e)}static parseInline(e,t){return new bl(t).parseInline(e)}parse(e,t=!0){let n,r,o,i,a,s,l,c,u,p,d,f,h,m,g,y,v,b,w,x="";const k=e.length;for(n=0;n<k;n++)if(p=e[n],this.options.extensions&&this.options.extensions.renderers&&this.options.extensions.renderers[p.type]&&(w=this.options.extensions.renderers[p.type].call({parser:this},p),!1!==w||!["space","hr","heading","code","table","blockquote","list","html","paragraph","text"].includes(p.type)))x+=w||"";else switch(p.type){case"space":continue;case"hr":x+=this.renderer.hr();continue;case"heading":x+=this.renderer.heading(this.parseInline(p.tokens),p.depth,Ys(this.parseInline(p.tokens,this.textRenderer)),this.slugger);continue;case"code":x+=this.renderer.code(p.text,p.lang,p.escaped);continue;case"table":for(c="",l="",i=p.header.length,r=0;r<i;r++)l+=this.renderer.tablecell(this.parseInline(p.header[r].tokens),{header:!0,align:p.align[r]});for(c+=this.renderer.tablerow(l),u="",i=p.rows.length,r=0;r<i;r++){for(s=p.rows[r],l="",a=s.length,o=0;o<a;o++)l+=this.renderer.tablecell(this.parseInline(s[o].tokens),{header:!1,align:p.align[o]});u+=this.renderer.tablerow(l)}x+=this.renderer.table(c,u);continue;case"blockquote":u=this.parse(p.tokens),x+=this.renderer.blockquote(u);continue;case"list":for(d=p.ordered,f=p.start,h=p.loose,i=p.items.length,u="",r=0;r<i;r++)g=p.items[r],y=g.checked,v=g.task,m="",g.task&&(b=this.renderer.checkbox(y),h?g.tokens.length>0&&"paragraph"===g.tokens[0].type?(g.tokens[0].text=b+" "+g.tokens[0].text,g.tokens[0].tokens&&g.tokens[0].tokens.length>0&&"text"===g.tokens[0].tokens[0].type&&(g.tokens[0].tokens[0].text=b+" "+g.tokens[0].tokens[0].text)):g.tokens.unshift({type:"text",text:b}):m+=b),m+=this.parse(g.tokens,h),u+=this.renderer.listitem(m,v,y);x+=this.renderer.list(u,d,f);continue;case"html":x+=this.renderer.html(p.text);continue;case"paragraph":x+=this.renderer.paragraph(this.parseInline(p.tokens));continue;case"text":for(u=p.tokens?this.parseInline(p.tokens):p.text;n+1<k&&"text"===e[n+1].type;)p=e[++n],u+="\n"+(p.tokens?this.parseInline(p.tokens):p.text);x+=t?this.renderer.paragraph(u):u;continue;default:{const e='Token with "'+p.type+'" type was not found.';if(this.options.silent)return void console.error(e);throw new Error(e)}}return x}parseInline(e,t){t=t||this.renderer;let n,r,o,i="";const a=e.length;for(n=0;n<a;n++)if(r=e[n],this.options.extensions&&this.options.extensions.renderers&&this.options.extensions.renderers[r.type]&&(o=this.options.extensions.renderers[r.type].call({parser:this},r),!1!==o||!["escape","html","link","image","strong","em","codespan","br","del","text"].includes(r.type)))i+=o||"";else switch(r.type){case"escape":case"text":i+=t.text(r.text);break;case"html":i+=t.html(r.text);break;case"link":i+=t.link(r.href,r.title,this.parseInline(r.tokens,t));break;case"image":i+=t.image(r.href,r.title,r.text);break;case"strong":i+=t.strong(this.parseInline(r.tokens,t));break;case"em":i+=t.em(this.parseInline(r.tokens,t));break;case"codespan":i+=t.codespan(r.text);break;case"br":i+=t.br();break;case"del":i+=t.del(this.parseInline(r.tokens,t));break;default:{const e='Token with "'+r.type+'" type was not found.';if(this.options.silent)return void console.error(e);throw new Error(e)}}return i}}function wl(e,t,n){if(null==e)throw new Error("marked(): input parameter is undefined or null");if("string"!=typeof e)throw new Error("marked(): input parameter is of type "+Object.prototype.toString.call(e)+", string expected");if("function"==typeof t&&(n=t,t=null),sl(t=ol({},wl.defaults,t||{})),n){const r=t.highlight;let o;try{o=ml.lex(e,t)}catch(e){return n(e)}const i=function(e){let i;if(!e)try{t.walkTokens&&wl.walkTokens(o,t.walkTokens),i=bl.parse(o,t)}catch(t){e=t}return t.highlight=r,e?n(e):n(null,i)};if(!r||r.length<3)return i();if(delete t.highlight,!o.length)return i();let a=0;return wl.walkTokens(o,(function(e){"code"===e.type&&(a++,setTimeout((()=>{r(e.text,e.lang,(function(t,n){if(t)return i(t);null!=n&&n!==e.text&&(e.text=n,e.escaped=!0),a--,0===a&&i()}))}),0))})),void(0===a&&i())}try{const n=ml.lex(e,t);return t.walkTokens&&wl.walkTokens(n,t.walkTokens),bl.parse(n,t)}catch(e){if(e.message+="\nPlease report this to https://github.com/markedjs/marked.",t.silent)return"<p>An error occurred:</p><pre>"+Ws(e.message+"",!0)+"</pre>";throw e}}wl.options=wl.setOptions=function(e){var t;return ol(wl.defaults,e),t=wl.defaults,Ms=t,wl},wl.getDefaults=function(){return{baseUrl:null,breaks:!1,extensions:null,gfm:!0,headerIds:!0,headerPrefix:"",highlight:null,langPrefix:"language-",mangle:!0,pedantic:!1,renderer:null,sanitize:!1,sanitizer:null,silent:!1,smartLists:!1,smartypants:!1,tokenizer:null,walkTokens:null,xhtml:!1}},wl.defaults=Ms,wl.use=function(...e){const t=ol({},...e),n=wl.defaults.extensions||{renderers:{},childTokens:{}};let r;e.forEach((e=>{if(e.extensions&&(r=!0,e.extensions.forEach((e=>{if(!e.name)throw new Error("extension name required");if(e.renderer){const t=n.renderers?n.renderers[e.name]:null;n.renderers[e.name]=t?function(...n){let r=e.renderer.apply(this,n);return!1===r&&(r=t.apply(this,n)),r}:e.renderer}if(e.tokenizer){if(!e.level||"block"!==e.level&&"inline"!==e.level)throw new Error("extension level must be 'block' or 'inline'");n[e.level]?n[e.level].unshift(e.tokenizer):n[e.level]=[e.tokenizer],e.start&&("block"===e.level?n.startBlock?n.startBlock.push(e.start):n.startBlock=[e.start]:"inline"===e.level&&(n.startInline?n.startInline.push(e.start):n.startInline=[e.start]))}e.childTokens&&(n.childTokens[e.name]=e.childTokens)}))),e.renderer){const n=wl.defaults.renderer||new gl;for(const t in e.renderer){const r=n[t];n[t]=(...o)=>{let i=e.renderer[t].apply(n,o);return!1===i&&(i=r.apply(n,o)),i}}t.renderer=n}if(e.tokenizer){const n=wl.defaults.tokenizer||new ul;for(const t in e.tokenizer){const r=n[t];n[t]=(...o)=>{let i=e.tokenizer[t].apply(n,o);return!1===i&&(i=r.apply(n,o)),i}}t.tokenizer=n}if(e.walkTokens){const n=wl.defaults.walkTokens;t.walkTokens=function(t){e.walkTokens.call(this,t),n&&n.call(this,t)}}r&&(t.extensions=n),wl.setOptions(t)}))},wl.walkTokens=function(e,t){for(const n of e)switch(t.call(wl,n),n.type){case"table":for(const e of n.header)wl.walkTokens(e.tokens,t);for(const e of n.rows)for(const n of e)wl.walkTokens(n.tokens,t);break;case"list":wl.walkTokens(n.items,t);break;default:wl.defaults.extensions&&wl.defaults.extensions.childTokens&&wl.defaults.extensions.childTokens[n.type]?wl.defaults.extensions.childTokens[n.type].forEach((function(e){wl.walkTokens(n[e],t)})):n.tokens&&wl.walkTokens(n.tokens,t)}},wl.parseInline=function(e,t){if(null==e)throw new Error("marked.parseInline(): input parameter is undefined or null");if("string"!=typeof e)throw new Error("marked.parseInline(): input parameter is of type "+Object.prototype.toString.call(e)+", string expected");sl(t=ol({},wl.defaults,t||{}));try{const n=ml.lexInline(e,t);return t.walkTokens&&wl.walkTokens(n,t.walkTokens),bl.parseInline(n,t)}catch(e){if(e.message+="\nPlease report this to https://github.com/markedjs/marked.",t.silent)return"<p>An error occurred:</p><pre>"+Ws(e.message+"",!0)+"</pre>";throw e}},wl.Parser=bl,wl.parser=bl.parse,wl.Renderer=gl,wl.TextRenderer=yl,wl.Lexer=ml,wl.lexer=ml.lex,wl.Tokenizer=ul,wl.Slugger=vl,wl.parse=wl,wl.options,wl.setOptions,wl.use,wl.walkTokens,wl.parseInline,bl.parse,ml.lex;var xl=Object.defineProperty,kl=Object.defineProperties,_l=Object.getOwnPropertyDescriptors,Ol=Object.getOwnPropertySymbols,Sl=Object.prototype.hasOwnProperty,El=Object.prototype.propertyIsEnumerable,Pl=(e,t,n)=>t in e?xl(e,t,{enumerable:!0,configurable:!0,writable:!0,value:n}):e[t]=n,Al=(e,t)=>{for(var n in t||(t={}))Sl.call(t,n)&&Pl(e,n,t[n]);if(Ol)for(var n of Ol(t))El.call(t,n)&&Pl(e,n,t[n]);return e},$l=(e,t)=>kl(e,_l(t));const Cl=new wl.Renderer;wl.setOptions({renderer:Cl,highlight:(e,t)=>vs(e,t)});const Rl="(?:^ {0,3}\x3c!-- ReDoc-Inject:\\s+?<({component}).*?/?>\\s+?--\x3e\\s*$|(?:^ {0,3}<({component})([\\s\\S]*?)>([\\s\\S]*?)</\\2>|^ {0,3}<({component})([\\s\\S]*?)(?:/>|\\n{2,})))";class jl{constructor(e,t){this.options=e,this.parentId=t,this.headings=[],this.headingRule=(e,t,n,r)=>(1===t?this.currentTopHeading=this.saveHeading(e,t):2===t&&this.saveHeading(e,t,this.currentTopHeading&&this.currentTopHeading.items,this.currentTopHeading&&this.currentTopHeading.id),this.originalHeadingRule(e,t,n,r)),this.parentId=t,this.parser=new wl.Parser,this.headingEnhanceRenderer=new wl.Renderer,this.originalHeadingRule=this.headingEnhanceRenderer.heading.bind(this.headingEnhanceRenderer),this.headingEnhanceRenderer.heading=this.headingRule}static containsComponent(e,t){return new RegExp(Rl.replace(/{component}/g,t),"gmi").test(e)}static getTextBeforeHading(e,t){const n=e.search(new RegExp(`^##?\\s+${t}`,"m"));return n>-1?e.substring(0,n):e}saveHeading(e,t,n=this.headings,r){e=e.replace(/&#(\d+);/g,((e,t)=>String.fromCharCode(parseInt(t,10)))).replace(/&/g,"&").replace(/"/g,'"');const o={id:r?`${r}/${no(e)}`:`${this.parentId||"section"}/${no(e)}`,name:e,level:t,items:[]};return n.push(o),o}flattenHeadings(e){if(void 0===e)return[];const t=[];for(const n of e)t.push(n),t.push(...this.flattenHeadings(n.items));return t}attachHeadingsDescriptions(e){const t=e=>new RegExp(`##?\\s+${e.name.replace(/[-\/\\^$*+?.()|[\]{}]/g,"\\$&")}s*(\n|\r\n|$|s*)`),n=this.flattenHeadings(this.headings);if(n.length<1)return;let r=n[0],o=t(r),i=e.search(o);for(let a=1;a<n.length;a++){const s=n[a],l=t(s),c=e.substr(i+1).search(l)+i+1;r.description=e.substring(i,c).replace(o,"").trim(),r=s,o=l,i=c}r.description=e.substring(i).replace(o,"").trim()}renderMd(e,t=!1){const n=t?{renderer:this.headingEnhanceRenderer}:void 0;return wl(e.toString(),n)}extractHeadings(e){this.renderMd(e,!0),this.attachHeadingsDescriptions(e);const t=this.headings;return this.headings=[],t}renderMdWithComponents(e){const t=this.options&&this.options.allowedMdComponents;if(!t||0===Object.keys(t).length)return[this.renderMd(e)];const n=Object.keys(t).join("|"),r=new RegExp(Rl.replace(/{component}/g,n),"mig"),o=[],i=[];let a=r.exec(e),s=0;for(;a;){o.push(e.substring(s,a.index)),s=r.lastIndex;const n=t[a[1]||a[2]||a[5]],l=a[3]||a[6],c=a[4];n&&i.push({component:n.component,propsSelector:n.propsSelector,props:$l(Al(Al({},Tl(l)),n.props),{children:c})}),a=r.exec(e)}o.push(e.substring(s));const l=[];for(let e=0;e<o.length;e++){const t=o[e];t&&l.push(this.renderMd(t)),i[e]&&l.push(i[e])}return l}}function Tl(e){if(!e)return{};const t=/([\w-]+)\s*=\s*(?:{([^}]+?)}|"([^"]+?)")/gim,n={};let r;for(;null!==(r=t.exec(e));)if(r[3])n[r[1]]=r[3];else if(r[2]){let e;try{e=JSON.parse(r[2])}catch(e){}n[r[1]]=e}return n}class Il{constructor(e,t=new xo({})){this.parser=e,this.options=t,Object.assign(this,e.spec.info),this.description=e.spec.info.description||"",this.summary=e.spec.info.summary||"";const n=this.description.search(/^\s*##?\s+/m);n>-1&&(this.description=this.description.substring(0,n)),this.downloadLink=this.getDownloadLink(),this.downloadFileName=this.getDownloadFileName()}getDownloadLink(){if(this.options.downloadDefinitionUrl)return this.options.downloadDefinitionUrl;if(this.parser.specUrl)return this.parser.specUrl;if(qr&&window.Blob&&window.URL&&window.URL.createObjectURL){const e=new Blob([JSON.stringify(this.parser.spec,null,2)],{type:"application/json"});return window.URL.createObjectURL(e)}}getDownloadFileName(){return this.parser.specUrl||this.options.downloadDefinitionUrl?this.options.downloadFileName:this.options.downloadFileName||"openapi.json"}}var Nl=Object.defineProperty,Dl=Object.defineProperties,Ll=Object.getOwnPropertyDescriptors,Ml=Object.getOwnPropertySymbols,Fl=Object.prototype.hasOwnProperty,zl=Object.prototype.propertyIsEnumerable,Ul=(e,t,n)=>t in e?Nl(e,t,{enumerable:!0,configurable:!0,writable:!0,value:n}):e[t]=n;class Vl{constructor(e,t){const n=t.spec.components&&t.spec.components.securitySchemes||{};this.schemes=Object.keys(e||{}).map((r=>{const{resolved:o}=t.deref(n[r]),i=e[r]||[];if(!o)return void console.warn(`Non existing security scheme referenced: ${r}. Skipping`);const a=o["x-displayName"]||r;return((e,t)=>Dl(e,Ll(t)))(((e,t)=>{for(var n in t||(t={}))Fl.call(t,n)&&Ul(e,n,t[n]);if(Ml)for(var n of Ml(t))zl.call(t,n)&&Ul(e,n,t[n]);return e})({},o),{id:r,sectionId:r,displayName:a,scopes:i})})).filter((e=>void 0!==e))}}var Bl=Object.defineProperty,ql=Object.defineProperties,Wl=Object.getOwnPropertyDescriptor,Hl=Object.getOwnPropertyDescriptors,Yl=Object.getOwnPropertySymbols,Kl=Object.prototype.hasOwnProperty,Gl=Object.prototype.propertyIsEnumerable,Ql=(e,t,n)=>t in e?Bl(e,t,{enumerable:!0,configurable:!0,writable:!0,value:n}):e[t]=n,Xl=(e,t)=>{for(var n in t||(t={}))Kl.call(t,n)&&Ql(e,n,t[n]);if(Yl)for(var n of Yl(t))Gl.call(t,n)&&Ql(e,n,t[n]);return e},Jl=(e,t)=>ql(e,Hl(t)),Zl=(e,t,n,r)=>{for(var o,i=r>1?void 0:r?Wl(t,n):t,a=e.length-1;a>=0;a--)(o=e[a])&&(i=(r?o(t,n,i):o(i))||i);return r&&i&&Bl(t,n,i),i};class ec{constructor(e,t,n,r,o){this.expanded=!1,this.operations=[],tn(this),this.name=t;const{resolved:i}=e.deref(n);for(const n of Object.keys(i)){const a=i[n],s=Object.keys(a).filter(Xa);for(const i of s){const s=a[i],l=new _u(e,Jl(Xl({},s),{pathName:n,pointer:Da.compile([r,t,n,i]),httpVerb:i,pathParameters:a.parameters||[],pathServers:a.servers}),void 0,o,!0);this.operations.push(l)}}}toggle(){this.expanded=!this.expanded}}Zl([Ae],ec.prototype,"expanded",2),Zl([Pt],ec.prototype,"toggle",1);var tc=Object.defineProperty,nc=Object.defineProperties,rc=Object.getOwnPropertyDescriptors,oc=Object.getOwnPropertySymbols,ic=Object.prototype.hasOwnProperty,ac=Object.prototype.propertyIsEnumerable,sc=(e,t,n)=>t in e?tc(e,t,{enumerable:!0,configurable:!0,writable:!0,value:n}):e[t]=n,lc=(e,t)=>{for(var n in t||(t={}))ic.call(t,n)&&sc(e,n,t[n]);if(oc)for(var n of oc(t))ac.call(t,n)&&sc(e,n,t[n]);return e},cc=(e,t)=>nc(e,rc(t)),uc=(e,t)=>{var n={};for(var r in e)ic.call(e,r)&&t.indexOf(r)<0&&(n[r]=e[r]);if(null!=e&&oc)for(var r of oc(e))t.indexOf(r)<0&&ac.call(e,r)&&(n[r]=e[r]);return n};function pc(e,t){return t&&e[e.length-1]!==t?[...e,t]:e}function dc(e,t){return t?e.concat(t):e}class fc{constructor(e,t,n=new xo({})){this.options=n,this.allowMergeRefs=!1,this.byRef=e=>{let t;if(this.spec){"#"!==e.charAt(0)&&(e="#"+e),e=decodeURIComponent(e);try{t=Da.get(this.spec,e)}catch(e){}return t||{}}},this.validate(e),this.spec=e,this.allowMergeRefs=e.openapi.startsWith("3.1");const r=qr?window.location.href:"";"string"==typeof t&&(this.specUrl=r?new URL(t,r).href:t)}validate(e){if(void 0===e.openapi)throw new Error("Document must be valid OpenAPI 3.0.0 definition")}isRef(e){return!!e&&void 0!==e.$ref&&null!==e.$ref}deref(e,t=[],n=!1){const r=null==e?void 0:e["x-refsStack"];if(t=dc(t,r),this.isRef(e)){const r=ls(e.$ref);if(r&&this.options.ignoreNamedSchemas.has(r))return{resolved:{type:"object",title:r},refsStack:t};let o=this.byRef(e.$ref);if(!o)throw new Error(`Failed to resolve $ref "${e.$ref}"`);let i=t;if(t.includes(e.$ref)||t.length>999)o=Object.assign({},o,{"x-circular-ref":!0});else if(this.isRef(o)){const e=this.deref(o,t,n);i=e.refsStack,o=e.resolved}return i=pc(t,e.$ref),o=this.allowMergeRefs?this.mergeRefs(e,o,n):o,{resolved:o,refsStack:i}}return{resolved:e,refsStack:dc(t,r)}}mergeRefs(e,t,n){const r=e,{$ref:o}=r,i=uc(r,["$ref"]),a=Object.keys(i);if(0===a.length)return t;if(n&&a.some((e=>!["description","title","externalDocs","x-refsStack","x-parentRefs","readOnly","writeOnly"].includes(e)))){const e=i,{description:n,title:r,readOnly:o,writeOnly:a}=e;return{allOf:[{description:n,title:r,readOnly:o,writeOnly:a},t,uc(e,["description","title","readOnly","writeOnly"])]}}return lc(lc({},t),i)}mergeAllOf(e,t,n){var r;if(e["x-circular-ref"])return e;if(void 0===(e=this.hoistOneOfs(e,n)).allOf)return e;let o=cc(lc({},e),{"x-parentRefs":[],allOf:void 0,title:e.title||ls(t)});void 0!==o.properties&&"object"==typeof o.properties&&(o.properties=lc({},o.properties)),void 0!==o.items&&"object"==typeof o.items&&(o.items=lc({},o.items));const i=function(e,t){const n=new Set;return e.filter((e=>{const t=e.$ref;return!t||t&&!n.has(t)&&n.add(t)}))}(e.allOf.map((e=>{var t;const{resolved:r,refsStack:i}=this.deref(e,n,!0),a=e.$ref||void 0,s=this.mergeAllOf(r,a,i);if(!s["x-circular-ref"]||!s.allOf)return a&&(null==(t=o["x-parentRefs"])||t.push(...s["x-parentRefs"]||[],a)),{$ref:a,refsStack:pc(i,a),schema:s}})).filter((e=>void 0!==e)));for(const{schema:e,refsStack:n}of i){const i=e,{type:a,enum:s,properties:l,items:c,required:u,title:p,description:d,readOnly:f,writeOnly:h,oneOf:m,anyOf:g,"x-circular-ref":y}=i,v=uc(i,["type","enum","properties","items","required","title","description","readOnly","writeOnly","oneOf","anyOf","x-circular-ref"]);if(o.type!==a&&void 0!==o.type&&void 0!==a&&console.warn(`Incompatible types in allOf at "${t}": "${o.type}" and "${a}"`),void 0!==a&&(Array.isArray(a)&&Array.isArray(o.type)?o.type=[...a,...o.type]:o.type=a),void 0!==s&&(Array.isArray(s)&&Array.isArray(o.enum)?o.enum=Array.from(new Set([...s,...o.enum])):o.enum=s),void 0!==l&&"object"==typeof l){o.properties=o.properties||{};for(const e in l){const i=dc(n,null==(r=l[e])?void 0:r["x-refsStack"]);if(o.properties[e]){if(!y){const n=this.mergeAllOf({allOf:[o.properties[e],cc(lc({},l[e]),{"x-refsStack":i})],"x-refsStack":i},t+"/properties/"+e,i);o.properties[e]=n}}else o.properties[e]=cc(lc({},l[e]),{"x-refsStack":i})}}if(void 0!==c&&!y){const r="boolean"==typeof o.items?{}:Object.assign({},o.items),i="boolean"==typeof e.items?{}:Object.assign({},e.items);o.items=this.mergeAllOf({allOf:[r,i]},t+"/items",n)}void 0!==m&&(o.oneOf=m),void 0!==g&&(o.anyOf=g),void 0!==u&&(o.required=[...o.required||[],...u]),o=lc(cc(lc({},o),{title:o.title||p,description:o.description||d,readOnly:void 0!==o.readOnly?o.readOnly:f,writeOnly:void 0!==o.writeOnly?o.writeOnly:h,"x-circular-ref":o["x-circular-ref"]||y}),v)}return o}findDerived(e){const t={},n=this.spec.components&&this.spec.components.schemas||{};for(const r in n){const{resolved:o}=this.deref(n[r]);void 0!==o.allOf&&o.allOf.find((t=>void 0!==t.$ref&&e.indexOf(t.$ref)>-1))&&(t["#/components/schemas/"+r]=[o["x-discriminator-value"]||r])}return t}hoistOneOfs(e,t){if(void 0===e.allOf)return e;const n=e.allOf;for(let e=0;e<n.length;e++){const r=n[e];if(Array.isArray(r.oneOf)){const o=n.slice(0,e),i=n.slice(e+1);return{oneOf:r.oneOf.map((e=>({allOf:[...o,e,...i],"x-refsStack":t})))}}}return e}}var hc=Object.defineProperty,mc=Object.defineProperties,gc=Object.getOwnPropertyDescriptor,yc=Object.getOwnPropertyDescriptors,vc=Object.getOwnPropertySymbols,bc=Object.prototype.hasOwnProperty,wc=Object.prototype.propertyIsEnumerable,xc=(e,t,n)=>t in e?hc(e,t,{enumerable:!0,configurable:!0,writable:!0,value:n}):e[t]=n,kc=(e,t)=>{for(var n in t||(t={}))bc.call(t,n)&&xc(e,n,t[n]);if(vc)for(var n of vc(t))wc.call(t,n)&&xc(e,n,t[n]);return e},_c=(e,t)=>mc(e,yc(t)),Oc=(e,t,n,r)=>{for(var o,i=r>1?void 0:r?gc(t,n):t,a=e.length-1;a>=0;a--)(o=e[a])&&(i=(r?o(t,n,i):o(i))||i);return r&&i&&hc(t,n,i),i};const Sc=class{constructor(e,t,n,r,o=!1,i=[]){this.options=r,this.refsStack=i,this.typePrefix="",this.isCircular=!1,this.activeOneOf=0,tn(this),this.pointer=t.$ref||n||"";const{resolved:a,refsStack:s}=e.deref(t,i,!0);this.refsStack=pc(s,this.pointer),this.rawSchema=a,this.schema=e.mergeAllOf(this.rawSchema,this.pointer,this.refsStack),this.init(e,o),r.showExtensions&&(this.extensions=gs(this.schema,r.showExtensions))}activateOneOf(e){this.activeOneOf=e}hasType(e){return this.type===e||io(this.type)&&this.type.includes(e)}init(e,t){var n,r,o,i,a,s,l,c;const u=this.schema;if(this.isCircular=!!u["x-circular-ref"],this.title=u.title||ss(this.pointer)&&Da.baseName(this.pointer)||"",this.description=u.description||"",this.type=u.type||function(e){if(void 0!==e.type&&!io(e.type))return e.type;const t=Object.keys(Ja);for(const n of t){const t=Ja[n];if(void 0!==e[n])return t}return"any"}(u),this.format=u.format,this.enum=u.enum||[],this.example=u.example,this.examples=u.examples,this.deprecated=!!u.deprecated,this.pattern=u.pattern,this.externalDocs=u.externalDocs,this.constraints=us(u),this.displayFormat=this.format,this.isPrimitive=Za(u,this.type),this.default=u.default,this.readOnly=!!u.readOnly,this.writeOnly=!!u.writeOnly,this.const=u.const||"",this.contentEncoding=u.contentEncoding,this.contentMediaType=u.contentMediaType,this.minItems=u.minItems,this.maxItems=u.maxItems,(u.nullable||u["x-nullable"])&&(io(this.type)&&!this.type.some((e=>null===e||"null"===e))?this.type=[...this.type,"null"]:io(this.type)||null===this.type&&"null"===this.type||(this.type=[this.type,"null"])),this.displayType=io(this.type)?this.type.map((e=>null===e?"null":e)).join(" or "):this.type,!this.isCircular)if(u.if&&u.then||u.if&&u.else)this.initConditionalOperators(u,e);else if(t||void 0===Ac(u)){if(t&&io(u.oneOf)&&u.oneOf.find((e=>e.$ref===this.pointer))&&delete u.oneOf,void 0!==u.oneOf)return this.initOneOf(u.oneOf,e),this.oneOfType="One of",void(void 0!==u.anyOf&&console.warn(`oneOf and anyOf are not supported on the same level. Skipping anyOf at ${this.pointer}`));if(void 0!==u.anyOf)return this.initOneOf(u.anyOf,e),void(this.oneOfType="Any of");if(this.hasType("object"))this.fields=Pc(e,u,this.pointer,this.options,this.refsStack);else if(this.hasType("array")&&(io(u.items)||io(u.prefixItems)?this.fields=Pc(e,u,this.pointer,this.options,this.refsStack):u.items&&(this.items=new Sc(e,u.items,this.pointer+"/items",this.options,!1,this.refsStack)),this.displayType=u.prefixItems||io(u.items)?"items":((null==(n=this.items)?void 0:n.displayType)||this.displayType).split(" or ").map((e=>e.replace(/^(string|object|number|integer|array|boolean)s?( ?.*)/,"$1s$2"))).join(" or "),this.displayFormat=(null==(r=this.items)?void 0:r.format)||"",this.typePrefix=(null==(o=this.items)?void 0:o.typePrefix)||""+lo("arrayOf"),this.title=this.title||(null==(i=this.items)?void 0:i.title)||"",this.isPrimitive=void 0!==(null==(a=this.items)?void 0:a.isPrimitive)?null==(s=this.items)?void 0:s.isPrimitive:this.isPrimitive,void 0===this.example&&void 0!==(null==(l=this.items)?void 0:l.example)&&(this.example=[this.items.example]),(null==(c=this.items)?void 0:c.isPrimitive)&&(this.enum=this.items.enum),io(this.type))){const e=this.type.filter((e=>"array"!==e));e.length&&(this.displayType+=` or ${e.join(" or ")}`)}this.enum.length&&this.options.sortEnumValuesAlphabetically&&this.enum.sort()}else this.initDiscriminator(u,e)}initOneOf(e,t){if(this.oneOf=e.map(((e,n)=>{const{resolved:r,refsStack:o}=t.deref(e,this.refsStack,!0),i=t.mergeAllOf(r,this.pointer+"/oneOf/"+n,o),a=ss(e.$ref)&&!i.title?Da.baseName(e.$ref):`${i.title||""}${i.const&&JSON.stringify(i.const)||""}`;return new Sc(t,_c(kc({},i),{title:a,allOf:[_c(kc({},this.schema),{oneOf:void 0,anyOf:void 0})],discriminator:r.allOf?void 0:i.discriminator}),e.$ref||this.pointer+"/oneOf/"+n,this.options,!1,o)})),this.options.simpleOneOfTypeLabel){const e=function(e){const t=new Set;return function e(n){for(const r of n.oneOf||[])r.oneOf?e(r):r.type&&t.add(r.type)}(e),Array.from(t.values())}(this);this.displayType=e.join(" or ")}else this.displayType=this.oneOf.map((e=>{let t=e.typePrefix+(e.title?`${e.title} (${e.displayType})`:e.displayType);return t.indexOf(" or ")>-1&&(t=`(${t})`),t})).join(" or ")}initDiscriminator(e,t){const n=Ac(e);this.discriminatorProp=n.propertyName;const r=t.findDerived([...this.schema["x-parentRefs"]||[],this.pointer]);if(e.oneOf)for(const t of e.oneOf){if(void 0===t.$ref)continue;const e=Da.baseName(t.$ref);r[t.$ref]=e}const o=n.mapping||{};let i=n["x-explicitMappingOnly"]||!1;0===Object.keys(o).length&&(i=!1);const a={};for(const e in o){const t=o[e];io(a[t])?a[t].push(e):a[t]=[e]}const s=kc(i?{}:kc({},r),a);let l=[];for(const e of Object.keys(s)){const t=s[e];if(io(t))for(const n of t)l.push({$ref:e,name:n});else l.push({$ref:e,name:t})}const c=Object.keys(o);0!==c.length&&(l=l.sort(((e,t)=>{const n=c.indexOf(e.name),r=c.indexOf(t.name);return n<0&&r<0?e.name.localeCompare(t.name):n<0?1:r<0?-1:n-r}))),this.oneOf=l.map((({$ref:e,name:n})=>{const r=new Sc(t,{$ref:e},e,this.options,!0,this.refsStack.slice(0,-1));return r.title=n,r}))}initConditionalOperators(e,t){const n=e,{if:r,else:o={},then:i={}}=n,a=((e,t)=>{var n={};for(var r in e)bc.call(e,r)&&t.indexOf(r)<0&&(n[r]=e[r]);if(null!=e&&vc)for(var r of vc(e))t.indexOf(r)<0&&wc.call(e,r)&&(n[r]=e[r]);return n})(n,["if","else","then"]),s=[{allOf:[a,i,r],title:r&&r["x-displayName"]||(null==r?void 0:r.title)||"case 1"},{allOf:[a,o],title:o&&o["x-displayName"]||(null==o?void 0:o.title)||"case 2"}];this.oneOf=s.map(((e,n)=>new Sc(t,kc({},e),this.pointer+"/oneOf/"+n,this.options,!1,this.refsStack))),this.oneOfType="One of"}};let Ec=Sc;function Pc(e,t,n,r,o){const i=t.properties||t.prefixItems||t.items||{},a=t.patternProperties||{},s=t.additionalProperties||t.unevaluatedProperties,l=t.prefixItems?t.items:t.additionalItems,c=t.default;let u=Object.keys(i||[]).map((a=>{let s=i[a];s||(console.warn(`Field "${a}" is invalid, skipping.\n Field must be an object but got ${typeof s} at "${n}"`),s={});const l=void 0!==t.required&&t.required.indexOf(a)>-1;return new Nc(e,{name:t.properties?a:`[${a}]`,required:l,schema:_c(kc({},s),{default:void 0===s.default&&c?c[a]:s.default})},n+"/properties/"+a,r,o)}));return r.sortPropsAlphabetically&&(u=ds(u,"name")),r.requiredPropsFirst&&(u=ps(u,r.sortPropsAlphabetically?void 0:t.required)),u.push(...Object.keys(a).map((t=>{let i=a[t];return i||(console.warn(`Field "${t}" is invalid, skipping.\n Field must be an object but got ${typeof i} at "${n}"`),i={}),new Nc(e,{name:t,required:!1,schema:i,kind:"patternProperties"},`${n}/patternProperties/${t}`,r,o)}))),"object"!=typeof s&&!0!==s||u.push(new Nc(e,{name:("object"==typeof s&&s["x-additionalPropertiesName"]||"property name").concat("*"),required:!1,schema:!0===s?{}:s,kind:"additionalProperties"},n+"/additionalProperties",r,o)),u.push(...function({parser:e,schema:t=!1,fieldsCount:n,$ref:r,options:o,refsStack:i}){return ao(t)?t?[new Nc(e,{name:`[${n}...]`,schema:{}},`${r}/additionalItems`,o,i)]:[]:io(t)?[...t.map(((t,a)=>new Nc(e,{name:`[${n+a}]`,schema:t},`${r}/additionalItems`,o,i)))]:eo(t)?[new Nc(e,{name:`[${n}...]`,schema:t},`${r}/additionalItems`,o,i)]:[]}({parser:e,schema:l,fieldsCount:u.length,$ref:n,options:r,refsStack:o})),u}function Ac(e){return e.discriminator||e["x-discriminator"]}Oc([Ae],Ec.prototype,"activeOneOf",2),Oc([Pt],Ec.prototype,"activateOneOf",1);const $c={};class Cc{constructor(e,t,n,r){this.mime=n;const{resolved:o}=e.deref(t);this.value=o.value,this.summary=o.summary,this.description=o.description,o.externalValue&&(this.externalValueUrl=new URL(o.externalValue,e.specUrl).href),"application/x-www-form-urlencoded"===n&&this.value&&"object"==typeof this.value&&(this.value=function(e,t={}){if(io(e))throw new Error("Payload must have fields: "+e.toString());return Object.keys(e).map((n=>{const r=e[n],{style:o="form",explode:i=!0}=t[n]||{};switch(o){case"form":return rs(n,i,r);case"spaceDelimited":return ts(r,n,"%20");case"pipeDelimited":return ts(r,n,"|");case"deepObject":return ns(r,n);default:return console.warn("Incorrect or unsupported encoding style: "+o),""}})).join("&")}(this.value,r))}getExternalValue(e){return this.externalValueUrl?(this.externalValueUrl in $c||($c[this.externalValueUrl]=fetch(this.externalValueUrl).then((t=>t.text().then((n=>{if(!t.ok)return Promise.reject(new Error(n));if(!es(e))return n;try{return JSON.parse(n)}catch(e){return n}}))))),$c[this.externalValueUrl]):Promise.resolve(void 0)}}var Rc=Object.defineProperty,jc=Object.getOwnPropertyDescriptor,Tc=(e,t,n,r)=>{for(var o,i=r>1?void 0:r?jc(t,n):t,a=e.length-1;a>=0;a--)(o=e[a])&&(i=(r?o(t,n,i):o(i))||i);return r&&i&&Rc(t,n,i),i};const Ic={path:{style:"simple",explode:!1},query:{style:"form",explode:!0},header:{style:"simple",explode:!1},cookie:{style:"form",explode:!0}};class Nc{constructor(e,t,n,r,o){var i,a,s,l,c;this.expanded=void 0,tn(this);const{resolved:u}=e.deref(t);this.kind=t.kind||"field",this.name=t.name||u.name,this.in=u.in,this.required=!!u.required;let p=u.schema,d="";if(!p&&u.in&&u.content&&(d=Object.keys(u.content)[0],p=u.content[d]&&u.content[d].schema),this.schema=new Ec(e,p||{},n,r,!1,o),this.description=void 0===u.description?this.schema.description||"":u.description,this.example=u.example||this.schema.example,void 0!==u.examples||void 0!==this.schema.examples){const t=u.examples||this.schema.examples;this.examples=io(t)?t:Qr(t,((t,n)=>new Cc(e,t,n,u.encoding)))}d?this.serializationMime=d:u.style?this.style=u.style:this.in&&(this.style=null!=(a=null==(i=Ic[this.in])?void 0:i.style)?a:"form"),void 0===u.explode&&this.in?this.explode=null==(l=null==(s=Ic[this.in])?void 0:s.explode)||l:this.explode=!!u.explode,this.deprecated=void 0===u.deprecated?!!this.schema.deprecated:u.deprecated,r.showExtensions&&(this.extensions=gs(u,r.showExtensions)),this.const=(null==(c=this.schema)?void 0:c.const)||(null==u?void 0:u.const)||""}toggle(){this.expanded=!this.expanded}collapse(){this.expanded=!1}expand(){this.expanded=!0}}function Dc(e){return e<10?"0"+e:e}function Lc(e,t){return t>e.length?e.repeat(Math.trunc(t/e.length)+1).substring(0,t):e}function Mc(...e){const t=e=>e&&"object"==typeof e;return e.reduce(((e,n)=>(Object.keys(n||{}).forEach((r=>{const o=e[r],i=n[r];t(o)&&t(i)?e[r]=Mc(o,i):e[r]=i})),e)),Array.isArray(e[e.length-1])?[]:{})}function Fc(e){return{value:"object"===e?{}:"array"===e?[]:void 0}}function zc(e,t){t&&e.pop()}Tc([Ae],Nc.prototype,"expanded",2),Tc([Pt],Nc.prototype,"toggle",1),Tc([Pt],Nc.prototype,"collapse",1),Tc([Pt],Nc.prototype,"expand",1);const Uc={multipleOf:"number",maximum:"number",exclusiveMaximum:"number",minimum:"number",exclusiveMinimum:"number",maxLength:"string",minLength:"string",pattern:"string",items:"array",maxItems:"array",minItems:"array",uniqueItems:"array",additionalItems:"array",maxProperties:"object",minProperties:"object",required:"object",additionalProperties:"object",properties:"object",patternProperties:"object",dependencies:"object"};function Vc(e){if(void 0!==e.type)return Array.isArray(e.type)?0===e.type.length?null:e.type[0]:e.type;const t=Object.keys(Uc);for(var n=0;n<t.length;n++){let r=t[n],o=Uc[r];if(void 0!==e[r])return o}return null}let Bc={},qc=[];function Wc(e){let t;return void 0!==e.const?t=e.const:void 0!==e.examples&&e.examples.length?t=e.examples[0]:void 0!==e.enum&&e.enum.length?t=e.enum[0]:void 0!==e.default&&(t=e.default),t}function Hc(e){const t=Wc(e);if(void 0!==t)return{value:t,readOnly:e.readOnly,writeOnly:e.writeOnly,type:null}}function Yc(e,t,n,r){if(r){if(qc.includes(e))return Fc(Vc(e));qc.push(e)}if(r&&r.depth>t.maxSampleDepth)return zc(qc,r),Fc(Vc(e));if(e.$ref){if(!n)throw new Error("Your schema contains $ref. You must provide full specification in the third parameter.");let o=decodeURIComponent(e.$ref);o.startsWith("#")&&(o=o.substring(1));const i=Ia().get(n,o);let a;return!0!==Bc[o]?(Bc[o]=!0,a=Yc(i,t,n,r),Bc[o]=!1):a=Fc(Vc(i)),zc(qc,r),a}if(void 0!==e.example)return zc(qc,r),{value:e.example,readOnly:e.readOnly,writeOnly:e.writeOnly,type:e.type};if(void 0!==e.allOf)return zc(qc,r),Hc(e)||function(e,t,n,r,o){let i=Yc(e,n,r);const a=[];for(let e of t){const{type:t,readOnly:s,writeOnly:l,value:c}=Yc({type:i.type,...e},n,r,o);i.type&&t&&t!==i.type&&(console.warn("allOf: schemas with different types can't be merged"),i.type=t),i.type=i.type||t,i.readOnly=i.readOnly||s,i.writeOnly=i.writeOnly||l,null!=c&&a.push(c)}if("object"===i.type)return i.value=Mc(i.value||{},...a.filter((e=>"object"==typeof e))),i;{"array"===i.type&&(n.quiet||console.warn('OpenAPI Sampler: found allOf with "array" type. Result may be incorrect'));const e=a[a.length-1];return i.value=null!=e?e:i.value,i}}({...e,allOf:void 0},e.allOf,t,n,r);if(e.oneOf&&e.oneOf.length)return e.anyOf&&(t.quiet||console.warn("oneOf and anyOf are not supported on the same level. Skipping anyOf")),zc(qc,r),a(e,Object.assign({readOnly:e.readOnly,writeOnly:e.writeOnly},e.oneOf[0]));if(e.anyOf&&e.anyOf.length)return zc(qc,r),a(e,Object.assign({readOnly:e.readOnly,writeOnly:e.writeOnly},e.anyOf[0]));if(e.if&&e.then){zc(qc,r);const{if:o,then:i,...a}=e;return Yc(Mc(a,o,i),t,n,r)}let o=Wc(e),i=null;if(void 0===o){o=null,i=e.type,Array.isArray(i)&&e.type.length>0&&(i=e.type[0]),i||(i=Vc(e));let a=Jc[i];a&&(o=a(e,t,n,r))}return zc(qc,r),{value:o,readOnly:e.readOnly,writeOnly:e.writeOnly,type:i};function a(e,o){const i=Hc(e);if(void 0!==i)return i;const a=Yc({...e,oneOf:void 0,anyOf:void 0},t,n,r),s=Yc(o,t,n,r);if("object"==typeof a.value&&"object"==typeof s.value){const e=Mc(a.value,s.value);return{...s,value:e}}return s}}function Kc(e){let t=0;if("boolean"==typeof e.exclusiveMinimum||"boolean"==typeof e.exclusiveMaximum){if(e.maximum&&e.minimum)return t=e.exclusiveMinimum?Math.floor(e.minimum)+1:e.minimum,(e.exclusiveMaximum&&t>=e.maximum||!e.exclusiveMaximum&&t>e.maximum)&&(t=(e.maximum+e.minimum)/2),t;if(e.minimum)return e.exclusiveMinimum?Math.floor(e.minimum)+1:e.minimum;if(e.maximum)return e.exclusiveMaximum?e.maximum>0?0:Math.floor(e.maximum)-1:e.maximum>0?0:e.maximum}else{if(e.minimum)return e.minimum;e.exclusiveMinimum?(t=Math.floor(e.exclusiveMinimum)+1,t===e.exclusiveMaximum&&(t=(t+Math.floor(e.exclusiveMaximum)-1)/2)):e.exclusiveMaximum?t=Math.floor(e.exclusiveMaximum)-1:e.maximum&&(t=e.maximum)}return t}function Gc({min:e,max:t,omitTime:n,omitDate:r}){let o=function(e,t,n,r){var o=n?"":e.getUTCFullYear()+"-"+Dc(e.getUTCMonth()+1)+"-"+Dc(e.getUTCDate());return t||(o+="T"+Dc(e.getUTCHours())+":"+Dc(e.getUTCMinutes())+":"+Dc(e.getUTCSeconds())+"Z"),o}(new Date("2019-08-24T14:15:22.123Z"),n,r);return o.length<e&&console.warn(`Using minLength = ${e} is incorrect with format "date-time"`),t&&o.length>t&&console.warn(`Using maxLength = ${t} is incorrect with format "date-time"`),o}function Qc(e,t){let n=Lc("string",e);return t&&n.length>t&&(n=n.substring(0,t)),n}const Xc={email:function(){return"user@example.com"},"idn-email":function(){return"пошта@укр.нет"},password:function(e,t){let n="pa$$word";return e>n.length&&(n+="_",n+=Lc("qwerty!@#$%^123456",e-n.length).substring(0,e-n.length)),n},"date-time":function(e,t){return Gc({min:e,max:t,omitTime:!1,omitDate:!1})},date:function(e,t){return Gc({min:e,max:t,omitTime:!0,omitDate:!1})},time:function(e,t){return Gc({min:e,max:t,omitTime:!1,omitDate:!0}).slice(1)},ipv4:function(){return"192.168.0.1"},ipv6:function(){return"2001:0db8:85a3:0000:0000:8a2e:0370:7334"},hostname:function(){return"example.com"},"idn-hostname":function(){return"приклад.укр"},iri:function(){return"http://example.com"},"iri-reference":function(){return"../словник"},uri:function(){return"http://example.com"},"uri-reference":function(){return"../dictionary"},"uri-template":function(){return"http://example.com/{endpoint}"},uuid:function(e,t,n){return r=function(e){var t=0;if(0==e.length)return t;for(var n=0;n<e.length;n++)t=(t<<5)-t+e.charCodeAt(n),t&=t;return t}(n||"id"),o=function(e,t,n,r){return function(){var o=(e|=0)-((t|=0)<<27|t>>>5)|0;return e=t^((n|=0)<<17|n>>>15),t=n+(r|=0)|0,n=r+o|0,((r=e+o|0)>>>0)/4294967296}}(r,r,r,r),"xxxxxxxx-xxxx-4xxx-yxxx-xxxxxxxxxxxx".replace(/[xy]/g,(e=>{var t=16*o()%16|0;return("x"==e?t:3&t|8).toString(16)}));var r,o},default:Qc,"json-pointer":function(){return"/json/pointer"},"relative-json-pointer":function(){return"1/relative/json/pointer"},regex:function(){return"/regex/"}};var Jc={};const Zc={skipReadOnly:!1,maxSampleDepth:15};function eu(e,t,n){let r=Object.assign({},Zc,t);return Bc={},qc=[],Yc(e,r,n).value}function tu(e,t){Jc[e]=t}tu("array",(function(e,t={},n,r){const o=r&&r.depth||1;let i=Math.min(null!=e.maxItems?e.maxItems:1/0,e.minItems||1);const a=e.prefixItems||e.items||e.contains;Array.isArray(a)&&(i=Math.max(i,a.length));let s=[];if(!a)return s;for(let e=0;e<i;e++){let r=(l=e,Array.isArray(a)?a[l]||{}:a||{}),{value:i}=Yc(r,t,n,{depth:o+1});s.push(i)}var l;return s})),tu("boolean",(function(e){return!0})),tu("integer",Kc),tu("number",Kc),tu("object",(function(e,t={},n,r){let o={};const i=r&&r.depth||1;if(e&&"object"==typeof e.properties){let r=(Array.isArray(e.required)?e.required:[]).reduce(((e,t)=>(e[t]=!0,e)),{});Object.keys(e.properties).forEach((a=>{if(t.skipNonRequired&&!r.hasOwnProperty(a))return;const s=Yc(e.properties[a],t,n,{propertyName:a,depth:i+1});t.skipReadOnly&&s.readOnly||t.skipWriteOnly&&s.writeOnly||(o[a]=s.value)}))}if(e&&"object"==typeof e.additionalProperties){const r=e.additionalProperties["x-additionalPropertiesName"]||"property";o[`${String(r)}1`]=Yc(e.additionalProperties,t,n,{depth:i+1}).value,o[`${String(r)}2`]=Yc(e.additionalProperties,t,n,{depth:i+1}).value}return o})),tu("string",(function(e,t,n,r){let o=e.format||"default",i=Xc[o]||Qc,a=r&&r.propertyName;return i(0|e.minLength,e.maxLength,a)}));class nu{constructor(e,t,n,r,o){this.name=t,this.isRequestType=n,this.schema=r.schema&&new Ec(e,r.schema,"",o),this.onlyRequiredInSamples=o.onlyRequiredInSamples,this.generatedPayloadSamplesMaxDepth=o.generatedPayloadSamplesMaxDepth,void 0!==r.examples?this.examples=Qr(r.examples,(n=>new Cc(e,n,t,r.encoding))):void 0!==r.example?this.examples={default:new Cc(e,{value:e.deref(r.example).resolved},t,r.encoding)}:es(t)&&this.generateExample(e,r)}generateExample(e,t){const n={skipReadOnly:this.isRequestType,skipWriteOnly:!this.isRequestType,skipNonRequired:this.isRequestType&&this.onlyRequiredInSamples,maxSampleDepth:this.generatedPayloadSamplesMaxDepth};if(this.schema&&this.schema.oneOf){this.examples={};for(const r of this.schema.oneOf){const o=eu(r.rawSchema,n,e.spec);this.schema.discriminatorProp&&"object"==typeof o&&o&&(o[this.schema.discriminatorProp]=r.title),this.examples[r.title]=new Cc(e,{value:o},this.name,t.encoding)}}else this.schema&&(this.examples={default:new Cc(e,{value:eu(t.schema,n,e.spec)},this.name,t.encoding)})}}var ru=Object.defineProperty,ou=Object.getOwnPropertyDescriptor,iu=(e,t,n,r)=>{for(var o,i=r>1?void 0:r?ou(t,n):t,a=e.length-1;a>=0;a--)(o=e[a])&&(i=(r?o(t,n,i):o(i))||i);return r&&i&&ru(t,n,i),i};class au{constructor(e,t,n,r){this.isRequestType=n,this.activeMimeIdx=0,tn(this),r.unstable_ignoreMimeParameters&&(t=function(e){const t={};return Object.keys(e).forEach((n=>{const r=e[n],o=n.split(";")[0].trim();t[o]?t[o]=Ha(Ha({},t[o]),r):t[o]=r})),t}(t)),this.mediaTypes=Object.keys(t).map((o=>{const i=t[o];return new nu(e,o,n,i,r)}))}activate(e){this.activeMimeIdx=e}get active(){return this.mediaTypes[this.activeMimeIdx]}get hasSample(){return this.mediaTypes.filter((e=>!!e.examples)).length>0}}iu([Ae],au.prototype,"activeMimeIdx",2),iu([Pt],au.prototype,"activate",1),iu([je],au.prototype,"active",1);class su{constructor({parser:e,infoOrRef:t,options:n,isEvent:r}){const o=!r,{resolved:i}=e.deref(t);this.description=i.description||"",this.required=!!i.required;const a=function(e){let t=e.content;const n=e["x-examples"],r=e["x-example"];if(n){t=Ha({},t);for(const e of Object.keys(n)){const r=n[e];t[e]=Ya(Ha({},t[e]),{examples:r})}}else if(r){t=Ha({},t);for(const e of Object.keys(r)){const n=r[e];t[e]=Ya(Ha({},t[e]),{example:n})}}return t}(i);void 0!==a&&(this.content=new au(e,a,o,n))}}var lu=Object.defineProperty,cu=Object.defineProperties,uu=Object.getOwnPropertyDescriptor,pu=Object.getOwnPropertyDescriptors,du=Object.getOwnPropertySymbols,fu=Object.prototype.hasOwnProperty,hu=Object.prototype.propertyIsEnumerable,mu=(e,t,n)=>t in e?lu(e,t,{enumerable:!0,configurable:!0,writable:!0,value:n}):e[t]=n,gu=(e,t,n,r)=>{for(var o,i=r>1?void 0:r?uu(t,n):t,a=e.length-1;a>=0;a--)(o=e[a])&&(i=(r?o(t,n,i):o(i))||i);return r&&i&&lu(t,n,i),i};class yu{constructor({parser:e,code:t,defaultAsError:n,infoOrRef:r,options:o,isEvent:i}){this.expanded=!1,this.headers=[],tn(this),this.expanded="all"===o.expandResponses||o.expandResponses[t];const{resolved:a}=e.deref(r);this.code=t,void 0!==a.content&&(this.content=new au(e,a.content,i,o)),void 0!==a["x-summary"]?(this.summary=a["x-summary"],this.description=a.description||""):(this.summary=a.description||"",this.description=""),this.type=Ga(t,n);const s=a.headers;void 0!==s&&(this.headers=Object.keys(s).map((t=>{const n=s[t];return new Nc(e,((e,t)=>cu(e,pu(t)))(((e,t)=>{for(var n in t||(t={}))fu.call(t,n)&&mu(e,n,t[n]);if(du)for(var n of du(t))hu.call(t,n)&&mu(e,n,t[n]);return e})({},n),{name:t}),"",o)}))),o.showExtensions&&(this.extensions=gs(a,o.showExtensions))}toggle(){this.expanded=!this.expanded}}gu([Ae],yu.prototype,"expanded",2),gu([Pt],yu.prototype,"toggle",1);var vu=Object.defineProperty,bu=Object.getOwnPropertyDescriptor,wu=(e,t,n,r)=>{for(var o,i=r>1?void 0:r?bu(t,n):t,a=e.length-1;a>=0;a--)(o=e[a])&&(i=(r?o(t,n,i):o(i))||i);return r&&i&&vu(t,n,i),i};function xu(e){return"payload"===e.lang&&e.requestBodyContent}let ku=!1;class _u{constructor(e,t,n,r,o=!1){var i;this.parser=e,this.operationSpec=t,this.options=r,this.type="operation",this.items=[],this.ready=!0,this.active=!1,this.expanded=!1,tn(this),this.pointer=t.pointer,this.description=t.description,this.parent=n,this.externalDocs=t.externalDocs,this.deprecated=!!t.deprecated,this.httpVerb=t.httpVerb,this.deprecated=!!t.deprecated,this.operationId=t.operationId,this.path=t.pathName,this.isCallback=o,this.isWebhook=t.isWebhook,this.isEvent=this.isCallback||this.isWebhook,this.name=(i=t).summary||i.operationId||i.description&&i.description.substring(0,50)||i.pathName||"<no summary>",this.sidebarLabel=r.sideNavStyle===co.IdOnly?this.operationId||this.path:r.sideNavStyle===co.PathOnly?this.path:this.name,this.isCallback?(this.security=(t.security||[]).map((t=>new Vl(t,e))),this.servers=fs("",t.servers||t.pathServers||[])):(this.operationHash=t.operationId&&"operation/"+t.operationId,this.id=void 0!==t.operationId?(n?n.id+"/":"")+this.operationHash:void 0!==n?n.id+this.pointer:this.pointer,this.security=(t.security||e.spec.security||[]).map((t=>new Vl(t,e))),this.servers=fs(e.specUrl,t.servers||t.pathServers||e.spec.servers||[])),r.showExtensions&&(this.extensions=gs(t,r.showExtensions))}activate(){this.active=!0}deactivate(){this.active=!1}toggle(){this.expanded=!this.expanded}expand(){this.parent&&this.parent.expand()}collapse(){}get requestBody(){return this.operationSpec.requestBody&&new su({parser:this.parser,infoOrRef:this.operationSpec.requestBody,options:this.options,isEvent:this.isEvent})}get codeSamples(){let e=this.operationSpec["x-codeSamples"]||this.operationSpec["x-code-samples"]||[];this.operationSpec["x-code-samples"]&&!ku&&(ku=!0,console.warn('"x-code-samples" is deprecated. Use "x-codeSamples" instead'));const t=this.requestBody&&this.requestBody.content;if(t&&t.hasSample){const n=Math.min(e.length,this.options.payloadSampleIdx);e=[...e.slice(0,n),{lang:"payload",label:"Payload",source:"",requestBodyContent:t},...e.slice(n)]}return e}get parameters(){const e=function(e,t=[],n=[]){const r={};return n.forEach((t=>{({resolved:t}=e.deref(t)),r[t.name+"_"+t.in]=!0})),(t=t.filter((t=>(({resolved:t}=e.deref(t)),!r[t.name+"_"+t.in])))).concat(n)}(this.parser,this.operationSpec.pathParameters,this.operationSpec.parameters).map((e=>new Nc(this.parser,e,this.pointer,this.options)));return this.options.sortPropsAlphabetically?ds(e,"name"):this.options.requiredPropsFirst?ps(e):e}get responses(){let e=!1;return Object.keys(this.operationSpec.responses||[]).filter((t=>{return"default"===t||("success"===Ga(t)&&(e=!0),"default"===(n=t)||Jr(n)||Ka(n));var n})).map((t=>new yu({parser:this.parser,code:t,defaultAsError:e,infoOrRef:this.operationSpec.responses[t],options:this.options,isEvent:this.isEvent})))}get callbacks(){return Object.keys(this.operationSpec.callbacks||[]).map((e=>new ec(this.parser,e,this.operationSpec.callbacks[e],this.pointer,this.options)))}}wu([Ae],_u.prototype,"ready",2),wu([Ae],_u.prototype,"active",2),wu([Ae],_u.prototype,"expanded",2),wu([Pt],_u.prototype,"activate",1),wu([Pt],_u.prototype,"deactivate",1),wu([Pt],_u.prototype,"toggle",1),wu([$s],_u.prototype,"requestBody",1),wu([$s],_u.prototype,"codeSamples",1),wu([$s],_u.prototype,"parameters",1),wu([$s],_u.prototype,"responses",1),wu([$s],_u.prototype,"callbacks",1);const Ou=ga.div`
width: calc(100% - ${e=>e.theme.rightPanel.width});
padding: 0 ${e=>e.theme.spacing.sectionHorizontal}px;
${({compact:e,theme:t})=>ma("medium",!0)`
width: 100%;
padding: ${`${e?0:t.spacing.sectionVertical}px ${t.spacing.sectionHorizontal}px`};
`};
`,Su=ga.div.attrs((e=>({[gf]:e.id})))`
padding: ${e=>e.theme.spacing.sectionVertical}px 0;
&:last-child {
min-height: calc(100vh + 1px);
}
& > &:last-child {
min-height: initial;
}
${ma("medium",!0)`
padding: 0;
`}
${e=>e.underlined?"\n position: relative;\n\n &:not(:last-of-type):after {\n position: absolute;\n bottom: 0;\n width: 100%;\n display: block;\n content: '';\n border-bottom: 1px solid rgba(0, 0, 0, 0.2);\n }\n ":""}
`,Eu=ga.div`
width: ${e=>e.theme.rightPanel.width};
color: ${({theme:e})=>e.rightPanel.textColor};
background-color: ${e=>e.theme.rightPanel.backgroundColor};
padding: 0 ${e=>e.theme.spacing.sectionHorizontal}px;
${ma("medium",!0)`
width: 100%;
padding: ${e=>`${e.theme.spacing.sectionVertical}px ${e.theme.spacing.sectionHorizontal}px`};
`};
`,Pu=ga(Eu)`
background-color: ${e=>e.theme.rightPanel.backgroundColor};
`,Au=ga.div`
display: flex;
width: 100%;
padding: 0;
${ma("medium",!0)`
flex-direction: column;
`};
`,$u={1:"1.85714em",2:"1.57143em",3:"1.27em"},Cu=e=>pa`
font-family: ${({theme:e})=>e.typography.headings.fontFamily};
font-weight: ${({theme:e})=>e.typography.headings.fontWeight};
font-size: ${$u[e]};
line-height: ${({theme:e})=>e.typography.headings.lineHeight};
`,Ru=ga.h1`
${Cu(1)};
color: ${({theme:e})=>e.colors.text.primary};
${ya("H1")};
`,ju=ga.h2`
${Cu(2)};
color: ${({theme:e})=>e.colors.text.primary};
margin: 0 0 20px;
${ya("H2")};
`,Tu=(ga.h2`
${Cu(3)};
color: ${({theme:e})=>e.colors.text.primary};
${ya("H3")};
`,ga.h3`
color: ${({theme:e})=>e.rightPanel.textColor};
${ya("RightPanelHeader")};
`),Iu=ga.h5`
border-bottom: 1px solid rgba(38, 50, 56, 0.3);
margin: 1em 0 1em 0;
color: rgba(38, 50, 56, 0.5);
font-weight: normal;
text-transform: uppercase;
font-size: 0.929em;
line-height: 20px;
${ya("UnderlinedHeader")};
`,Nu=(0,n.createContext)(void 0),{Provider:Du,Consumer:Lu}=Nu;function Mu(e){const{spec:t,specUrl:o,options:i,onLoaded:a,children:s}=e,[l,c]=n.useState(null),[u,p]=n.useState(null);if(u)throw u;n.useEffect((()=>{!function(){return e=this,null,n=function*(){if(t||o){c(null);try{const e=yield function(e){return t=this,n=function*(){const t=new $a.Config({}),n={config:t,base:qr?window.location.href:process.cwd()};qr&&(t.resolve.http.customFetch=r.g.fetch),"object"==typeof e&&null!==e?n.doc={source:{absoluteRef:""},parsed:e}:n.ref=e;const{bundle:{parsed:o}}=yield(0,Aa.bundle)(n);return void 0!==o.swagger?(i=o,console.warn("[ReDoc Compatibility mode]: Converting OpenAPI 2.0 to OpenAPI 3.0"),new Promise(((e,t)=>(0,Ca.convertObj)(i,{patch:!0,warnOnly:!0,text:"{}",anchors:!0},((n,r)=>{if(n)return t(n);e(r&&r.openapi)}))))):o;var i},new Promise(((e,r)=>{var o=e=>{try{a(n.next(e))}catch(e){r(e)}},i=e=>{try{a(n.throw(e))}catch(e){r(e)}},a=t=>t.done?e(t.value):Promise.resolve(t.value).then(o,i);a((n=n.apply(t,null)).next())}));var t,n}(t||o);c(e)}catch(e){throw p(e),e}}},new Promise(((t,r)=>{var o=e=>{try{a(n.next(e))}catch(e){r(e)}},i=e=>{try{a(n.throw(e))}catch(e){r(e)}},a=e=>e.done?t(e.value):Promise.resolve(e.value).then(o,i);a((n=n.apply(e,null)).next())}));var e,n}()}),[t,o]);const d=n.useMemo((()=>{if(!l)return null;try{return new ey(l,o,i)}catch(e){throw a&&a(e),e}}),[l,o,i]);return n.useEffect((()=>{d&&a&&a()}),[d,a]),s({loading:!d,store:d})}const Fu=e=>pa`
${e} {
cursor: pointer;
margin-left: -20px;
padding: 0;
line-height: 1;
width: 20px;
display: inline-block;
outline: 0;
}
${e}:before {
content: '';
width: 15px;
height: 15px;
background-size: contain;
background-image: url('data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHZlcnNpb249IjEuMSIgeD0iMCIgeT0iMCIgd2lkdGg9IjUxMiIgaGVpZ2h0PSI1MTIiIHZpZXdCb3g9IjAgMCA1MTIgNTEyIiBlbmFibGUtYmFja2dyb3VuZD0ibmV3IDAgMCA1MTIgNTEyIiB4bWw6c3BhY2U9InByZXNlcnZlIj48cGF0aCBmaWxsPSIjMDEwMTAxIiBkPSJNNDU5LjcgMjMzLjRsLTkwLjUgOTAuNWMtNTAgNTAtMTMxIDUwLTE4MSAwIC03LjktNy44LTE0LTE2LjctMTkuNC0yNS44bDQyLjEtNDIuMWMyLTIgNC41LTMuMiA2LjgtNC41IDIuOSA5LjkgOCAxOS4zIDE1LjggMjcuMiAyNSAyNSA2NS42IDI0LjkgOTAuNSAwbDkwLjUtOTAuNWMyNS0yNSAyNS02NS42IDAtOTAuNSAtMjQuOS0yNS02NS41LTI1LTkwLjUgMGwtMzIuMiAzMi4yYy0yNi4xLTEwLjItNTQuMi0xMi45LTgxLjYtOC45bDY4LjYtNjguNmM1MC01MCAxMzEtNTAgMTgxIDBDNTA5LjYgMTAyLjMgNTA5LjYgMTgzLjQgNDU5LjcgMjMzLjR6TTIyMC4zIDM4Mi4ybC0zMi4yIDMyLjJjLTI1IDI0LjktNjUuNiAyNC45LTkwLjUgMCAtMjUtMjUtMjUtNjUuNiAwLTkwLjVsOTAuNS05MC41YzI1LTI1IDY1LjUtMjUgOTAuNSAwIDcuOCA3LjggMTIuOSAxNy4yIDE1LjggMjcuMSAyLjQtMS40IDQuOC0yLjUgNi44LTQuNWw0Mi4xLTQyYy01LjQtOS4yLTExLjYtMTgtMTkuNC0yNS44IC01MC01MC0xMzEtNTAtMTgxIDBsLTkwLjUgOTAuNWMtNTAgNTAtNTAgMTMxIDAgMTgxIDUwIDUwIDEzMSA1MCAxODEgMGw2OC42LTY4LjZDMjc0LjYgMzk1LjEgMjQ2LjQgMzkyLjMgMjIwLjMgMzgyLjJ6Ii8+PC9zdmc+Cg==');
opacity: 0.5;
visibility: hidden;
display: inline-block;
vertical-align: middle;
}
h1:hover > ${e}::before, h2:hover > ${e}::before, ${e}:hover::before {
visibility: visible;
}
`,zu=ga((function(e){const t=n.useContext(Nu),r=n.useCallback((n=>{t&&function(e,t,n){t.defaultPrevented||0!==t.button||(e=>!!(e.metaKey||e.altKey||e.ctrlKey||e.shiftKey))(t)||(t.preventDefault(),e.replace(encodeURI(n)))}(t.menu.history,n,e.to)}),[t,e.to]);return t?n.createElement("a",{className:e.className,href:t.menu.history.linkForId(e.to),onClick:r,"aria-label":e.to},e.children):null}))`
${Fu("&")};
`;function Uu(e){return n.createElement(zu,{to:e.to})}const Vu={left:"90deg",right:"-90deg",up:"-180deg",down:"0"},Bu=ga((e=>n.createElement("svg",{className:e.className,style:e.style,version:"1.1",viewBox:"0 0 24 24",x:"0",xmlns:"http://www.w3.org/2000/svg",y:"0","aria-hidden":"true"},n.createElement("polygon",{points:"17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "}))))`
height: ${e=>e.size||"18px"};
width: ${e=>e.size||"18px"};
min-width: ${e=>e.size||"18px"};
vertical-align: middle;
float: ${e=>e.float||""};
transition: transform 0.2s ease-out;
transform: rotateZ(${e=>Vu[e.direction||"down"]});
polygon {
fill: ${({color:e,theme:t})=>e&&t.colors.responses[e]&&t.colors.responses[e].color||e};
}
`,qu=ga.span`
display: inline-block;
padding: 2px 8px;
margin: 0;
background-color: ${e=>e.theme.colors[e.type].main};
color: ${e=>e.theme.colors[e.type].contrastText};
font-size: ${e=>e.theme.typography.code.fontSize};
vertical-align: middle;
line-height: 1.6;
border-radius: 4px;
font-weight: ${({theme:e})=>e.typography.fontWeightBold};
font-size: 12px;
+ span[type] {
margin-left: 4px;
}
`,Wu=pa`
text-decoration: line-through;
color: #707070;
`,Hu=ga.caption`
text-align: right;
font-size: 0.9em;
font-weight: normal;
color: ${e=>e.theme.colors.text.secondary};
`,Yu=ga.td`
border-left: 1px solid ${e=>e.theme.schema.linesColor};
box-sizing: border-box;
position: relative;
padding: 10px 10px 10px 0;
${ma("small")`
display: block;
overflow: hidden;
`}
tr:first-of-type > &,
tr.last > & {
border-left-width: 0;
background-position: top left;
background-repeat: no-repeat;
background-size: 1px 100%;
}
tr:first-of-type > & {
background-image: linear-gradient(
to bottom,
transparent 0%,
transparent 22px,
${e=>e.theme.schema.linesColor} 22px,
${e=>e.theme.schema.linesColor} 100%
);
}
tr.last > & {
background-image: linear-gradient(
to bottom,
${e=>e.theme.schema.linesColor} 0%,
${e=>e.theme.schema.linesColor} 22px,
transparent 22px,
transparent 100%
);
}
tr.last + tr > & {
border-left-color: transparent;
}
tr.last:first-child > & {
background: none;
border-left-color: transparent;
}
`,Ku=ga(Yu)`
padding: 0;
`,Gu=ga(Yu)`
vertical-align: top;
line-height: 20px;
white-space: nowrap;
font-size: 13px;
font-family: ${e=>e.theme.typography.code.fontFamily};
&.deprecated {
${Wu};
}
${({kind:e})=>"patternProperties"===e&&pa`
> span.property-name {
display: inline-table;
white-space: break-spaces;
margin-right: 20px;
::before,
::after {
content: '/';
filter: opacity(0.2);
}
}
`}
${({kind:e=""})=>["field","additionalProperties","patternProperties"].includes(e)?"":"font-style: italic"};
${ya("PropertyNameCell")};
`,Qu=ga.td`
border-bottom: 1px solid #9fb4be;
padding: 10px 0;
width: ${e=>e.theme.schema.defaultDetailsWidth};
box-sizing: border-box;
tr.expanded & {
border-bottom: none;
}
${ma("small")`
padding: 0 20px;
border-bottom: none;
border-left: 1px solid ${e=>e.theme.schema.linesColor};
tr.last > & {
border-left: none;
}
`}
${ya("PropertyDetailsCell")};
`,Xu=ga.span`
color: ${e=>e.theme.schema.linesColor};
font-family: ${e=>e.theme.typography.code.fontFamily};
margin-right: 10px;
&::before {
content: '';
display: inline-block;
vertical-align: middle;
width: 10px;
height: 1px;
background: ${e=>e.theme.schema.linesColor};
}
&::after {
content: '';
display: inline-block;
vertical-align: middle;
width: 1px;
background: ${e=>e.theme.schema.linesColor};
height: 7px;
}
`,Ju=ga.div`
padding: ${({theme:e})=>e.schema.nestingSpacing};
`,Zu=ga.table`
border-collapse: separate;
border-radius: 3px;
font-size: ${e=>e.theme.typography.fontSize};
border-spacing: 0;
width: 100%;
> tr {
vertical-align: middle;
}
${ma("small")`
display: block;
> tr, > tbody > tr {
display: block;
}
`}
${ma("small",!1," and (-ms-high-contrast:none)")`
td {
float: left;
width: 100%;
}
`}
&
${Ju},
&
${Ju}
${Ju}
${Ju},
&
${Ju}
${Ju}
${Ju}
${Ju}
${Ju} {
margin: ${({theme:e})=>e.schema.nestingSpacing};
margin-right: 0;
background: ${({theme:e})=>e.schema.nestedBackground};
}
&
${Ju}
${Ju},
&
${Ju}
${Ju}
${Ju}
${Ju},
&
${Ju}
${Ju}
${Ju}
${Ju}
${Ju}
${Ju} {
background: #ffffff;
}
`,ep=ga.div`
margin: 0 0 3px 0;
display: inline-block;
`,tp=ga.span`
font-size: 0.9em;
margin-right: 10px;
color: ${e=>e.theme.colors.primary.main};
font-family: ${e=>e.theme.typography.headings.fontFamily};
}
`,np=ga.button`
display: inline-block;
margin-right: 10px;
margin-bottom: 5px;
font-size: 0.8em;
cursor: pointer;
border: 1px solid ${e=>e.theme.colors.primary.main};
padding: 2px 10px;
line-height: 1.5em;
outline: none;
&:focus {
box-shadow: 0 0 0 1px ${e=>e.theme.colors.primary.main};
}
${({deprecated:e})=>e&&Wu||""};
${e=>e.active?`\n color: white;\n background-color: ${e.theme.colors.primary.main};\n &:focus {\n box-shadow: none;\n background-color: ${Rr(.15,e.theme.colors.primary.main)};\n }\n `:`\n color: ${e.theme.colors.primary.main};\n background-color: white;\n `}
`,rp=ga.div`
font-size: 0.9em;
font-family: ${e=>e.theme.typography.code.fontFamily};
&::after {
content: ' [';
}
`,op=ga.div`
font-size: 0.9em;
font-family: ${e=>e.theme.typography.code.fontFamily};
&::after {
content: ']';
}
`;function ip(e){return function(t){return!!t.type&&t.type.tabsRole===e}}var ap=ip("Tab"),sp=ip("TabList"),lp=ip("TabPanel");function cp(){return cp=Object.assign||function(e){for(var t=1;t<arguments.length;t++){var n=arguments[t];for(var r in n)Object.prototype.hasOwnProperty.call(n,r)&&(e[r]=n[r])}return e},cp.apply(this,arguments)}function up(e,t){return n.Children.map(e,(function(e){return null===e?null:function(e){return ap(e)||sp(e)||lp(e)}(e)?t(e):e.props&&e.props.children&&"object"==typeof e.props.children?(0,n.cloneElement)(e,cp({},e.props,{children:up(e.props.children,t)})):e}))}function pp(e,t){return n.Children.forEach(e,(function(e){null!==e&&(ap(e)||lp(e)?t(e):e.props&&e.props.children&&"object"==typeof e.props.children&&(sp(e)&&t(e),pp(e.props.children,t)))}))}function dp(e){var t,n,r="";if("string"==typeof e||"number"==typeof e)r+=e;else if("object"==typeof e)if(Array.isArray(e))for(t=0;t<e.length;t++)e[t]&&(n=dp(e[t]))&&(r&&(r+=" "),r+=n);else for(t in e)e[t]&&(r&&(r+=" "),r+=t);return r}function fp(){for(var e,t,n=0,r="";n<arguments.length;)(e=arguments[n++])&&(t=dp(e))&&(r&&(r+=" "),r+=t);return r}var hp,mp=0;function gp(){return"react-tabs-"+mp++}function yp(e){var t=0;return pp(e,(function(e){ap(e)&&t++})),t}function vp(){return vp=Object.assign||function(e){for(var t=1;t<arguments.length;t++){var n=arguments[t];for(var r in n)Object.prototype.hasOwnProperty.call(n,r)&&(e[r]=n[r])}return e},vp.apply(this,arguments)}function bp(e,t){return bp=Object.setPrototypeOf||function(e,t){return e.__proto__=t,e},bp(e,t)}function wp(e){return e&&"getAttribute"in e}function xp(e){return wp(e)&&"tab"===e.getAttribute("role")}function kp(e){return wp(e)&&"true"===e.getAttribute("aria-disabled")}var _p=function(e){var t,r;function o(){for(var t,n=arguments.length,r=new Array(n),o=0;o<n;o++)r[o]=arguments[o];return(t=e.call.apply(e,[this].concat(r))||this).tabNodes=[],t.handleKeyDown=function(e){var n=t.props,r=n.direction,o=n.disableUpDownKeys;if(t.isTabFromContainer(e.target)){var i=t.props.selectedIndex,a=!1,s=!1;32!==e.keyCode&&13!==e.keyCode||(a=!0,s=!1,t.handleClick(e)),37===e.keyCode||!o&&38===e.keyCode?(i="rtl"===r?t.getNextTab(i):t.getPrevTab(i),a=!0,s=!0):39===e.keyCode||!o&&40===e.keyCode?(i="rtl"===r?t.getPrevTab(i):t.getNextTab(i),a=!0,s=!0):35===e.keyCode?(i=t.getLastTab(),a=!0,s=!0):36===e.keyCode&&(i=t.getFirstTab(),a=!0,s=!0),a&&e.preventDefault(),s&&t.setSelected(i,e)}},t.handleClick=function(e){var n=e.target;do{if(t.isTabFromContainer(n)){if(kp(n))return;var r=[].slice.call(n.parentNode.children).filter(xp).indexOf(n);return void t.setSelected(r,e)}}while(null!=(n=n.parentNode))},t}r=e,(t=o).prototype=Object.create(r.prototype),t.prototype.constructor=t,bp(t,r);var i=o.prototype;return i.setSelected=function(e,t){if(!(e<0||e>=this.getTabsCount())){var n=this.props;(0,n.onSelect)(e,n.selectedIndex,t)}},i.getNextTab=function(e){for(var t=this.getTabsCount(),n=e+1;n<t;n++)if(!kp(this.getTab(n)))return n;for(var r=0;r<e;r++)if(!kp(this.getTab(r)))return r;return e},i.getPrevTab=function(e){for(var t=e;t--;)if(!kp(this.getTab(t)))return t;for(t=this.getTabsCount();t-- >e;)if(!kp(this.getTab(t)))return t;return e},i.getFirstTab=function(){for(var e=this.getTabsCount(),t=0;t<e;t++)if(!kp(this.getTab(t)))return t;return null},i.getLastTab=function(){for(var e=this.getTabsCount();e--;)if(!kp(this.getTab(e)))return e;return null},i.getTabsCount=function(){return yp(this.props.children)},i.getPanelsCount=function(){return e=this.props.children,t=0,pp(e,(function(e){lp(e)&&t++})),t;var e,t},i.getTab=function(e){return this.tabNodes["tabs-"+e]},i.getChildren=function(){var e=this,t=0,r=this.props,o=r.children,i=r.disabledTabClassName,a=r.focus,s=r.forceRenderTabPanel,l=r.selectedIndex,c=r.selectedTabClassName,u=r.selectedTabPanelClassName,p=r.environment;this.tabIds=this.tabIds||[],this.panelIds=this.panelIds||[];for(var d=this.tabIds.length-this.getTabsCount();d++<0;)this.tabIds.push(gp()),this.panelIds.push(gp());return up(o,(function(r){var o=r;if(sp(r)){var d=0,f=!1;null==hp&&function(e){var t=e||("undefined"!=typeof window?window:void 0);try{hp=!(void 0===t||!t.document||!t.document.activeElement)}catch(e){hp=!1}}(p),hp&&(f=n.Children.toArray(r.props.children).filter(ap).some((function(t,n){var r=p||("undefined"!=typeof window?window:void 0);return r&&r.document.activeElement===e.getTab(n)}))),o=(0,n.cloneElement)(r,{children:up(r.props.children,(function(t){var r="tabs-"+d,o=l===d,s={tabRef:function(t){e.tabNodes[r]=t},id:e.tabIds[d],panelId:e.panelIds[d],selected:o,focus:o&&(a||f)};return c&&(s.selectedClassName=c),i&&(s.disabledClassName=i),d++,(0,n.cloneElement)(t,s)}))})}else if(lp(r)){var h={id:e.panelIds[t],tabId:e.tabIds[t],selected:l===t};s&&(h.forceRender=s),u&&(h.selectedClassName=u),t++,o=(0,n.cloneElement)(r,h)}return o}))},i.isTabFromContainer=function(e){if(!xp(e))return!1;var t=e.parentElement;do{if(t===this.node)return!0;if(t.getAttribute("data-tabs"))break;t=t.parentElement}while(t);return!1},i.render=function(){var e=this,t=this.props,r=(t.children,t.className),o=(t.disabledTabClassName,t.domRef),i=(t.focus,t.forceRenderTabPanel,t.onSelect,t.selectedIndex,t.selectedTabClassName,t.selectedTabPanelClassName,t.environment,t.disableUpDownKeys,function(e,t){if(null==e)return{};var n,r,o={},i=Object.keys(e);for(r=0;r<i.length;r++)n=i[r],t.indexOf(n)>=0||(o[n]=e[n]);return o}(t,["children","className","disabledTabClassName","domRef","focus","forceRenderTabPanel","onSelect","selectedIndex","selectedTabClassName","selectedTabPanelClassName","environment","disableUpDownKeys"]));return n.createElement("div",vp({},i,{className:fp(r),onClick:this.handleClick,onKeyDown:this.handleKeyDown,ref:function(t){e.node=t,o&&o(t)},"data-tabs":!0}),this.getChildren())},o}(n.Component);function Op(e,t){return Op=Object.setPrototypeOf||function(e,t){return e.__proto__=t,e},Op(e,t)}_p.defaultProps={className:"react-tabs",focus:!1},_p.propTypes={};var Sp=function(e){var t,r;function o(t){var n;return(n=e.call(this,t)||this).handleSelected=function(e,t,r){var o=n.props.onSelect,i=n.state.mode;if("function"!=typeof o||!1!==o(e,t,r)){var a={focus:"keydown"===r.type};1===i&&(a.selectedIndex=e),n.setState(a)}},n.state=o.copyPropsToState(n.props,{},t.defaultFocus),n}return r=e,(t=o).prototype=Object.create(r.prototype),t.prototype.constructor=t,Op(t,r),o.getDerivedStateFromProps=function(e,t){return o.copyPropsToState(e,t)},o.getModeFromProps=function(e){return null===e.selectedIndex?1:0},o.copyPropsToState=function(e,t,n){void 0===n&&(n=!1);var r={focus:n,mode:o.getModeFromProps(e)};if(1===r.mode){var i,a=Math.max(0,yp(e.children)-1);i=null!=t.selectedIndex?Math.min(t.selectedIndex,a):e.defaultIndex||0,r.selectedIndex=i}return r},o.prototype.render=function(){var e=this.props,t=e.children,r=(e.defaultIndex,e.defaultFocus,function(e,t){if(null==e)return{};var n,r,o={},i=Object.keys(e);for(r=0;r<i.length;r++)n=i[r],t.indexOf(n)>=0||(o[n]=e[n]);return o}(e,["children","defaultIndex","defaultFocus"])),o=this.state,i=o.focus,a=o.selectedIndex;return r.focus=i,r.onSelect=this.handleSelected,null!=a&&(r.selectedIndex=a),n.createElement(_p,r,t)},o}(n.Component);function Ep(){return Ep=Object.assign||function(e){for(var t=1;t<arguments.length;t++){var n=arguments[t];for(var r in n)Object.prototype.hasOwnProperty.call(n,r)&&(e[r]=n[r])}return e},Ep.apply(this,arguments)}function Pp(e,t){return Pp=Object.setPrototypeOf||function(e,t){return e.__proto__=t,e},Pp(e,t)}Sp.defaultProps={defaultFocus:!1,forceRenderTabPanel:!1,selectedIndex:null,defaultIndex:null,environment:null,disableUpDownKeys:!1},Sp.propTypes={},Sp.tabsRole="Tabs";var Ap=function(e){var t,r;function o(){return e.apply(this,arguments)||this}return r=e,(t=o).prototype=Object.create(r.prototype),t.prototype.constructor=t,Pp(t,r),o.prototype.render=function(){var e=this.props,t=e.children,r=e.className,o=function(e,t){if(null==e)return{};var n,r,o={},i=Object.keys(e);for(r=0;r<i.length;r++)n=i[r],t.indexOf(n)>=0||(o[n]=e[n]);return o}(e,["children","className"]);return n.createElement("ul",Ep({},o,{className:fp(r),role:"tablist"}),t)},o}(n.Component);function $p(){return $p=Object.assign||function(e){for(var t=1;t<arguments.length;t++){var n=arguments[t];for(var r in n)Object.prototype.hasOwnProperty.call(n,r)&&(e[r]=n[r])}return e},$p.apply(this,arguments)}function Cp(e,t){return Cp=Object.setPrototypeOf||function(e,t){return e.__proto__=t,e},Cp(e,t)}Ap.defaultProps={className:"react-tabs__tab-list"},Ap.propTypes={},Ap.tabsRole="TabList";var Rp="react-tabs__tab",jp=function(e){var t,r;function o(){return e.apply(this,arguments)||this}r=e,(t=o).prototype=Object.create(r.prototype),t.prototype.constructor=t,Cp(t,r);var i=o.prototype;return i.componentDidMount=function(){this.checkFocus()},i.componentDidUpdate=function(){this.checkFocus()},i.checkFocus=function(){var e=this.props,t=e.selected,n=e.focus;t&&n&&this.node.focus()},i.render=function(){var e,t=this,r=this.props,o=r.children,i=r.className,a=r.disabled,s=r.disabledClassName,l=(r.focus,r.id),c=r.panelId,u=r.selected,p=r.selectedClassName,d=r.tabIndex,f=r.tabRef,h=function(e,t){if(null==e)return{};var n,r,o={},i=Object.keys(e);for(r=0;r<i.length;r++)n=i[r],t.indexOf(n)>=0||(o[n]=e[n]);return o}(r,["children","className","disabled","disabledClassName","focus","id","panelId","selected","selectedClassName","tabIndex","tabRef"]);return n.createElement("li",$p({},h,{className:fp(i,(e={},e[p]=u,e[s]=a,e)),ref:function(e){t.node=e,f&&f(e)},role:"tab",id:l,"aria-selected":u?"true":"false","aria-disabled":a?"true":"false","aria-controls":c,tabIndex:d||(u?"0":null)}),o)},o}(n.Component);function Tp(){return Tp=Object.assign||function(e){for(var t=1;t<arguments.length;t++){var n=arguments[t];for(var r in n)Object.prototype.hasOwnProperty.call(n,r)&&(e[r]=n[r])}return e},Tp.apply(this,arguments)}function Ip(e,t){return Ip=Object.setPrototypeOf||function(e,t){return e.__proto__=t,e},Ip(e,t)}jp.defaultProps={className:Rp,disabledClassName:Rp+"--disabled",focus:!1,id:null,panelId:null,selected:!1,selectedClassName:Rp+"--selected"},jp.propTypes={},jp.tabsRole="Tab";var Np=function(e){var t,r;function o(){return e.apply(this,arguments)||this}return r=e,(t=o).prototype=Object.create(r.prototype),t.prototype.constructor=t,Ip(t,r),o.prototype.render=function(){var e,t=this.props,r=t.children,o=t.className,i=t.forceRender,a=t.id,s=t.selected,l=t.selectedClassName,c=t.tabId,u=function(e,t){if(null==e)return{};var n,r,o={},i=Object.keys(e);for(r=0;r<i.length;r++)n=i[r],t.indexOf(n)>=0||(o[n]=e[n]);return o}(t,["children","className","forceRender","id","selected","selectedClassName","tabId"]);return n.createElement("div",Tp({},u,{className:fp(o,(e={},e[l]=s,e)),role:"tabpanel",id:a,"aria-labelledby":c}),i||s?r:null)},o}(n.Component);Np.defaultProps={className:"react-tabs__tab-panel",forceRender:!1,selectedClassName:"react-tabs__tab-panel--selected"},Np.propTypes={},Np.tabsRole="TabPanel";const Dp=ga(Sp)`
> ul {
list-style: none;
padding: 0;
margin: 0;
margin: 0 -5px;
> li {
padding: 5px 10px;
display: inline-block;
background-color: ${({theme:e})=>e.codeBlock.backgroundColor};
border-bottom: 1px solid rgba(0, 0, 0, 0.5);
cursor: pointer;
text-align: center;
outline: none;
color: ${({theme:e})=>Rr(e.colors.tonalOffset,e.rightPanel.textColor)};
margin: 0
${({theme:e})=>`${e.spacing.unit}px ${e.spacing.unit}px ${e.spacing.unit}px`};
border: 1px solid ${({theme:e})=>Rr(.05,e.codeBlock.backgroundColor)};
border-radius: 5px;
min-width: 60px;
font-size: 0.9em;
font-weight: bold;
&.react-tabs__tab--selected {
color: ${e=>e.theme.colors.text.primary};
background: ${({theme:e})=>e.rightPanel.textColor};
&:focus {
outline: auto;
}
}
&:only-child {
flex: none;
min-width: 100px;
}
&.tab-success {
color: ${e=>e.theme.colors.responses.success.tabTextColor};
}
&.tab-redirect {
color: ${e=>e.theme.colors.responses.redirect.tabTextColor};
}
&.tab-info {
color: ${e=>e.theme.colors.responses.info.tabTextColor};
}
&.tab-error {
color: ${e=>e.theme.colors.responses.error.tabTextColor};
}
}
}
> .react-tabs__tab-panel {
background: ${({theme:e})=>e.codeBlock.backgroundColor};
& > div,
& > pre {
padding: ${e=>4*e.theme.spacing.unit}px;
margin: 0;
}
& > div > pre {
padding: 0;
}
}
`,Lp=(ga(Dp)`
> ul {
display: block;
> li {
padding: 2px 5px;
min-width: auto;
margin: 0 15px 0 0;
font-size: 13px;
font-weight: normal;
border-bottom: 1px dashed;
color: ${({theme:e})=>Rr(e.colors.tonalOffset,e.rightPanel.textColor)};
border-radius: 0;
background: none;
&:last-child {
margin-right: 0;
}
&.react-tabs__tab--selected {
color: ${({theme:e})=>e.rightPanel.textColor};
background: none;
}
}
}
> .react-tabs__tab-panel {
& > div,
& > pre {
padding: ${e=>2*e.theme.spacing.unit}px 0;
}
}
`,ga.div`
/**
* Based on prism-dark.css
*/
code[class*='language-'],
pre[class*='language-'] {
/* color: white;
background: none; */
text-shadow: 0 -0.1em 0.2em black;
text-align: left;
white-space: pre;
word-spacing: normal;
word-break: normal;
word-wrap: normal;
line-height: 1.5;
-moz-tab-size: 4;
-o-tab-size: 4;
tab-size: 4;
-webkit-hyphens: none;
-moz-hyphens: none;
-ms-hyphens: none;
hyphens: none;
}
@media print {
code[class*='language-'],
pre[class*='language-'] {
text-shadow: none;
}
}
/* Code blocks */
pre[class*='language-'] {
padding: 1em;
margin: 0.5em 0;
overflow: auto;
}
.token.comment,
.token.prolog,
.token.doctype,
.token.cdata {
color: hsl(30, 20%, 50%);
}
.token.punctuation {
opacity: 0.7;
}
.namespace {
opacity: 0.7;
}
.token.property,
.token.tag,
.token.number,
.token.constant,
.token.symbol {
color: #4a8bb3;
}
.token.boolean {
color: #e64441;
}
.token.selector,
.token.attr-name,
.token.string,
.token.char,
.token.builtin,
.token.inserted {
color: #a0fbaa;
& + a,
& + a:visited {
color: #4ed2ba;
text-decoration: underline;
}
}
.token.property.string {
color: white;
}
.token.operator,
.token.entity,
.token.url,
.token.variable {
color: hsl(40, 90%, 60%);
}
.token.atrule,
.token.attr-value,
.token.keyword {
color: hsl(350, 40%, 70%);
}
.token.regex,
.token.important {
color: #e90;
}
.token.important,
.token.bold {
font-weight: bold;
}
.token.italic {
font-style: italic;
}
.token.entity {
cursor: help;
}
.token.deleted {
color: red;
}
${ya("Prism")};
`),Mp=ga.div`
opacity: 0.7;
transition: opacity 0.3s ease;
text-align: right;
&:focus-within {
opacity: 1;
}
> button {
background-color: transparent;
border: 0;
color: inherit;
padding: 2px 10px;
font-family: ${({theme:e})=>e.typography.fontFamily};
font-size: ${({theme:e})=>e.typography.fontSize};
line-height: ${({theme:e})=>e.typography.lineHeight};
cursor: pointer;
outline: 0;
:hover,
:focus {
background: rgba(255, 255, 255, 0.1);
}
}
`,Fp=ga.div`
&:hover ${Mp} {
opacity: 1;
}
`,zp=ga(Lp.withComponent("pre"))`
font-family: ${e=>e.theme.typography.code.fontFamily};
font-size: ${e=>e.theme.typography.code.fontSize};
overflow-x: auto;
margin: 0;
white-space: ${({theme:e})=>e.typography.code.wrap?"pre-wrap":"pre"};
`;function Up(e){return getComputedStyle(e)}function Vp(e,t){for(var n in t){var r=t[n];"number"==typeof r&&(r+="px"),e.style[n]=r}return e}function Bp(e){var t=document.createElement("div");return t.className=e,t}var qp="undefined"!=typeof Element&&(Element.prototype.matches||Element.prototype.webkitMatchesSelector||Element.prototype.mozMatchesSelector||Element.prototype.msMatchesSelector);function Wp(e,t){if(!qp)throw new Error("No element matching method supported");return qp.call(e,t)}function Hp(e){e.remove?e.remove():e.parentNode&&e.parentNode.removeChild(e)}function Yp(e,t){return Array.prototype.filter.call(e.children,(function(e){return Wp(e,t)}))}var Kp=function(e){return"ps__thumb-"+e},Gp=function(e){return"ps__rail-"+e},Qp="ps__child--consume",Xp="ps--focus",Jp="ps--clicking",Zp=function(e){return"ps--active-"+e},ed=function(e){return"ps--scrolling-"+e},td={x:null,y:null};function nd(e,t){var n=e.element.classList,r=ed(t);n.contains(r)?clearTimeout(td[t]):n.add(r)}function rd(e,t){td[t]=setTimeout((function(){return e.isAlive&&e.element.classList.remove(ed(t))}),e.settings.scrollingThreshold)}var od=function(e){this.element=e,this.handlers={}},id={isEmpty:{configurable:!0}};od.prototype.bind=function(e,t){void 0===this.handlers[e]&&(this.handlers[e]=[]),this.handlers[e].push(t),this.element.addEventListener(e,t,!1)},od.prototype.unbind=function(e,t){var n=this;this.handlers[e]=this.handlers[e].filter((function(r){return!(!t||r===t)||(n.element.removeEventListener(e,r,!1),!1)}))},od.prototype.unbindAll=function(){for(var e in this.handlers)this.unbind(e)},id.isEmpty.get=function(){var e=this;return Object.keys(this.handlers).every((function(t){return 0===e.handlers[t].length}))},Object.defineProperties(od.prototype,id);var ad=function(){this.eventElements=[]};function sd(e){if("function"==typeof window.CustomEvent)return new CustomEvent(e);var t=document.createEvent("CustomEvent");return t.initCustomEvent(e,!1,!1,void 0),t}function ld(e,t,n,r,o){var i;if(void 0===r&&(r=!0),void 0===o&&(o=!1),"top"===t)i=["contentHeight","containerHeight","scrollTop","y","up","down"];else{if("left"!==t)throw new Error("A proper axis should be provided");i=["contentWidth","containerWidth","scrollLeft","x","left","right"]}!function(e,t,n,r,o){var i=n[0],a=n[1],s=n[2],l=n[3],c=n[4],u=n[5];void 0===r&&(r=!0),void 0===o&&(o=!1);var p=e.element;e.reach[l]=null,p[s]<1&&(e.reach[l]="start"),p[s]>e[i]-e[a]-1&&(e.reach[l]="end"),t&&(p.dispatchEvent(sd("ps-scroll-"+l)),t<0?p.dispatchEvent(sd("ps-scroll-"+c)):t>0&&p.dispatchEvent(sd("ps-scroll-"+u)),r&&function(e,t){nd(e,t),rd(e,t)}(e,l)),e.reach[l]&&(t||o)&&p.dispatchEvent(sd("ps-"+l+"-reach-"+e.reach[l]))}(e,n,i,r,o)}function cd(e){return parseInt(e,10)||0}ad.prototype.eventElement=function(e){var t=this.eventElements.filter((function(t){return t.element===e}))[0];return t||(t=new od(e),this.eventElements.push(t)),t},ad.prototype.bind=function(e,t,n){this.eventElement(e).bind(t,n)},ad.prototype.unbind=function(e,t,n){var r=this.eventElement(e);r.unbind(t,n),r.isEmpty&&this.eventElements.splice(this.eventElements.indexOf(r),1)},ad.prototype.unbindAll=function(){this.eventElements.forEach((function(e){return e.unbindAll()})),this.eventElements=[]},ad.prototype.once=function(e,t,n){var r=this.eventElement(e),o=function(e){r.unbind(t,o),n(e)};r.bind(t,o)};var ud={isWebKit:"undefined"!=typeof document&&"WebkitAppearance"in document.documentElement.style,supportsTouch:"undefined"!=typeof window&&("ontouchstart"in window||"maxTouchPoints"in window.navigator&&window.navigator.maxTouchPoints>0||window.DocumentTouch&&document instanceof window.DocumentTouch),supportsIePointer:"undefined"!=typeof navigator&&navigator.msMaxTouchPoints,isChrome:"undefined"!=typeof navigator&&/Chrome/i.test(navigator&&navigator.userAgent)};function pd(e){var t=e.element,n=Math.floor(t.scrollTop),r=t.getBoundingClientRect();e.containerWidth=Math.round(r.width),e.containerHeight=Math.round(r.height),e.contentWidth=t.scrollWidth,e.contentHeight=t.scrollHeight,t.contains(e.scrollbarXRail)||(Yp(t,Gp("x")).forEach((function(e){return Hp(e)})),t.appendChild(e.scrollbarXRail)),t.contains(e.scrollbarYRail)||(Yp(t,Gp("y")).forEach((function(e){return Hp(e)})),t.appendChild(e.scrollbarYRail)),!e.settings.suppressScrollX&&e.containerWidth+e.settings.scrollXMarginOffset<e.contentWidth?(e.scrollbarXActive=!0,e.railXWidth=e.containerWidth-e.railXMarginWidth,e.railXRatio=e.containerWidth/e.railXWidth,e.scrollbarXWidth=dd(e,cd(e.railXWidth*e.containerWidth/e.contentWidth)),e.scrollbarXLeft=cd((e.negativeScrollAdjustment+t.scrollLeft)*(e.railXWidth-e.scrollbarXWidth)/(e.contentWidth-e.containerWidth))):e.scrollbarXActive=!1,!e.settings.suppressScrollY&&e.containerHeight+e.settings.scrollYMarginOffset<e.contentHeight?(e.scrollbarYActive=!0,e.railYHeight=e.containerHeight-e.railYMarginHeight,e.railYRatio=e.containerHeight/e.railYHeight,e.scrollbarYHeight=dd(e,cd(e.railYHeight*e.containerHeight/e.contentHeight)),e.scrollbarYTop=cd(n*(e.railYHeight-e.scrollbarYHeight)/(e.contentHeight-e.containerHeight))):e.scrollbarYActive=!1,e.scrollbarXLeft>=e.railXWidth-e.scrollbarXWidth&&(e.scrollbarXLeft=e.railXWidth-e.scrollbarXWidth),e.scrollbarYTop>=e.railYHeight-e.scrollbarYHeight&&(e.scrollbarYTop=e.railYHeight-e.scrollbarYHeight),function(e,t){var n={width:t.railXWidth},r=Math.floor(e.scrollTop);t.isRtl?n.left=t.negativeScrollAdjustment+e.scrollLeft+t.containerWidth-t.contentWidth:n.left=e.scrollLeft,t.isScrollbarXUsingBottom?n.bottom=t.scrollbarXBottom-r:n.top=t.scrollbarXTop+r,Vp(t.scrollbarXRail,n);var o={top:r,height:t.railYHeight};t.isScrollbarYUsingRight?t.isRtl?o.right=t.contentWidth-(t.negativeScrollAdjustment+e.scrollLeft)-t.scrollbarYRight-t.scrollbarYOuterWidth-9:o.right=t.scrollbarYRight-e.scrollLeft:t.isRtl?o.left=t.negativeScrollAdjustment+e.scrollLeft+2*t.containerWidth-t.contentWidth-t.scrollbarYLeft-t.scrollbarYOuterWidth:o.left=t.scrollbarYLeft+e.scrollLeft,Vp(t.scrollbarYRail,o),Vp(t.scrollbarX,{left:t.scrollbarXLeft,width:t.scrollbarXWidth-t.railBorderXWidth}),Vp(t.scrollbarY,{top:t.scrollbarYTop,height:t.scrollbarYHeight-t.railBorderYWidth})}(t,e),e.scrollbarXActive?t.classList.add(Zp("x")):(t.classList.remove(Zp("x")),e.scrollbarXWidth=0,e.scrollbarXLeft=0,t.scrollLeft=!0===e.isRtl?e.contentWidth:0),e.scrollbarYActive?t.classList.add(Zp("y")):(t.classList.remove(Zp("y")),e.scrollbarYHeight=0,e.scrollbarYTop=0,t.scrollTop=0)}function dd(e,t){return e.settings.minScrollbarLength&&(t=Math.max(t,e.settings.minScrollbarLength)),e.settings.maxScrollbarLength&&(t=Math.min(t,e.settings.maxScrollbarLength)),t}function fd(e,t){var n=t[0],r=t[1],o=t[2],i=t[3],a=t[4],s=t[5],l=t[6],c=t[7],u=t[8],p=e.element,d=null,f=null,h=null;function m(t){t.touches&&t.touches[0]&&(t[o]=t.touches[0].pageY),p[l]=d+h*(t[o]-f),nd(e,c),pd(e),t.stopPropagation(),t.type.startsWith("touch")&&t.changedTouches.length>1&&t.preventDefault()}function g(){rd(e,c),e[u].classList.remove(Jp),e.event.unbind(e.ownerDocument,"mousemove",m)}function y(t,a){d=p[l],a&&t.touches&&(t[o]=t.touches[0].pageY),f=t[o],h=(e[r]-e[n])/(e[i]-e[s]),a?e.event.bind(e.ownerDocument,"touchmove",m):(e.event.bind(e.ownerDocument,"mousemove",m),e.event.once(e.ownerDocument,"mouseup",g),t.preventDefault()),e[u].classList.add(Jp),t.stopPropagation()}e.event.bind(e[a],"mousedown",(function(e){y(e)})),e.event.bind(e[a],"touchstart",(function(e){y(e,!0)}))}var hd={"click-rail":function(e){e.element,e.event.bind(e.scrollbarY,"mousedown",(function(e){return e.stopPropagation()})),e.event.bind(e.scrollbarYRail,"mousedown",(function(t){var n=t.pageY-window.pageYOffset-e.scrollbarYRail.getBoundingClientRect().top>e.scrollbarYTop?1:-1;e.element.scrollTop+=n*e.containerHeight,pd(e),t.stopPropagation()})),e.event.bind(e.scrollbarX,"mousedown",(function(e){return e.stopPropagation()})),e.event.bind(e.scrollbarXRail,"mousedown",(function(t){var n=t.pageX-window.pageXOffset-e.scrollbarXRail.getBoundingClientRect().left>e.scrollbarXLeft?1:-1;e.element.scrollLeft+=n*e.containerWidth,pd(e),t.stopPropagation()}))},"drag-thumb":function(e){fd(e,["containerWidth","contentWidth","pageX","railXWidth","scrollbarX","scrollbarXWidth","scrollLeft","x","scrollbarXRail"]),fd(e,["containerHeight","contentHeight","pageY","railYHeight","scrollbarY","scrollbarYHeight","scrollTop","y","scrollbarYRail"])},keyboard:function(e){var t=e.element;e.event.bind(e.ownerDocument,"keydown",(function(n){if(!(n.isDefaultPrevented&&n.isDefaultPrevented()||n.defaultPrevented)&&(Wp(t,":hover")||Wp(e.scrollbarX,":focus")||Wp(e.scrollbarY,":focus"))){var r,o=document.activeElement?document.activeElement:e.ownerDocument.activeElement;if(o){if("IFRAME"===o.tagName)o=o.contentDocument.activeElement;else for(;o.shadowRoot;)o=o.shadowRoot.activeElement;if(Wp(r=o,"input,[contenteditable]")||Wp(r,"select,[contenteditable]")||Wp(r,"textarea,[contenteditable]")||Wp(r,"button,[contenteditable]"))return}var i=0,a=0;switch(n.which){case 37:i=n.metaKey?-e.contentWidth:n.altKey?-e.containerWidth:-30;break;case 38:a=n.metaKey?e.contentHeight:n.altKey?e.containerHeight:30;break;case 39:i=n.metaKey?e.contentWidth:n.altKey?e.containerWidth:30;break;case 40:a=n.metaKey?-e.contentHeight:n.altKey?-e.containerHeight:-30;break;case 32:a=n.shiftKey?e.containerHeight:-e.containerHeight;break;case 33:a=e.containerHeight;break;case 34:a=-e.containerHeight;break;case 36:a=e.contentHeight;break;case 35:a=-e.contentHeight;break;default:return}e.settings.suppressScrollX&&0!==i||e.settings.suppressScrollY&&0!==a||(t.scrollTop-=a,t.scrollLeft+=i,pd(e),function(n,r){var o=Math.floor(t.scrollTop);if(0===n){if(!e.scrollbarYActive)return!1;if(0===o&&r>0||o>=e.contentHeight-e.containerHeight&&r<0)return!e.settings.wheelPropagation}var i=t.scrollLeft;if(0===r){if(!e.scrollbarXActive)return!1;if(0===i&&n<0||i>=e.contentWidth-e.containerWidth&&n>0)return!e.settings.wheelPropagation}return!0}(i,a)&&n.preventDefault())}}))},wheel:function(e){var t=e.element;function n(n){var r=function(e){var t=e.deltaX,n=-1*e.deltaY;return void 0!==t&&void 0!==n||(t=-1*e.wheelDeltaX/6,n=e.wheelDeltaY/6),e.deltaMode&&1===e.deltaMode&&(t*=10,n*=10),t!=t&&n!=n&&(t=0,n=e.wheelDelta),e.shiftKey?[-n,-t]:[t,n]}(n),o=r[0],i=r[1];if(!function(e,n,r){if(!ud.isWebKit&&t.querySelector("select:focus"))return!0;if(!t.contains(e))return!1;for(var o=e;o&&o!==t;){if(o.classList.contains(Qp))return!0;var i=Up(o);if(r&&i.overflowY.match(/(scroll|auto)/)){var a=o.scrollHeight-o.clientHeight;if(a>0&&(o.scrollTop>0&&r<0||o.scrollTop<a&&r>0))return!0}if(n&&i.overflowX.match(/(scroll|auto)/)){var s=o.scrollWidth-o.clientWidth;if(s>0&&(o.scrollLeft>0&&n<0||o.scrollLeft<s&&n>0))return!0}o=o.parentNode}return!1}(n.target,o,i)){var a=!1;e.settings.useBothWheelAxes?e.scrollbarYActive&&!e.scrollbarXActive?(i?t.scrollTop-=i*e.settings.wheelSpeed:t.scrollTop+=o*e.settings.wheelSpeed,a=!0):e.scrollbarXActive&&!e.scrollbarYActive&&(o?t.scrollLeft+=o*e.settings.wheelSpeed:t.scrollLeft-=i*e.settings.wheelSpeed,a=!0):(t.scrollTop-=i*e.settings.wheelSpeed,t.scrollLeft+=o*e.settings.wheelSpeed),pd(e),a=a||function(n,r){var o=Math.floor(t.scrollTop),i=0===t.scrollTop,a=o+t.offsetHeight===t.scrollHeight,s=0===t.scrollLeft,l=t.scrollLeft+t.offsetWidth===t.scrollWidth;return!(Math.abs(r)>Math.abs(n)?i||a:s||l)||!e.settings.wheelPropagation}(o,i),a&&!n.ctrlKey&&(n.stopPropagation(),n.preventDefault())}}void 0!==window.onwheel?e.event.bind(t,"wheel",n):void 0!==window.onmousewheel&&e.event.bind(t,"mousewheel",n)},touch:function(e){if(ud.supportsTouch||ud.supportsIePointer){var t=e.element,n={},r=0,o={},i=null;ud.supportsTouch?(e.event.bind(t,"touchstart",c),e.event.bind(t,"touchmove",u),e.event.bind(t,"touchend",p)):ud.supportsIePointer&&(window.PointerEvent?(e.event.bind(t,"pointerdown",c),e.event.bind(t,"pointermove",u),e.event.bind(t,"pointerup",p)):window.MSPointerEvent&&(e.event.bind(t,"MSPointerDown",c),e.event.bind(t,"MSPointerMove",u),e.event.bind(t,"MSPointerUp",p)))}function a(n,r){t.scrollTop-=r,t.scrollLeft-=n,pd(e)}function s(e){return e.targetTouches?e.targetTouches[0]:e}function l(e){return!(e.pointerType&&"pen"===e.pointerType&&0===e.buttons||(!e.targetTouches||1!==e.targetTouches.length)&&(!e.pointerType||"mouse"===e.pointerType||e.pointerType===e.MSPOINTER_TYPE_MOUSE))}function c(e){if(l(e)){var t=s(e);n.pageX=t.pageX,n.pageY=t.pageY,r=(new Date).getTime(),null!==i&&clearInterval(i)}}function u(i){if(l(i)){var c=s(i),u={pageX:c.pageX,pageY:c.pageY},p=u.pageX-n.pageX,d=u.pageY-n.pageY;if(function(e,n,r){if(!t.contains(e))return!1;for(var o=e;o&&o!==t;){if(o.classList.contains(Qp))return!0;var i=Up(o);if(r&&i.overflowY.match(/(scroll|auto)/)){var a=o.scrollHeight-o.clientHeight;if(a>0&&(o.scrollTop>0&&r<0||o.scrollTop<a&&r>0))return!0}if(n&&i.overflowX.match(/(scroll|auto)/)){var s=o.scrollWidth-o.clientWidth;if(s>0&&(o.scrollLeft>0&&n<0||o.scrollLeft<s&&n>0))return!0}o=o.parentNode}return!1}(i.target,p,d))return;a(p,d),n=u;var f=(new Date).getTime(),h=f-r;h>0&&(o.x=p/h,o.y=d/h,r=f),function(n,r){var o=Math.floor(t.scrollTop),i=t.scrollLeft,a=Math.abs(n),s=Math.abs(r);if(s>a){if(r<0&&o===e.contentHeight-e.containerHeight||r>0&&0===o)return 0===window.scrollY&&r>0&&ud.isChrome}else if(a>s&&(n<0&&i===e.contentWidth-e.containerWidth||n>0&&0===i))return!0;return!0}(p,d)&&i.preventDefault()}}function p(){e.settings.swipeEasing&&(clearInterval(i),i=setInterval((function(){e.isInitialized?clearInterval(i):o.x||o.y?Math.abs(o.x)<.01&&Math.abs(o.y)<.01?clearInterval(i):e.element?(a(30*o.x,30*o.y),o.x*=.8,o.y*=.8):clearInterval(i):clearInterval(i)}),10))}}},md=function(e,t){var n=this;if(void 0===t&&(t={}),"string"==typeof e&&(e=document.querySelector(e)),!e||!e.nodeName)throw new Error("no element is specified to initialize PerfectScrollbar");for(var r in this.element=e,e.classList.add("ps"),this.settings={handlers:["click-rail","drag-thumb","keyboard","wheel","touch"],maxScrollbarLength:null,minScrollbarLength:null,scrollingThreshold:1e3,scrollXMarginOffset:0,scrollYMarginOffset:0,suppressScrollX:!1,suppressScrollY:!1,swipeEasing:!0,useBothWheelAxes:!1,wheelPropagation:!0,wheelSpeed:1},t)this.settings[r]=t[r];this.containerWidth=null,this.containerHeight=null,this.contentWidth=null,this.contentHeight=null;var o,i,a=function(){return e.classList.add(Xp)},s=function(){return e.classList.remove(Xp)};this.isRtl="rtl"===Up(e).direction,!0===this.isRtl&&e.classList.add("ps__rtl"),this.isNegativeScroll=(i=e.scrollLeft,e.scrollLeft=-1,o=e.scrollLeft<0,e.scrollLeft=i,o),this.negativeScrollAdjustment=this.isNegativeScroll?e.scrollWidth-e.clientWidth:0,this.event=new ad,this.ownerDocument=e.ownerDocument||document,this.scrollbarXRail=Bp(Gp("x")),e.appendChild(this.scrollbarXRail),this.scrollbarX=Bp(Kp("x")),this.scrollbarXRail.appendChild(this.scrollbarX),this.scrollbarX.setAttribute("tabindex",0),this.event.bind(this.scrollbarX,"focus",a),this.event.bind(this.scrollbarX,"blur",s),this.scrollbarXActive=null,this.scrollbarXWidth=null,this.scrollbarXLeft=null;var l=Up(this.scrollbarXRail);this.scrollbarXBottom=parseInt(l.bottom,10),isNaN(this.scrollbarXBottom)?(this.isScrollbarXUsingBottom=!1,this.scrollbarXTop=cd(l.top)):this.isScrollbarXUsingBottom=!0,this.railBorderXWidth=cd(l.borderLeftWidth)+cd(l.borderRightWidth),Vp(this.scrollbarXRail,{display:"block"}),this.railXMarginWidth=cd(l.marginLeft)+cd(l.marginRight),Vp(this.scrollbarXRail,{display:""}),this.railXWidth=null,this.railXRatio=null,this.scrollbarYRail=Bp(Gp("y")),e.appendChild(this.scrollbarYRail),this.scrollbarY=Bp(Kp("y")),this.scrollbarYRail.appendChild(this.scrollbarY),this.scrollbarY.setAttribute("tabindex",0),this.event.bind(this.scrollbarY,"focus",a),this.event.bind(this.scrollbarY,"blur",s),this.scrollbarYActive=null,this.scrollbarYHeight=null,this.scrollbarYTop=null;var c=Up(this.scrollbarYRail);this.scrollbarYRight=parseInt(c.right,10),isNaN(this.scrollbarYRight)?(this.isScrollbarYUsingRight=!1,this.scrollbarYLeft=cd(c.left)):this.isScrollbarYUsingRight=!0,this.scrollbarYOuterWidth=this.isRtl?function(e){var t=Up(e);return cd(t.width)+cd(t.paddingLeft)+cd(t.paddingRight)+cd(t.borderLeftWidth)+cd(t.borderRightWidth)}(this.scrollbarY):null,this.railBorderYWidth=cd(c.borderTopWidth)+cd(c.borderBottomWidth),Vp(this.scrollbarYRail,{display:"block"}),this.railYMarginHeight=cd(c.marginTop)+cd(c.marginBottom),Vp(this.scrollbarYRail,{display:""}),this.railYHeight=null,this.railYRatio=null,this.reach={x:e.scrollLeft<=0?"start":e.scrollLeft>=this.contentWidth-this.containerWidth?"end":null,y:e.scrollTop<=0?"start":e.scrollTop>=this.contentHeight-this.containerHeight?"end":null},this.isAlive=!0,this.settings.handlers.forEach((function(e){return hd[e](n)})),this.lastScrollTop=Math.floor(e.scrollTop),this.lastScrollLeft=e.scrollLeft,this.event.bind(this.element,"scroll",(function(e){return n.onScroll(e)})),pd(this)};md.prototype.update=function(){this.isAlive&&(this.negativeScrollAdjustment=this.isNegativeScroll?this.element.scrollWidth-this.element.clientWidth:0,Vp(this.scrollbarXRail,{display:"block"}),Vp(this.scrollbarYRail,{display:"block"}),this.railXMarginWidth=cd(Up(this.scrollbarXRail).marginLeft)+cd(Up(this.scrollbarXRail).marginRight),this.railYMarginHeight=cd(Up(this.scrollbarYRail).marginTop)+cd(Up(this.scrollbarYRail).marginBottom),Vp(this.scrollbarXRail,{display:"none"}),Vp(this.scrollbarYRail,{display:"none"}),pd(this),ld(this,"top",0,!1,!0),ld(this,"left",0,!1,!0),Vp(this.scrollbarXRail,{display:""}),Vp(this.scrollbarYRail,{display:""}))},md.prototype.onScroll=function(e){this.isAlive&&(pd(this),ld(this,"top",this.element.scrollTop-this.lastScrollTop),ld(this,"left",this.element.scrollLeft-this.lastScrollLeft),this.lastScrollTop=Math.floor(this.element.scrollTop),this.lastScrollLeft=this.element.scrollLeft)},md.prototype.destroy=function(){this.isAlive&&(this.event.unbindAll(),Hp(this.scrollbarX),Hp(this.scrollbarY),Hp(this.scrollbarXRail),Hp(this.scrollbarYRail),this.removePsClasses(),this.element=null,this.scrollbarX=null,this.scrollbarY=null,this.scrollbarXRail=null,this.scrollbarYRail=null,this.isAlive=!1)},md.prototype.removePsClasses=function(){this.element.className=this.element.className.split(" ").filter((function(e){return!e.match(/^ps([-_].+|)$/)})).join(" ")};var gd=md,yd=Object.defineProperty,vd=Object.getOwnPropertySymbols,bd=Object.prototype.hasOwnProperty,wd=Object.prototype.propertyIsEnumerable,xd=(e,t,n)=>t in e?yd(e,t,{enumerable:!0,configurable:!0,writable:!0,value:n}):e[t]=n;const kd=gd||t;let _d="";qr&&(_d=r(3433),_d="function"==typeof _d.toString&&_d.toString()||"",_d="[object Object]"===_d?"":_d);const Od=da`${_d}`,Sd=ga.div`
position: relative;
`;class Ed extends n.Component{constructor(){super(...arguments),this.handleRef=e=>{this._container=e}}componentDidMount(){const e=this._container.parentElement&&this._container.parentElement.scrollTop||0;this.inst=new kd(this._container,this.props.options||{}),this._container.scrollTo&&this._container.scrollTo(0,e)}componentDidUpdate(){this.inst.update()}componentWillUnmount(){this.inst.destroy()}render(){const{children:e,className:t,updateFn:r}=this.props;return r&&r(this.componentDidUpdate.bind(this)),n.createElement(n.Fragment,null,_d&&n.createElement(Od,null),n.createElement(Sd,{className:`scrollbar-container ${t}`,ref:this.handleRef},e))}}function Pd(e){return n.createElement(Sa.Consumer,null,(t=>t.nativeScrollbars?n.createElement("div",{style:{overflow:"auto",overscrollBehavior:"contain",msOverflowStyle:"-ms-autohiding-scrollbar"}},e.children):n.createElement(Ed,((e,t)=>{for(var n in t||(t={}))bd.call(t,n)&&xd(e,n,t[n]);if(vd)for(var n of vd(t))wd.call(t,n)&&xd(e,n,t[n]);return e})({},e),e.children)))}const Ad=ga((({className:e,style:t})=>n.createElement("svg",{className:e,style:t,xmlns:"http://www.w3.org/2000/svg",width:"16",height:"16",viewBox:"0 0 24 24",fill:"none",stroke:"currentColor",strokeWidth:"2",strokeLinecap:"round",strokeLinejoin:"round"},n.createElement("polyline",{points:"6 9 12 15 18 9"}))))`
position: absolute;
pointer-events: none;
z-index: 1;
top: 50%;
-webkit-transform: translateY(-50%);
-ms-transform: translateY(-50%);
transform: translateY(-50%);
right: 8px;
margin: auto;
text-align: center;
polyline {
color: ${e=>"dark"===e.variant&&"white"};
}
`,$d=n.memo((e=>{const{options:t,onChange:r,placeholder:o,value:i="",variant:a,className:s}=e;return n.createElement("div",{className:s},n.createElement(Ad,{variant:a}),n.createElement("select",{onChange:e=>{const{selectedIndex:n}=e.target;r(t[o?n-1:n])},value:i,className:"dropdown-select"},o&&n.createElement("option",{disabled:!0,hidden:!0,value:o},o),t.map((({idx:e,value:t,title:r},o)=>n.createElement("option",{key:e||t+o,value:t},r||t)))),n.createElement("label",null,i))})),Cd=ca($d)`
label {
box-sizing: border-box;
min-width: 100px;
outline: none;
display: inline-block;
font-family: ${e=>e.theme.typography.headings.fontFamily};
color: ${({theme:e})=>e.colors.text.primary};
vertical-align: bottom;
width: ${({fullWidth:e})=>e?"100%":"auto"};
text-transform: none;
padding: 0 22px 0 4px;
font-size: 0.929em;
line-height: 1.5em;
font-family: inherit;
text-overflow: ellipsis;
overflow: hidden;
white-space: nowrap;
}
.dropdown-select {
position: absolute;
top: 0;
left: 0;
width: 100%;
height: 100%;
opacity: 0;
border: none;
appearance: none;
cursor: pointer;
color: ${({theme:e})=>e.colors.text.primary};
line-height: inherit;
font-family: inherit;
}
box-sizing: border-box;
min-width: 100px;
outline: none;
display: inline-block;
border-radius: 2px;
border: 1px solid rgba(38, 50, 56, 0.5);
vertical-align: bottom;
padding: 2px 0px 2px 6px;
position: relative;
width: auto;
background: white;
color: #263238;
font-family: ${e=>e.theme.typography.headings.fontFamily};
font-size: 0.929em;
line-height: 1.5em;
cursor: pointer;
transition: border 0.25s ease, color 0.25s ease, box-shadow 0.25s ease;
&:hover,
&:focus-within {
border: 1px solid ${e=>e.theme.colors.primary.main};
color: ${e=>e.theme.colors.primary.main};
box-shadow: 0px 0px 0px 1px ${e=>e.theme.colors.primary.main};
}
`,Rd=ca(Cd)`
margin-left: 10px;
text-transform: none;
font-size: 0.969em;
font-size: 1em;
border: none;
padding: 0 1.2em 0 0;
background: transparent;
&:hover,
&:focus-within {
border: none;
box-shadow: none;
label {
color: ${e=>e.theme.colors.primary.main};
text-shadow: 0px 0px 0px ${e=>e.theme.colors.primary.main};
}
}
`,jd=ca.span`
margin-left: 10px;
text-transform: none;
font-size: 0.929em;
color: black;
`;var Td=Object.defineProperty,Id=Object.defineProperties,Nd=Object.getOwnPropertyDescriptors,Dd=Object.getOwnPropertySymbols,Ld=Object.prototype.hasOwnProperty,Md=Object.prototype.propertyIsEnumerable,Fd=(e,t,n)=>t in e?Td(e,t,{enumerable:!0,configurable:!0,writable:!0,value:n}):e[t]=n,zd=(e,t)=>{for(var n in t||(t={}))Ld.call(t,n)&&Fd(e,n,t[n]);if(Dd)for(var n of Dd(t))Md.call(t,n)&&Fd(e,n,t[n]);return e},Ud=(e,t)=>Id(e,Nd(t));class Vd{constructor(e,t,n){this.operations=[];const{resolved:r}=e.deref(n||{});this.initWebhooks(e,r,t)}initWebhooks(e,t,n){for(const r of Object.keys(t)){const o=t[r],i=Object.keys(o).filter(Xa);for(const t of i){const r=o[t];if(o.$ref){const r=e.deref(o||{});this.initWebhooks(e,{[t]:r},n)}if(!r)continue;const i=new _u(e,Ud(zd({},r),{httpVerb:t}),void 0,n,!1);this.operations.push(i)}}}}class Bd{constructor(e,t,n){const{resolved:r}=e.deref(n);this.id=t,this.sectionId=hs+t,this.type=r.type,this.displayName=r["x-displayName"]||t,this.description=r.description||"","apiKey"===r.type&&(this.apiKey={name:r.name,in:r.in}),"http"===r.type&&(this.http={scheme:r.scheme,bearerFormat:r.bearerFormat}),"openIdConnect"===r.type&&(this.openId={connectUrl:r.openIdConnectUrl}),"oauth2"===r.type&&r.flows&&(this.flows=r.flows)}}class qd{constructor(e){const t=e.spec.components&&e.spec.components.securitySchemes||{};this.schemes=Object.keys(t).map((n=>new Bd(e,n,t[n])))}}var Wd=Object.defineProperty,Hd=Object.getOwnPropertySymbols,Yd=Object.prototype.hasOwnProperty,Kd=Object.prototype.propertyIsEnumerable,Gd=(e,t,n)=>t in e?Wd(e,t,{enumerable:!0,configurable:!0,writable:!0,value:n}):e[t]=n,Qd=(e,t)=>{for(var n in t||(t={}))Yd.call(t,n)&&Gd(e,n,t[n]);if(Hd)for(var n of Hd(t))Kd.call(t,n)&&Gd(e,n,t[n]);return e};class Xd{constructor(e,t,n){var r,o,i;this.options=n,this.parser=new fc(e,t,n),this.info=new Il(this.parser,this.options),this.externalDocs=this.parser.spec.externalDocs,this.contentItems=df.buildStructure(this.parser,this.options),this.securitySchemes=new qd(this.parser);const a=Qd(Qd({},null==(o=null==(r=this.parser)?void 0:r.spec)?void 0:o["x-webhooks"]),null==(i=this.parser)?void 0:i.spec.webhooks);this.webhooks=new Vd(this.parser,n,a)}}var Jd=Object.defineProperty,Zd=Object.getOwnPropertyDescriptor,ef=(e,t,n,r)=>{for(var o,i=r>1?void 0:r?Zd(t,n):t,a=e.length-1;a>=0;a--)(o=e[a])&&(i=(r?o(t,n,i):o(i))||i);return r&&i&&Jd(t,n,i),i};class tf{constructor(e,t,n){this.items=[],this.active=!1,this.expanded=!1,tn(this),this.id=t.id||e+"/"+no(t.name),this.type=e,this.name=t["x-displayName"]||t.name,this.level=t.level||1,this.sidebarLabel=this.name,this.description=t.description||"";const r=t.items;r&&r.length&&(this.description=jl.getTextBeforeHading(this.description,r[0].name)),this.parent=n,this.externalDocs=t.externalDocs,"group"===this.type&&(this.expanded=!0)}activate(){this.active=!0}expand(){this.parent&&this.parent.expand(),this.expanded=!0}collapse(){"group"!==this.type&&(this.expanded=!1)}deactivate(){this.active=!1}}ef([Ae],tf.prototype,"active",2),ef([Ae],tf.prototype,"expanded",2),ef([Pt],tf.prototype,"activate",1),ef([Pt],tf.prototype,"expand",1),ef([Pt],tf.prototype,"collapse",1),ef([Pt],tf.prototype,"deactivate",1);var nf=Object.defineProperty,rf=Object.defineProperties,of=Object.getOwnPropertyDescriptors,af=Object.getOwnPropertySymbols,sf=Object.prototype.hasOwnProperty,lf=Object.prototype.propertyIsEnumerable,cf=(e,t,n)=>t in e?nf(e,t,{enumerable:!0,configurable:!0,writable:!0,value:n}):e[t]=n,uf=(e,t)=>{for(var n in t||(t={}))sf.call(t,n)&&cf(e,n,t[n]);if(af)for(var n of af(t))lf.call(t,n)&&cf(e,n,t[n]);return e},pf=(e,t)=>rf(e,of(t));class df{static buildStructure(e,t){const n=e.spec,r=[],o=df.getTagsWithOperations(e,n);return r.push(...df.addMarkdownItems(n.info.description||"",void 0,1,t)),n["x-tagGroups"]&&n["x-tagGroups"].length>0?r.push(...df.getTagGroupsItems(e,void 0,n["x-tagGroups"],o,t)):r.push(...df.getTagsItems(e,o,void 0,void 0,t)),r}static addMarkdownItems(e,t,n,r){const o=new jl(r,null==t?void 0:t.id).extractHeadings(e||"");o.length&&t&&t.description&&(t.description=jl.getTextBeforeHading(t.description,o[0].name));const i=(e,t,n=1)=>t.map((t=>{const r=new tf("section",t,e);return r.depth=n,t.items&&(r.items=i(r,t.items,n+1)),r}));return i(t,o,n)}static getTagGroupsItems(e,t,n,r,o){const i=[];for(const a of n){const n=new tf("group",a,t);n.depth=0,n.items=df.getTagsItems(e,r,n,a,o),i.push(n)}return i}static getTagsItems(e,t,n,r,o){let i;i=void 0===r?Object.keys(t):r.tags;const a=i.map((e=>t[e]?(t[e].used=!0,t[e]):(console.warn(`Non-existing tag "${e}" is added to the group "${r.name}"`),null))),s=[];for(const t of a){if(!t)continue;const r=new tf("tag",t,n);if(r.depth=1,""!==t.name)r.items=[...df.addMarkdownItems(t.description||"",r,r.depth+1,o),...this.getOperationsItems(e,r,t,r.depth+1,o)],s.push(r);else{const n=[...df.addMarkdownItems(t.description||"",r,r.depth+1,o),...this.getOperationsItems(e,void 0,t,r.depth+1,o)];s.push(...n)}}return o.sortTagsAlphabetically&&s.sort(Cs("name")),s}static getOperationsItems(e,t,n,r,o){if(0===n.operations.length)return[];const i=[];for(const a of n.operations){const n=new _u(e,a,t,o);n.depth=r,i.push(n)}return o.sortOperationsAlphabetically&&i.sort(Cs("name")),i}static getTagsWithOperations(e,t){const n={},r=t["x-webhooks"]||t.webhooks;for(const e of t.tags||[])n[e.name]=pf(uf({},e),{operations:[]});function o(e,t,r){for(const i of Object.keys(t)){const a=t[i],s=Object.keys(a).filter(Xa);for(const t of s){const s=a[t];if(a.$ref){const{resolved:t}=e.deref(a);o(e,{[i]:t},r);continue}let l=null==s?void 0:s.tags;l&&l.length||(l=[""]);for(const e of l){let o=n[e];void 0===o&&(o={name:e,operations:[]},n[e]=o),o["x-traitTag"]||o.operations.push(pf(uf({},s),{pathName:i,pointer:Da.compile(["paths",i,t]),httpVerb:t,pathParameters:a.parameters||[],pathServers:a.servers,isWebhook:!!r}))}}}}return r&&o(e,r,!0),t.paths&&o(e,t.paths),n}}var ff=Object.defineProperty,hf=Object.getOwnPropertyDescriptor,mf=(e,t,n,r)=>{for(var o,i=r>1?void 0:r?hf(t,n):t,a=e.length-1;a>=0;a--)(o=e[a])&&(i=(r?o(t,n,i):o(i))||i);return r&&i&&ff(t,n,i),i};const gf="data-section-id";class yf{constructor(e,t,n){this.scroll=t,this.history=n,this.activeItemIdx=-1,this.sideBarOpened=!1,this.updateOnScroll=e=>{const t=e?1:-1;let n=this.activeItemIdx;for(;(-1!==n||e)&&!(n>=this.flatItems.length-1&&e);){if(e){const e=this.getElementAtOrFirstChild(n+1);if(this.scroll.isElementBellow(e))break}else{const e=this.getElementAt(n);if(this.scroll.isElementAbove(e))break}n+=t}this.activate(this.flatItems[n],!0,!0)},this.updateOnHistory=(e=this.history.currentId)=>{if(!e)return;let t;t=this.flatItems.find((t=>t.id===e)),t?this.activateAndScroll(t,!1):(e.startsWith(hs)&&(t=this.flatItems.find((e=>hs.startsWith(e.id))),this.activateAndScroll(t,!1)),this.scroll.scrollIntoViewBySelector(`[${gf}="${oo(e)}"]`))},this.getItemById=e=>this.flatItems.find((t=>t.id===e)),tn(this),this.items=e.contentItems,this.flatItems=function(e,t){const n=[],r=e=>{for(const t of e)n.push(t),t.items&&r(t.items)};return r(e),n}(this.items||[]),this.flatItems.forEach(((e,t)=>e.absoluteIdx=t)),this.subscribe()}static updateOnHistory(e=Ns.currentId,t){e&&t.scrollIntoViewBySelector(`[${gf}="${oo(e)}"]`)}subscribe(){this._unsubscribe=this.scroll.subscribe(this.updateOnScroll),this._hashUnsubscribe=this.history.subscribe(this.updateOnHistory)}toggleSidebar(){this.sideBarOpened=!this.sideBarOpened}closeSidebar(){this.sideBarOpened=!1}getElementAt(e){const t=this.flatItems[e];return t&&Wr(`[${gf}="${oo(t.id)}"]`)||null}getElementAtOrFirstChild(e){let t=this.flatItems[e];return t&&"group"===t.type&&(t=t.items[0]),t&&Wr(`[${gf}="${oo(t.id)}"]`)||null}get activeItem(){return this.flatItems[this.activeItemIdx]||void 0}activate(e,t=!0,n=!1){if((this.activeItem&&this.activeItem.id)!==(e&&e.id)&&(!e||"group"!==e.type)){if(this.deactivate(this.activeItem),!e)return this.activeItemIdx=-1,void this.history.replace("",n);e.depth<=0||(this.activeItemIdx=e.absoluteIdx,t&&this.history.replace(encodeURI(e.id),n),e.activate(),e.expand())}}deactivate(e){if(void 0!==e)for(e.deactivate();void 0!==e;)e.collapse(),e=e.parent}activateAndScroll(e,t,n){const r=e&&this.getItemById(e.id)||e;this.activate(r,t,n),this.scrollToActive(),r&&r.items.length||this.closeSidebar()}scrollToActive(){this.scroll.scrollIntoView(this.getElementAt(this.activeItemIdx))}dispose(){this._unsubscribe(),this._hashUnsubscribe()}}mf([Ae],yf.prototype,"activeItemIdx",2),mf([Ae],yf.prototype,"sideBarOpened",2),mf([Pt],yf.prototype,"toggleSidebar",1),mf([Pt],yf.prototype,"closeSidebar",1),mf([Pt],yf.prototype,"activate",1),mf([Pt.bound],yf.prototype,"activateAndScroll",1);var vf=Object.defineProperty,bf=Object.getOwnPropertyDescriptor;const wf="scroll";class xf{constructor(e){this.options=e,this._prevOffsetY=0,this._scrollParent=qr?window:void 0,this._emiter=new ja,this.bind()}bind(){this._prevOffsetY=this.scrollY(),this._scrollParent&&this._scrollParent.addEventListener("scroll",this.handleScroll)}dispose(){this._scrollParent&&this._scrollParent.removeEventListener("scroll",this.handleScroll),this._emiter.removeAllListeners(wf)}scrollY(){return"undefined"!=typeof HTMLElement&&this._scrollParent instanceof HTMLElement?this._scrollParent.scrollTop:void 0!==this._scrollParent?this._scrollParent.pageYOffset:0}isElementBellow(e){if(null!==e)return e.getBoundingClientRect().top>this.options.scrollYOffset()}isElementAbove(e){if(null===e)return;const t=e.getBoundingClientRect().top;return(t>0?Math.floor(t):Math.ceil(t))<=this.options.scrollYOffset()}subscribe(e){const t=this._emiter.addListener(wf,e);return()=>t.removeListener(wf,e)}scrollIntoView(e){null!==e&&(e.scrollIntoView(),this._scrollParent&&this._scrollParent.scrollBy&&this._scrollParent.scrollBy(0,1-this.options.scrollYOffset()))}scrollIntoViewBySelector(e){const t=Wr(e);this.scrollIntoView(t)}handleScroll(){const e=this.scrollY()-this._prevOffsetY>0;this._prevOffsetY=this.scrollY(),this._emiter.emit(wf,e)}}((e,t,n,r)=>{for(var o,i=bf(t,n),a=e.length-1;a>=0;a--)(o=e[a])&&(i=o(t,n,i)||i);i&&vf(t,n,i)})([Ra.bind,(100,(e,t,n)=>{n.value=function(e,t){let n,r,o,i=null,a=0;const s=()=>{a=(new Date).getTime(),i=null,o=e.apply(n,r),i||(n=r=null)};return function(){const l=(new Date).getTime(),c=t-(l-a);return n=this,r=arguments,c<=0||c>t?(i&&(clearTimeout(i),i=null),a=l,o=e.apply(n,r),i||(n=r=null)):i||(i=setTimeout(s,c)),o}}(n.value,100)})],xf.prototype,"handleScroll");class kf{constructor(){this.searchWorker=function(){let e;if(qr)try{e=r(6980)}catch(t){e=r(4798).default}else e=r(4798).default;return new e}()}indexItems(e){const t=e=>{e.forEach((e=>{"group"!==e.type&&this.add(e.name,(e.description||"").concat(" ",e.path||""),e.id),t(e.items)}))};t(e),this.searchWorker.done()}add(e,t,n){this.searchWorker.add(e,t,n)}dispose(){this.searchWorker.terminate(),this.searchWorker.dispose()}search(e){return this.searchWorker.search(e)}toJS(){return e=this,null,t=function*(){return this.searchWorker.toJS()},new Promise(((n,r)=>{var o=e=>{try{a(t.next(e))}catch(e){r(e)}},i=e=>{try{a(t.throw(e))}catch(e){r(e)}},a=e=>e.done?n(e.value):Promise.resolve(e.value).then(o,i);a((t=t.apply(e,null)).next())}));var e,t}load(e){this.searchWorker.load(e)}fromExternalJS(e,t){e&&t&&this.searchWorker.fromExternalJS(e,t)}}var _f=Object.defineProperty,Of=Object.getOwnPropertySymbols,Sf=Object.prototype.hasOwnProperty,Ef=Object.prototype.propertyIsEnumerable,Pf=(e,t,n)=>t in e?_f(e,t,{enumerable:!0,configurable:!0,writable:!0,value:n}):e[t]=n;function Af(e){const{Label:t=jd,Dropdown:r=Rd}=e;return 1===e.options.length?n.createElement(t,null,e.options[0].value):n.createElement(r,((e,t)=>{for(var n in t||(t={}))Sf.call(t,n)&&Pf(e,n,t[n]);if(Of)for(var n of Of(t))Ef.call(t,n)&&Pf(e,n,t[n]);return e})({},e))}var $f=r(7856);const Cf=pa`
a {
text-decoration: ${e=>e.theme.typography.links.textDecoration};
color: ${e=>e.theme.typography.links.color};
&:visited {
color: ${e=>e.theme.typography.links.visited};
}
&:hover {
color: ${e=>e.theme.typography.links.hover};
text-decoration: ${e=>e.theme.typography.links.hoverTextDecoration};
}
}
`,Rf=ga(Lp)`
font-family: ${e=>e.theme.typography.fontFamily};
font-weight: ${e=>e.theme.typography.fontWeightRegular};
line-height: ${e=>e.theme.typography.lineHeight};
p {
&:last-child {
margin-bottom: 0;
}
}
${({compact:e})=>e&&"\n p:first-child {\n margin-top: 0;\n }\n p:last-child {\n margin-bottom: 0;\n }\n "}
${({inline:e})=>e&&" p {\n display: inline-block;\n }"}
h1 {
${Cu(1)};
color: ${e=>e.theme.colors.primary.main};
margin-top: 0;
}
h2 {
${Cu(2)};
color: ${e=>e.theme.colors.text.primary};
}
code {
color: ${({theme:e})=>e.typography.code.color};
background-color: ${({theme:e})=>e.typography.code.backgroundColor};
font-family: ${e=>e.theme.typography.code.fontFamily};
border-radius: 2px;
border: 1px solid rgba(38, 50, 56, 0.1);
padding: 0 ${({theme:e})=>e.spacing.unit}px;
font-size: ${e=>e.theme.typography.code.fontSize};
font-weight: ${({theme:e})=>e.typography.code.fontWeight};
word-break: break-word;
}
pre {
font-family: ${e=>e.theme.typography.code.fontFamily};
white-space: ${({theme:e})=>e.typography.code.wrap?"pre-wrap":"pre"};
background-color: ${({theme:e})=>e.codeBlock.backgroundColor};
color: white;
padding: ${e=>4*e.theme.spacing.unit}px;
overflow-x: auto;
line-height: normal;
border-radius: 0px;
border: 1px solid rgba(38, 50, 56, 0.1);
code {
background-color: transparent;
color: white;
padding: 0;
&:before,
&:after {
content: none;
}
}
}
blockquote {
margin: 0;
margin-bottom: 1em;
padding: 0 15px;
color: #777;
border-left: 4px solid #ddd;
}
img {
max-width: 100%;
box-sizing: content-box;
}
ul,
ol {
padding-left: 2em;
margin: 0;
margin-bottom: 1em;
ul,
ol {
margin-bottom: 0;
margin-top: 0;
}
}
table {
display: block;
width: 100%;
overflow: auto;
word-break: normal;
word-break: keep-all;
border-collapse: collapse;
border-spacing: 0;
margin-top: 1.5em;
margin-bottom: 1.5em;
}
table tr {
background-color: #fff;
border-top: 1px solid #ccc;
&:nth-child(2n) {
background-color: ${({theme:e})=>e.schema.nestedBackground};
}
}
table th,
table td {
padding: 6px 13px;
border: 1px solid #ddd;
}
table th {
text-align: left;
font-weight: bold;
}
${Fu(".share-link")};
${Cf}
${ya("Markdown")};
`;var jf=Object.defineProperty,Tf=Object.getOwnPropertySymbols,If=Object.prototype.hasOwnProperty,Nf=Object.prototype.propertyIsEnumerable,Df=(e,t,n)=>t in e?jf(e,t,{enumerable:!0,configurable:!0,writable:!0,value:n}):e[t]=n;const Lf=Rf.withComponent("span");function Mf(e){const t=e.inline?Lf:Rf;return n.createElement(Pa,null,(r=>{return n.createElement(t,((e,t)=>{for(var n in t||(t={}))If.call(t,n)&&Df(e,n,t[n]);if(Tf)for(var n of Tf(t))Nf.call(t,n)&&Df(e,n,t[n]);return e})({className:"redoc-markdown "+(e.className||""),dangerouslySetInnerHTML:{__html:(o=r.untrustedSpec,i=e.html,o?$f.sanitize(i):i)},"data-role":e["data-role"]},e));var o,i}))}class Ff extends n.Component{render(){const{source:e,inline:t,compact:r,className:o,"data-role":i}=this.props,a=new jl;return n.createElement(Mf,{html:a.renderMd(e),inline:t,compact:r,className:o,"data-role":i})}}const zf=ga.div`
position: relative;
`,Uf=ga.div`
position: absolute;
min-width: 80px;
max-width: 500px;
background: #fff;
bottom: 100%;
left: 50%;
margin-bottom: 10px;
transform: translateX(-50%);
border-radius: 4px;
padding: 0.3em 0.6em;
text-align: center;
box-shadow: 0px 0px 5px 0px rgba(204, 204, 204, 1);
`,Vf=ga.div`
background: #fff;
color: #000;
display: inline;
font-size: 0.85em;
white-space: nowrap;
`,Bf=ga.div`
position: absolute;
width: 0;
height: 0;
bottom: -5px;
left: 50%;
margin-left: -5px;
border-left: solid transparent 5px;
border-right: solid transparent 5px;
border-top: solid #fff 5px;
`,qf=ga.div`
position: absolute;
width: 100%;
height: 20px;
bottom: -20px;
`;class Wf extends n.Component{render(){const{open:e,title:t,children:r}=this.props;return n.createElement(zf,null,r,e&&n.createElement(Uf,null,n.createElement(Vf,null,t),n.createElement(Bf,null),n.createElement(qf,null)))}}const Hf="undefined"!=typeof document&&document.queryCommandSupported&&document.queryCommandSupported("copy");class Yf{static isSupported(){return Hf}static selectElement(e){let t,n;document.body.createTextRange?(t=document.body.createTextRange(),t.moveToElementText(e),t.select()):document.createRange&&window.getSelection&&(n=window.getSelection(),t=document.createRange(),t.selectNodeContents(e),n.removeAllRanges(),n.addRange(t))}static deselect(){if(document.selection)document.selection.empty();else if(window.getSelection){const e=window.getSelection();e&&e.removeAllRanges()}}static copySelected(){let e;try{e=document.execCommand("copy")}catch(t){e=!1}return e}static copyElement(e){Yf.selectElement(e);const t=Yf.copySelected();return t&&Yf.deselect(),t}static copyCustom(e){const t=document.createElement("textarea");t.style.position="fixed",t.style.top="0",t.style.left="0",t.style.width="2em",t.style.height="2em",t.style.padding="0",t.style.border="none",t.style.outline="none",t.style.boxShadow="none",t.style.background="transparent",t.value=e,document.body.appendChild(t),t.select();const n=Yf.copySelected();return document.body.removeChild(t),n}}const Kf=e=>{const[t,r]=n.useState(!1),o=()=>{const t="string"==typeof e.data?e.data:JSON.stringify(e.data,null,2);Yf.copyCustom(t),i()},i=()=>{r(!0),setTimeout((()=>{r(!1)}),1500)};return e.children({renderCopyButton:()=>n.createElement("button",{onClick:o},n.createElement(Wf,{title:Yf.isSupported()?"Copied":"Not supported in your browser",open:t},"Copy"))})};let Gf=1;function Qf(e,t){Gf=1;let n="";return n+='<div class="redoc-json">',n+="<code>",n+=th(e,t),n+="</code>",n+="</div>",n}function Xf(e){return void 0!==e?e.toString().replace(/&/g,"&").replace(/"/g,""").replace(/</g,"<").replace(/>/g,">"):""}function Jf(e){return JSON.stringify(e).slice(1,-1)}function Zf(e,t){return'<span class="'+t+'">'+Xf(e)+"</span>"}function eh(e){return'<span class="token punctuation">'+e+"</span>"}function th(e,t){const n=typeof e;let r="";return null==e?r+=Zf("null","token keyword"):e&&e.constructor===Array?(Gf++,r+=function(e,t){const n=Gf>t?"collapsed":"";let r=`<button class="collapser" aria-label="${Gf>t+1?"expand":"collapse"}"></button>${eh("[")}<span class="ellipsis"></span><ul class="array collapsible">`,o=!1;const i=e.length;for(let a=0;a<i;a++)o=!0,r+='<li><div class="hoverable '+n+'">',r+=th(e[a],t),a<i-1&&(r+=","),r+="</div></li>";return r+=`</ul>${eh("]")}`,o||(r=eh("[ ]")),r}(e,t),Gf--):e&&e.constructor===Date?r+=Zf('"'+e.toISOString()+'"',"token string"):"object"===n?(Gf++,r+=function(e,t){const n=Gf>t?"collapsed":"",r=Object.keys(e),o=r.length;let i=`<button class="collapser" aria-label="${Gf>t+1?"expand":"collapse"}"></button>${eh("{")}<span class="ellipsis"></span><ul class="obj collapsible">`,a=!1;for(let s=0;s<o;s++){const l=r[s];a=!0,i+='<li><div class="hoverable '+n+'">',i+='<span class="property token string">"'+Xf(l)+'"</span>: ',i+=th(e[l],t),s<o-1&&(i+=eh(",")),i+="</div></li>"}return i+=`</ul>${eh("}")}`,a||(i=eh("{ }")),i}(e,t),Gf--):"number"===n?r+=Zf(e,"token number"):"string"===n?/^(http|https):\/\/[^\s]+$/.test(e)?r+=Zf('"',"token string")+'<a href="'+encodeURI(e)+'">'+Xf(Jf(e))+"</a>"+Zf('"',"token string"):r+=Zf('"'+Jf(e)+'"',"token string"):"boolean"===n&&(r+=Zf(e,"token boolean")),r}const nh=pa`
.redoc-json code > .collapser {
display: none;
pointer-events: none;
}
font-family: ${e=>e.theme.typography.code.fontFamily};
font-size: ${e=>e.theme.typography.code.fontSize};
white-space: ${({theme:e})=>e.typography.code.wrap?"pre-wrap":"pre"};
contain: content;
overflow-x: auto;
.callback-function {
color: gray;
}
.collapser:after {
content: '-';
cursor: pointer;
}
.collapsed > .collapser:after {
content: '+';
cursor: pointer;
}
.ellipsis:after {
content: ' … ';
}
.collapsible {
margin-left: 2em;
}
.hoverable {
padding-top: 1px;
padding-bottom: 1px;
padding-left: 2px;
padding-right: 2px;
border-radius: 2px;
}
.hovered {
background-color: rgba(235, 238, 249, 1);
}
.collapser {
background-color: transparent;
border: 0;
color: #fff;
font-family: ${e=>e.theme.typography.code.fontFamily};
font-size: ${e=>e.theme.typography.code.fontSize};
padding-right: 6px;
padding-left: 6px;
padding-top: 0;
padding-bottom: 0;
display: flex;
align-items: center;
justify-content: center;
width: 15px;
height: 15px;
position: absolute;
top: 4px;
left: -1.5em;
cursor: default;
user-select: none;
-webkit-user-select: none;
padding: 2px;
&:focus {
outline-color: #fff;
outline-style: dotted;
outline-width: 1px;
}
}
ul {
list-style-type: none;
padding: 0px;
margin: 0px 0px 0px 26px;
}
li {
position: relative;
display: block;
}
.hoverable {
display: inline-block;
}
.selected {
outline-style: solid;
outline-width: 1px;
outline-style: dotted;
}
.collapsed > .collapsible {
display: none;
}
.ellipsis {
display: none;
}
.collapsed > .ellipsis {
display: inherit;
}
`,rh=ga.div`
&:hover > ${Mp} {
opacity: 1;
}
`,oh=ga((e=>{const[t,r]=n.useState(),o=({renderCopyButton:t})=>{const o=e.data&&Object.values(e.data).some((e=>"object"==typeof e&&null!==e));return n.createElement(rh,null,n.createElement(Mp,null,t(),o&&n.createElement(n.Fragment,null,n.createElement("button",{onClick:i}," Expand all "),n.createElement("button",{onClick:a}," Collapse all "))),n.createElement(Sa.Consumer,null,(t=>n.createElement(Lp,{className:e.className,ref:e=>r(e),dangerouslySetInnerHTML:{__html:Qf(e.data,t.jsonSampleExpandLevel)}}))))},i=()=>{const e=null==t?void 0:t.getElementsByClassName("collapsible");for(const t of Array.prototype.slice.call(e)){const e=t.parentNode;e.classList.remove("collapsed"),e.querySelector(".collapser").setAttribute("aria-label","collapse")}},a=()=>{const e=null==t?void 0:t.getElementsByClassName("collapsible"),n=Array.prototype.slice.call(e,1);for(const e of n){const t=e.parentNode;t.classList.add("collapsed"),t.querySelector(".collapser").setAttribute("aria-label","expand")}},s=e=>{let t;"collapser"===e.className&&(t=e.parentElement.getElementsByClassName("collapsible")[0],t.parentElement.classList.contains("collapsed")?(t.parentElement.classList.remove("collapsed"),e.setAttribute("aria-label","collapse")):(t.parentElement.classList.add("collapsed"),e.setAttribute("aria-label","expand")))},l=n.useCallback((e=>{s(e.target)}),[]),c=n.useCallback((e=>{"Enter"===e.key&&s(e.target)}),[]);return n.useEffect((()=>(null==t||t.addEventListener("click",l),null==t||t.addEventListener("focus",c),()=>{null==t||t.removeEventListener("click",l),null==t||t.removeEventListener("focus",c)})),[l,c,t]),n.createElement(Kf,{data:e.data},o)}))`
${nh};
`,ih=e=>{const{source:t,lang:r}=e;return n.createElement(zp,{dangerouslySetInnerHTML:{__html:vs(t,r)}})},ah=e=>{const{source:t,lang:r}=e;return n.createElement(Kf,{data:t},(({renderCopyButton:e})=>n.createElement(Fp,null,n.createElement(Mp,null,e()),n.createElement(ih,{lang:r,source:t}))))};function sh({value:e,mimeType:t}){return es(t)?n.createElement(oh,{data:e}):("object"==typeof e&&(e=JSON.stringify(e,null,2)),n.createElement(ah,{lang:(r=t,-1!==r.search(/xml/i)?"xml":-1!==r.search(/csv/i)?"csv":-1!==r.search(/plain/i)?"tex":"clike"),source:e}));var r}function lh({example:e,mimeType:t}){return void 0===e.value&&e.externalValueUrl?n.createElement(ch,{example:e,mimeType:t}):n.createElement(sh,{value:e.value,mimeType:t})}function ch({example:e,mimeType:t}){const r=function(e,t){const[,r]=(0,n.useState)(!0),o=(0,n.useRef)(void 0),i=(0,n.useRef)(void 0);return i.current!==e&&(o.current=void 0),i.current=e,(0,n.useEffect)((()=>{(()=>{return n=this,i=function*(){r(!0);try{o.current=yield e.getExternalValue(t)}catch(e){o.current=e}r(!1)},new Promise(((e,t)=>{var r=e=>{try{a(i.next(e))}catch(e){t(e)}},o=e=>{try{a(i.throw(e))}catch(e){t(e)}},a=t=>t.done?e(t.value):Promise.resolve(t.value).then(r,o);a((i=i.apply(n,null)).next())}));var n,i})()}),[e,t]),o.current}(e,t);return void 0===r?n.createElement("span",null,"Loading..."):r instanceof Error?n.createElement(zp,null,"Error loading external example: ",n.createElement("br",null),n.createElement("a",{className:"token string",href:e.externalValueUrl,target:"_blank",rel:"noopener noreferrer"},e.externalValueUrl)):n.createElement(sh,{value:r,mimeType:t})}const uh=ga.div`
padding: 0.9em;
background-color: ${({theme:e})=>Ur(.6,e.rightPanel.backgroundColor)};
margin: 0 0 10px 0;
display: block;
font-family: ${({theme:e})=>e.typography.headings.fontFamily};
font-size: 0.929em;
line-height: 1.5em;
`,ph=ga.span`
font-family: ${({theme:e})=>e.typography.headings.fontFamily};
font-size: 12px;
position: absolute;
z-index: 1;
top: -11px;
left: 12px;
font-weight: ${({theme:e})=>e.typography.fontWeightBold};
color: ${({theme:e})=>Ur(.3,e.rightPanel.textColor)};
`,dh=ga.div`
position: relative;
`,fh=ga(Cd)`
label {
color: ${({theme:e})=>e.rightPanel.textColor};
text-overflow: ellipsis;
white-space: nowrap;
overflow: hidden;
font-size: 1em;
text-transform: none;
border: none;
}
margin: 0 0 10px 0;
display: block;
background-color: ${({theme:e})=>Ur(.6,e.rightPanel.backgroundColor)};
border: none;
padding: 0.9em 1.6em 0.9em 0.9em;
box-shadow: none;
&:hover,
&:focus-within {
border: none;
box-shadow: none;
background-color: ${({theme:e})=>Ur(.3,e.rightPanel.backgroundColor)};
}
`,hh=ga.div`
font-family: ${e=>e.theme.typography.code.fontFamily};
font-size: 12px;
color: #ee807f;
`;class mh extends n.Component{constructor(){super(...arguments),this.state={activeIdx:0},this.switchMedia=({idx:e})=>{void 0!==e&&this.setState({activeIdx:e})}}render(){const{activeIdx:e}=this.state,t=this.props.mediaType.examples||{},r=this.props.mediaType.name,o=n.createElement(hh,null,"No sample"),i=Object.keys(t);if(0===i.length)return o;if(i.length>1){const o=i.map(((e,n)=>({value:t[e].summary||e,idx:n}))),a=t[i[e]],s=a.description;return n.createElement(gh,null,n.createElement(dh,null,n.createElement(ph,null,"Example"),this.props.renderDropdown({value:o[e].value,options:o,onChange:this.switchMedia,ariaLabel:"Example"})),n.createElement("div",null,s&&n.createElement(Ff,{source:s}),n.createElement(lh,{example:a,mimeType:r})))}{const e=t[i[0]];return n.createElement(gh,null,e.description&&n.createElement(Ff,{source:e.description}),n.createElement(lh,{example:e,mimeType:r}))}}}const gh=ga.div`
margin-top: 15px;
`;if(!n.useState)throw new Error("mobx-react-lite requires React with Hooks support");if(!tn)throw new Error("mobx-react-lite@3 requires mobx at least version 6 to be available");function yh(e){e()}var vh=[];function bh(e){return Dt(Bn(e,t));var t}var wh="undefined"==typeof FinalizationRegistry?void 0:FinalizationRegistry;function xh(e){return{reaction:e,mounted:!1,changedBeforeMount:!1,cleanAt:Date.now()+kh}}var kh=1e4,_h=wh?function(e){var t=new Map,n=1,r=new e((function(e){var n=t.get(e);n&&(n.reaction.dispose(),t.delete(e))}));return{addReactionToTrack:function(e,o,i){var a=n++;return r.register(i,a,e),e.current=xh(o),e.current.finalizationRegistryCleanupToken=a,t.set(a,e.current),e.current},recordReactionAsCommitted:function(e){r.unregister(e),e.current&&e.current.finalizationRegistryCleanupToken&&t.delete(e.current.finalizationRegistryCleanupToken)},forceCleanupTimerToRunNowForTests:function(){},resetCleanupScheduleForTests:function(){}}}(wh):function(){var e,t=new Set;function n(){void 0===e&&(e=setTimeout(r,1e4))}function r(){e=void 0;var r=Date.now();t.forEach((function(e){var n=e.current;n&&r>=n.cleanAt&&(n.reaction.dispose(),e.current=null,t.delete(e))})),t.size>0&&n()}return{addReactionToTrack:function(e,r,o){var i;return e.current=xh(r),i=e,t.add(i),n(),e.current},recordReactionAsCommitted:function(e){t.delete(e)},forceCleanupTimerToRunNowForTests:function(){e&&(clearTimeout(e),r())},resetCleanupScheduleForTests:function(){var n,r;if(t.size>0){try{for(var o=function(e){var t="function"==typeof Symbol&&Symbol.iterator,n=t&&e[t],r=0;if(n)return n.call(e);if(e&&"number"==typeof e.length)return{next:function(){return e&&r>=e.length&&(e=void 0),{value:e&&e[r++],done:!e}}};throw new TypeError(t?"Object is not iterable.":"Symbol.iterator is not defined.")}(t),i=o.next();!i.done;i=o.next()){var a=i.value,s=a.current;s&&(s.reaction.dispose(),a.current=null)}}catch(e){n={error:e}}finally{try{i&&!i.done&&(r=o.return)&&r.call(o)}finally{if(n)throw n.error}}t.clear()}e&&(clearTimeout(e),e=void 0)}}}(),Oh=_h.addReactionToTrack,Sh=_h.recordReactionAsCommitted,Eh=(_h.resetCleanupScheduleForTests,_h.forceCleanupTimerToRunNowForTests,!1);function Ph(){return Eh}function Ah(e){return"observer"+e}var $h=function(){};function Ch(e,t){if(void 0===t&&(t="observed"),Ph())return e();var r,o=function(e,t){var n="function"==typeof Symbol&&e[Symbol.iterator];if(!n)return e;var r,o,i=n.call(e),a=[];try{for(;(void 0===t||t-- >0)&&!(r=i.next()).done;)a.push(r.value)}catch(e){o={error:e}}finally{try{r&&!r.done&&(n=i.return)&&n.call(i)}finally{if(o)throw o.error}}return a}(n.useState(new $h),1)[0],i=(r=function(e,t){var n="function"==typeof Symbol&&e[Symbol.iterator];if(!n)return e;var r,o,i=n.call(e),a=[];try{for(;(void 0===t||t-- >0)&&!(r=i.next()).done;)a.push(r.value)}catch(e){o={error:e}}finally{try{r&&!r.done&&(n=i.return)&&n.call(i)}finally{if(o)throw o.error}}return a}((0,n.useState)(0),2)[1],(0,n.useCallback)((function(){r((function(e){return e+1}))}),vh)),a=n.useRef(null);if(!a.current)var s=new mt(Ah(t),(function(){l.mounted?i():l.changedBeforeMount=!0})),l=Oh(a,s,o);var c,u,p=a.current.reaction;if(n.useDebugValue(p,bh),n.useEffect((function(){return Sh(a),a.current?(a.current.mounted=!0,a.current.changedBeforeMount&&(a.current.changedBeforeMount=!1,i())):(a.current={reaction:new mt(Ah(t),(function(){i()})),mounted:!0,changedBeforeMount:!1,cleanAt:1/0},i()),function(){a.current.reaction.dispose(),a.current=null}}),[]),p.track((function(){try{c=e()}catch(e){u=e}})),u)throw u;return c}var Rh=function(){return Rh=Object.assign||function(e){for(var t,n=1,r=arguments.length;n<r;n++)for(var o in t=arguments[n])Object.prototype.hasOwnProperty.call(t,o)&&(e[o]=t[o]);return e},Rh.apply(this,arguments)};var jh={$$typeof:!0,render:!0,compare:!0,type:!0};function Th(e){var t=e.children,n=e.render,r=t||n;return"function"!=typeof r?null:Ch(r)}Th.displayName="Observer",function(e){e||(e=yh),Nt({reactionScheduler:e})}(i.unstable_batchedUpdates);var Ih=0,Nh={};function Dh(e){return Nh[e]||(Nh[e]=function(e){if("function"==typeof Symbol)return Symbol(e);var t="__$mobx-react "+e+" ("+Ih+")";return Ih++,t}(e)),Nh[e]}function Lh(e,t){if(Mh(e,t))return!0;if("object"!=typeof e||null===e||"object"!=typeof t||null===t)return!1;var n=Object.keys(e),r=Object.keys(t);if(n.length!==r.length)return!1;for(var o=0;o<n.length;o++)if(!Object.hasOwnProperty.call(t,n[o])||!Mh(e[n[o]],t[n[o]]))return!1;return!0}function Mh(e,t){return e===t?0!==e||1/e==1/t:e!=e&&t!=t}function Fh(e,t,n){Object.hasOwnProperty.call(e,t)?e[t]=n:Object.defineProperty(e,t,{enumerable:!1,configurable:!0,writable:!0,value:n})}var zh=Dh("patchMixins"),Uh=Dh("patchedDefinition");function Vh(e,t){for(var n=this,r=arguments.length,o=new Array(r>2?r-2:0),i=2;i<r;i++)o[i-2]=arguments[i];t.locks++;try{var a;return null!=e&&(a=e.apply(this,o)),a}finally{t.locks--,0===t.locks&&t.methods.forEach((function(e){e.apply(n,o)}))}}function Bh(e,t){return function(){for(var n=arguments.length,r=new Array(n),o=0;o<n;o++)r[o]=arguments[o];Vh.call.apply(Vh,[this,e,t].concat(r))}}function qh(e,t,n){var r=function(e,t){var n=e[zh]=e[zh]||{},r=n[t]=n[t]||{};return r.locks=r.locks||0,r.methods=r.methods||[],r}(e,t);r.methods.indexOf(n)<0&&r.methods.push(n);var o=Object.getOwnPropertyDescriptor(e,t);if(!o||!o[Uh]){var i=e[t],a=Wh(e,t,o?o.enumerable:void 0,r,i);Object.defineProperty(e,t,a)}}function Wh(e,t,n,r,o){var i,a=Bh(o,r);return(i={})[Uh]=!0,i.get=function(){return a},i.set=function(o){if(this===e)a=Bh(o,r);else{var i=Wh(this,t,n,r,o);Object.defineProperty(this,t,i)}},i.configurable=!0,i.enumerable=n,i}var Hh=W||"$mobx",Yh=Dh("isMobXReactObserver"),Kh=Dh("isUnmounted"),Gh=Dh("skipRender"),Qh=Dh("isForcingUpdate");function Xh(e){var t=e.prototype;if(e[Yh]){var r=Jh(t);console.warn("The provided component class ("+r+") \n has already been declared as an observer component.")}else e[Yh]=!0;if(t.componentWillReact)throw new Error("The componentWillReact life-cycle event is no longer supported");if(e.__proto__!==n.PureComponent)if(t.shouldComponentUpdate){if(t.shouldComponentUpdate!==em)throw new Error("It is not allowed to use shouldComponentUpdate in observer based components.")}else t.shouldComponentUpdate=em;tm(t,"props"),tm(t,"state");var o=t.render;return t.render=function(){return Zh.call(this,o)},qh(t,"componentWillUnmount",(function(){var e;if(!0!==Ph()&&(null==(e=this.render[Hh])||e.dispose(),this[Kh]=!0,!this.render[Hh])){var t=Jh(this);console.warn("The reactive render of an observer class component ("+t+") \n was overriden after MobX attached. This may result in a memory leak if the \n overriden reactive render was not properly disposed.")}})),e}function Jh(e){return e.displayName||e.name||e.constructor&&(e.constructor.displayName||e.constructor.name)||"<component>"}function Zh(e){var t=this;if(!0===Ph())return e.call(this);Fh(this,Gh,!1),Fh(this,Qh,!1);var r=Jh(this),o=e.bind(this),i=!1,a=new mt(r+".render()",(function(){if(!i&&(i=!0,!0!==t[Kh])){var e=!0;try{Fh(t,Qh,!0),t[Gh]||n.Component.prototype.forceUpdate.call(t),e=!1}finally{Fh(t,Qh,!1),e&&a.dispose()}}}));function s(){i=!1;var e=void 0,t=void 0;if(a.track((function(){try{t=function(e,t){var n=ze(e);try{return t()}finally{Ue(n)}}(!1,o)}catch(t){e=t}})),e)throw e;return t}return a.reactComponent=this,s[Hh]=a,this.render=s,s.call(this)}function em(e,t){return Ph()&&console.warn("[mobx-react] It seems that a re-rendering of a React component is triggered while in static (server-side) mode. Please make sure components are rendered only once server-side."),this.state!==t||!Lh(this.props,e)}function tm(e,t){var n=Dh("reactProp_"+t+"_valueHolder"),r=Dh("reactProp_"+t+"_atomHolder");function o(){return this[r]||Fh(this,r,K("reactive "+t)),this[r]}Object.defineProperty(e,t,{configurable:!0,enumerable:!0,get:function(){var e=!1;return nt&&rt&&(e=nt(!0)),o.call(this).reportObserved(),nt&&rt&&rt(e),this[n]},set:function(e){this[Qh]||Lh(this[n],e)?Fh(this,n,e):(Fh(this,n,e),Fh(this,Gh,!0),o.call(this).reportChanged(),Fh(this,Gh,!1))}})}var nm="function"==typeof Symbol&&Symbol.for,rm=nm?Symbol.for("react.forward_ref"):"function"==typeof n.forwardRef&&(0,n.forwardRef)((function(e){return null})).$$typeof,om=nm?Symbol.for("react.memo"):"function"==typeof n.memo&&(0,n.memo)((function(e){return null})).$$typeof;function im(e){if(!0===e.isMobxInjector&&console.warn("Mobx observer: You are trying to use 'observer' on a component that already has 'inject'. Please apply 'observer' before applying 'inject'"),om&&e.$$typeof===om)throw new Error("Mobx observer: You are trying to use 'observer' on a function component wrapped in either another observer or 'React.memo'. The observer already applies 'React.memo' for you.");if(rm&&e.$$typeof===rm){var t=e.render;if("function"!=typeof t)throw new Error("render property of ForwardRef was not a function");return(0,n.forwardRef)((function(){var e=arguments;return(0,n.createElement)(Th,null,(function(){return t.apply(void 0,e)}))}))}return"function"!=typeof e||e.prototype&&e.prototype.render||e.isReactClass||Object.prototype.isPrototypeOf.call(n.Component,e)?Xh(e):function(e,t){if(Ph())return e;var r,o,i,a=Rh({forwardRef:!1},t),s=e.displayName||e.name,l=function(t,n){return Ch((function(){return e(t,n)}),s)};return l.displayName=s,r=a.forwardRef?(0,n.memo)((0,n.forwardRef)(l)):(0,n.memo)(l),o=e,i=r,Object.keys(o).forEach((function(e){jh[e]||Object.defineProperty(i,e,Object.getOwnPropertyDescriptor(o,e))})),r.displayName=s,r}(e)}if(!n.Component)throw new Error("mobx-react requires React to be available");if(!Ae)throw new Error("mobx-react requires mobx to be available");const am=ga(Gu)`
button {
background-color: transparent;
border: 0;
outline: 0;
font-size: 13px;
font-family: ${e=>e.theme.typography.code.fontFamily};
cursor: pointer;
padding: 0;
color: ${e=>e.theme.colors.text.primary};
&:focus {
font-weight: ${({theme:e})=>e.typography.fontWeightBold};
}
${({kind:e})=>"patternProperties"===e&&pa`
display: inline-flex;
margin-right: 20px;
> span.property-name {
white-space: break-spaces;
text-align: left;
::before,
::after {
content: '/';
filter: opacity(0.2);
}
}
> svg {
align-self: center;
}
`}
}
${Bu} {
height: ${({theme:e})=>e.schema.arrow.size};
width: ${({theme:e})=>e.schema.arrow.size};
polygon {
fill: ${({theme:e})=>e.schema.arrow.color};
}
}
`,sm=ga.span`
vertical-align: middle;
font-size: ${({theme:e})=>e.typography.code.fontSize};
line-height: 20px;
`,lm=ga(sm)`
color: ${e=>Ur(.1,e.theme.schema.typeNameColor)};
`,cm=ga(sm)`
color: ${e=>e.theme.schema.typeNameColor};
`,um=ga(sm)`
color: ${e=>e.theme.schema.typeTitleColor};
word-break: break-word;
`,pm=cm,dm=ga(sm.withComponent("div"))`
color: ${e=>e.theme.schema.requireLabelColor};
font-size: ${e=>e.theme.schema.labelsTextSize};
font-weight: normal;
margin-left: 20px;
line-height: 1;
`,fm=ga(dm)`
color: ${e=>e.theme.colors.primary.light};
`,hm=ga(sm)`
color: ${({theme:e})=>e.colors.warning.main};
font-size: 13px;
`,mm=ga(sm)`
color: #0e7c86;
&::before,
&::after {
font-weight: bold;
}
`,gm=ga(sm)`
border-radius: 2px;
word-break: break-word;
${({theme:e})=>`\n background-color: ${Ur(.95,e.colors.text.primary)};\n color: ${Ur(.1,e.colors.text.primary)};\n\n padding: 0 ${e.spacing.unit}px;\n border: 1px solid ${Ur(.9,e.colors.text.primary)};\n font-family: ${e.typography.code.fontFamily};\n}`};
& + & {
margin-left: 0;
}
${ya("ExampleValue")};
`,ym=ga(gm)``,vm=ga(sm)`
border-radius: 2px;
${({theme:e})=>`\n background-color: ${Ur(.95,e.colors.primary.light)};\n color: ${Ur(.1,e.colors.primary.main)};\n\n margin: 0 ${e.spacing.unit}px;\n padding: 0 ${e.spacing.unit}px;\n border: 1px solid ${Ur(.9,e.colors.primary.main)};\n}`};
& + & {
margin-left: 0;
}
${ya("ConstraintItem")};
`,bm=ga.button`
background-color: transparent;
border: 0;
color: ${({theme:e})=>e.colors.text.secondary};
margin-left: ${({theme:e})=>e.spacing.unit}px;
border-radius: 2px;
cursor: pointer;
outline-color: ${({theme:e})=>e.colors.text.secondary};
font-size: 12px;
`;Object.defineProperty,Object.getOwnPropertyDescriptor;const wm=ga.div`
${Cf};
${({compact:e})=>e?"":"margin: 1em 0"}
`;let xm=class extends n.Component{render(){const{externalDocs:e}=this.props;return e&&e.url?n.createElement(wm,{compact:this.props.compact},n.createElement("a",{href:e.url},e.description||e.url)):null}};xm=((e,t,n,r)=>{for(var o,i=t,a=e.length-1;a>=0;a--)(o=e[a])&&(i=o(i)||i);return i})([im],xm);class km extends n.PureComponent{constructor(){super(...arguments),this.state={collapsed:!0}}toggle(){this.setState({collapsed:!this.state.collapsed})}render(){const{values:e,isArrayType:t}=this.props,{collapsed:r}=this.state,{enumSkipQuotes:o,maxDisplayedEnumValues:i}=this.context;if(!e.length)return null;const a=this.state.collapsed&&i?e.slice(0,i):e,s=!!i&&e.length>i,l=i?r?`… ${e.length-i} more`:"Hide":"";return n.createElement("div",null,n.createElement(sm,null,t?lo("enumArray"):""," ",1===e.length?lo("enumSingleValue"):lo("enum"),":")," ",a.map(((e,t)=>{const r=o?String(e):JSON.stringify(e);return n.createElement(n.Fragment,{key:t},n.createElement(gm,null,r)," ")})),s?n.createElement(_m,{onClick:()=>{this.toggle()}},l):null)}}km.contextType=Sa;const _m=ga.span`
color: ${e=>e.theme.colors.primary.main};
vertical-align: middle;
font-size: 13px;
line-height: 20px;
padding: 0 5px;
cursor: pointer;
`,Om=ga(Rf)`
margin: 2px 0;
`;class Sm extends n.PureComponent{render(){const e=this.props.extensions;return n.createElement(Sa.Consumer,null,(t=>n.createElement(n.Fragment,null,t.showExtensions&&Object.keys(e).map((t=>n.createElement(Om,{key:t},n.createElement(sm,null," ",t.substring(2),": ")," ",n.createElement(ym,null,"string"==typeof e[t]?e[t]:JSON.stringify(e[t]))))))))}}function Em({field:e}){return e.examples?n.createElement(n.Fragment,null,n.createElement(sm,null," ",lo("examples"),": "),io(e.examples)?e.examples.map(((t,r)=>{const o=is(e,t),i=e.in?String(o):JSON.stringify(o);return n.createElement(n.Fragment,{key:r},n.createElement(gm,null,i)," ")})):n.createElement(Pm,null,Object.values(e.examples).map(((t,r)=>n.createElement("li",{key:r+t.value},n.createElement(gm,null,is(e,t.value))," -"," ",t.summary||t.description))))):null}const Pm=ga.ul`
margin-top: 1em;
list-style-position: outside;
`;class Am extends n.PureComponent{render(){return 0===this.props.constraints.length?null:n.createElement("span",null," ",this.props.constraints.map((e=>n.createElement(vm,{key:e}," ",e," "))))}}const $m=n.memo((function({value:e,label:t,raw:r}){if(void 0===e)return null;const o=r?String(e):JSON.stringify(e);return n.createElement("div",null,n.createElement(sm,null," ",t," ")," ",n.createElement(gm,null,o))}));function Cm(e){const t=e.schema.pattern,{hideSchemaPattern:r}=n.useContext(Sa),[o,i]=n.useState(!1),a=n.useCallback((()=>i(!o)),[o]);return!t||r?null:n.createElement(n.Fragment,null,n.createElement(mm,null,o||t.length<45?t:`${t.substr(0,45)}...`),t.length>45&&n.createElement(bm,{onClick:a},o?"Hide pattern":"Show pattern"))}function Rm({schema:e}){const{hideSchemaPattern:t}=n.useContext(Sa);return e&&("string"!==e.type||e.constraints.length)&&((null==e?void 0:e.pattern)&&!t||e.items||e.displayFormat||e.constraints.length)?n.createElement(jm,null,"[ items",e.displayFormat&&n.createElement(pm,null," <",e.displayFormat," >"),n.createElement(Am,{constraints:e.constraints}),n.createElement(Cm,{schema:e}),e.items&&n.createElement(Rm,{schema:e.items})," ]"):null}const jm=ga(lm)`
margin: 0 5px;
vertical-align: text-top;
`;var Tm=Object.defineProperty,Im=Object.getOwnPropertySymbols,Nm=Object.prototype.hasOwnProperty,Dm=Object.prototype.propertyIsEnumerable,Lm=(e,t,n)=>t in e?Tm(e,t,{enumerable:!0,configurable:!0,writable:!0,value:n}):e[t]=n,Mm=(e,t)=>{for(var n in t||(t={}))Nm.call(t,n)&&Lm(e,n,t[n]);if(Im)for(var n of Im(t))Dm.call(t,n)&&Lm(e,n,t[n]);return e};const Fm=im((e=>{const{enumSkipQuotes:t,hideSchemaTitles:r}=n.useContext(Sa),{showExamples:o,field:i,renderDiscriminatorSwitch:a}=e,{schema:s,description:l,deprecated:c,extensions:u,in:p,const:d}=i,f="array"===s.type,h=t||"header"===p,m=n.useMemo((()=>!o||void 0===i.example&&void 0===i.examples?null:void 0!==i.examples?n.createElement(Em,{field:i}):n.createElement($m,{label:lo("example")+":",value:is(i,i.example),raw:Boolean(i.in)})),[i,o]);return n.createElement("div",null,n.createElement("div",null,n.createElement(lm,null,s.typePrefix),n.createElement(cm,null,s.displayType),s.displayFormat&&n.createElement(pm,null," ","<",s.displayFormat,">"," "),s.contentEncoding&&n.createElement(pm,null," ","<",s.contentEncoding,">"," "),s.contentMediaType&&n.createElement(pm,null," ","<",s.contentMediaType,">"," "),s.title&&!r&&n.createElement(um,null," (",s.title,") "),n.createElement(Am,{constraints:s.constraints}),n.createElement(Cm,{schema:s}),s.isCircular&&n.createElement(hm,null," ",lo("recursive")," "),f&&s.items&&n.createElement(Rm,{schema:s.items})),c&&n.createElement("div",null,n.createElement(qu,{type:"warning"}," ",lo("deprecated")," ")),n.createElement($m,{raw:h,label:lo("default")+":",value:s.default}),!a&&n.createElement(km,{isArrayType:f,values:s.enum})," ",m,n.createElement(Sm,{extensions:Mm(Mm({},u),s.extensions)}),n.createElement("div",null,n.createElement(Ff,{compact:!0,source:l})),s.externalDocs&&n.createElement(xm,{externalDocs:s.externalDocs,compact:!0}),a&&a(e)||null,d&&n.createElement($m,{label:lo("const")+":",value:d})||null)})),zm=n.memo(Fm);var Um=Object.defineProperty,Vm=(Object.getOwnPropertyDescriptor,Object.getOwnPropertySymbols),Bm=Object.prototype.hasOwnProperty,qm=Object.prototype.propertyIsEnumerable,Wm=(e,t,n)=>t in e?Um(e,t,{enumerable:!0,configurable:!0,writable:!0,value:n}):e[t]=n;let Hm=class extends n.Component{constructor(){super(...arguments),this.toggle=()=>{void 0===this.props.field.expanded&&this.props.expandByDefault?this.props.field.collapse():this.props.field.toggle()},this.handleKeyPress=e=>{"Enter"===e.key&&(e.preventDefault(),this.toggle())}}render(){const{className:e="",field:t,isLast:r,expandByDefault:o}=this.props,{name:i,deprecated:a,required:s,kind:l}=t,c=!t.schema.isPrimitive&&!t.schema.isCircular,u=void 0===t.expanded?o:t.expanded,p=n.createElement(n.Fragment,null,"additionalProperties"===l&&n.createElement(fm,null,"additional property"),"patternProperties"===l&&n.createElement(fm,null,"pattern property"),s&&n.createElement(dm,null,"required")),d=c?n.createElement(am,{className:a?"deprecated":"",kind:l,title:i},n.createElement(Xu,null),n.createElement("button",{onClick:this.toggle,onKeyPress:this.handleKeyPress,"aria-label":"expand properties"},n.createElement("span",{className:"property-name"},i),n.createElement(Bu,{direction:u?"down":"right"})),p):n.createElement(Gu,{className:a?"deprecated":void 0,kind:l,title:i},n.createElement(Xu,null),n.createElement("span",{className:"property-name"},i),p);return n.createElement(n.Fragment,null,n.createElement("tr",{className:r?"last "+e:e},d,n.createElement(Qu,null,n.createElement(zm,((e,t)=>{for(var n in t||(t={}))Bm.call(t,n)&&Wm(e,n,t[n]);if(Vm)for(var n of Vm(t))qm.call(t,n)&&Wm(e,n,t[n]);return e})({},this.props)))),u&&c&&n.createElement("tr",{key:t.name+"inner"},n.createElement(Ku,{colSpan:2},n.createElement(Ju,null,n.createElement(Pg,{schema:t.schema,skipReadOnly:this.props.skipReadOnly,skipWriteOnly:this.props.skipWriteOnly,showTitle:this.props.showTitle,level:this.props.level})))))}};Hm=((e,t,n,r)=>{for(var o,i=t,a=e.length-1;a>=0;a--)(o=e[a])&&(i=o(i)||i);return i})([im],Hm);Object.defineProperty,Object.getOwnPropertyDescriptor;let Ym=class extends n.Component{constructor(){super(...arguments),this.changeActiveChild=e=>{void 0!==e.idx&&this.props.parent.activateOneOf(e.idx)}}sortOptions(e,t){if(0===t.length)return;const n={};t.forEach(((e,t)=>{n[e]=t})),e.sort(((e,t)=>n[e.value]>n[t.value]?1:-1))}render(){const{parent:e,enumValues:t}=this.props;if(void 0===e.oneOf)return null;const r=e.oneOf.map(((e,t)=>({value:e.title,idx:t}))),o=r[e.activeOneOf].value;return this.sortOptions(r,t),n.createElement(Cd,{value:o,options:r,onChange:this.changeActiveChild,ariaLabel:"Example"})}};Ym=((e,t,n,r)=>{for(var o,i=t,a=e.length-1;a>=0;a--)(o=e[a])&&(i=o(i)||i);return i})([im],Ym);const Km=im((({schema:{fields:e=[],title:t},showTitle:r,discriminator:o,skipReadOnly:i,skipWriteOnly:a,level:s})=>{const{expandSingleSchemaField:l,showObjectSchemaExamples:c,schemaExpansionLevel:u}=n.useContext(Sa),p=n.useMemo((()=>i||a?e.filter((e=>!(i&&e.schema.readOnly||a&&e.schema.writeOnly))):e),[i,a,e]),d=l&&1===p.length||u>=s;return n.createElement(Zu,null,r&&n.createElement(Hu,null,t),n.createElement("tbody",null,Gr(p,((e,t)=>n.createElement(Hm,{key:e.name,isLast:t,field:e,expandByDefault:d,renderDiscriminatorSwitch:(null==o?void 0:o.fieldName)===e.name?()=>n.createElement(Ym,{parent:o.parentSchema,enumValues:e.schema.enum}):void 0,className:e.expanded?"expanded":void 0,showExamples:c,skipReadOnly:i,skipWriteOnly:a,showTitle:r,level:s})))))}));var Gm=Object.defineProperty,Qm=Object.defineProperties,Xm=Object.getOwnPropertyDescriptors,Jm=Object.getOwnPropertySymbols,Zm=Object.prototype.hasOwnProperty,eg=Object.prototype.propertyIsEnumerable,tg=(e,t,n)=>t in e?Gm(e,t,{enumerable:!0,configurable:!0,writable:!0,value:n}):e[t]=n,ng=(e,t)=>{for(var n in t||(t={}))Zm.call(t,n)&&tg(e,n,t[n]);if(Jm)for(var n of Jm(t))eg.call(t,n)&&tg(e,n,t[n]);return e},rg=(e,t)=>Qm(e,Xm(t));const og=ga.div`
padding-left: ${({theme:e})=>2*e.spacing.unit}px;
`;class ig extends n.PureComponent{render(){const e=this.props.schema,t=e.items,r=void 0===e.minItems&&void 0===e.maxItems?"":`(${us(e)})`;return e.fields?n.createElement(Km,rg(ng({},this.props),{level:this.props.level})):!e.displayType||t||r.length?n.createElement("div",null,n.createElement(rp,null," Array ",r),n.createElement(og,null,n.createElement(Pg,rg(ng({},this.props),{schema:t}))),n.createElement(op,null)):n.createElement("div",null,n.createElement(cm,null,e.displayType))}}var ag=Object.defineProperty,sg=Object.defineProperties,lg=Object.getOwnPropertyDescriptor,cg=Object.getOwnPropertyDescriptors,ug=Object.getOwnPropertySymbols,pg=Object.prototype.hasOwnProperty,dg=Object.prototype.propertyIsEnumerable,fg=(e,t,n)=>t in e?ag(e,t,{enumerable:!0,configurable:!0,writable:!0,value:n}):e[t]=n,hg=(e,t,n,r)=>{for(var o,i=r>1?void 0:r?lg(t,n):t,a=e.length-1;a>=0;a--)(o=e[a])&&(i=(r?o(t,n,i):o(i))||i);return r&&i&&ag(t,n,i),i};let mg=class extends n.Component{constructor(){super(...arguments),this.activateOneOf=()=>{this.props.schema.activateOneOf(this.props.idx)}}render(){const{idx:e,schema:t,subSchema:r}=this.props;return n.createElement(np,{deprecated:r.deprecated,active:e===t.activeOneOf,onClick:this.activateOneOf},r.title||r.typePrefix+r.displayType)}};mg=hg([im],mg);let gg=class extends n.Component{render(){const{schema:{oneOf:e},schema:t}=this.props;if(void 0===e)return null;const r=e[t.activeOneOf];return n.createElement("div",null,n.createElement(tp,null," ",t.oneOfType," "),n.createElement(ep,null,e.map(((e,r)=>n.createElement(mg,{key:e.pointer,schema:t,subSchema:e,idx:r})))),n.createElement("div",null,e[t.activeOneOf].deprecated&&n.createElement(qu,{type:"warning"},"Deprecated")),n.createElement(Am,{constraints:r.constraints}),n.createElement(Pg,((e,t)=>sg(e,cg(t)))(((e,t)=>{for(var n in t||(t={}))pg.call(t,n)&&fg(e,n,t[n]);if(ug)for(var n of ug(t))dg.call(t,n)&&fg(e,n,t[n]);return e})({},this.props),{schema:r})))}};gg=hg([im],gg);const yg=im((({schema:e})=>n.createElement("div",null,n.createElement(cm,null,e.displayType),e.title&&n.createElement(um,null," ",e.title," "),n.createElement(hm,null," ",lo("recursive")," "))));var vg=Object.defineProperty,bg=Object.defineProperties,wg=(Object.getOwnPropertyDescriptor,Object.getOwnPropertyDescriptors),xg=Object.getOwnPropertySymbols,kg=Object.prototype.hasOwnProperty,_g=Object.prototype.propertyIsEnumerable,Og=(e,t,n)=>t in e?vg(e,t,{enumerable:!0,configurable:!0,writable:!0,value:n}):e[t]=n,Sg=(e,t)=>{for(var n in t||(t={}))kg.call(t,n)&&Og(e,n,t[n]);if(xg)for(var n of xg(t))_g.call(t,n)&&Og(e,n,t[n]);return e},Eg=(e,t)=>bg(e,wg(t));let Pg=class extends n.Component{render(){var e;const t=this.props,{schema:r}=t,o=((e,t)=>{var n={};for(var r in e)kg.call(e,r)&&t.indexOf(r)<0&&(n[r]=e[r]);if(null!=e&&xg)for(var r of xg(e))t.indexOf(r)<0&&_g.call(e,r)&&(n[r]=e[r]);return n})(t,["schema"]),i=(o.level||0)+1;if(!r)return n.createElement("em",null," Schema not provided ");const{type:a,oneOf:s,discriminatorProp:l,isCircular:c}=r;if(c)return n.createElement(yg,{schema:r});if(void 0!==l){if(!s||!s.length)return console.warn(`Looks like you are using discriminator wrong: you don't have any definition inherited from the ${r.title}`),null;const e=s[r.activeOneOf];return e.isCircular?n.createElement(yg,{schema:e}):n.createElement(Km,Eg(Sg({},o),{level:i,schema:e,discriminator:{fieldName:l,parentSchema:r}}))}if(void 0!==s)return n.createElement(gg,Sg({schema:r},o));const u=io(a)?a:[a];if(u.includes("object")){if(null==(e=r.fields)?void 0:e.length)return n.createElement(Km,Eg(Sg({},this.props),{level:i}))}else if(u.includes("array"))return n.createElement(ig,Eg(Sg({},this.props),{level:i}));const p={schema:r,name:"",required:!1,description:r.description,externalDocs:r.externalDocs,deprecated:!1,toggle:()=>null,expanded:!1};return n.createElement("div",null,n.createElement(zm,{field:p}))}};Pg=((e,t,n,r)=>{for(var o,i=t,a=e.length-1;a>=0;a--)(o=e[a])&&(i=o(i)||i);return i})([im],Pg);var Ag=Object.defineProperty,$g=Object.defineProperties,Cg=Object.getOwnPropertyDescriptors,Rg=Object.getOwnPropertySymbols,jg=Object.prototype.hasOwnProperty,Tg=Object.prototype.propertyIsEnumerable,Ig=(e,t,n)=>t in e?Ag(e,t,{enumerable:!0,configurable:!0,writable:!0,value:n}):e[t]=n;class Ng extends n.PureComponent{constructor(){super(...arguments),this.renderDropdown=e=>{return n.createElement(Af,(t=((e,t)=>{for(var n in t||(t={}))jg.call(t,n)&&Ig(e,n,t[n]);if(Rg)for(var n of Rg(t))Tg.call(t,n)&&Ig(e,n,t[n]);return e})({Label:jd,Dropdown:fh},e),$g(t,Cg({variant:"dark"}))));var t}}static getMediaType(e,t){if(!e)return{};const n={schema:{$ref:e}};return t&&(n.examples={example:{$ref:t}}),n}get mediaModel(){const{parser:e,schemaRef:t,exampleRef:n,options:r}=this.props;return this._mediaModel||(this._mediaModel=new nu(e,"json",!1,Ng.getMediaType(t,n),r)),this._mediaModel}render(){const{showReadOnly:e=!0,showWriteOnly:t=!1}=this.props;return n.createElement(Su,null,n.createElement(Au,null,n.createElement(Ou,null,n.createElement(Pg,{skipWriteOnly:!t,skipReadOnly:!e,schema:this.mediaModel.schema})),n.createElement(Pu,null,n.createElement(Dg,null,n.createElement(mh,{renderDropdown:this.renderDropdown,mediaType:this.mediaModel})))))}}const Dg=ga.div`
background: ${({theme:e})=>e.codeBlock.backgroundColor};
& > div,
& > pre {
padding: ${e=>4*e.theme.spacing.unit}px;
margin: 0;
}
& > div > pre {
padding: 0;
}
`,Lg=(ca.div`
background-color: #e4e7eb;
`,ca.ul`
display: inline;
list-style: none;
padding: 0;
li {
display: inherit;
&:after {
content: ',';
}
&:last-child:after {
content: none;
}
}
`,ca.code`
font-size: ${e=>e.theme.typography.code.fontSize};
font-family: ${e=>e.theme.typography.code.fontFamily};
margin: 0 3px;
padding: 0.2em;
display: inline-block;
line-height: 1;
&:after {
content: ',';
font-weight: normal;
}
&:last-child:after {
content: none;
}
`),Mg=ca.span`
&:after {
content: ' and ';
font-weight: normal;
}
&:last-child:after {
content: none;
}
${Cf};
`,Fg=ca.span`
${e=>!e.expanded&&"white-space: nowrap;"}
&:after {
content: ' or ';
${e=>e.expanded&&"content: ' or \\a';"}
white-space: pre;
}
&:last-child:after,
&:only-child:after {
content: none;
}
${Cf};
`,zg=ca.div`
flex: 1 1 auto;
cursor: pointer;
`,Ug=ca.div`
width: ${e=>e.theme.schema.defaultDetailsWidth};
text-overflow: ellipsis;
border-radius: 4px;
overflow: hidden;
${e=>e.expanded&&`background: ${e.theme.colors.gray[100]};\n padding: 8px 9.6px;\n margin: 20px 0;\n width: 100%;\n `};
${ma("small")`
margin-top: 10px;
`}
`,Vg=ca(Iu)`
display: inline-block;
margin: 0;
`,Bg=ca.div`
width: 100%;
display: flex;
margin: 1em 0;
flex-direction: ${e=>e.expanded?"column":"row"};
${ma("small")`
flex-direction: column;
`}
`,qg=ca.div`
margin: 0.5em 0;
`,Wg=ca.div`
border-bottom: 1px solid ${({theme:e})=>e.colors.border.dark};
margin-bottom: 1.5em;
padding-bottom: 0.7em;
h5 {
line-height: 1em;
margin: 0 0 0.6em;
font-size: ${({theme:e})=>e.typography.fontSize};
}
.redoc-markdown p:first-child {
display: inline;
}
`;function Hg({children:e,height:t}){const r=n.createRef(),[o,i]=n.useState(!1),[a,s]=n.useState(!1);return n.useEffect((()=>{r.current&&r.current.clientHeight+20<r.current.scrollHeight&&s(!0)}),[r]),n.createElement(n.Fragment,null,n.createElement(Yg,{ref:r,className:o?"":"container",style:{height:o?"auto":t}},e),n.createElement(Kg,{dimmed:!o},a&&n.createElement(Gg,{onClick:()=>{i(!o)}},o?"See less":"See more")))}const Yg=ca.div`
overflow-y: hidden;
`,Kg=ca.div`
text-align: center;
line-height: 1.5em;
${({dimmed:e})=>e&&"background-image: linear-gradient(to bottom, transparent,rgb(255 255 255));\n position: relative;\n top: -0.5em;\n padding-top: 0.5em;\n background-position-y: -1em;\n "}
`,Gg=ca.a`
cursor: pointer;
`,Qg=n.memo((function(e){const{type:t,flow:r,RequiredScopes:o}=e,i=Object.keys((null==r?void 0:r.scopes)||{});return n.createElement(n.Fragment,null,n.createElement(qg,null,n.createElement("b",null,"Flow type: "),n.createElement("code",null,t," ")),("implicit"===t||"authorizationCode"===t)&&n.createElement(qg,null,n.createElement("strong",null," Authorization URL: "),n.createElement("code",null,n.createElement("a",{target:"_blank",rel:"noopener noreferrer",href:r.authorizationUrl},r.authorizationUrl))),("password"===t||"clientCredentials"===t||"authorizationCode"===t)&&n.createElement(qg,null,n.createElement("b",null," Token URL: "),n.createElement("code",null,r.tokenUrl)),r.refreshUrl&&n.createElement(qg,null,n.createElement("strong",null," Refresh URL: "),r.refreshUrl),!!i.length&&n.createElement(n.Fragment,null,o||null,n.createElement(qg,null,n.createElement("b",null," Scopes: ")),n.createElement(Hg,{height:"4em"},n.createElement("ul",null,i.map((e=>n.createElement("li",{key:e},n.createElement("code",null,e)," -"," ",n.createElement(Ff,{className:"redoc-markdown",inline:!0,source:r.scopes[e]||""}))))))))}));function Xg(e){const{RequiredScopes:t,scheme:r}=e;return n.createElement(Rf,null,r.apiKey?n.createElement(n.Fragment,null,n.createElement(qg,null,n.createElement("b",null,(o=r.apiKey.in||"").charAt(0).toUpperCase()+o.slice(1)," parameter name: "),n.createElement("code",null,r.apiKey.name)),t):r.http?n.createElement(n.Fragment,null,n.createElement(qg,null,n.createElement("b",null,"HTTP Authorization Scheme: "),n.createElement("code",null,r.http.scheme)),n.createElement(qg,null,"bearer"===r.http.scheme&&r.http.bearerFormat&&n.createElement(n.Fragment,null,n.createElement("b",null,"Bearer format: "),n.createElement("code",null,r.http.bearerFormat))),t):r.openId?n.createElement(n.Fragment,null,n.createElement(qg,null,n.createElement("b",null,"Connect URL: "),n.createElement("code",null,n.createElement("a",{target:"_blank",rel:"noopener noreferrer",href:r.openId.connectUrl},r.openId.connectUrl))),t):r.flows?Object.keys(r.flows).map((e=>n.createElement(Qg,{key:e,type:e,RequiredScopes:t,flow:r.flows[e]}))):null);var o}const Jg={oauth2:"OAuth2",apiKey:"API Key",http:"HTTP",openIdConnect:"OpenID Connect"};class Zg extends n.PureComponent{render(){return this.props.securitySchemes.schemes.map((e=>n.createElement(Su,{id:e.sectionId,key:e.id},n.createElement(Au,null,n.createElement(Ou,null,n.createElement(ju,null,n.createElement(Uu,{to:e.sectionId}),e.displayName),n.createElement(Ff,{source:e.description||""}),n.createElement(Wg,null,n.createElement(qg,null,n.createElement("b",null,"Security Scheme Type: "),n.createElement("span",null,Jg[e.type]||e.type)),n.createElement(Xg,{scheme:e})))))))}}class ey{constructor(e,t,n={},r=!0){var o,i,a,s;this.marker=new Ls,this.disposer=null,this.rawOptions=n,this.options=new xo(n,ty),this.scroll=new xf(this.options),yf.updateOnHistory(Ns.currentId,this.scroll),this.spec=new Xd(e,t,this.options),this.menu=new yf(this.spec,this.scroll,Ns),this.options.disableSearch||(this.search=new kf,r&&this.search.indexItems(this.menu.items),this.disposer=(o=this.menu,i="activeItemIdx",w(a=e=>{this.updateMarkOnMenu(e.newValue)})?function(e,t,n,r){return qn(e,t).observe_(n,r)}(o,i,a,s):function(e,t,n){return qn(e).observe_(t,n)}(o,i,a)))}static fromJS(e){const t=new ey(e.spec.data,e.spec.url,e.options,!1);return t.menu.activeItemIdx=e.menu.activeItemIdx||0,t.menu.activate(t.menu.flatItems[t.menu.activeItemIdx]),t.options.disableSearch||t.search.load(e.searchIndex),t}onDidMount(){this.menu.updateOnHistory(),this.updateMarkOnMenu(this.menu.activeItemIdx)}dispose(){this.scroll.dispose(),this.menu.dispose(),this.search&&this.search.dispose(),null!=this.disposer&&this.disposer()}toJS(){return e=this,t=null,n=function*(){return{menu:{activeItemIdx:this.menu.activeItemIdx},spec:{url:this.spec.parser.specUrl,data:this.spec.parser.spec},searchIndex:this.search?yield this.search.toJS():void 0,options:this.rawOptions}},new Promise(((r,o)=>{var i=e=>{try{s(n.next(e))}catch(e){o(e)}},a=e=>{try{s(n.throw(e))}catch(e){o(e)}},s=e=>e.done?r(e.value):Promise.resolve(e.value).then(i,a);s((n=n.apply(e,t)).next())}));var e,t,n}updateMarkOnMenu(e){const t=Math.max(0,e),n=Math.min(this.menu.flatItems.length,t+5),r=[];for(let e=t;e<n;e++){const t=this.menu.getElementAt(e);t&&r.push(t)}if(-1===e&&qr){const e=document.querySelector('[data-role="redoc-description"]'),t=document.querySelector('[data-role="redoc-summary"]');e&&r.push(e),t&&r.push(t)}this.marker.addOnly(r),this.marker.mark()}}const ty={allowedMdComponents:{SecurityDefinitions:{component:Zg,propsSelector:e=>({securitySchemes:e.spec.securitySchemes})},"security-definitions":{component:Zg,propsSelector:e=>({securitySchemes:e.spec.securitySchemes})},SchemaDefinition:{component:Ng,propsSelector:e=>({parser:e.spec.parser,options:e.options})}}},ny=ga(Ru)`
margin-top: 0;
margin-bottom: 0.5em;
${ya("ApiHeader")};
`,ry=ga.a`
border: 1px solid ${e=>e.theme.colors.primary.main};
color: ${e=>e.theme.colors.primary.main};
font-weight: normal;
margin-left: 0.5em;
padding: 4px 8px 4px;
display: inline-block;
text-decoration: none;
cursor: pointer;
${ya("DownloadButton")};
`,oy=ga.span`
&::before {
content: '|';
display: inline-block;
opacity: 0.5;
width: ${15}px;
text-align: center;
}
&:last-child::after {
display: none;
}
`,iy=ga.div`
overflow: hidden;
`,ay=ga.div`
display: flex;
flex-wrap: wrap;
// hide separator on new lines: idea from https://stackoverflow.com/a/31732902/1749888
margin-left: -${15}px;
`;Object.defineProperty,Object.getOwnPropertyDescriptor;let sy=class extends n.Component{constructor(){super(...arguments),this.handleDownloadClick=e=>{e.target.href||(e.target.href=this.props.store.spec.info.downloadLink)}}render(){const{store:e}=this.props,{info:t,externalDocs:r}=e.spec,o=e.options.hideDownloadButton,i=t.downloadFileName,a=t.downloadLink,s=t.license&&n.createElement(oy,null,"License:"," ",t.license.identifier?t.license.identifier:n.createElement("a",{href:t.license.url},t.license.name))||null,l=t.contact&&t.contact.url&&n.createElement(oy,null,"URL: ",n.createElement("a",{href:t.contact.url},t.contact.url))||null,c=t.contact&&t.contact.email&&n.createElement(oy,null,t.contact.name||"E-mail",":"," ",n.createElement("a",{href:"mailto:"+t.contact.email},t.contact.email))||null,u=t.termsOfService&&n.createElement(oy,null,n.createElement("a",{href:t.termsOfService},"Terms of Service"))||null,p=t.version&&n.createElement("span",null,"(",t.version,")")||null;return n.createElement(Su,null,n.createElement(Au,null,n.createElement(Ou,{className:"api-info"},n.createElement(ny,null,t.title," ",p),!o&&n.createElement("p",null,lo("downloadSpecification"),":",n.createElement(ry,{download:i||!0,target:"_blank",href:a,onClick:this.handleDownloadClick},lo("download"))),n.createElement(Rf,null,(t.license||t.contact||t.termsOfService)&&n.createElement(iy,null,n.createElement(ay,null,c," ",l," ",s," ",u))||null),n.createElement(Ff,{source:e.spec.info.summary,"data-role":"redoc-summary"}),n.createElement(Ff,{source:e.spec.info.description,"data-role":"redoc-description"}),r&&n.createElement(xm,{externalDocs:r}))))}};sy=((e,t,n,r)=>{for(var o,i=t,a=e.length-1;a>=0;a--)(o=e[a])&&(i=o(i)||i);return i})([im],sy);const ly=ga.img`
max-height: ${e=>e.theme.logo.maxHeight};
max-width: ${e=>e.theme.logo.maxWidth};
padding: ${e=>e.theme.logo.gutter};
width: 100%;
display: block;
`,cy=ga.div`
text-align: center;
`,uy=ga.a`
display: inline-block;
`;Object.defineProperty,Object.getOwnPropertyDescriptor;let py=class extends n.Component{render(){const{info:e}=this.props,t=e["x-logo"];if(!t||!t.url)return null;const r=t.href||e.contact&&e.contact.url,o=t.altText?t.altText:"logo",i=n.createElement(ly,{src:t.url,alt:o});return n.createElement(cy,{style:{backgroundColor:t.backgroundColor}},r?(a=r,e=>n.createElement(uy,{href:a},e))(i):i);var a}};py=((e,t,n,r)=>{for(var o,i=t,a=e.length-1;a>=0;a--)(o=e[a])&&(i=o(i)||i);return i})([im],py);var dy=Object.defineProperty,fy=Object.getOwnPropertySymbols,hy=Object.prototype.hasOwnProperty,my=Object.prototype.propertyIsEnumerable,gy=(e,t,n)=>t in e?dy(e,t,{enumerable:!0,configurable:!0,writable:!0,value:n}):e[t]=n,yy=(e,t)=>{for(var n in t||(t={}))hy.call(t,n)&&gy(e,n,t[n]);if(fy)for(var n of fy(t))my.call(t,n)&&gy(e,n,t[n]);return e};class vy extends n.Component{render(){return n.createElement(Pa,null,(e=>n.createElement(Lu,null,(t=>this.renderWithOptionsAndStore(e,t)))))}renderWithOptionsAndStore(e,t){const{source:r,htmlWrap:o=(e=>e)}=this.props;if(!t)throw new Error("When using components in markdown, store prop must be provided");const i=new jl(e,this.props.parentId).renderMdWithComponents(r);return i.length?i.map(((e,r)=>{if("string"==typeof e)return n.cloneElement(o(n.createElement(Mf,{html:e,inline:!1,compact:!1})),{key:r});const i=e.component;return n.createElement(i,yy({key:r},yy(yy({},e.props),e.propsSelector(t))))})):null}}var by=r(4184),wy=r.n(by);const xy=ga.span.attrs((e=>({className:`operation-type ${e.type}`})))`
width: 9ex;
display: inline-block;
height: ${e=>e.theme.typography.code.fontSize};
line-height: ${e=>e.theme.typography.code.fontSize};
background-color: #333;
border-radius: 3px;
background-repeat: no-repeat;
background-position: 6px 4px;
font-size: 7px;
font-family: Verdana, sans-serif; // web-safe
color: white;
text-transform: uppercase;
text-align: center;
font-weight: bold;
vertical-align: middle;
margin-right: 6px;
margin-top: 2px;
&.get {
background-color: ${e=>e.theme.colors.http.get};
}
&.post {
background-color: ${e=>e.theme.colors.http.post};
}
&.put {
background-color: ${e=>e.theme.colors.http.put};
}
&.options {
background-color: ${e=>e.theme.colors.http.options};
}
&.patch {
background-color: ${e=>e.theme.colors.http.patch};
}
&.delete {
background-color: ${e=>e.theme.colors.http.delete};
}
&.basic {
background-color: ${e=>e.theme.colors.http.basic};
}
&.link {
background-color: ${e=>e.theme.colors.http.link};
}
&.head {
background-color: ${e=>e.theme.colors.http.head};
}
&.hook {
background-color: ${e=>e.theme.colors.primary.main};
}
`;function ky(e,{theme:t},n){return e>1?t.sidebar.level1Items[n]:1===e?t.sidebar.groupItems[n]:""}const _y=ga.ul`
margin: 0;
padding: 0;
&:first-child {
padding-bottom: 32px;
}
& & {
font-size: 0.929em;
}
${e=>e.expanded?"":"display: none;"};
`,Oy=ga.li`
list-style: none inside none;
overflow: hidden;
text-overflow: ellipsis;
padding: 0;
${e=>0===e.depth?"margin-top: 15px":""};
`,Sy={0:pa`
opacity: 0.7;
text-transform: ${({theme:e})=>e.sidebar.groupItems.textTransform};
font-size: 0.8em;
padding-bottom: 0;
cursor: default;
`,1:pa`
font-size: 0.929em;
text-transform: ${({theme:e})=>e.sidebar.level1Items.textTransform};
`},Ey=ga.label.attrs((e=>({role:"menuitem",className:wy()("-depth"+e.depth,{active:e.active})})))`
cursor: pointer;
color: ${e=>e.active?ky(e.depth,e,"activeTextColor"):e.theme.sidebar.textColor};
margin: 0;
padding: 12.5px ${e=>4*e.theme.spacing.unit}px;
${({depth:e,type:t,theme:n})=>"section"===t&&e>1&&"padding-left: "+8*n.spacing.unit+"px;"||""}
display: flex;
justify-content: space-between;
font-family: ${e=>e.theme.typography.headings.fontFamily};
${e=>Sy[e.depth]};
background-color: ${e=>e.active?ky(e.depth,e,"activeBackgroundColor"):e.theme.sidebar.backgroundColor};
${e=>e.deprecated&&Wu||""};
&:hover {
color: ${e=>ky(e.depth,e,"activeTextColor")};
background-color: ${e=>ky(e.depth,e,"activeBackgroundColor")};
}
${Bu} {
height: ${({theme:e})=>e.sidebar.arrow.size};
width: ${({theme:e})=>e.sidebar.arrow.size};
polygon {
fill: ${({theme:e})=>e.sidebar.arrow.color};
}
}
`,Py=ga.span`
display: inline-block;
vertical-align: middle;
width: ${e=>e.width?e.width:"auto"};
overflow: hidden;
text-overflow: ellipsis;
`,Ay=ga.div`
${({theme:e})=>pa`
font-size: 0.8em;
margin-top: ${2*e.spacing.unit}px;
text-align: center;
position: fixed;
width: ${e.sidebar.width};
bottom: 0;
background: ${e.sidebar.backgroundColor};
a,
a:visited,
a:hover {
color: ${e.sidebar.textColor} !important;
padding: ${e.spacing.unit}px 0;
border-top: 1px solid ${Rr(.1,e.sidebar.backgroundColor)};
text-decoration: none;
display: flex;
align-items: center;
justify-content: center;
}
`};
img {
width: 15px;
margin-right: 5px;
}
${ma("small")`
width: 100%;
`};
`,$y=ga.button`
border: 0;
width: 100%;
text-align: left;
& > * {
vertical-align: middle;
}
${Bu} {
polygon {
fill: ${({theme:e})=>Rr(e.colors.tonalOffset,e.colors.gray[100])};
}
}
`,Cy=ga.span`
text-decoration: ${e=>e.deprecated?"line-through":"none"};
margin-right: 8px;
`,Ry=ga(xy)`
margin: 0 5px 0 0;
`,jy=ga((e=>{const{name:t,opened:r,className:o,onClick:i,httpVerb:a,deprecated:s}=e;return n.createElement($y,{className:o,onClick:i||void 0},n.createElement(Ry,{type:a},ms(a)),n.createElement(Bu,{size:"1.5em",direction:r?"down":"right",float:"left"}),n.createElement(Cy,{deprecated:s},t),s?n.createElement(qu,{type:"warning"}," ",lo("deprecated")," "):null)}))`
padding: 10px;
border-radius: 2px;
margin-bottom: 4px;
line-height: 1.5em;
background-color: ${({theme:e})=>e.colors.gray[100]};
cursor: pointer;
outline-color: ${({theme:e})=>Rr(e.colors.tonalOffset,e.colors.gray[100])};
`,Ty=ga.div`
padding: 10px 25px;
background-color: ${({theme:e})=>e.colors.gray[50]};
margin-bottom: 5px;
margin-top: 5px;
`;class Iy extends n.PureComponent{constructor(){super(...arguments),this.selectElement=()=>{Yf.selectElement(this.child)}}render(){const{children:e}=this.props;return n.createElement("div",{ref:e=>this.child=e,onClick:this.selectElement,onFocus:this.selectElement,tabIndex:0,role:"button"},e)}}const Ny=ga.div`
cursor: pointer;
position: relative;
margin-bottom: 5px;
`,Dy=ga.span`
font-family: ${e=>e.theme.typography.code.fontFamily};
margin-left: 10px;
flex: 1;
overflow-x: hidden;
text-overflow: ellipsis;
`,Ly=ga.button`
outline: 0;
color: inherit;
width: 100%;
text-align: left;
cursor: pointer;
padding: 10px 30px 10px ${e=>e.inverted?"10px":"20px"};
border-radius: ${e=>e.inverted?"0":"4px 4px 0 0"};
background-color: ${e=>e.inverted?"transparent":e.theme.codeBlock.backgroundColor};
display: flex;
white-space: nowrap;
align-items: center;
border: ${e=>e.inverted?"0":"1px solid transparent"};
border-bottom: ${e=>e.inverted?"1px solid #ccc":"0"};
transition: border-color 0.25s ease;
${e=>e.expanded&&!e.inverted&&`border-color: ${e.theme.colors.border.dark};`||""}
.${Dy} {
color: ${e=>e.inverted?e.theme.colors.text.primary:"#ffffff"};
}
&:focus {
box-shadow: inset 0 2px 2px rgba(0, 0, 0, 0.45), 0 2px 0 rgba(128, 128, 128, 0.25);
}
`,My=ga.span.attrs((e=>({className:`http-verb ${e.type}`})))`
font-size: ${e=>e.compact?"0.8em":"0.929em"};
line-height: ${e=>e.compact?"18px":"20px"};
background-color: ${e=>e.theme.colors.http[e.type]||"#999999"};
color: #ffffff;
padding: ${e=>e.compact?"2px 8px":"3px 10px"};
text-transform: uppercase;
font-family: ${e=>e.theme.typography.headings.fontFamily};
margin: 0;
`,Fy=ga.div`
position: absolute;
width: 100%;
z-index: 100;
background: ${e=>e.theme.rightPanel.servers.overlay.backgroundColor};
color: ${e=>e.theme.rightPanel.servers.overlay.textColor};
box-sizing: border-box;
box-shadow: 0px 0px 6px rgba(0, 0, 0, 0.33);
overflow: hidden;
border-bottom-left-radius: 4px;
border-bottom-right-radius: 4px;
transition: all 0.25s ease;
visibility: hidden;
${e=>e.expanded?"visibility: visible;":"transform: translateY(-50%) scaleY(0);"}
`,zy=ga.div`
padding: 10px;
`,Uy=ga.div`
padding: 5px;
border: 1px solid #ccc;
background: ${e=>e.theme.rightPanel.servers.url.backgroundColor};
word-break: break-all;
color: ${e=>e.theme.colors.primary.main};
> span {
color: ${e=>e.theme.colors.text.primary};
}
`;class Vy extends n.Component{constructor(e){super(e),this.toggle=()=>{this.setState({expanded:!this.state.expanded})},this.state={expanded:!1}}render(){const{operation:e,inverted:t,hideHostname:r}=this.props,{expanded:o}=this.state;return n.createElement(Sa.Consumer,null,(i=>n.createElement(Ny,null,n.createElement(Ly,{onClick:this.toggle,expanded:o,inverted:t},n.createElement(My,{type:e.httpVerb,compact:this.props.compact},e.httpVerb),n.createElement(Dy,null,e.path),n.createElement(Bu,{float:"right",color:t?"black":"white",size:"20px",direction:o?"up":"down",style:{marginRight:"-25px"}})),n.createElement(Fy,{expanded:o,"aria-hidden":!o},e.servers.map((t=>{const o=i.expandDefaultServerVariables?function(e,t={}){return e.replace(/(?:{)([\w-.]+)(?:})/g,((e,n)=>t[n]&&t[n].default||e))}(t.url,t.variables):t.url,a=function(e){try{return ro(e).pathname}catch(t){return e}}(o);return n.createElement(zy,{key:o},n.createElement(Ff,{source:t.description||"",compact:!0}),n.createElement(Iy,null,n.createElement(Uy,null,n.createElement("span",null,r||i.hideHostname?"/"===a?"":a:o),e.path)))}))))))}}class By extends n.PureComponent{render(){const{place:e,parameters:t}=this.props;return t&&t.length?n.createElement("div",{key:e},n.createElement(Iu,null,e," Parameters"),n.createElement(Zu,null,n.createElement("tbody",null,Gr(t,((e,t)=>n.createElement(Hm,{key:e.name,isLast:t,field:e,showExamples:!0})))))):null}}Object.defineProperty,Object.getOwnPropertyDescriptor;let qy=class extends n.Component{constructor(){super(...arguments),this.switchMedia=({idx:e})=>{this.props.content&&void 0!==e&&this.props.content.activate(e)}}render(){const{content:e}=this.props;if(!e||!e.mediaTypes||!e.mediaTypes.length)return null;const t=e.activeMimeIdx,r=e.mediaTypes.map(((e,t)=>({value:e.name,idx:t}))),o=({children:e})=>this.props.withLabel?n.createElement(dh,null,n.createElement(ph,null,"Content type"),e):e;return n.createElement(n.Fragment,null,n.createElement(o,null,this.props.renderDropdown({value:r[t].value,options:r,onChange:this.switchMedia,ariaLabel:"Content type"})),this.props.children(e.active))}};qy=((e,t,n,r)=>{for(var o,i=t,a=e.length-1;a>=0;a--)(o=e[a])&&(i=o(i)||i);return i})([im],qy);var Wy=Object.defineProperty,Hy=Object.getOwnPropertySymbols,Yy=Object.prototype.hasOwnProperty,Ky=Object.prototype.propertyIsEnumerable,Gy=(e,t,n)=>t in e?Wy(e,t,{enumerable:!0,configurable:!0,writable:!0,value:n}):e[t]=n;const Qy=["path","query","cookie","header"];class Xy extends n.PureComponent{orderParams(e){const t={};return e.forEach((e=>{var n,r,o;o=e,(n=t)[r=e.in]||(n[r]=[]),n[r].push(o)})),t}render(){const{body:e,parameters:t=[]}=this.props;if(void 0===e&&void 0===t)return null;const r=this.orderParams(t),o=t.length>0?Qy:[],i=e&&e.content,a=e&&e.description;return n.createElement(n.Fragment,null,o.map((e=>n.createElement(By,{key:e,place:e,parameters:r[e]}))),i&&n.createElement(Zy,{content:i,description:a}))}}function Jy(e){return n.createElement(Iu,{key:"header"},"Request Body schema: ",n.createElement(Af,((e,t)=>{for(var n in t||(t={}))Yy.call(t,n)&&Gy(e,n,t[n]);if(Hy)for(var n of Hy(t))Ky.call(t,n)&&Gy(e,n,t[n]);return e})({},e)))}function Zy(e){const{content:t,description:r}=e,{isRequestType:o}=t;return n.createElement(qy,{content:t,renderDropdown:Jy},(({schema:e})=>n.createElement(n.Fragment,null,void 0!==r&&n.createElement(Ff,{source:r}),"object"===(null==e?void 0:e.type)&&n.createElement(Am,{constraints:(null==e?void 0:e.constraints)||[]}),n.createElement(Pg,{skipReadOnly:o,skipWriteOnly:!o,key:"schema",schema:e}))))}const ev=ga(n.memo((function({title:e,type:t,empty:r,code:o,opened:i,className:a,onClick:s}){return n.createElement("button",{className:a,onClick:!r&&s||void 0,"aria-expanded":i,disabled:r},!r&&n.createElement(Bu,{size:"1.5em",color:t,direction:i?"down":"right",float:"left"}),n.createElement(rv,null,o," "),n.createElement(Ff,{compact:!0,inline:!0,source:e}))})))`
display: block;
border: 0;
width: 100%;
text-align: left;
padding: 10px;
border-radius: 2px;
margin-bottom: 4px;
line-height: 1.5em;
cursor: pointer;
color: ${e=>e.theme.colors.responses[e.type].color};
background-color: ${e=>e.theme.colors.responses[e.type].backgroundColor};
&:focus {
outline: auto ${e=>e.theme.colors.responses[e.type].color};
}
${e=>e.empty?'\ncursor: default;\n&::before {\n content: "—";\n font-weight: bold;\n width: 1.5em;\n text-align: center;\n display: inline-block;\n vertical-align: top;\n}\n&:focus {\n outline: 0;\n}\n':""};
`,tv=ga.div`
padding: 10px;
`,nv=ga(Iu.withComponent("caption"))`
text-align: left;
margin-top: 1em;
caption-side: top;
`,rv=ga.strong`
vertical-align: top;
`;class ov extends n.PureComponent{render(){const{headers:e}=this.props;return void 0===e||0===e.length?null:n.createElement(Zu,null,n.createElement(nv,null," Response Headers "),n.createElement("tbody",null,Gr(e,((e,t)=>n.createElement(Hm,{isLast:t,key:e.name,field:e,showExamples:!0})))))}}var iv=Object.defineProperty,av=Object.getOwnPropertySymbols,sv=Object.prototype.hasOwnProperty,lv=Object.prototype.propertyIsEnumerable,cv=(e,t,n)=>t in e?iv(e,t,{enumerable:!0,configurable:!0,writable:!0,value:n}):e[t]=n;class uv extends n.PureComponent{constructor(){super(...arguments),this.renderDropdown=e=>n.createElement(Iu,{key:"header"},"Response Schema: ",n.createElement(Af,((e,t)=>{for(var n in t||(t={}))sv.call(t,n)&&cv(e,n,t[n]);if(av)for(var n of av(t))lv.call(t,n)&&cv(e,n,t[n]);return e})({},e)))}render(){const{description:e,extensions:t,headers:r,content:o}=this.props.response;return n.createElement(n.Fragment,null,e&&n.createElement(Ff,{source:e}),n.createElement(Sm,{extensions:t}),n.createElement(ov,{headers:r}),n.createElement(qy,{content:o,renderDropdown:this.renderDropdown},(({schema:e})=>n.createElement(n.Fragment,null,"object"===(null==e?void 0:e.type)&&n.createElement(Am,{constraints:(null==e?void 0:e.constraints)||[]}),n.createElement(Pg,{skipWriteOnly:!0,key:"schema",schema:e})))))}}const pv=im((({response:e})=>{const{extensions:t,headers:r,type:o,summary:i,description:a,code:s,expanded:l,content:c}=e,u=n.useMemo((()=>void 0===c?[]:c.mediaTypes.filter((e=>void 0!==e.schema))),[c]),p=n.useMemo((()=>!(t&&0!==Object.keys(t).length||0!==r.length||0!==u.length||a)),[t,r,u,a]);return n.createElement("div",null,n.createElement(ev,{onClick:()=>e.toggle(),type:o,empty:p,title:i||"",code:s,opened:l}),l&&!p&&n.createElement(tv,null,n.createElement(uv,{response:e})))})),dv=ga.h3`
font-size: 1.3em;
padding: 0.2em 0;
margin: 3em 0 1.1em;
color: ${({theme:e})=>e.colors.text.primary};
font-weight: normal;
`;class fv extends n.PureComponent{render(){const{responses:e,isCallback:t}=this.props;return e&&0!==e.length?n.createElement("div",null,n.createElement(dv,null,lo(t?"callbackResponses":"responses")),e.map((e=>n.createElement(pv,{key:e.code,response:e})))):null}}function hv(e){const{security:t,showSecuritySchemeType:r,expanded:o}=e,i=t.schemes.length>1;return 0===t.schemes.length?n.createElement(Fg,{expanded:o},"None"):n.createElement(Fg,{expanded:o},i&&"(",t.schemes.map((e=>n.createElement(Mg,{key:e.id},r&&`${Jg[e.type]||e.type}: `,n.createElement("i",null,e.displayName),o&&e.scopes.length?[" (",e.scopes.map((e=>n.createElement(Lg,{key:e},e))),") "]:null))),i&&") ")}const mv=({scopes:e})=>e.length?n.createElement("div",null,n.createElement("b",null,"Required scopes: "),e.map(((e,t)=>n.createElement(n.Fragment,{key:t},n.createElement("code",null,e)," ")))):null;function gv(e){const t=(0,n.useContext)(Nu),r=null==t?void 0:t.options.showSecuritySchemeType,[o,i]=(0,n.useState)(!1),{securities:a}=e;if(!(null==a?void 0:a.length)||(null==t?void 0:t.options.hideSecuritySection))return null;const s=null==t?void 0:t.spec.securitySchemes.schemes.filter((({id:e})=>a.find((t=>t.schemes.find((t=>t.id===e))))));return n.createElement(n.Fragment,null,n.createElement(Bg,{expanded:o},n.createElement(zg,{onClick:()=>i(!o)},n.createElement(Vg,null,"Authorizations:"),n.createElement(Bu,{size:"1.3em",direction:o?"down":"right"})),n.createElement(Ug,{expanded:o},a.map(((e,t)=>n.createElement(hv,{key:t,expanded:o,showSecuritySchemeType:r,security:e}))))),o&&(null==s?void 0:s.length)&&s.map(((e,t)=>n.createElement(Wg,{key:t},n.createElement("h5",null,n.createElement(yv,null)," ",Jg[e.type]||e.type,": ",e.id),n.createElement(Ff,{source:e.description||""}),n.createElement(Xg,{key:e.id,scheme:e,RequiredScopes:n.createElement(mv,{scopes:vv(e.id,a)})})))))}const yv=()=>n.createElement("svg",{xmlns:"http://www.w3.org/2000/svg",viewBox:"0 0 24 24",width:"11",height:"11"},n.createElement("path",{fill:"currentColor",d:"M18 10V6A6 6 0 0 0 6 6v4H3v14h18V10h-3zM8 6c0-2.206 1.794-4 4-4s4 1.794 4 4v4H8V6zm11 16H5V12h14v10z"}));function vv(e,t){const n=[];let r=t.length;for(;r--;){const o=t[r];let i=o.schemes.length;for(;i--;){const t=o.schemes[i];t.id===e&&Array.isArray(t.scopes)&&n.push(...t.scopes)}}return Array.from(new Set(n))}Object.defineProperty,Object.getOwnPropertyDescriptor;let bv=class extends n.Component{render(){const{operation:e}=this.props,{description:t,externalDocs:r}=e,o=!(!t&&!r);return n.createElement(Ty,null,o&&n.createElement(wv,null,void 0!==t&&n.createElement(Ff,{source:t}),r&&n.createElement(xm,{externalDocs:r})),n.createElement(Vy,{operation:this.props.operation,inverted:!0,compact:!0}),n.createElement(Sm,{extensions:e.extensions}),n.createElement(gv,{securities:e.security}),n.createElement(Xy,{parameters:e.parameters,body:e.requestBody}),n.createElement(fv,{responses:e.responses,isCallback:e.isCallback}))}};bv=((e,t,n,r)=>{for(var o,i=t,a=e.length-1;a>=0;a--)(o=e[a])&&(i=o(i)||i);return i})([im],bv);const wv=ga.div`
margin-bottom: ${({theme:e})=>3*e.spacing.unit}px;
`;Object.defineProperty,Object.getOwnPropertyDescriptor;let xv=class extends n.Component{constructor(){super(...arguments),this.toggle=()=>{this.props.callbackOperation.toggle()}}render(){const{name:e,expanded:t,httpVerb:r,deprecated:o}=this.props.callbackOperation;return n.createElement(n.Fragment,null,n.createElement(jy,{onClick:this.toggle,name:e,opened:t,httpVerb:r,deprecated:o}),t&&n.createElement(bv,{operation:this.props.callbackOperation}))}};xv=((e,t,n,r)=>{for(var o,i=t,a=e.length-1;a>=0;a--)(o=e[a])&&(i=o(i)||i);return i})([im],xv);class kv extends n.PureComponent{render(){const{callbacks:e}=this.props;return e&&0!==e.length?n.createElement("div",null,n.createElement(_v,null," Callbacks "),e.map((e=>e.operations.map(((t,r)=>n.createElement(xv,{key:`${e.name}_${r}`,callbackOperation:t})))))):null}}const _v=ga.h3`
font-size: 1.3em;
padding: 0.2em 0;
margin: 3em 0 1.1em;
color: ${({theme:e})=>e.colors.text.primary};
font-weight: normal;
`;Object.defineProperty,Object.getOwnPropertyDescriptor;let Ov=class extends n.Component{constructor(e){super(e),this.switchItem=({idx:e})=>{this.props.items&&void 0!==e&&this.setState({activeItemIdx:e})},this.state={activeItemIdx:0}}render(){const{items:e}=this.props;if(!e||!e.length)return null;const t=({children:e})=>this.props.label?n.createElement(dh,null,n.createElement(ph,null,this.props.label),e):e;return n.createElement(n.Fragment,null,n.createElement(t,null,this.props.renderDropdown({value:this.props.options[this.state.activeItemIdx].value,options:this.props.options,onChange:this.switchItem,ariaLabel:this.props.label||"Callback"})),this.props.children(e[this.state.activeItemIdx]))}};Ov=((e,t,n,r)=>{for(var o,i=t,a=e.length-1;a>=0;a--)(o=e[a])&&(i=o(i)||i);return i})([im],Ov);var Sv=Object.defineProperty,Ev=Object.defineProperties,Pv=(Object.getOwnPropertyDescriptor,Object.getOwnPropertyDescriptors),Av=Object.getOwnPropertySymbols,$v=Object.prototype.hasOwnProperty,Cv=Object.prototype.propertyIsEnumerable,Rv=(e,t,n)=>t in e?Sv(e,t,{enumerable:!0,configurable:!0,writable:!0,value:n}):e[t]=n;let jv=class extends n.Component{constructor(){super(...arguments),this.renderDropdown=e=>{return n.createElement(Af,(t=((e,t)=>{for(var n in t||(t={}))$v.call(t,n)&&Rv(e,n,t[n]);if(Av)for(var n of Av(t))Cv.call(t,n)&&Rv(e,n,t[n]);return e})({Label:uh,Dropdown:fh},e),Ev(t,Pv({variant:"dark"}))));var t}}render(){const e=this.props.content;return void 0===e?null:n.createElement(qy,{content:e,renderDropdown:this.renderDropdown,withLabel:!0},(e=>n.createElement(mh,{key:"samples",mediaType:e,renderDropdown:this.renderDropdown})))}};jv=((e,t,n,r)=>{for(var o,i=t,a=e.length-1;a>=0;a--)(o=e[a])&&(i=o(i)||i);return i})([im],jv);class Tv extends n.Component{render(){const e=this.props.callback.codeSamples.find((e=>xu(e)));return e?n.createElement(Iv,null,n.createElement(jv,{content:e.requestBodyContent})):null}}const Iv=ga.div`
margin-top: 15px;
`;var Nv=Object.defineProperty,Dv=Object.defineProperties,Lv=(Object.getOwnPropertyDescriptor,Object.getOwnPropertyDescriptors),Mv=Object.getOwnPropertySymbols,Fv=Object.prototype.hasOwnProperty,zv=Object.prototype.propertyIsEnumerable,Uv=(e,t,n)=>t in e?Nv(e,t,{enumerable:!0,configurable:!0,writable:!0,value:n}):e[t]=n;let Vv=class extends n.Component{constructor(){super(...arguments),this.renderDropdown=e=>{return n.createElement(Af,(t=((e,t)=>{for(var n in t||(t={}))Fv.call(t,n)&&Uv(e,n,t[n]);if(Mv)for(var n of Mv(t))zv.call(t,n)&&Uv(e,n,t[n]);return e})({Label:uh,Dropdown:fh},e),Dv(t,Lv({variant:"dark"}))));var t}}render(){const{callbacks:e}=this.props;if(!e||0===e.length)return null;const t=e.map((e=>e.operations.map((e=>e)))).reduce(((e,t)=>e.concat(t)),[]);if(!t.some((e=>e.codeSamples.length>0)))return null;const r=t.map(((e,t)=>({value:`${e.httpVerb.toUpperCase()}: ${e.name}`,idx:t})));return n.createElement("div",null,n.createElement(Tu,null," Callback payload samples "),n.createElement(Bv,null,n.createElement(Ov,{items:t,renderDropdown:this.renderDropdown,label:"Callback",options:r},(e=>n.createElement(Tv,{key:"callbackPayloadSample",callback:e,renderDropdown:this.renderDropdown})))))}};Vv.contextType=Sa,Vv=((e,t,n,r)=>{for(var o,i=t,a=e.length-1;a>=0;a--)(o=e[a])&&(i=o(i)||i);return i})([im],Vv);const Bv=ga.div`
background: ${({theme:e})=>e.codeBlock.backgroundColor};
padding: ${e=>4*e.theme.spacing.unit}px;
`;Object.defineProperty,Object.getOwnPropertyDescriptor;let qv=class extends n.Component{render(){const{operation:e}=this.props,t=e.codeSamples,r=t.length>0,o=1===t.length&&this.context.hideSingleRequestSampleTab;return r&&n.createElement("div",null,n.createElement(Tu,null," ",lo("requestSamples")," "),n.createElement(Dp,{defaultIndex:0},n.createElement(Ap,{hidden:o},t.map((e=>n.createElement(jp,{key:e.lang+"_"+(e.label||"")},void 0!==e.label?e.label:e.lang)))),t.map((e=>n.createElement(Np,{key:e.lang+"_"+(e.label||"")},xu(e)?n.createElement("div",null,n.createElement(jv,{content:e.requestBodyContent})):n.createElement(ah,{lang:e.lang,source:e.source}))))))||null}};qv.contextType=Sa,qv=((e,t,n,r)=>{for(var o,i=t,a=e.length-1;a>=0;a--)(o=e[a])&&(i=o(i)||i);return i})([im],qv);Object.defineProperty,Object.getOwnPropertyDescriptor;let Wv=class extends n.Component{render(){const{operation:e}=this.props,t=e.responses.filter((e=>e.content&&e.content.hasSample));return t.length>0&&n.createElement("div",null,n.createElement(Tu,null," ",lo("responseSamples")," "),n.createElement(Dp,{defaultIndex:0},n.createElement(Ap,null,t.map((e=>n.createElement(jp,{className:"tab-"+e.type,key:e.code},e.code)))),t.map((e=>n.createElement(Np,{key:e.code},n.createElement("div",null,n.createElement(jv,{content:e.content})))))))||null}};Wv=((e,t,n,r)=>{for(var o,i=t,a=e.length-1;a>=0;a--)(o=e[a])&&(i=o(i)||i);return i})([im],Wv);var Hv=Object.defineProperty,Yv=Object.defineProperties,Kv=Object.getOwnPropertyDescriptors,Gv=Object.getOwnPropertySymbols,Qv=Object.prototype.hasOwnProperty,Xv=Object.prototype.propertyIsEnumerable,Jv=(e,t,n)=>t in e?Hv(e,t,{enumerable:!0,configurable:!0,writable:!0,value:n}):e[t]=n;const Zv=ga.div`
margin-bottom: ${({theme:e})=>6*e.spacing.unit}px;
`,eb=im((({operation:e})=>{const{name:t,description:r,deprecated:o,externalDocs:i,isWebhook:a,httpVerb:s}=e,l=!(!r&&!i),{showWebhookVerb:c}=n.useContext(Sa);return n.createElement(Sa.Consumer,null,(u=>n.createElement(Au,((e,t)=>Yv(e,Kv(t)))(((e,t)=>{for(var n in t||(t={}))Qv.call(t,n)&&Jv(e,n,t[n]);if(Gv)for(var n of Gv(t))Xv.call(t,n)&&Jv(e,n,t[n]);return e})({},{[gf]:e.operationHash}),{id:e.operationHash}),n.createElement(Ou,null,n.createElement(ju,null,n.createElement(Uu,{to:e.id}),t," ",o&&n.createElement(qu,{type:"warning"}," Deprecated "),a&&n.createElement(qu,{type:"primary"}," ","Webhook ",c&&s&&"| "+s.toUpperCase())),u.pathInMiddlePanel&&!a&&n.createElement(Vy,{operation:e,inverted:!0}),l&&n.createElement(Zv,null,void 0!==r&&n.createElement(Ff,{source:r}),i&&n.createElement(xm,{externalDocs:i})),n.createElement(Sm,{extensions:e.extensions}),n.createElement(gv,{securities:e.security}),n.createElement(Xy,{parameters:e.parameters,body:e.requestBody}),n.createElement(fv,{responses:e.responses}),n.createElement(kv,{callbacks:e.callbacks})),n.createElement(Pu,null,!u.pathInMiddlePanel&&!a&&n.createElement(Vy,{operation:e}),n.createElement(qv,{operation:e}),n.createElement(Wv,{operation:e}),n.createElement(Vv,{callbacks:e.callbacks})))))}));var tb=Object.defineProperty,nb=Object.getOwnPropertyDescriptor,rb=Object.getOwnPropertySymbols,ob=Object.prototype.hasOwnProperty,ib=Object.prototype.propertyIsEnumerable,ab=(e,t,n)=>t in e?tb(e,t,{enumerable:!0,configurable:!0,writable:!0,value:n}):e[t]=n,sb=(e,t,n,r)=>{for(var o,i=r>1?void 0:r?nb(t,n):t,a=e.length-1;a>=0;a--)(o=e[a])&&(i=(r?o(t,n,i):o(i))||i);return r&&i&&tb(t,n,i),i};let lb=class extends n.Component{render(){const e=this.props.items;return 0===e.length?null:e.map((e=>n.createElement(cb,{key:e.id,item:e})))}};lb=sb([im],lb);let cb=class extends n.Component{render(){const e=this.props.item;let t;const{type:r}=e;switch(r){case"group":t=null;break;case"tag":case"section":default:t=n.createElement(pb,((e,t)=>{for(var n in t||(t={}))ob.call(t,n)&&ab(e,n,t[n]);if(rb)for(var n of rb(t))ib.call(t,n)&&ab(e,n,t[n]);return e})({},this.props));break;case"operation":t=n.createElement(db,{item:e})}return n.createElement(n.Fragment,null,t&&n.createElement(Su,{id:e.id,underlined:"operation"===e.type},t),e.items&&n.createElement(lb,{items:e.items}))}};cb=sb([im],cb);const ub=e=>n.createElement(Ou,{compact:!0},e);let pb=class extends n.Component{render(){const{name:e,description:t,externalDocs:r,level:o}=this.props.item,i=2===o?ju:Ru;return n.createElement(n.Fragment,null,n.createElement(Au,null,n.createElement(Ou,{compact:!1},n.createElement(i,null,n.createElement(Uu,{to:this.props.item.id}),e))),n.createElement(vy,{parentId:this.props.item.id,source:t||"",htmlWrap:ub}),r&&n.createElement(Au,null,n.createElement(Ou,null,n.createElement(xm,{externalDocs:r}))))}};pb=sb([im],pb);let db=class extends n.Component{render(){return n.createElement(eb,{operation:this.props.item})}};db=sb([im],db);var fb=Object.defineProperty,hb=Object.defineProperties,mb=(Object.getOwnPropertyDescriptor,Object.getOwnPropertyDescriptors),gb=Object.getOwnPropertySymbols,yb=Object.prototype.hasOwnProperty,vb=Object.prototype.propertyIsEnumerable,bb=(e,t,n)=>t in e?fb(e,t,{enumerable:!0,configurable:!0,writable:!0,value:n}):e[t]=n;let wb=class extends n.Component{constructor(){super(...arguments),this.ref=n.createRef(),this.activate=e=>{this.props.onActivate(this.props.item),e.stopPropagation()}}componentDidMount(){this.scrollIntoViewIfActive()}componentDidUpdate(){this.scrollIntoViewIfActive()}scrollIntoViewIfActive(){this.props.item.active&&this.ref.current&&Hr(this.ref.current)}render(){const{item:e,withoutChildren:t}=this.props;return n.createElement(Oy,{onClick:this.activate,depth:e.depth,"data-item-id":e.id},"operation"===e.type?n.createElement(xb,((e,t)=>hb(e,mb(t)))(((e,t)=>{for(var n in t||(t={}))yb.call(t,n)&&bb(e,n,t[n]);if(gb)for(var n of gb(t))vb.call(t,n)&&bb(e,n,t[n]);return e})({},this.props),{item:e})):n.createElement(Ey,{depth:e.depth,active:e.active,type:e.type,ref:this.ref},n.createElement(Py,{title:e.sidebarLabel},e.sidebarLabel,this.props.children),e.depth>0&&e.items.length>0&&n.createElement(Bu,{float:"right",direction:e.expanded?"down":"right"})||null),!t&&e.items&&e.items.length>0&&n.createElement(Pb,{expanded:e.expanded,items:e.items,onActivate:this.props.onActivate}))}};wb=((e,t,n,r)=>{for(var o,i=t,a=e.length-1;a>=0;a--)(o=e[a])&&(i=o(i)||i);return i})([im],wb);const xb=im((e=>{const{item:t}=e,r=n.createRef(),{showWebhookVerb:o}=n.useContext(Sa);return n.useEffect((()=>{e.item.active&&r.current&&Hr(r.current)}),[e.item.active,r]),n.createElement(Ey,{depth:t.depth,active:t.active,deprecated:t.deprecated,ref:r},t.isWebhook?n.createElement(xy,{type:"hook"},o?t.httpVerb:lo("webhook")):n.createElement(xy,{type:t.httpVerb},ms(t.httpVerb)),n.createElement(Py,{width:"calc(100% - 38px)"},t.sidebarLabel,e.children))}));var kb=Object.defineProperty,_b=(Object.getOwnPropertyDescriptor,Object.getOwnPropertySymbols),Ob=Object.prototype.hasOwnProperty,Sb=Object.prototype.propertyIsEnumerable,Eb=(e,t,n)=>t in e?kb(e,t,{enumerable:!0,configurable:!0,writable:!0,value:n}):e[t]=n;let Pb=class extends n.Component{render(){const{items:e,root:t,className:r}=this.props,o=null==this.props.expanded||this.props.expanded;return n.createElement(_y,((e,t)=>{for(var n in t||(t={}))Ob.call(t,n)&&Eb(e,n,t[n]);if(_b)for(var n of _b(t))Sb.call(t,n)&&Eb(e,n,t[n]);return e})({className:r,style:this.props.style,expanded:o},t?{role:"menu"}:{}),e.map(((e,t)=>n.createElement(wb,{key:t,item:e,onActivate:this.props.onActivate}))))}};function Ab(){const[e,t]=(0,n.useState)(!1);return(0,n.useEffect)((()=>{t(!0)}),[]),e?n.createElement("img",{alt:"redocly logo",onError:()=>t(!1),src:"https://cdn.redoc.ly/redoc/logo-mini.svg"}):null}Pb=((e,t,n,r)=>{for(var o,i=t,a=e.length-1;a>=0;a--)(o=e[a])&&(i=o(i)||i);return i})([im],Pb);Object.defineProperty,Object.getOwnPropertyDescriptor;let $b=class extends n.Component{constructor(){super(...arguments),this.activate=e=>{if(e&&e.active&&this.context.menuToggle)return e.expanded?e.collapse():e.expand();this.props.menu.activateAndScroll(e,!0),setTimeout((()=>{this._updateScroll&&this._updateScroll()}))},this.saveScrollUpdate=e=>{this._updateScroll=e}}render(){const e=this.props.menu;return n.createElement(Pd,{updateFn:this.saveScrollUpdate,className:this.props.className,options:{wheelPropagation:!1}},n.createElement(Pb,{items:e.items,onActivate:this.activate,root:!0}),n.createElement(Ay,null,n.createElement("a",{target:"_blank",rel:"noopener noreferrer",href:"https://redocly.com/redoc/"},n.createElement(Ab,null),"API docs by Redocly")))}};$b.contextType=Sa,$b=((e,t,n,r)=>{for(var o,i=t,a=e.length-1;a>=0;a--)(o=e[a])&&(i=o(i)||i);return i})([im],$b);const Cb=({open:e})=>{const t=e?8:-4;return n.createElement(jb,null,n.createElement(Rb,{size:15,style:{transform:`translate(2px, ${t}px) rotate(180deg)`,transition:"transform 0.2s ease"}}),n.createElement(Rb,{size:15,style:{transform:`translate(2px, ${0-t}px)`,transition:"transform 0.2s ease"}}))},Rb=({size:e=10,className:t="",style:r})=>n.createElement("svg",{className:t,style:r||{},viewBox:"0 0 926.23699 573.74994",version:"1.1",x:"0px",y:"0px",width:e,height:e},n.createElement("g",{transform:"translate(904.92214,-879.1482)"},n.createElement("path",{d:"\n m -673.67664,1221.6502 -231.2455,-231.24803 55.6165,\n -55.627 c 30.5891,-30.59485 56.1806,-55.627 56.8701,-55.627 0.6894,\n 0 79.8637,78.60862 175.9427,174.68583 l 174.6892,174.6858 174.6892,\n -174.6858 c 96.079,-96.07721 175.253196,-174.68583 175.942696,\n -174.68583 0.6895,0 26.281,25.03215 56.8701,\n 55.627 l 55.6165,55.627 -231.245496,231.24803 c -127.185,127.1864\n -231.5279,231.248 -231.873,231.248 -0.3451,0 -104.688,\n -104.0616 -231.873,-231.248 z\n ",fill:"currentColor"}))),jb=ga.div`
user-select: none;
width: 20px;
height: 20px;
align-self: center;
display: flex;
flex-direction: column;
color: ${e=>e.theme.colors.primary.main};
`;Object.defineProperty,Object.getOwnPropertyDescriptor;let Tb;qr&&(Tb=r(5114));const Ib=Tb&&Tb(),Nb=ga.div`
width: ${e=>e.theme.sidebar.width};
background-color: ${e=>e.theme.sidebar.backgroundColor};
overflow: hidden;
display: flex;
flex-direction: column;
backface-visibility: hidden;
/* contain: strict; TODO: breaks layout since Chrome 80*/
height: 100vh;
position: sticky;
position: -webkit-sticky;
top: 0;
${ma("small")`
position: fixed;
z-index: 20;
width: 100%;
background: ${({theme:e})=>e.sidebar.backgroundColor};
display: ${e=>e.open?"flex":"none"};
`};
@media print {
display: none;
}
`,Db=ga.div`
outline: none;
user-select: none;
background-color: ${({theme:e})=>e.fab.backgroundColor};
color: ${e=>e.theme.colors.primary.main};
display: none;
cursor: pointer;
position: fixed;
right: 20px;
z-index: 100;
border-radius: 50%;
box-shadow: 0 0 20px rgba(0, 0, 0, 0.3);
${ma("small")`
display: flex;
`};
bottom: 44px;
width: 60px;
height: 60px;
padding: 0 20px;
svg {
color: ${({theme:e})=>e.fab.color};
}
@media print {
display: none;
}
`;let Lb=class extends n.Component{constructor(){super(...arguments),this.state={offsetTop:"0px"},this.toggleNavMenu=()=>{this.props.menu.toggleSidebar()}}componentDidMount(){Ib&&Ib.add(this.stickyElement),this.setState({offsetTop:this.getScrollYOffset(this.context)})}componentWillUnmount(){Ib&&Ib.remove(this.stickyElement)}getScrollYOffset(e){let t;return t=void 0!==this.props.scrollYOffset?xo.normalizeScrollYOffset(this.props.scrollYOffset)():e.scrollYOffset(),t+"px"}render(){const e=this.props.menu.sideBarOpened,t=this.state.offsetTop;return n.createElement(n.Fragment,null,n.createElement(Nb,{open:e,className:this.props.className,style:{top:t,height:`calc(100vh - ${t})`},ref:e=>{this.stickyElement=e}},this.props.children),!this.context.hideFab&&n.createElement(Db,{onClick:this.toggleNavMenu},n.createElement(Cb,{open:e})))}};Lb.contextType=Sa,Lb=((e,t,n,r)=>{for(var o,i=t,a=e.length-1;a>=0;a--)(o=e[a])&&(i=o(i)||i);return i})([im],Lb);const Mb=ga.div`
${({theme:e})=>`\n font-family: ${e.typography.fontFamily};\n font-size: ${e.typography.fontSize};\n font-weight: ${e.typography.fontWeightRegular};\n line-height: ${e.typography.lineHeight};\n color: ${e.colors.text.primary};\n display: flex;\n position: relative;\n text-align: left;\n\n -webkit-font-smoothing: ${e.typography.smoothing};\n font-smoothing: ${e.typography.smoothing};\n ${e.typography.optimizeSpeed?"text-rendering: optimizeSpeed !important":""};\n\n tap-highlight-color: rgba(0, 0, 0, 0);\n text-size-adjust: 100%;\n\n * {\n box-sizing: border-box;\n -webkit-tap-highlight-color: rgba(255, 255, 255, 0);\n }\n`};
`,Fb=ga.div`
z-index: 1;
position: relative;
overflow: hidden;
width: calc(100% - ${e=>e.theme.sidebar.width});
${ma("small",!0)`
width: 100%;
`};
contain: layout;
`,zb=ga.div`
background: ${({theme:e})=>e.rightPanel.backgroundColor};
position: absolute;
top: 0;
bottom: 0;
right: 0;
width: ${({theme:e})=>{if(e.rightPanel.width.endsWith("%")){const t=parseInt(e.rightPanel.width,10);return`calc((100% - ${e.sidebar.width}) * ${t/100})`}return e.rightPanel.width}};
${ma("medium",!0)`
display: none;
`};
`,Ub=ga.div`
padding: 5px 0;
`,Vb=ga.input.attrs((()=>({className:"search-input"})))`
width: calc(100% - ${e=>8*e.theme.spacing.unit}px);
box-sizing: border-box;
margin: 0 ${e=>4*e.theme.spacing.unit}px;
padding: 5px ${e=>2*e.theme.spacing.unit}px 5px
${e=>4*e.theme.spacing.unit}px;
border: 0;
border-bottom: 1px solid
${({theme:e})=>(Ir(e.sidebar.backgroundColor)>.5?Rr:Dr)(.1,e.sidebar.backgroundColor)};
font-family: ${({theme:e})=>e.typography.fontFamily};
font-weight: bold;
font-size: 13px;
color: ${e=>e.theme.sidebar.textColor};
background-color: transparent;
outline: none;
`,Bb=ga((e=>n.createElement("svg",{className:e.className,version:"1.1",viewBox:"0 0 1000 1000",x:"0px",xmlns:"http://www.w3.org/2000/svg",y:"0px"},n.createElement("path",{d:"M968.2,849.4L667.3,549c83.9-136.5,66.7-317.4-51.7-435.6C477.1-25,252.5-25,113.9,113.4c-138.5,138.3-138.5,362.6,0,501C219.2,730.1,413.2,743,547.6,666.5l301.9,301.4c43.6,43.6,76.9,14.9,104.2-12.4C981,928.3,1011.8,893,968.2,849.4z M524.5,522c-88.9,88.7-233,88.7-321.8,0c-88.9-88.7-88.9-232.6,0-321.3c88.9-88.7,233-88.7,321.8,0C613.4,289.4,613.4,433.3,524.5,522z"})))).attrs({className:"search-icon"})`
position: absolute;
left: ${e=>4*e.theme.spacing.unit}px;
height: 1.8em;
width: 0.9em;
path {
fill: ${e=>e.theme.sidebar.textColor};
}
`,qb=ga.div`
padding: ${e=>e.theme.spacing.unit}px 0;
background-color: ${({theme:e})=>Rr(.05,e.sidebar.backgroundColor)}};
color: ${e=>e.theme.sidebar.textColor};
min-height: 150px;
max-height: 250px;
border-top: ${({theme:e})=>Rr(.1,e.sidebar.backgroundColor)}};
border-bottom: ${({theme:e})=>Rr(.1,e.sidebar.backgroundColor)}};
margin-top: 10px;
line-height: 1.4;
font-size: 0.9em;
li {
background-color: inherit;
}
${Ey} {
padding-top: 6px;
padding-bottom: 6px;
&:hover,
&.active {
background-color: ${({theme:e})=>Rr(.1,e.sidebar.backgroundColor)};
}
> svg {
display: none;
}
}
`,Wb=ga.i`
position: absolute;
display: inline-block;
width: ${e=>2*e.theme.spacing.unit}px;
text-align: center;
right: ${e=>4*e.theme.spacing.unit}px;
line-height: 2em;
vertical-align: middle;
margin-right: 2px;
cursor: pointer;
font-style: normal;
color: '#666';
`;var Hb=Object.defineProperty,Yb=Object.getOwnPropertyDescriptor;class Kb extends n.PureComponent{constructor(e){super(e),this.activeItemRef=null,this.clear=()=>{this.setState({results:[],noResults:!1,term:"",activeItemIdx:-1}),this.props.marker.unmark()},this.handleKeyDown=e=>{if(27===e.keyCode&&this.clear(),40===e.keyCode&&(this.setState({activeItemIdx:Math.min(this.state.activeItemIdx+1,this.state.results.length-1)}),e.preventDefault()),38===e.keyCode&&(this.setState({activeItemIdx:Math.max(0,this.state.activeItemIdx-1)}),e.preventDefault()),13===e.keyCode){const e=this.state.results[this.state.activeItemIdx];if(e){const t=this.props.getItemById(e.meta);t&&this.props.onActivate(t)}}},this.search=e=>{const{minCharacterLengthToInitSearch:t}=this.context,n=e.target.value;n.length<t?this.clearResults(n):this.setState({term:n},(()=>this.searchCallback(this.state.term)))},this.state={results:[],noResults:!1,term:"",activeItemIdx:-1}}clearResults(e){this.setState({results:[],noResults:!1,term:e}),this.props.marker.unmark()}setResults(e,t){this.setState({results:e,noResults:0===e.length}),this.props.marker.mark(t)}searchCallback(e){this.props.search.search(e).then((t=>{this.setResults(t,e)}))}render(){const{activeItemIdx:e}=this.state,t=this.state.results.filter((e=>this.props.getItemById(e.meta))).map((e=>({item:this.props.getItemById(e.meta),score:e.score}))).sort(((e,t)=>t.score-e.score));return n.createElement(Ub,{role:"search"},this.state.term&&n.createElement(Wb,{onClick:this.clear},"×"),n.createElement(Bb,null),n.createElement(Vb,{value:this.state.term,onKeyDown:this.handleKeyDown,placeholder:"Search...","aria-label":"Search",type:"text",onChange:this.search}),t.length>0&&n.createElement(Pd,{options:{wheelPropagation:!1}},n.createElement(qb,{"data-role":"search:results"},t.map(((t,r)=>n.createElement(wb,{item:Object.create(t.item,{active:{value:r===e}}),onActivate:this.props.onActivate,withoutChildren:!0,key:t.item.id,"data-role":"search:result"}))))),this.state.term&&this.state.noResults?n.createElement(qb,{"data-role":"search:results"},lo("noResultsFound")):null)}}Kb.contextType=Sa,((e,t,n,r)=>{for(var o,i=Yb(t,n),a=e.length-1;a>=0;a--)(o=e[a])&&(i=o(t,n,i)||i);i&&Hb(t,n,i)})([Ra.bind,(0,Ra.debounce)(400)],Kb.prototype,"searchCallback");class Gb extends n.Component{componentDidMount(){this.props.store.onDidMount()}componentWillUnmount(){this.props.store.dispose()}render(){const{store:{spec:e,menu:t,options:r,search:o,marker:i}}=this.props,a=this.props.store;return n.createElement(ha,{theme:r.theme},n.createElement(Du,{value:a},n.createElement(Ea,{value:r},n.createElement(Mb,{className:"redoc-wrap"},n.createElement(Lb,{menu:t,className:"menu-content"},n.createElement(py,{info:e.info}),!r.disableSearch&&n.createElement(Kb,{search:o,marker:i,getItemById:t.getItemById,onActivate:t.activateAndScroll})||null,n.createElement($b,{menu:t})),n.createElement(Fb,{className:"api-content"},n.createElement(sy,{store:a}),n.createElement(lb,{items:t.items})),n.createElement(zb,null)))))}}Gb.propTypes={store:Oa.instanceOf(ey).isRequired};const Qb=function(e){const{spec:t,specUrl:o,options:i={},onLoaded:a}=e,s=bo(i.hideLoading,!1),l=new xo(i);if(void 0!==l.nonce)try{r.nc=l.nonce}catch(e){}return n.createElement(ba,null,n.createElement(Mu,{spec:t,specUrl:o,options:i,onLoaded:a},(({loading:e,store:t})=>e?s?null:n.createElement(_a,{color:l.theme.colors.primary.main}):n.createElement(Gb,{store:t}))))};var Xb=Object.defineProperty,Jb=Object.getOwnPropertySymbols,Zb=Object.prototype.hasOwnProperty,ew=Object.prototype.propertyIsEnumerable,tw=(e,t,n)=>t in e?Xb(e,t,{enumerable:!0,configurable:!0,writable:!0,value:n}):e[t]=n,nw=(e,t)=>{for(var n in t||(t={}))Zb.call(t,n)&&tw(e,n,t[n]);if(Jb)for(var n of Jb(t))ew.call(t,n)&&tw(e,n,t[n]);return e};Nt({useProxies:"ifavailable"});const rw="2.0.0",ow="5fb4daa";function iw(e){const t=function(e){const t={},n=e.attributes;for(let e=0;e<n.length;e++){const r=n[e];t[r.name]=r.value}return t}(e),n={};for(const e in t){const r=e.replace(/-(.)/g,((e,t)=>t.toUpperCase())),o=t[e];n[r]="theme"===e?JSON.parse(o):o}return n}function aw(e,t={},r=Wr("redoc"),o){if(null===r)throw new Error('"element" argument is not provided and <redoc> tag is not found on the page');let a,s;"string"==typeof e?a=e:"object"==typeof e&&(s=e),(0,i.render)(n.createElement(Qb,{spec:s,onLoaded:o,specUrl:a,options:nw(nw({},t),iw(r))},["Loading..."]),r)}function sw(e=Wr("redoc")){e&&(0,i.unmountComponentAtNode)(e)}function lw(e,t=Wr("redoc"),r){const o=ey.fromJS(e);setTimeout((()=>{(0,i.hydrate)(n.createElement(Gb,{store:o}),t,r)}),0)}!function(){const e=Wr("redoc");if(!e)return;const t=e.getAttribute("spec-url");t&&aw(t,{},e)}()}(),o}()}));
//# sourceMappingURL=redoc.standalone.js.map</script><style data-styled="true" data-styled-version="5.3.0">.juinod{width:calc(100% - 40%);padding:0 40px;}/*!sc*/
@media print,screen and (max-width:75rem){.juinod{width:100%;padding:40px 40px;}}/*!sc*/
.bJcDWV{width:calc(100% - 40%);padding:0 40px;}/*!sc*/
@media print,screen and (max-width:75rem){.bJcDWV{width:100%;padding:0px 40px;}}/*!sc*/
data-styled.g4[id="sc-hKFxyN"]{content:"juinod,bJcDWV,"}/*!sc*/
.jlMQbh{padding:40px 0;}/*!sc*/
.jlMQbh:last-child{min-height:calc(100vh + 1px);}/*!sc*/
.sc-eCApnc > .sc-eCApnc:last-child{min-height:initial;}/*!sc*/
@media print,screen and (max-width:75rem){.jlMQbh{padding:0;}}/*!sc*/
.liLqNm{padding:40px 0;position:relative;}/*!sc*/
.liLqNm:last-child{min-height:calc(100vh + 1px);}/*!sc*/
.sc-eCApnc > .sc-eCApnc:last-child{min-height:initial;}/*!sc*/
@media print,screen and (max-width:75rem){.liLqNm{padding:0;}}/*!sc*/
.liLqNm:not(:last-of-type):after{position:absolute;bottom:0;width:100%;display:block;content:'';border-bottom:1px solid rgba(0,0,0,0.2);}/*!sc*/
data-styled.g5[id="sc-eCApnc"]{content:"jlMQbh,liLqNm,"}/*!sc*/
.gBjRyf{width:40%;color:#ffffff;background-color:#263238;padding:0 40px;}/*!sc*/
@media print,screen and (max-width:75rem){.gBjRyf{width:100%;padding:40px 40px;}}/*!sc*/
data-styled.g6[id="sc-jSFjdj"]{content:"gBjRyf,"}/*!sc*/
.gcushC{background-color:#263238;}/*!sc*/
data-styled.g7[id="sc-gKAaRy"]{content:"gcushC,"}/*!sc*/
.gLxhOh{display:-webkit-box;display:-webkit-flex;display:-ms-flexbox;display:flex;width:100%;padding:0;}/*!sc*/
@media print,screen and (max-width:75rem){.gLxhOh{-webkit-flex-direction:column;-ms-flex-direction:column;flex-direction:column;}}/*!sc*/
data-styled.g8[id="sc-iCoGMd"]{content:"gLxhOh,"}/*!sc*/
.bpZWeL{font-family:Montserrat,sans-serif;font-weight:400;font-size:1.85714em;line-height:1.6em;color:#333333;}/*!sc*/
data-styled.g9[id="sc-fujyAs"]{content:"bpZWeL,"}/*!sc*/
.eftmgB{font-family:Montserrat,sans-serif;font-weight:400;font-size:1.57143em;line-height:1.6em;color:#333333;margin:0 0 20px;}/*!sc*/
data-styled.g10[id="sc-pNWdM"]{content:"eftmgB,"}/*!sc*/
.iXmHCl{color:#ffffff;}/*!sc*/
data-styled.g12[id="sc-kEqXSa"]{content:"iXmHCl,"}/*!sc*/
.eONCmm{border-bottom:1px solid rgba(38,50,56,0.3);margin:1em 0 1em 0;color:rgba(38,50,56,0.5);font-weight:normal;text-transform:uppercase;font-size:0.929em;line-height:20px;}/*!sc*/
data-styled.g13[id="sc-iqAclL"]{content:"eONCmm,"}/*!sc*/
.iUxAWq{cursor:pointer;margin-left:-20px;padding:0;line-height:1;width:20px;display:inline-block;outline:0;}/*!sc*/
.iUxAWq:before{content:'';width:15px;height:15px;background-size:contain;background-image:url('data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHZlcnNpb249IjEuMSIgeD0iMCIgeT0iMCIgd2lkdGg9IjUxMiIgaGVpZ2h0PSI1MTIiIHZpZXdCb3g9IjAgMCA1MTIgNTEyIiBlbmFibGUtYmFja2dyb3VuZD0ibmV3IDAgMCA1MTIgNTEyIiB4bWw6c3BhY2U9InByZXNlcnZlIj48cGF0aCBmaWxsPSIjMDEwMTAxIiBkPSJNNDU5LjcgMjMzLjRsLTkwLjUgOTAuNWMtNTAgNTAtMTMxIDUwLTE4MSAwIC03LjktNy44LTE0LTE2LjctMTkuNC0yNS44bDQyLjEtNDIuMWMyLTIgNC41LTMuMiA2LjgtNC41IDIuOSA5LjkgOCAxOS4zIDE1LjggMjcuMiAyNSAyNSA2NS42IDI0LjkgOTAuNSAwbDkwLjUtOTAuNWMyNS0yNSAyNS02NS42IDAtOTAuNSAtMjQuOS0yNS02NS41LTI1LTkwLjUgMGwtMzIuMiAzMi4yYy0yNi4xLTEwLjItNTQuMi0xMi45LTgxLjYtOC45bDY4LjYtNjguNmM1MC01MCAxMzEtNTAgMTgxIDBDNTA5LjYgMTAyLjMgNTA5LjYgMTgzLjQgNDU5LjcgMjMzLjR6TTIyMC4zIDM4Mi4ybC0zMi4yIDMyLjJjLTI1IDI0LjktNjUuNiAyNC45LTkwLjUgMCAtMjUtMjUtMjUtNjUuNiAwLTkwLjVsOTAuNS05MC41YzI1LTI1IDY1LjUtMjUgOTAuNSAwIDcuOCA3LjggMTIuOSAxNy4yIDE1LjggMjcuMSAyLjQtMS40IDQuOC0yLjUgNi44LTQuNWw0Mi4xLTQyYy01LjQtOS4yLTExLjYtMTgtMTkuNC0yNS44IC01MC01MC0xMzEtNTAtMTgxIDBsLTkwLjUgOTAuNWMtNTAgNTAtNTAgMTMxIDAgMTgxIDUwIDUwIDEzMSA1MCAxODEgMGw2OC42LTY4LjZDMjc0LjYgMzk1LjEgMjQ2LjQgMzkyLjMgMjIwLjMgMzgyLjJ6Ii8+PC9zdmc+Cg==');opacity:0.5;visibility:hidden;display:inline-block;vertical-align:middle;}/*!sc*/
h1:hover > .sc-crzoAE::before,h2:hover > .iUxAWq::before,.iUxAWq:hover::before{visibility:visible;}/*!sc*/
data-styled.g14[id="sc-crzoAE"]{content:"iUxAWq,"}/*!sc*/
.dvcDrG{height:18px;width:18px;min-width:18px;vertical-align:middle;float:right;-webkit-transition:-webkit-transform 0.2s ease-out;-webkit-transition:transform 0.2s ease-out;transition:transform 0.2s ease-out;-webkit-transform:rotateZ(-90deg);-ms-transform:rotateZ(-90deg);transform:rotateZ(-90deg);}/*!sc*/
.iPqByX{height:1.3em;width:1.3em;min-width:1.3em;vertical-align:middle;-webkit-transition:-webkit-transform 0.2s ease-out;-webkit-transition:transform 0.2s ease-out;transition:transform 0.2s ease-out;-webkit-transform:rotateZ(-90deg);-ms-transform:rotateZ(-90deg);transform:rotateZ(-90deg);}/*!sc*/
.dqYXmg{height:1.5em;width:1.5em;min-width:1.5em;vertical-align:middle;float:left;-webkit-transition:-webkit-transform 0.2s ease-out;-webkit-transition:transform 0.2s ease-out;transition:transform 0.2s ease-out;-webkit-transform:rotateZ(-90deg);-ms-transform:rotateZ(-90deg);transform:rotateZ(-90deg);}/*!sc*/
.dqYXmg polygon{fill:#1d8127;}/*!sc*/
.bRmrKA{height:20px;width:20px;min-width:20px;vertical-align:middle;float:right;-webkit-transition:-webkit-transform 0.2s ease-out;-webkit-transition:transform 0.2s ease-out;transition:transform 0.2s ease-out;-webkit-transform:rotateZ(0);-ms-transform:rotateZ(0);transform:rotateZ(0);}/*!sc*/
.bRmrKA polygon{fill:white;}/*!sc*/
.hGHhhO{height:18px;width:18px;min-width:18px;vertical-align:middle;-webkit-transition:-webkit-transform 0.2s ease-out;-webkit-transition:transform 0.2s ease-out;transition:transform 0.2s ease-out;-webkit-transform:rotateZ(-90deg);-ms-transform:rotateZ(-90deg);transform:rotateZ(-90deg);}/*!sc*/
.dVWHLw{height:1.5em;width:1.5em;min-width:1.5em;vertical-align:middle;float:left;-webkit-transition:-webkit-transform 0.2s ease-out;-webkit-transition:transform 0.2s ease-out;transition:transform 0.2s ease-out;-webkit-transform:rotateZ(-90deg);-ms-transform:rotateZ(-90deg);transform:rotateZ(-90deg);}/*!sc*/
.dVWHLw polygon{fill:#d41f1c;}/*!sc*/
data-styled.g15[id="sc-dIsUp"]{content:"dvcDrG,iPqByX,dqYXmg,bRmrKA,hGHhhO,dVWHLw,"}/*!sc*/
.eSYQnm{display:inline-block;padding:2px 8px;margin:0;background-color:#ffa500;color:#ffffff;font-size:13px;vertical-align:middle;line-height:1.6;border-radius:4px;font-weight:600;font-size:12px;}/*!sc*/
.eSYQnm + span[type]{margin-left:4px;}/*!sc*/
.jeXFeD{display:inline-block;padding:2px 8px;margin:0;background-color:#32329f;color:#fff;font-size:13px;vertical-align:middle;line-height:1.6;border-radius:4px;font-weight:600;font-size:12px;}/*!sc*/
.jeXFeD + span[type]{margin-left:4px;}/*!sc*/
data-styled.g16[id="sc-bqGGPW"]{content:"eSYQnm,jeXFeD,"}/*!sc*/
.iwcKgn{border-left:1px solid #7c7cbb;box-sizing:border-box;position:relative;padding:10px 10px 10px 0;}/*!sc*/
@media screen and (max-width:50rem){.iwcKgn{display:block;overflow:hidden;}}/*!sc*/
tr:first-of-type > .sc-hBMUJo,tr.last > .iwcKgn{border-left-width:0;background-position:top left;background-repeat:no-repeat;background-size:1px 100%;}/*!sc*/
tr:first-of-type > .sc-hBMUJo{background-image:linear-gradient( to bottom, transparent 0%, transparent 22px, #7c7cbb 22px, #7c7cbb 100% );}/*!sc*/
tr.last > .sc-hBMUJo{background-image:linear-gradient( to bottom, #7c7cbb 0%, #7c7cbb 22px, transparent 22px, transparent 100% );}/*!sc*/
tr.last + tr > .sc-hBMUJo{border-left-color:transparent;}/*!sc*/
tr.last:first-child > .sc-hBMUJo{background:none;border-left-color:transparent;}/*!sc*/
data-styled.g18[id="sc-hBMUJo"]{content:"iwcKgn,"}/*!sc*/
.cAqMTE{vertical-align:top;line-height:20px;white-space:nowrap;font-size:13px;font-family:Courier,monospace;}/*!sc*/
.cAqMTE.deprecated{-webkit-text-decoration:line-through;text-decoration:line-through;color:#707070;}/*!sc*/
data-styled.g20[id="sc-fFSPTT"]{content:"cAqMTE,"}/*!sc*/
.ctPuOP{border-bottom:1px solid #9fb4be;padding:10px 0;width:75%;box-sizing:border-box;}/*!sc*/
tr.expanded .sc-bkbkJK{border-bottom:none;}/*!sc*/
@media screen and (max-width:50rem){.ctPuOP{padding:0 20px;border-bottom:none;border-left:1px solid #7c7cbb;}tr.last > .sc-bkbkJK{border-left:none;}}/*!sc*/
data-styled.g21[id="sc-bkbkJK"]{content:"ctPuOP,"}/*!sc*/
.bcnRwz{color:#7c7cbb;font-family:Courier,monospace;margin-right:10px;}/*!sc*/
.bcnRwz::before{content:'';display:inline-block;vertical-align:middle;width:10px;height:1px;background:#7c7cbb;}/*!sc*/
.bcnRwz::after{content:'';display:inline-block;vertical-align:middle;width:1px;background:#7c7cbb;height:7px;}/*!sc*/
data-styled.g22[id="sc-iemWCZ"]{content:"bcnRwz,"}/*!sc*/
.VCQHZ{border-collapse:separate;border-radius:3px;font-size:14px;border-spacing:0;width:100%;}/*!sc*/
.VCQHZ > tr{vertical-align:middle;}/*!sc*/
@media screen and (max-width:50rem){.VCQHZ{display:block;}.VCQHZ > tr,.VCQHZ > tbody > tr{display:block;}}/*!sc*/
@media screen and (max-width:50rem) and (-ms-high-contrast:none){.VCQHZ td{float:left;width:100%;}}/*!sc*/
.VCQHZ .sc-dIvrsQ,.VCQHZ .sc-dIvrsQ .sc-dIvrsQ .sc-dIvrsQ,.VCQHZ .sc-dIvrsQ .sc-dIvrsQ .sc-dIvrsQ .sc-dIvrsQ .sc-dIvrsQ{margin:1em;margin-right:0;background:#fafafa;}/*!sc*/
.VCQHZ .sc-dIvrsQ .sc-dIvrsQ,.VCQHZ .sc-dIvrsQ .sc-dIvrsQ .sc-dIvrsQ .sc-dIvrsQ,.VCQHZ .sc-dIvrsQ .sc-dIvrsQ .sc-dIvrsQ .sc-dIvrsQ .sc-dIvrsQ .sc-dIvrsQ{background:#ffffff;}/*!sc*/
data-styled.g24[id="sc-hHEiqL"]{content:"VCQHZ,"}/*!sc*/
.EoFth{margin:0 0 3px 0;display:inline-block;}/*!sc*/
data-styled.g25[id="sc-dlMDgC"]{content:"EoFth,"}/*!sc*/
.juYXUf{font-size:0.9em;margin-right:10px;color:#32329f;font-family:Montserrat,sans-serif;}/*!sc*/
data-styled.g26[id="sc-kfYoZR"]{content:"juYXUf,"}/*!sc*/
.PukRR{display:inline-block;margin-right:10px;margin-bottom:5px;font-size:0.8em;cursor:pointer;border:1px solid #32329f;padding:2px 10px;line-height:1.5em;outline:none;color:white;background-color:#32329f;}/*!sc*/
.PukRR:focus{box-shadow:0 0 0 1px #32329f;}/*!sc*/
.PukRR:focus{box-shadow:none;background-color:#202065;}/*!sc*/
.bpjiHN{display:inline-block;margin-right:10px;margin-bottom:5px;font-size:0.8em;cursor:pointer;border:1px solid #32329f;padding:2px 10px;line-height:1.5em;outline:none;color:#32329f;background-color:white;}/*!sc*/
.bpjiHN:focus{box-shadow:0 0 0 1px #32329f;}/*!sc*/
data-styled.g27[id="sc-fKgJPI"]{content:"PukRR,bpjiHN,"}/*!sc*/
.gxohHo > ul{list-style:none;padding:0;margin:0;margin:0 -5px;}/*!sc*/
.gxohHo > ul > li{padding:5px 10px;display:inline-block;background-color:#11171a;border-bottom:1px solid rgba(0,0,0,0.5);cursor:pointer;text-align:center;outline:none;color:#ccc;margin:0 5px 5px 5px;border:1px solid #07090b;border-radius:5px;min-width:60px;font-size:0.9em;font-weight:bold;}/*!sc*/
.gxohHo > ul > li.react-tabs__tab--selected{color:#333333;background:#ffffff;}/*!sc*/
.gxohHo > ul > li.react-tabs__tab--selected:focus{outline:auto;}/*!sc*/
.gxohHo > ul > li:only-child{-webkit-flex:none;-ms-flex:none;flex:none;min-width:100px;}/*!sc*/
.gxohHo > ul > li.tab-success{color:#1d8127;}/*!sc*/
.gxohHo > ul > li.tab-redirect{color:#ffa500;}/*!sc*/
.gxohHo > ul > li.tab-info{color:#87ceeb;}/*!sc*/
.gxohHo > ul > li.tab-error{color:#d41f1c;}/*!sc*/
.gxohHo > .react-tabs__tab-panel{background:#11171a;}/*!sc*/
.gxohHo > .react-tabs__tab-panel > div,.gxohHo > .react-tabs__tab-panel > pre{padding:20px;margin:0;}/*!sc*/
.gxohHo > .react-tabs__tab-panel > div > pre{padding:0;}/*!sc*/
data-styled.g30[id="sc-cxNHIi"]{content:"gxohHo,"}/*!sc*/
.jCdxGr code[class*='language-'],.jCdxGr pre[class*='language-']{text-shadow:0 -0.1em 0.2em black;text-align:left;white-space:pre;word-spacing:normal;word-break:normal;word-wrap:normal;line-height:1.5;-moz-tab-size:4;-o-tab-size:4;tab-size:4;-webkit-hyphens:none;-moz-hyphens:none;-ms-hyphens:none;-webkit-hyphens:none;-moz-hyphens:none;-ms-hyphens:none;hyphens:none;}/*!sc*/
@media print{.jCdxGr code[class*='language-'],.jCdxGr pre[class*='language-']{text-shadow:none;}}/*!sc*/
.jCdxGr pre[class*='language-']{padding:1em;margin:0.5em 0;overflow:auto;}/*!sc*/
.jCdxGr .token.comment,.jCdxGr .token.prolog,.jCdxGr .token.doctype,.jCdxGr .token.cdata{color:hsl(30,20%,50%);}/*!sc*/
.jCdxGr .token.punctuation{opacity:0.7;}/*!sc*/
.jCdxGr .namespace{opacity:0.7;}/*!sc*/
.jCdxGr .token.property,.jCdxGr .token.tag,.jCdxGr .token.number,.jCdxGr .token.constant,.jCdxGr .token.symbol{color:#4a8bb3;}/*!sc*/
.jCdxGr .token.boolean{color:#e64441;}/*!sc*/
.jCdxGr .token.selector,.jCdxGr .token.attr-name,.jCdxGr .token.string,.jCdxGr .token.char,.jCdxGr .token.builtin,.jCdxGr .token.inserted{color:#a0fbaa;}/*!sc*/
.jCdxGr .token.selector + a,.jCdxGr .token.attr-name + a,.jCdxGr .token.string + a,.jCdxGr .token.char + a,.jCdxGr .token.builtin + a,.jCdxGr .token.inserted + a,.jCdxGr .token.selector + a:visited,.jCdxGr .token.attr-name + a:visited,.jCdxGr .token.string + a:visited,.jCdxGr .token.char + a:visited,.jCdxGr .token.builtin + a:visited,.jCdxGr .token.inserted + a:visited{color:#4ed2ba;-webkit-text-decoration:underline;text-decoration:underline;}/*!sc*/
.jCdxGr .token.property.string{color:white;}/*!sc*/
.jCdxGr .token.operator,.jCdxGr .token.entity,.jCdxGr .token.url,.jCdxGr .token.variable{color:hsl(40,90%,60%);}/*!sc*/
.jCdxGr .token.atrule,.jCdxGr .token.attr-value,.jCdxGr .token.keyword{color:hsl(350,40%,70%);}/*!sc*/
.jCdxGr .token.regex,.jCdxGr .token.important{color:#e90;}/*!sc*/
.jCdxGr .token.important,.jCdxGr .token.bold{font-weight:bold;}/*!sc*/
.jCdxGr .token.italic{font-style:italic;}/*!sc*/
.jCdxGr .token.entity{cursor:help;}/*!sc*/
.jCdxGr .token.deleted{color:red;}/*!sc*/
data-styled.g32[id="sc-iJCRrE"]{content:"jCdxGr,"}/*!sc*/
.hMPeqJ{opacity:0.7;-webkit-transition:opacity 0.3s ease;transition:opacity 0.3s ease;text-align:right;}/*!sc*/
.hMPeqJ:focus-within{opacity:1;}/*!sc*/
.hMPeqJ > button{background-color:transparent;border:0;color:inherit;padding:2px 10px;font-family:Roboto,sans-serif;font-size:14px;line-height:1.5em;cursor:pointer;outline:0;}/*!sc*/
.hMPeqJ > button:hover,.hMPeqJ > button:focus{background:rgba(255,255,255,0.1);}/*!sc*/
data-styled.g33[id="sc-giAqHp"]{content:"hMPeqJ,"}/*!sc*/
.kiAqTA:hover .sc-giAqHp{opacity:1;}/*!sc*/
data-styled.g34[id="sc-ezzafa"]{content:"kiAqTA,"}/*!sc*/
.eMUKnN code[class*='language-'],.eMUKnN pre[class*='language-']{text-shadow:0 -0.1em 0.2em black;text-align:left;white-space:pre;word-spacing:normal;word-break:normal;word-wrap:normal;line-height:1.5;-moz-tab-size:4;-o-tab-size:4;tab-size:4;-webkit-hyphens:none;-moz-hyphens:none;-ms-hyphens:none;-webkit-hyphens:none;-moz-hyphens:none;-ms-hyphens:none;hyphens:none;}/*!sc*/
@media print{.eMUKnN code[class*='language-'],.eMUKnN pre[class*='language-']{text-shadow:none;}}/*!sc*/
.eMUKnN pre[class*='language-']{padding:1em;margin:0.5em 0;overflow:auto;}/*!sc*/
.eMUKnN .token.comment,.eMUKnN .token.prolog,.eMUKnN .token.doctype,.eMUKnN .token.cdata{color:hsl(30,20%,50%);}/*!sc*/
.eMUKnN .token.punctuation{opacity:0.7;}/*!sc*/
.eMUKnN .namespace{opacity:0.7;}/*!sc*/
.eMUKnN .token.property,.eMUKnN .token.tag,.eMUKnN .token.number,.eMUKnN .token.constant,.eMUKnN .token.symbol{color:#4a8bb3;}/*!sc*/
.eMUKnN .token.boolean{color:#e64441;}/*!sc*/
.eMUKnN .token.selector,.eMUKnN .token.attr-name,.eMUKnN .token.string,.eMUKnN .token.char,.eMUKnN .token.builtin,.eMUKnN .token.inserted{color:#a0fbaa;}/*!sc*/
.eMUKnN .token.selector + a,.eMUKnN .token.attr-name + a,.eMUKnN .token.string + a,.eMUKnN .token.char + a,.eMUKnN .token.builtin + a,.eMUKnN .token.inserted + a,.eMUKnN .token.selector + a:visited,.eMUKnN .token.attr-name + a:visited,.eMUKnN .token.string + a:visited,.eMUKnN .token.char + a:visited,.eMUKnN .token.builtin + a:visited,.eMUKnN .token.inserted + a:visited{color:#4ed2ba;-webkit-text-decoration:underline;text-decoration:underline;}/*!sc*/
.eMUKnN .token.property.string{color:white;}/*!sc*/
.eMUKnN .token.operator,.eMUKnN .token.entity,.eMUKnN .token.url,.eMUKnN .token.variable{color:hsl(40,90%,60%);}/*!sc*/
.eMUKnN .token.atrule,.eMUKnN .token.attr-value,.eMUKnN .token.keyword{color:hsl(350,40%,70%);}/*!sc*/
.eMUKnN .token.regex,.eMUKnN .token.important{color:#e90;}/*!sc*/
.eMUKnN .token.important,.eMUKnN .token.bold{font-weight:bold;}/*!sc*/
.eMUKnN .token.italic{font-style:italic;}/*!sc*/
.eMUKnN .token.entity{cursor:help;}/*!sc*/
.eMUKnN .token.deleted{color:red;}/*!sc*/
data-styled.g35[id="sc-bYwzuL"]{content:"eMUKnN,"}/*!sc*/
.bOBJeo{font-family:Courier,monospace;font-size:13px;overflow-x:auto;margin:0;white-space:pre;}/*!sc*/
data-styled.g36[id="sc-kLojOw"]{content:"bOBJeo,"}/*!sc*/
.leCKhp{position:relative;}/*!sc*/
data-styled.g38[id="sc-iklJeh"]{content:"leCKhp,"}/*!sc*/
.gVpQmv{position:absolute;pointer-events:none;z-index:1;top:50%;-webkit-transform:translateY(-50%);-ms-transform:translateY(-50%);-webkit-transform:translateY(-50%);-ms-transform:translateY(-50%);transform:translateY(-50%);right:8px;margin:auto;text-align:center;}/*!sc*/
.gVpQmv polyline{color:white;}/*!sc*/
.hzcSs{position:absolute;pointer-events:none;z-index:1;top:50%;-webkit-transform:translateY(-50%);-ms-transform:translateY(-50%);-webkit-transform:translateY(-50%);-ms-transform:translateY(-50%);transform:translateY(-50%);right:8px;margin:auto;text-align:center;}/*!sc*/
data-styled.g39[id="sc-jJMGnK"]{content:"gVpQmv,hzcSs,"}/*!sc*/
.bycQNU{box-sizing:border-box;min-width:100px;outline:none;display:inline-block;border-radius:2px;border:1px solid rgba(38,50,56,0.5);vertical-align:bottom;padding:2px 0px 2px 6px;position:relative;width:auto;background:white;color:#263238;font-family:Montserrat,sans-serif;font-size:0.929em;line-height:1.5em;cursor:pointer;-webkit-transition:border 0.25s ease,color 0.25s ease,box-shadow 0.25s ease;transition:border 0.25s ease,color 0.25s ease,box-shadow 0.25s ease;}/*!sc*/
.bycQNU label{box-sizing:border-box;min-width:100px;outline:none;display:inline-block;font-family:Montserrat,sans-serif;color:#333333;vertical-align:bottom;width:auto;text-transform:none;padding:0 22px 0 4px;font-size:0.929em;line-height:1.5em;font-family:inherit;text-overflow:ellipsis;overflow:hidden;white-space:nowrap;}/*!sc*/
.bycQNU .dropdown-select{position:absolute;top:0;left:0;width:100%;height:100%;opacity:0;border:none;-webkit-appearance:none;-moz-appearance:none;appearance:none;cursor:pointer;color:#333333;line-height:inherit;font-family:inherit;}/*!sc*/
.bycQNU:hover,.bycQNU:focus-within{border:1px solid #32329f;color:#32329f;box-shadow:0px 0px 0px 1px #32329f;}/*!sc*/
data-styled.g40[id="sc-hiKfDv"]{content:"bycQNU,"}/*!sc*/
.dhIYNk{margin-left:10px;text-transform:none;font-size:0.969em;font-size:1em;border:none;padding:0 1.2em 0 0;background:transparent;}/*!sc*/
.dhIYNk:hover,.dhIYNk:focus-within{border:none;box-shadow:none;}/*!sc*/
.dhIYNk:hover label,.dhIYNk:focus-within label{color:#32329f;text-shadow:0px 0px 0px #32329f;}/*!sc*/
data-styled.g41[id="sc-gXfVKN"]{content:"dhIYNk,"}/*!sc*/
.eKyrDP{margin-left:10px;text-transform:none;font-size:0.929em;color:black;}/*!sc*/
data-styled.g42[id="sc-cBoqAE"]{content:"eKyrDP,"}/*!sc*/
.QGruV{font-family:Roboto,sans-serif;font-weight:400;line-height:1.5em;}/*!sc*/
.QGruV p:last-child{margin-bottom:0;}/*!sc*/
.QGruV h1{font-family:Montserrat,sans-serif;font-weight:400;font-size:1.85714em;line-height:1.6em;color:#32329f;margin-top:0;}/*!sc*/
.QGruV h2{font-family:Montserrat,sans-serif;font-weight:400;font-size:1.57143em;line-height:1.6em;color:#333333;}/*!sc*/
.QGruV code{color:#e53935;background-color:rgba(38,50,56,0.05);font-family:Courier,monospace;border-radius:2px;border:1px solid rgba(38,50,56,0.1);padding:0 5px;font-size:13px;font-weight:400;word-break:break-word;}/*!sc*/
.QGruV pre{font-family:Courier,monospace;white-space:pre;background-color:#11171a;color:white;padding:20px;overflow-x:auto;line-height:normal;border-radius:0px;border:1px solid rgba(38,50,56,0.1);}/*!sc*/
.QGruV pre code{background-color:transparent;color:white;padding:0;}/*!sc*/
.QGruV pre code:before,.QGruV pre code:after{content:none;}/*!sc*/
.QGruV blockquote{margin:0;margin-bottom:1em;padding:0 15px;color:#777;border-left:4px solid #ddd;}/*!sc*/
.QGruV img{max-width:100%;box-sizing:content-box;}/*!sc*/
.QGruV ul,.QGruV ol{padding-left:2em;margin:0;margin-bottom:1em;}/*!sc*/
.QGruV ul ul,.QGruV ol ul,.QGruV ul ol,.QGruV ol ol{margin-bottom:0;margin-top:0;}/*!sc*/
.QGruV table{display:block;width:100%;overflow:auto;word-break:normal;word-break:keep-all;border-collapse:collapse;border-spacing:0;margin-top:1.5em;margin-bottom:1.5em;}/*!sc*/
.QGruV table tr{background-color:#fff;border-top:1px solid #ccc;}/*!sc*/
.QGruV table tr:nth-child(2n){background-color:#fafafa;}/*!sc*/
.QGruV table th,.QGruV table td{padding:6px 13px;border:1px solid #ddd;}/*!sc*/
.QGruV table th{text-align:left;font-weight:bold;}/*!sc*/
.QGruV .share-link{cursor:pointer;margin-left:-20px;padding:0;line-height:1;width:20px;display:inline-block;outline:0;}/*!sc*/
.QGruV .share-link:before{content:'';width:15px;height:15px;background-size:contain;background-image:url('data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHZlcnNpb249IjEuMSIgeD0iMCIgeT0iMCIgd2lkdGg9IjUxMiIgaGVpZ2h0PSI1MTIiIHZpZXdCb3g9IjAgMCA1MTIgNTEyIiBlbmFibGUtYmFja2dyb3VuZD0ibmV3IDAgMCA1MTIgNTEyIiB4bWw6c3BhY2U9InByZXNlcnZlIj48cGF0aCBmaWxsPSIjMDEwMTAxIiBkPSJNNDU5LjcgMjMzLjRsLTkwLjUgOTAuNWMtNTAgNTAtMTMxIDUwLTE4MSAwIC03LjktNy44LTE0LTE2LjctMTkuNC0yNS44bDQyLjEtNDIuMWMyLTIgNC41LTMuMiA2LjgtNC41IDIuOSA5LjkgOCAxOS4zIDE1LjggMjcuMiAyNSAyNSA2NS42IDI0LjkgOTAuNSAwbDkwLjUtOTAuNWMyNS0yNSAyNS02NS42IDAtOTAuNSAtMjQuOS0yNS02NS41LTI1LTkwLjUgMGwtMzIuMiAzMi4yYy0yNi4xLTEwLjItNTQuMi0xMi45LTgxLjYtOC45bDY4LjYtNjguNmM1MC01MCAxMzEtNTAgMTgxIDBDNTA5LjYgMTAyLjMgNTA5LjYgMTgzLjQgNDU5LjcgMjMzLjR6TTIyMC4zIDM4Mi4ybC0zMi4yIDMyLjJjLTI1IDI0LjktNjUuNiAyNC45LTkwLjUgMCAtMjUtMjUtMjUtNjUuNiAwLTkwLjVsOTAuNS05MC41YzI1LTI1IDY1LjUtMjUgOTAuNSAwIDcuOCA3LjggMTIuOSAxNy4yIDE1LjggMjcuMSAyLjQtMS40IDQuOC0yLjUgNi44LTQuNWw0Mi4xLTQyYy01LjQtOS4yLTExLjYtMTgtMTkuNC0yNS44IC01MC01MC0xMzEtNTAtMTgxIDBsLTkwLjUgOTAuNWMtNTAgNTAtNTAgMTMxIDAgMTgxIDUwIDUwIDEzMSA1MCAxODEgMGw2OC42LTY4LjZDMjc0LjYgMzk1LjEgMjQ2LjQgMzkyLjMgMjIwLjMgMzgyLjJ6Ii8+PC9zdmc+Cg==');opacity:0.5;visibility:hidden;display:inline-block;vertical-align:middle;}/*!sc*/
.QGruV h1:hover > .share-link::before,.QGruV h2:hover > .share-link::before,.QGruV .share-link:hover::before{visibility:visible;}/*!sc*/
.QGruV a{-webkit-text-decoration:auto;text-decoration:auto;color:#32329f;}/*!sc*/
.QGruV a:visited{color:#32329f;}/*!sc*/
.QGruV a:hover{color:#6868cf;-webkit-text-decoration:auto;text-decoration:auto;}/*!sc*/
.lhENGb{font-family:Roboto,sans-serif;font-weight:400;line-height:1.5em;}/*!sc*/
.lhENGb p:last-child{margin-bottom:0;}/*!sc*/
.lhENGb p:first-child{margin-top:0;}/*!sc*/
.lhENGb p:last-child{margin-bottom:0;}/*!sc*/
.lhENGb h1{font-family:Montserrat,sans-serif;font-weight:400;font-size:1.85714em;line-height:1.6em;color:#32329f;margin-top:0;}/*!sc*/
.lhENGb h2{font-family:Montserrat,sans-serif;font-weight:400;font-size:1.57143em;line-height:1.6em;color:#333333;}/*!sc*/
.lhENGb code{color:#e53935;background-color:rgba(38,50,56,0.05);font-family:Courier,monospace;border-radius:2px;border:1px solid rgba(38,50,56,0.1);padding:0 5px;font-size:13px;font-weight:400;word-break:break-word;}/*!sc*/
.lhENGb pre{font-family:Courier,monospace;white-space:pre;background-color:#11171a;color:white;padding:20px;overflow-x:auto;line-height:normal;border-radius:0px;border:1px solid rgba(38,50,56,0.1);}/*!sc*/
.lhENGb pre code{background-color:transparent;color:white;padding:0;}/*!sc*/
.lhENGb pre code:before,.lhENGb pre code:after{content:none;}/*!sc*/
.lhENGb blockquote{margin:0;margin-bottom:1em;padding:0 15px;color:#777;border-left:4px solid #ddd;}/*!sc*/
.lhENGb img{max-width:100%;box-sizing:content-box;}/*!sc*/
.lhENGb ul,.lhENGb ol{padding-left:2em;margin:0;margin-bottom:1em;}/*!sc*/
.lhENGb ul ul,.lhENGb ol ul,.lhENGb ul ol,.lhENGb ol ol{margin-bottom:0;margin-top:0;}/*!sc*/
.lhENGb table{display:block;width:100%;overflow:auto;word-break:normal;word-break:keep-all;border-collapse:collapse;border-spacing:0;margin-top:1.5em;margin-bottom:1.5em;}/*!sc*/
.lhENGb table tr{background-color:#fff;border-top:1px solid #ccc;}/*!sc*/
.lhENGb table tr:nth-child(2n){background-color:#fafafa;}/*!sc*/
.lhENGb table th,.lhENGb table td{padding:6px 13px;border:1px solid #ddd;}/*!sc*/
.lhENGb table th{text-align:left;font-weight:bold;}/*!sc*/
.lhENGb .share-link{cursor:pointer;margin-left:-20px;padding:0;line-height:1;width:20px;display:inline-block;outline:0;}/*!sc*/
.lhENGb .share-link:before{content:'';width:15px;height:15px;background-size:contain;background-image:url('data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHZlcnNpb249IjEuMSIgeD0iMCIgeT0iMCIgd2lkdGg9IjUxMiIgaGVpZ2h0PSI1MTIiIHZpZXdCb3g9IjAgMCA1MTIgNTEyIiBlbmFibGUtYmFja2dyb3VuZD0ibmV3IDAgMCA1MTIgNTEyIiB4bWw6c3BhY2U9InByZXNlcnZlIj48cGF0aCBmaWxsPSIjMDEwMTAxIiBkPSJNNDU5LjcgMjMzLjRsLTkwLjUgOTAuNWMtNTAgNTAtMTMxIDUwLTE4MSAwIC03LjktNy44LTE0LTE2LjctMTkuNC0yNS44bDQyLjEtNDIuMWMyLTIgNC41LTMuMiA2LjgtNC41IDIuOSA5LjkgOCAxOS4zIDE1LjggMjcuMiAyNSAyNSA2NS42IDI0LjkgOTAuNSAwbDkwLjUtOTAuNWMyNS0yNSAyNS02NS42IDAtOTAuNSAtMjQuOS0yNS02NS41LTI1LTkwLjUgMGwtMzIuMiAzMi4yYy0yNi4xLTEwLjItNTQuMi0xMi45LTgxLjYtOC45bDY4LjYtNjguNmM1MC01MCAxMzEtNTAgMTgxIDBDNTA5LjYgMTAyLjMgNTA5LjYgMTgzLjQgNDU5LjcgMjMzLjR6TTIyMC4zIDM4Mi4ybC0zMi4yIDMyLjJjLTI1IDI0LjktNjUuNiAyNC45LTkwLjUgMCAtMjUtMjUtMjUtNjUuNiAwLTkwLjVsOTAuNS05MC41YzI1LTI1IDY1LjUtMjUgOTAuNSAwIDcuOCA3LjggMTIuOSAxNy4yIDE1LjggMjcuMSAyLjQtMS40IDQuOC0yLjUgNi44LTQuNWw0Mi4xLTQyYy01LjQtOS4yLTExLjYtMTgtMTkuNC0yNS44IC01MC01MC0xMzEtNTAtMTgxIDBsLTkwLjUgOTAuNWMtNTAgNTAtNTAgMTMxIDAgMTgxIDUwIDUwIDEzMSA1MCAxODEgMGw2OC42LTY4LjZDMjc0LjYgMzk1LjEgMjQ2LjQgMzkyLjMgMjIwLjMgMzgyLjJ6Ii8+PC9zdmc+Cg==');opacity:0.5;visibility:hidden;display:inline-block;vertical-align:middle;}/*!sc*/
.lhENGb h1:hover > .share-link::before,.lhENGb h2:hover > .share-link::before,.lhENGb .share-link:hover::before{visibility:visible;}/*!sc*/
.lhENGb a{-webkit-text-decoration:auto;text-decoration:auto;color:#32329f;}/*!sc*/
.lhENGb a:visited{color:#32329f;}/*!sc*/
.lhENGb a:hover{color:#6868cf;-webkit-text-decoration:auto;text-decoration:auto;}/*!sc*/
data-styled.g43[id="sc-ciSkZP"]{content:"QGruV,lhENGb,"}/*!sc*/
.eDjFAZ{font-family:Roboto,sans-serif;font-weight:400;line-height:1.5em;}/*!sc*/
.eDjFAZ p:last-child{margin-bottom:0;}/*!sc*/
.eDjFAZ p:first-child{margin-top:0;}/*!sc*/
.eDjFAZ p:last-child{margin-bottom:0;}/*!sc*/
.eDjFAZ p{display:inline-block;}/*!sc*/
.eDjFAZ h1{font-family:Montserrat,sans-serif;font-weight:400;font-size:1.85714em;line-height:1.6em;color:#32329f;margin-top:0;}/*!sc*/
.eDjFAZ h2{font-family:Montserrat,sans-serif;font-weight:400;font-size:1.57143em;line-height:1.6em;color:#333333;}/*!sc*/
.eDjFAZ code{color:#e53935;background-color:rgba(38,50,56,0.05);font-family:Courier,monospace;border-radius:2px;border:1px solid rgba(38,50,56,0.1);padding:0 5px;font-size:13px;font-weight:400;word-break:break-word;}/*!sc*/
.eDjFAZ pre{font-family:Courier,monospace;white-space:pre;background-color:#11171a;color:white;padding:20px;overflow-x:auto;line-height:normal;border-radius:0px;border:1px solid rgba(38,50,56,0.1);}/*!sc*/
.eDjFAZ pre code{background-color:transparent;color:white;padding:0;}/*!sc*/
.eDjFAZ pre code:before,.eDjFAZ pre code:after{content:none;}/*!sc*/
.eDjFAZ blockquote{margin:0;margin-bottom:1em;padding:0 15px;color:#777;border-left:4px solid #ddd;}/*!sc*/
.eDjFAZ img{max-width:100%;box-sizing:content-box;}/*!sc*/
.eDjFAZ ul,.eDjFAZ ol{padding-left:2em;margin:0;margin-bottom:1em;}/*!sc*/
.eDjFAZ ul ul,.eDjFAZ ol ul,.eDjFAZ ul ol,.eDjFAZ ol ol{margin-bottom:0;margin-top:0;}/*!sc*/
.eDjFAZ table{display:block;width:100%;overflow:auto;word-break:normal;word-break:keep-all;border-collapse:collapse;border-spacing:0;margin-top:1.5em;margin-bottom:1.5em;}/*!sc*/
.eDjFAZ table tr{background-color:#fff;border-top:1px solid #ccc;}/*!sc*/
.eDjFAZ table tr:nth-child(2n){background-color:#fafafa;}/*!sc*/
.eDjFAZ table th,.eDjFAZ table td{padding:6px 13px;border:1px solid #ddd;}/*!sc*/
.eDjFAZ table th{text-align:left;font-weight:bold;}/*!sc*/
.eDjFAZ .share-link{cursor:pointer;margin-left:-20px;padding:0;line-height:1;width:20px;display:inline-block;outline:0;}/*!sc*/
.eDjFAZ .share-link:before{content:'';width:15px;height:15px;background-size:contain;background-image:url('data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHZlcnNpb249IjEuMSIgeD0iMCIgeT0iMCIgd2lkdGg9IjUxMiIgaGVpZ2h0PSI1MTIiIHZpZXdCb3g9IjAgMCA1MTIgNTEyIiBlbmFibGUtYmFja2dyb3VuZD0ibmV3IDAgMCA1MTIgNTEyIiB4bWw6c3BhY2U9InByZXNlcnZlIj48cGF0aCBmaWxsPSIjMDEwMTAxIiBkPSJNNDU5LjcgMjMzLjRsLTkwLjUgOTAuNWMtNTAgNTAtMTMxIDUwLTE4MSAwIC03LjktNy44LTE0LTE2LjctMTkuNC0yNS44bDQyLjEtNDIuMWMyLTIgNC41LTMuMiA2LjgtNC41IDIuOSA5LjkgOCAxOS4zIDE1LjggMjcuMiAyNSAyNSA2NS42IDI0LjkgOTAuNSAwbDkwLjUtOTAuNWMyNS0yNSAyNS02NS42IDAtOTAuNSAtMjQuOS0yNS02NS41LTI1LTkwLjUgMGwtMzIuMiAzMi4yYy0yNi4xLTEwLjItNTQuMi0xMi45LTgxLjYtOC45bDY4LjYtNjguNmM1MC01MCAxMzEtNTAgMTgxIDBDNTA5LjYgMTAyLjMgNTA5LjYgMTgzLjQgNDU5LjcgMjMzLjR6TTIyMC4zIDM4Mi4ybC0zMi4yIDMyLjJjLTI1IDI0LjktNjUuNiAyNC45LTkwLjUgMCAtMjUtMjUtMjUtNjUuNiAwLTkwLjVsOTAuNS05MC41YzI1LTI1IDY1LjUtMjUgOTAuNSAwIDcuOCA3LjggMTIuOSAxNy4yIDE1LjggMjcuMSAyLjQtMS40IDQuOC0yLjUgNi44LTQuNWw0Mi4xLTQyYy01LjQtOS4yLTExLjYtMTgtMTkuNC0yNS44IC01MC01MC0xMzEtNTAtMTgxIDBsLTkwLjUgOTAuNWMtNTAgNTAtNTAgMTMxIDAgMTgxIDUwIDUwIDEzMSA1MCAxODEgMGw2OC42LTY4LjZDMjc0LjYgMzk1LjEgMjQ2LjQgMzkyLjMgMjIwLjMgMzgyLjJ6Ii8+PC9zdmc+Cg==');opacity:0.5;visibility:hidden;display:inline-block;vertical-align:middle;}/*!sc*/
.eDjFAZ h1:hover > .share-link::before,.eDjFAZ h2:hover > .share-link::before,.eDjFAZ .share-link:hover::before{visibility:visible;}/*!sc*/
.eDjFAZ a{-webkit-text-decoration:auto;text-decoration:auto;color:#32329f;}/*!sc*/
.eDjFAZ a:visited{color:#32329f;}/*!sc*/
.eDjFAZ a:hover{color:#6868cf;-webkit-text-decoration:auto;text-decoration:auto;}/*!sc*/
data-styled.g44[id="sc-jcwpoC"]{content:"eDjFAZ,"}/*!sc*/
.UksDl{position:relative;}/*!sc*/
data-styled.g45[id="sc-carFqZ"]{content:"UksDl,"}/*!sc*/
.esZIbL:hover > .sc-giAqHp{opacity:1;}/*!sc*/
data-styled.g50[id="sc-jNnpgg"]{content:"esZIbL,"}/*!sc*/
.gyljjx{font-family:Courier,monospace;font-size:13px;white-space:pre;contain:content;overflow-x:auto;}/*!sc*/
.gyljjx .redoc-json code > .collapser{display:none;pointer-events:none;}/*!sc*/
.gyljjx .callback-function{color:gray;}/*!sc*/
.gyljjx .collapser:after{content:'-';cursor:pointer;}/*!sc*/
.gyljjx .collapsed > .collapser:after{content:'+';cursor:pointer;}/*!sc*/
.gyljjx .ellipsis:after{content:' … ';}/*!sc*/
.gyljjx .collapsible{margin-left:2em;}/*!sc*/
.gyljjx .hoverable{padding-top:1px;padding-bottom:1px;padding-left:2px;padding-right:2px;border-radius:2px;}/*!sc*/
.gyljjx .hovered{background-color:rgba(235,238,249,1);}/*!sc*/
.gyljjx .collapser{background-color:transparent;border:0;color:#fff;font-family:Courier,monospace;font-size:13px;padding-right:6px;padding-left:6px;padding-top:0;padding-bottom:0;display:-webkit-box;display:-webkit-flex;display:-ms-flexbox;display:flex;-webkit-align-items:center;-webkit-box-align:center;-ms-flex-align:center;align-items:center;-webkit-box-pack:center;-webkit-justify-content:center;-ms-flex-pack:center;justify-content:center;width:15px;height:15px;position:absolute;top:4px;left:-1.5em;cursor:default;-webkit-user-select:none;-moz-user-select:none;-ms-user-select:none;user-select:none;-webkit-user-select:none;padding:2px;}/*!sc*/
.gyljjx .collapser:focus{outline-color:#fff;outline-style:dotted;outline-width:1px;}/*!sc*/
.gyljjx ul{list-style-type:none;padding:0px;margin:0px 0px 0px 26px;}/*!sc*/
.gyljjx li{position:relative;display:block;}/*!sc*/
.gyljjx .hoverable{display:inline-block;}/*!sc*/
.gyljjx .selected{outline-style:solid;outline-width:1px;outline-style:dotted;}/*!sc*/
.gyljjx .collapsed > .collapsible{display:none;}/*!sc*/
.gyljjx .ellipsis{display:none;}/*!sc*/
.gyljjx .collapsed > .ellipsis{display:inherit;}/*!sc*/
data-styled.g51[id="sc-dPaNzc"]{content:"gyljjx,"}/*!sc*/
.kQSIAz{padding:0.9em;background-color:rgba(38,50,56,0.4);margin:0 0 10px 0;display:block;font-family:Montserrat,sans-serif;font-size:0.929em;line-height:1.5em;}/*!sc*/
data-styled.g52[id="sc-bBjRSN"]{content:"kQSIAz,"}/*!sc*/
.hlhNtL{font-family:Montserrat,sans-serif;font-size:12px;position:absolute;z-index:1;top:-11px;left:12px;font-weight:600;color:rgba(255,255,255,0.7);}/*!sc*/
data-styled.g53[id="sc-cOifOu"]{content:"hlhNtL,"}/*!sc*/
.jojbRz{position:relative;}/*!sc*/
data-styled.g54[id="sc-Arkif"]{content:"jojbRz,"}/*!sc*/
.hLNtis{margin:0 0 10px 0;display:block;background-color:rgba(38,50,56,0.4);border:none;padding:0.9em 1.6em 0.9em 0.9em;box-shadow:none;}/*!sc*/
.hLNtis label{color:#ffffff;text-overflow:ellipsis;white-space:nowrap;overflow:hidden;font-size:1em;text-transform:none;border:none;}/*!sc*/
.hLNtis:hover,.hLNtis:focus-within{border:none;box-shadow:none;background-color:rgba(38,50,56,0.7);}/*!sc*/
data-styled.g55[id="sc-khIgEk"]{content:"hLNtis,"}/*!sc*/
.kuxzOM{font-family:Courier,monospace;font-size:12px;color:#ee807f;}/*!sc*/
data-styled.g56[id="sc-hTRkXV"]{content:"kuxzOM,"}/*!sc*/
.dSaTNC{margin-top:15px;}/*!sc*/
data-styled.g57[id="sc-jgPyTC"]{content:"dSaTNC,"}/*!sc*/
.hTttpy button{background-color:transparent;border:0;outline:0;font-size:13px;font-family:Courier,monospace;cursor:pointer;padding:0;color:#333333;}/*!sc*/
.hTttpy button:focus{font-weight:600;}/*!sc*/
.hTttpy .sc-dIsUp{height:1.1em;width:1.1em;}/*!sc*/
.hTttpy .sc-dIsUp polygon{fill:#666;}/*!sc*/
data-styled.g58[id="sc-gSYDnn"]{content:"hTttpy,"}/*!sc*/
.jWaWWE{vertical-align:middle;font-size:13px;line-height:20px;}/*!sc*/
data-styled.g59[id="sc-laZMeE"]{content:"jWaWWE,"}/*!sc*/
.jrLlAa{color:rgba(102,102,102,0.9);}/*!sc*/
data-styled.g60[id="sc-iNiQyp"]{content:"jrLlAa,"}/*!sc*/
.cThoNa{color:#666;}/*!sc*/
data-styled.g61[id="sc-jffHpj"]{content:"cThoNa,"}/*!sc*/
.bArHDh{color:#666;word-break:break-word;}/*!sc*/
data-styled.g62[id="sc-eJocfa"]{content:"bArHDh,"}/*!sc*/
.dLCGMn{vertical-align:middle;font-size:13px;line-height:20px;}/*!sc*/
data-styled.g63[id="sc-oeezt"]{content:"dLCGMn,"}/*!sc*/
.hIkHYw{color:#d41f1c;font-size:0.9em;font-weight:normal;margin-left:20px;line-height:1;}/*!sc*/
data-styled.g64[id="sc-hhIiOg"]{content:"hIkHYw,"}/*!sc*/
.fElSEN{border-radius:2px;word-break:break-word;background-color:rgba(51,51,51,0.05);color:rgba(51,51,51,0.9);padding:0 5px;border:1px solid rgba(51,51,51,0.1);font-family:Courier,monospace;}/*!sc*/
.sc-ckTSus + .sc-ckTSus{margin-left:0;}/*!sc*/
data-styled.g68[id="sc-ckTSus"]{content:"fElSEN,"}/*!sc*/
.gHBwqe{border-radius:2px;background-color:rgba(104,104,207,0.05);color:rgba(50,50,159,0.9);margin:0 5px;padding:0 5px;border:1px solid rgba(50,50,159,0.1);}/*!sc*/
.sc-FRrlG + .sc-FRrlG{margin-left:0;}/*!sc*/
data-styled.g70[id="sc-FRrlG"]{content:"gHBwqe,"}/*!sc*/
.dPrSxx:after{content:' and ';font-weight:normal;}/*!sc*/
.dPrSxx:last-child:after{content:none;}/*!sc*/
.dPrSxx a{-webkit-text-decoration:auto;text-decoration:auto;color:#32329f;}/*!sc*/
.dPrSxx a:visited{color:#32329f;}/*!sc*/
.dPrSxx a:hover{color:#6868cf;-webkit-text-decoration:auto;text-decoration:auto;}/*!sc*/
data-styled.g82[id="sc-dsXzNU"]{content:"dPrSxx,"}/*!sc*/
.fcvuS{white-space:nowrap;}/*!sc*/
.fcvuS:after{content:' or ';white-space:pre;}/*!sc*/
.fcvuS:last-child:after,.fcvuS:only-child:after{content:none;}/*!sc*/
.fcvuS a{-webkit-text-decoration:auto;text-decoration:auto;color:#32329f;}/*!sc*/
.fcvuS a:visited{color:#32329f;}/*!sc*/
.fcvuS a:hover{color:#6868cf;-webkit-text-decoration:auto;text-decoration:auto;}/*!sc*/
data-styled.g83[id="sc-daBunf"]{content:"fcvuS,"}/*!sc*/
.bhDyou{-webkit-flex:1 1 auto;-ms-flex:1 1 auto;flex:1 1 auto;cursor:pointer;}/*!sc*/
data-styled.g84[id="sc-jUfyBS"]{content:"bhDyou,"}/*!sc*/
.ccffaZ{width:75%;text-overflow:ellipsis;border-radius:4px;overflow:hidden;}/*!sc*/
@media screen and (max-width:50rem){.ccffaZ{margin-top:10px;}}/*!sc*/
data-styled.g85[id="sc-jQAxuV"]{content:"ccffaZ,"}/*!sc*/
.hZIgic{display:inline-block;margin:0;}/*!sc*/
data-styled.g86[id="sc-fuISkM"]{content:"hZIgic,"}/*!sc*/
.cvfxAX{width:100%;display:-webkit-box;display:-webkit-flex;display:-ms-flexbox;display:flex;margin:1em 0;-webkit-flex-direction:row;-ms-flex-direction:row;flex-direction:row;}/*!sc*/
@media screen and (max-width:50rem){.cvfxAX{-webkit-flex-direction:column;-ms-flex-direction:column;flex-direction:column;}}/*!sc*/
data-styled.g87[id="sc-fcmMJX"]{content:"cvfxAX,"}/*!sc*/
.fdKBSs{margin-top:0;margin-bottom:0.5em;}/*!sc*/
data-styled.g93[id="sc-dFRpbK"]{content:"fdKBSs,"}/*!sc*/
.gidAUi{border:1px solid #32329f;color:#32329f;font-weight:normal;margin-left:0.5em;padding:4px 8px 4px;display:inline-block;-webkit-text-decoration:none;text-decoration:none;cursor:pointer;}/*!sc*/
data-styled.g94[id="sc-bsatvv"]{content:"gidAUi,"}/*!sc*/
.dnRviY::before{content:'|';display:inline-block;opacity:0.5;width:15px;text-align:center;}/*!sc*/
.dnRviY:last-child::after{display:none;}/*!sc*/
data-styled.g95[id="sc-gIvpjk"]{content:"dnRviY,"}/*!sc*/
.jOrOKn{overflow:hidden;}/*!sc*/
data-styled.g96[id="sc-euEtCV"]{content:"jOrOKn,"}/*!sc*/
.bpQNnD{display:-webkit-box;display:-webkit-flex;display:-ms-flexbox;display:flex;-webkit-flex-wrap:wrap;-ms-flex-wrap:wrap;flex-wrap:wrap;margin-left:-15px;}/*!sc*/
data-styled.g97[id="sc-fHCHyC"]{content:"bpQNnD,"}/*!sc*/
.ecAtVr{width:9ex;display:inline-block;height:13px;line-height:13px;background-color:#333;border-radius:3px;background-repeat:no-repeat;background-position:6px 4px;font-size:7px;font-family:Verdana,sans-serif;color:white;text-transform:uppercase;text-align:center;font-weight:bold;vertical-align:middle;margin-right:6px;margin-top:2px;}/*!sc*/
.ecAtVr.get{background-color:#2F8132;}/*!sc*/
.ecAtVr.post{background-color:#186FAF;}/*!sc*/
.ecAtVr.put{background-color:#95507c;}/*!sc*/
.ecAtVr.options{background-color:#947014;}/*!sc*/
.ecAtVr.patch{background-color:#bf581d;}/*!sc*/
.ecAtVr.delete{background-color:#cc3333;}/*!sc*/
.ecAtVr.basic{background-color:#707070;}/*!sc*/
.ecAtVr.link{background-color:#07818F;}/*!sc*/
.ecAtVr.head{background-color:#A23DAD;}/*!sc*/
.ecAtVr.hook{background-color:#32329f;}/*!sc*/
data-styled.g101[id="sc-ikXwFM"]{content:"ecAtVr,"}/*!sc*/
.bcezPY{margin:0;padding:0;}/*!sc*/
.bcezPY:first-child{padding-bottom:32px;}/*!sc*/
.sc-uxdHp .sc-uxdHp{font-size:0.929em;}/*!sc*/
.kUEEAF{margin:0;padding:0;display:none;}/*!sc*/
.kUEEAF:first-child{padding-bottom:32px;}/*!sc*/
.sc-uxdHp .sc-uxdHp{font-size:0.929em;}/*!sc*/
data-styled.g102[id="sc-uxdHp"]{content:"bcezPY,kUEEAF,"}/*!sc*/
.jycHIP{list-style:none inside none;overflow:hidden;text-overflow:ellipsis;padding:0;}/*!sc*/
data-styled.g103[id="sc-biJonm"]{content:"jycHIP,"}/*!sc*/
.btqmKr{cursor:pointer;color:#333333;margin:0;padding:12.5px 20px;display:-webkit-box;display:-webkit-flex;display:-ms-flexbox;display:flex;-webkit-box-pack:justify;-webkit-justify-content:space-between;-ms-flex-pack:justify;justify-content:space-between;font-family:Montserrat,sans-serif;font-size:0.929em;text-transform:none;background-color:#fafafa;}/*!sc*/
.btqmKr:hover{color:#32329f;background-color:#e1e1e1;}/*!sc*/
.btqmKr .sc-dIsUp{height:1.5em;width:1.5em;}/*!sc*/
.btqmKr .sc-dIsUp polygon{fill:#333333;}/*!sc*/
.ddYEIg{cursor:pointer;color:#333333;margin:0;padding:12.5px 20px;display:-webkit-box;display:-webkit-flex;display:-ms-flexbox;display:flex;-webkit-box-pack:justify;-webkit-justify-content:space-between;-ms-flex-pack:justify;justify-content:space-between;font-family:Montserrat,sans-serif;background-color:#fafafa;-webkit-text-decoration:line-through;text-decoration:line-through;color:#707070;}/*!sc*/
.ddYEIg:hover{color:#32329f;background-color:#ededed;}/*!sc*/
.ddYEIg .sc-dIsUp{height:1.5em;width:1.5em;}/*!sc*/
.ddYEIg .sc-dIsUp polygon{fill:#333333;}/*!sc*/
.dNhyuN{cursor:pointer;color:#333333;margin:0;padding:12.5px 20px;display:-webkit-box;display:-webkit-flex;display:-ms-flexbox;display:flex;-webkit-box-pack:justify;-webkit-justify-content:space-between;-ms-flex-pack:justify;justify-content:space-between;font-family:Montserrat,sans-serif;background-color:#fafafa;}/*!sc*/
.dNhyuN:hover{color:#32329f;background-color:#ededed;}/*!sc*/
.dNhyuN .sc-dIsUp{height:1.5em;width:1.5em;}/*!sc*/
.dNhyuN .sc-dIsUp polygon{fill:#333333;}/*!sc*/
data-styled.g104[id="sc-eHEENL"]{content:"btqmKr,ddYEIg,dNhyuN,"}/*!sc*/
.ylzCN{display:inline-block;vertical-align:middle;width:auto;overflow:hidden;text-overflow:ellipsis;}/*!sc*/
.jYJtsM{display:inline-block;vertical-align:middle;width:calc(100% - 38px);overflow:hidden;text-overflow:ellipsis;}/*!sc*/
data-styled.g105[id="sc-hzUIXc"]{content:"ylzCN,jYJtsM,"}/*!sc*/
.blYhnj{font-size:0.8em;margin-top:10px;text-align:center;position:fixed;width:260px;bottom:0;background:#fafafa;}/*!sc*/
.blYhnj a,.blYhnj a:visited,.blYhnj a:hover{color:#333333 !important;padding:5px 0;border-top:1px solid #e1e1e1;-webkit-text-decoration:none;text-decoration:none;display:-webkit-box;display:-webkit-flex;display:-ms-flexbox;display:flex;-webkit-align-items:center;-webkit-box-align:center;-ms-flex-align:center;align-items:center;-webkit-box-pack:center;-webkit-justify-content:center;-ms-flex-pack:center;justify-content:center;}/*!sc*/
.blYhnj img{width:15px;margin-right:5px;}/*!sc*/
@media screen and (max-width:50rem){.blYhnj{width:100%;}}/*!sc*/
data-styled.g106[id="sc-kYPZxB"]{content:"blYhnj,"}/*!sc*/
.fWsqvQ{cursor:pointer;position:relative;margin-bottom:5px;}/*!sc*/
data-styled.g112[id="sc-EZqKI"]{content:"fWsqvQ,"}/*!sc*/
.fCEUju{font-family:Courier,monospace;margin-left:10px;-webkit-flex:1;-ms-flex:1;flex:1;overflow-x:hidden;text-overflow:ellipsis;}/*!sc*/
data-styled.g113[id="sc-jXcxbT"]{content:"fCEUju,"}/*!sc*/
.ilvUMs{outline:0;color:inherit;width:100%;text-align:left;cursor:pointer;padding:10px 30px 10px 20px;border-radius:4px 4px 0 0;background-color:#11171a;display:-webkit-box;display:-webkit-flex;display:-ms-flexbox;display:flex;white-space:nowrap;-webkit-align-items:center;-webkit-box-align:center;-ms-flex-align:center;align-items:center;border:1px solid transparent;border-bottom:0;-webkit-transition:border-color 0.25s ease;transition:border-color 0.25s ease;}/*!sc*/
.ilvUMs ..sc-jXcxbT{color:#ffffff;}/*!sc*/
.ilvUMs:focus{box-shadow:inset 0 2px 2px rgba(0,0,0,0.45),0 2px 0 rgba(128,128,128,0.25);}/*!sc*/
data-styled.g114[id="sc-eEVmNe"]{content:"ilvUMs,"}/*!sc*/
.ihNycv{font-size:0.929em;line-height:20px;background-color:#2F8132;color:#ffffff;padding:3px 10px;text-transform:uppercase;font-family:Montserrat,sans-serif;margin:0;}/*!sc*/
.ldMUmp{font-size:0.929em;line-height:20px;background-color:#186FAF;color:#ffffff;padding:3px 10px;text-transform:uppercase;font-family:Montserrat,sans-serif;margin:0;}/*!sc*/
.bJzUtf{font-size:0.929em;line-height:20px;background-color:#cc3333;color:#ffffff;padding:3px 10px;text-transform:uppercase;font-family:Montserrat,sans-serif;margin:0;}/*!sc*/
data-styled.g115[id="sc-fmdNqN"]{content:"ihNycv,ldMUmp,bJzUtf,"}/*!sc*/
.flIrdF{position:absolute;width:100%;z-index:100;background:#fafafa;color:#263238;box-sizing:border-box;box-shadow:0px 0px 6px rgba(0,0,0,0.33);overflow:hidden;border-bottom-left-radius:4px;border-bottom-right-radius:4px;-webkit-transition:all 0.25s ease;transition:all 0.25s ease;visibility:hidden;-webkit-transform:translateY(-50%) scaleY(0);-ms-transform:translateY(-50%) scaleY(0);transform:translateY(-50%) scaleY(0);}/*!sc*/
data-styled.g116[id="sc-ljsmAU"]{content:"flIrdF,"}/*!sc*/
.fQkroN{padding:10px;}/*!sc*/
data-styled.g117[id="sc-jlZJtj"]{content:"fQkroN,"}/*!sc*/
.dfUAUz{padding:5px;border:1px solid #ccc;background:#fff;word-break:break-all;color:#32329f;}/*!sc*/
.dfUAUz > span{color:#333333;}/*!sc*/
data-styled.g118[id="sc-dTSzeu"]{content:"dfUAUz,"}/*!sc*/
.lbYftx{display:block;border:0;width:100%;text-align:left;padding:10px;border-radius:2px;margin-bottom:4px;line-height:1.5em;cursor:pointer;color:#1d8127;background-color:rgba(29,129,39,0.07);}/*!sc*/
.lbYftx:focus{outline:auto #1d8127;}/*!sc*/
.NAUPn{display:block;border:0;width:100%;text-align:left;padding:10px;border-radius:2px;margin-bottom:4px;line-height:1.5em;cursor:pointer;color:#d41f1c;background-color:rgba(212,31,28,0.07);}/*!sc*/
.NAUPn:focus{outline:auto #d41f1c;}/*!sc*/
.jUGDyD{display:block;border:0;width:100%;text-align:left;padding:10px;border-radius:2px;margin-bottom:4px;line-height:1.5em;cursor:pointer;color:#1d8127;background-color:rgba(29,129,39,0.07);cursor:default;}/*!sc*/
.jUGDyD:focus{outline:auto #1d8127;}/*!sc*/
.jUGDyD::before{content:"—";font-weight:bold;width:1.5em;text-align:center;display:inline-block;vertical-align:top;}/*!sc*/
.jUGDyD:focus{outline:0;}/*!sc*/
data-styled.g119[id="sc-htmcrh"]{content:"lbYftx,NAUPn,jUGDyD,"}/*!sc*/
.cMoEZ{vertical-align:top;}/*!sc*/
data-styled.g123[id="sc-fWWYYk"]{content:"cMoEZ,"}/*!sc*/
.DvFer{font-size:1.3em;padding:0.2em 0;margin:3em 0 1.1em;color:#333333;font-weight:normal;}/*!sc*/
data-styled.g124[id="sc-fIxmyt"]{content:"DvFer,"}/*!sc*/
.hCTIhr{margin-bottom:30px;}/*!sc*/
data-styled.g129[id="sc-iGkqmO"]{content:"hCTIhr,"}/*!sc*/
.eOSIAa{-webkit-user-select:none;-moz-user-select:none;-ms-user-select:none;user-select:none;width:20px;height:20px;-webkit-align-self:center;-ms-flex-item-align:center;align-self:center;display:-webkit-box;display:-webkit-flex;display:-ms-flexbox;display:flex;-webkit-flex-direction:column;-ms-flex-direction:column;flex-direction:column;color:#32329f;}/*!sc*/
data-styled.g130[id="sc-irKDMX"]{content:"eOSIAa,"}/*!sc*/
.coDLND{width:260px;background-color:#fafafa;overflow:hidden;display:-webkit-box;display:-webkit-flex;display:-ms-flexbox;display:flex;-webkit-flex-direction:column;-ms-flex-direction:column;flex-direction:column;-webkit-backface-visibility:hidden;backface-visibility:hidden;height:100vh;position:-webkit-sticky;position:sticky;position:-webkit-sticky;top:0;}/*!sc*/
@media screen and (max-width:50rem){.coDLND{position:fixed;z-index:20;width:100%;background:#fafafa;display:none;}}/*!sc*/
@media print{.coDLND{display:none;}}/*!sc*/
data-styled.g131[id="sc-eWnToP"]{content:"coDLND,"}/*!sc*/
.ceJzZm{outline:none;-webkit-user-select:none;-moz-user-select:none;-ms-user-select:none;user-select:none;background-color:#f2f2f2;color:#32329f;display:none;cursor:pointer;position:fixed;right:20px;z-index:100;border-radius:50%;box-shadow:0 0 20px rgba(0,0,0,0.3);bottom:44px;width:60px;height:60px;padding:0 20px;}/*!sc*/
@media screen and (max-width:50rem){.ceJzZm{display:-webkit-box;display:-webkit-flex;display:-ms-flexbox;display:flex;}}/*!sc*/
.ceJzZm svg{color:#0065FB;}/*!sc*/
@media print{.ceJzZm{display:none;}}/*!sc*/
data-styled.g132[id="sc-kTCsyW"]{content:"ceJzZm,"}/*!sc*/
.fDfMfd{font-family:Roboto,sans-serif;font-size:14px;font-weight:400;line-height:1.5em;color:#333333;display:-webkit-box;display:-webkit-flex;display:-ms-flexbox;display:flex;position:relative;text-align:left;-webkit-font-smoothing:antialiased;font-smoothing:antialiased;text-rendering:optimizeSpeed !important;tap-highlight-color:rgba(0,0,0,0);-webkit-text-size-adjust:100%;text-size-adjust:100%;}/*!sc*/
.fDfMfd *{box-sizing:border-box;-webkit-tap-highlight-color:rgba(255,255,255,0);}/*!sc*/
data-styled.g133[id="sc-dvUynV"]{content:"fDfMfd,"}/*!sc*/
.kRuFuS{z-index:1;position:relative;overflow:hidden;width:calc(100% - 260px);contain:layout;}/*!sc*/
@media print,screen and (max-width:50rem){.kRuFuS{width:100%;}}/*!sc*/
data-styled.g134[id="sc-jtiXyc"]{content:"kRuFuS,"}/*!sc*/
.bgakXB{background:#263238;position:absolute;top:0;bottom:0;right:0;width:calc((100% - 260px) * 0.4);}/*!sc*/
@media print,screen and (max-width:75rem){.bgakXB{display:none;}}/*!sc*/
data-styled.g135[id="sc-ellfGf"]{content:"bgakXB,"}/*!sc*/
.bUGKYA{padding:5px 0;}/*!sc*/
data-styled.g136[id="sc-kizEQm"]{content:"bUGKYA,"}/*!sc*/
.eIJtBZ{width:calc(100% - 40px);box-sizing:border-box;margin:0 20px;padding:5px 10px 5px 20px;border:0;border-bottom:1px solid #e1e1e1;font-family:Roboto,sans-serif;font-weight:bold;font-size:13px;color:#333333;background-color:transparent;outline:none;}/*!sc*/
data-styled.g137[id="sc-cKRKFl"]{content:"eIJtBZ,"}/*!sc*/
.jIUTls{position:absolute;left:20px;height:1.8em;width:0.9em;}/*!sc*/
.jIUTls path{fill:#333333;}/*!sc*/
data-styled.g138[id="sc-iIgjPs"]{content:"jIUTls,"}/*!sc*/
</style>
<link href="https://fonts.googleapis.com/css?family=Montserrat:300,400,700|Roboto:300,400,700" rel="stylesheet">
</head>
<body>
<div id="redoc"><div class="sc-dvUynV fDfMfd redoc-wrap"><div class="sc-eWnToP coDLND menu-content" style="top:0px;height:calc(100vh - 0px)"><div role="search" class="sc-kizEQm bUGKYA"><svg class="sc-iIgjPs jIUTls search-icon" version="1.1" viewBox="0 0 1000 1000" x="0px" xmlns="http://www.w3.org/2000/svg" y="0px"><path d="M968.2,849.4L667.3,549c83.9-136.5,66.7-317.4-51.7-435.6C477.1-25,252.5-25,113.9,113.4c-138.5,138.3-138.5,362.6,0,501C219.2,730.1,413.2,743,547.6,666.5l301.9,301.4c43.6,43.6,76.9,14.9,104.2-12.4C981,928.3,1011.8,893,968.2,849.4z M524.5,522c-88.9,88.7-233,88.7-321.8,0c-88.9-88.7-88.9-232.6,0-321.3c88.9-88.7,233-88.7,321.8,0C613.4,289.4,613.4,433.3,524.5,522z"></path></svg><input type="text" value="" placeholder="Search..." aria-label="Search" class="sc-cKRKFl eIJtBZ search-input"/></div><div class="sc-iklJeh leCKhp scrollbar-container undefined"><ul class="sc-uxdHp bcezPY" role="menu"><li data-item-id="tag/Assistants" class="sc-biJonm jycHIP"><label type="tag" role="menuitem" class="sc-eHEENL btqmKr -depth1"><span title="Assistants" class="sc-hzUIXc ylzCN">Assistants</span><svg class="sc-dIsUp dvcDrG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></label><ul class="sc-uxdHp kUEEAF"><li data-item-id="tag/Assistants/operation/listAssistants" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL ddYEIg -depth2"><span type="get" class="sc-ikXwFM ecAtVr operation-type get">get</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">Returns a list of assistants.</span></label></li><li data-item-id="tag/Assistants/operation/createAssistant" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL ddYEIg -depth2"><span type="post" class="sc-ikXwFM ecAtVr operation-type post">post</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">Create an assistant with a model and instructions.</span></label></li><li data-item-id="tag/Assistants/operation/getAssistant" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL ddYEIg -depth2"><span type="get" class="sc-ikXwFM ecAtVr operation-type get">get</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">Retrieves an assistant.</span></label></li><li data-item-id="tag/Assistants/operation/modifyAssistant" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL ddYEIg -depth2"><span type="post" class="sc-ikXwFM ecAtVr operation-type post">post</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">Modifies an assistant.</span></label></li><li data-item-id="tag/Assistants/operation/deleteAssistant" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL ddYEIg -depth2"><span type="delete" class="sc-ikXwFM ecAtVr operation-type delete">del</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">Delete an assistant.</span></label></li><li data-item-id="tag/Assistants/operation/createThread" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="post" class="sc-ikXwFM ecAtVr operation-type post">post</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">Create a thread.</span></label></li><li data-item-id="tag/Assistants/operation/createThreadAndRun" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="post" class="sc-ikXwFM ecAtVr operation-type post">post</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">Create a thread and run it in one request.</span></label></li><li data-item-id="tag/Assistants/operation/getThread" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="get" class="sc-ikXwFM ecAtVr operation-type get">get</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">Retrieves a thread.</span></label></li><li data-item-id="tag/Assistants/operation/modifyThread" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="post" class="sc-ikXwFM ecAtVr operation-type post">post</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">Modifies a thread.</span></label></li><li data-item-id="tag/Assistants/operation/deleteThread" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="delete" class="sc-ikXwFM ecAtVr operation-type delete">del</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">Delete a thread.</span></label></li><li data-item-id="tag/Assistants/operation/listMessages" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="get" class="sc-ikXwFM ecAtVr operation-type get">get</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">Returns a list of messages for a given thread.</span></label></li><li data-item-id="tag/Assistants/operation/createMessage" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="post" class="sc-ikXwFM ecAtVr operation-type post">post</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">Create a message.</span></label></li><li data-item-id="tag/Assistants/operation/getMessage" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="get" class="sc-ikXwFM ecAtVr operation-type get">get</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">Retrieve a message.</span></label></li><li data-item-id="tag/Assistants/operation/modifyMessage" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="post" class="sc-ikXwFM ecAtVr operation-type post">post</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">Modifies a message.</span></label></li><li data-item-id="tag/Assistants/operation/deleteMessage" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="delete" class="sc-ikXwFM ecAtVr operation-type delete">del</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">Deletes a message.</span></label></li><li data-item-id="tag/Assistants/operation/listRuns" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="get" class="sc-ikXwFM ecAtVr operation-type get">get</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">Returns a list of runs belonging to a thread.</span></label></li><li data-item-id="tag/Assistants/operation/createRun" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="post" class="sc-ikXwFM ecAtVr operation-type post">post</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">Create a run.</span></label></li><li data-item-id="tag/Assistants/operation/getRun" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="get" class="sc-ikXwFM ecAtVr operation-type get">get</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">Retrieves a run.</span></label></li><li data-item-id="tag/Assistants/operation/modifyRun" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="post" class="sc-ikXwFM ecAtVr operation-type post">post</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">Modifies a run.</span></label></li><li data-item-id="tag/Assistants/operation/cancelRun" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="post" class="sc-ikXwFM ecAtVr operation-type post">post</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">Cancels a run that is `in_progress`.</span></label></li><li data-item-id="tag/Assistants/operation/listRunSteps" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="get" class="sc-ikXwFM ecAtVr operation-type get">get</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">Returns a list of run steps belonging to a run.</span></label></li><li data-item-id="tag/Assistants/operation/getRunStep" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="get" class="sc-ikXwFM ecAtVr operation-type get">get</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">Retrieves a run step.</span></label></li><li data-item-id="tag/Assistants/operation/submitToolOuputsToRun" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="post" class="sc-ikXwFM ecAtVr operation-type post">post</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">When a run has the `status: "requires_action"` and `required_action.type` is `submit_tool_outputs`, this endpoint can be used to submit the outputs from the tool calls once they're all completed. All outputs must be submitted in a single request.
</span></label></li></ul></li><li data-item-id="tag/Audio" class="sc-biJonm jycHIP"><label type="tag" role="menuitem" class="sc-eHEENL btqmKr -depth1"><span title="Audio" class="sc-hzUIXc ylzCN">Audio</span><svg class="sc-dIsUp dvcDrG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></label><ul class="sc-uxdHp kUEEAF"><li data-item-id="tag/Audio/operation/createSpeech" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="post" class="sc-ikXwFM ecAtVr operation-type post">post</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">Generates audio from the input text.
Returns the audio file content, or a stream of audio events.
</span></label></li><li data-item-id="tag/Audio/operation/createTranscription" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="post" class="sc-ikXwFM ecAtVr operation-type post">post</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">Transcribes audio into the input language.
Returns a transcription object in `json`, `diarized_json`, or `verbose_json`
format, or a stream of transcript events.
</span></label></li><li data-item-id="tag/Audio/operation/createTranslation" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="post" class="sc-ikXwFM ecAtVr operation-type post">post</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">Translates audio into English.</span></label></li><li data-item-id="tag/Audio/operation/createVoiceConsent" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="post" class="sc-ikXwFM ecAtVr operation-type post">post</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">Upload a voice consent recording.</span></label></li><li data-item-id="tag/Audio/operation/listVoiceConsents" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="get" class="sc-ikXwFM ecAtVr operation-type get">get</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">Returns a list of voice consent recordings.</span></label></li><li data-item-id="tag/Audio/operation/getVoiceConsent" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="get" class="sc-ikXwFM ecAtVr operation-type get">get</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">Retrieves a voice consent recording.</span></label></li><li data-item-id="tag/Audio/operation/updateVoiceConsent" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="post" class="sc-ikXwFM ecAtVr operation-type post">post</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">Updates a voice consent recording (metadata only).</span></label></li><li data-item-id="tag/Audio/operation/deleteVoiceConsent" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="delete" class="sc-ikXwFM ecAtVr operation-type delete">del</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">Deletes a voice consent recording.</span></label></li><li data-item-id="tag/Audio/operation/createVoice" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="post" class="sc-ikXwFM ecAtVr operation-type post">post</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">Creates a custom voice.</span></label></li></ul></li><li data-item-id="tag/Chat" class="sc-biJonm jycHIP"><label type="tag" role="menuitem" class="sc-eHEENL btqmKr -depth1"><span title="Chat" class="sc-hzUIXc ylzCN">Chat</span><svg class="sc-dIsUp dvcDrG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></label><ul class="sc-uxdHp kUEEAF"><li data-item-id="tag/Chat/operation/listChatCompletions" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="get" class="sc-ikXwFM ecAtVr operation-type get">get</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">List stored Chat Completions. Only Chat Completions that have been stored
with the `store` parameter set to `true` will be returned.
</span></label></li><li data-item-id="tag/Chat/operation/createChatCompletion" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="post" class="sc-ikXwFM ecAtVr operation-type post">post</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">**Starting a new project?** We recommend trying [Responses](/docs/api-reference/responses)
to take advantage of the latest OpenAI platform features. Compare
[Chat Completions with Responses](/docs/guides/responses-vs-chat-completions?api-mode=responses).
---
Creates a model response for the given chat conversation. Learn more in the
[text generation](/docs/guides/text-generation), [vision](/docs/guides/vision),
and [audio](/docs/guides/audio) guides.
Parameter support can differ depending on the model used to generate the
response, particularly for newer reasoning models. Parameters that are only
supported for reasoning models are noted below. For the current state of
unsupported parameters in reasoning models,
[refer to the reasoning guide](/docs/guides/reasoning).
Returns a chat completion object, or a streamed sequence of chat completion
chunk objects if the request is streamed.
</span></label></li><li data-item-id="tag/Chat/operation/getChatCompletion" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="get" class="sc-ikXwFM ecAtVr operation-type get">get</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">Get a stored chat completion. Only Chat Completions that have been created
with the `store` parameter set to `true` will be returned.
</span></label></li><li data-item-id="tag/Chat/operation/updateChatCompletion" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="post" class="sc-ikXwFM ecAtVr operation-type post">post</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">Modify a stored chat completion. Only Chat Completions that have been
created with the `store` parameter set to `true` can be modified. Currently,
the only supported modification is to update the `metadata` field.
</span></label></li><li data-item-id="tag/Chat/operation/deleteChatCompletion" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="delete" class="sc-ikXwFM ecAtVr operation-type delete">del</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">Delete a stored chat completion. Only Chat Completions that have been
created with the `store` parameter set to `true` can be deleted.
</span></label></li><li data-item-id="tag/Chat/operation/getChatCompletionMessages" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="get" class="sc-ikXwFM ecAtVr operation-type get">get</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">Get the messages in a stored chat completion. Only Chat Completions that
have been created with the `store` parameter set to `true` will be
returned.
</span></label></li></ul></li><li data-item-id="tag/Conversations" class="sc-biJonm jycHIP"><label type="tag" role="menuitem" class="sc-eHEENL btqmKr -depth1"><span title="Conversations" class="sc-hzUIXc ylzCN">Conversations</span><svg class="sc-dIsUp dvcDrG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></label><ul class="sc-uxdHp kUEEAF"><li data-item-id="tag/Conversations/operation/createConversationItems" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="post" class="sc-ikXwFM ecAtVr operation-type post">post</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">Create items in a conversation with the given ID.</span></label></li><li data-item-id="tag/Conversations/operation/listConversationItems" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="get" class="sc-ikXwFM ecAtVr operation-type get">get</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">List all items for a conversation with the given ID.</span></label></li><li data-item-id="tag/Conversations/operation/getConversationItem" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="get" class="sc-ikXwFM ecAtVr operation-type get">get</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">Get a single item from a conversation with the given IDs.</span></label></li><li data-item-id="tag/Conversations/operation/deleteConversationItem" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="delete" class="sc-ikXwFM ecAtVr operation-type delete">del</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">Delete an item from a conversation with the given IDs.</span></label></li><li data-item-id="tag/Conversations/operation/createConversation" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="post" class="sc-ikXwFM ecAtVr operation-type post">post</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">Create a conversation.</span></label></li><li data-item-id="tag/Conversations/operation/getConversation" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="get" class="sc-ikXwFM ecAtVr operation-type get">get</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">Get a conversation</span></label></li><li data-item-id="tag/Conversations/operation/deleteConversation" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="delete" class="sc-ikXwFM ecAtVr operation-type delete">del</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">Delete a conversation. Items in the conversation will not be deleted.</span></label></li><li data-item-id="tag/Conversations/operation/updateConversation" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="post" class="sc-ikXwFM ecAtVr operation-type post">post</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">Update a conversation</span></label></li></ul></li><li data-item-id="tag/Completions" class="sc-biJonm jycHIP"><label type="tag" role="menuitem" class="sc-eHEENL btqmKr -depth1"><span title="Completions" class="sc-hzUIXc ylzCN">Completions</span><svg class="sc-dIsUp dvcDrG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></label><ul class="sc-uxdHp kUEEAF"><li data-item-id="tag/Completions/operation/createCompletion" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="post" class="sc-ikXwFM ecAtVr operation-type post">post</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">Creates a completion for the provided prompt and parameters.
Returns a completion object, or a sequence of completion objects if the request is streamed.
</span></label></li></ul></li><li data-item-id="tag/Embeddings" class="sc-biJonm jycHIP"><label type="tag" role="menuitem" class="sc-eHEENL btqmKr -depth1"><span title="Embeddings" class="sc-hzUIXc ylzCN">Embeddings</span><svg class="sc-dIsUp dvcDrG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></label><ul class="sc-uxdHp kUEEAF"><li data-item-id="tag/Embeddings/operation/createEmbedding" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="post" class="sc-ikXwFM ecAtVr operation-type post">post</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">Creates an embedding vector representing the input text.</span></label></li></ul></li><li data-item-id="tag/Evals" class="sc-biJonm jycHIP"><label type="tag" role="menuitem" class="sc-eHEENL btqmKr -depth1"><span title="Evals" class="sc-hzUIXc ylzCN">Evals</span><svg class="sc-dIsUp dvcDrG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></label><ul class="sc-uxdHp kUEEAF"><li data-item-id="tag/Evals/operation/listEvals" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="get" class="sc-ikXwFM ecAtVr operation-type get">get</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">List evaluations for a project.
</span></label></li><li data-item-id="tag/Evals/operation/createEval" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="post" class="sc-ikXwFM ecAtVr operation-type post">post</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">Create the structure of an evaluation that can be used to test a model's performance.
An evaluation is a set of testing criteria and the config for a data source, which dictates the schema of the data used in the evaluation. After creating an evaluation, you can run it on different models and model parameters. We support several types of graders and datasources.
For more information, see the [Evals guide](/docs/guides/evals).
</span></label></li><li data-item-id="tag/Evals/operation/getEval" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="get" class="sc-ikXwFM ecAtVr operation-type get">get</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">Get an evaluation by ID.
</span></label></li><li data-item-id="tag/Evals/operation/updateEval" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="post" class="sc-ikXwFM ecAtVr operation-type post">post</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">Update certain properties of an evaluation.
</span></label></li><li data-item-id="tag/Evals/operation/deleteEval" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="delete" class="sc-ikXwFM ecAtVr operation-type delete">del</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">Delete an evaluation.
</span></label></li><li data-item-id="tag/Evals/operation/getEvalRuns" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="get" class="sc-ikXwFM ecAtVr operation-type get">get</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">Get a list of runs for an evaluation.
</span></label></li><li data-item-id="tag/Evals/operation/createEvalRun" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="post" class="sc-ikXwFM ecAtVr operation-type post">post</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">Kicks off a new run for a given evaluation, specifying the data source, and what model configuration to use to test. The datasource will be validated against the schema specified in the config of the evaluation.
</span></label></li><li data-item-id="tag/Evals/operation/getEvalRun" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="get" class="sc-ikXwFM ecAtVr operation-type get">get</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">Get an evaluation run by ID.
</span></label></li><li data-item-id="tag/Evals/operation/cancelEvalRun" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="post" class="sc-ikXwFM ecAtVr operation-type post">post</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">Cancel an ongoing evaluation run.
</span></label></li><li data-item-id="tag/Evals/operation/deleteEvalRun" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="delete" class="sc-ikXwFM ecAtVr operation-type delete">del</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">Delete an eval run.
</span></label></li><li data-item-id="tag/Evals/operation/getEvalRunOutputItems" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="get" class="sc-ikXwFM ecAtVr operation-type get">get</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">Get a list of output items for an evaluation run.
</span></label></li><li data-item-id="tag/Evals/operation/getEvalRunOutputItem" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="get" class="sc-ikXwFM ecAtVr operation-type get">get</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">Get an evaluation run output item by ID.
</span></label></li></ul></li><li data-item-id="tag/Fine-tuning" class="sc-biJonm jycHIP"><label type="tag" role="menuitem" class="sc-eHEENL btqmKr -depth1"><span title="Fine-tuning" class="sc-hzUIXc ylzCN">Fine-tuning</span><svg class="sc-dIsUp dvcDrG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></label><ul class="sc-uxdHp kUEEAF"><li data-item-id="tag/Fine-tuning/operation/runGrader" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="post" class="sc-ikXwFM ecAtVr operation-type post">post</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">Run a grader.
</span></label></li><li data-item-id="tag/Fine-tuning/operation/validateGrader" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="post" class="sc-ikXwFM ecAtVr operation-type post">post</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">Validate a grader.
</span></label></li><li data-item-id="tag/Fine-tuning/operation/listFineTuningCheckpointPermissions" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="get" class="sc-ikXwFM ecAtVr operation-type get">get</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">**NOTE:** This endpoint requires an [admin API key](../admin-api-keys).
Organization owners can use this endpoint to view all permissions for a fine-tuned model checkpoint.
</span></label></li><li data-item-id="tag/Fine-tuning/operation/createFineTuningCheckpointPermission" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="post" class="sc-ikXwFM ecAtVr operation-type post">post</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">**NOTE:** Calling this endpoint requires an [admin API key](../admin-api-keys).
This enables organization owners to share fine-tuned models with other projects in their organization.
</span></label></li><li data-item-id="tag/Fine-tuning/operation/deleteFineTuningCheckpointPermission" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="delete" class="sc-ikXwFM ecAtVr operation-type delete">del</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">**NOTE:** This endpoint requires an [admin API key](../admin-api-keys).
Organization owners can use this endpoint to delete a permission for a fine-tuned model checkpoint.
</span></label></li><li data-item-id="tag/Fine-tuning/operation/createFineTuningJob" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="post" class="sc-ikXwFM ecAtVr operation-type post">post</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">Creates a fine-tuning job which begins the process of creating a new model from a given dataset.
Response includes details of the enqueued job including job status and the name of the fine-tuned models once complete.
[Learn more about fine-tuning](/docs/guides/model-optimization)
</span></label></li><li data-item-id="tag/Fine-tuning/operation/listPaginatedFineTuningJobs" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="get" class="sc-ikXwFM ecAtVr operation-type get">get</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">List your organization's fine-tuning jobs
</span></label></li><li data-item-id="tag/Fine-tuning/operation/retrieveFineTuningJob" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="get" class="sc-ikXwFM ecAtVr operation-type get">get</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">Get info about a fine-tuning job.
[Learn more about fine-tuning](/docs/guides/model-optimization)
</span></label></li><li data-item-id="tag/Fine-tuning/operation/cancelFineTuningJob" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="post" class="sc-ikXwFM ecAtVr operation-type post">post</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">Immediately cancel a fine-tune job.
</span></label></li><li data-item-id="tag/Fine-tuning/operation/listFineTuningJobCheckpoints" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="get" class="sc-ikXwFM ecAtVr operation-type get">get</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">List checkpoints for a fine-tuning job.
</span></label></li><li data-item-id="tag/Fine-tuning/operation/listFineTuningEvents" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="get" class="sc-ikXwFM ecAtVr operation-type get">get</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">Get status updates for a fine-tuning job.
</span></label></li><li data-item-id="tag/Fine-tuning/operation/pauseFineTuningJob" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="post" class="sc-ikXwFM ecAtVr operation-type post">post</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">Pause a fine-tune job.
</span></label></li><li data-item-id="tag/Fine-tuning/operation/resumeFineTuningJob" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="post" class="sc-ikXwFM ecAtVr operation-type post">post</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">Resume a fine-tune job.
</span></label></li></ul></li><li data-item-id="tag/Graders" class="sc-biJonm jycHIP"><label type="tag" role="menuitem" class="sc-eHEENL btqmKr -depth1"><span title="Graders" class="sc-hzUIXc ylzCN">Graders</span></label></li><li data-item-id="tag/Batch" class="sc-biJonm jycHIP"><label type="tag" role="menuitem" class="sc-eHEENL btqmKr -depth1"><span title="Batch" class="sc-hzUIXc ylzCN">Batch</span><svg class="sc-dIsUp dvcDrG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></label><ul class="sc-uxdHp kUEEAF"><li data-item-id="tag/Batch/operation/createBatch" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="post" class="sc-ikXwFM ecAtVr operation-type post">post</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">Creates and executes a batch from an uploaded file of requests</span></label></li><li data-item-id="tag/Batch/operation/listBatches" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="get" class="sc-ikXwFM ecAtVr operation-type get">get</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">List your organization's batches.</span></label></li><li data-item-id="tag/Batch/operation/retrieveBatch" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="get" class="sc-ikXwFM ecAtVr operation-type get">get</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">Retrieves a batch.</span></label></li><li data-item-id="tag/Batch/operation/cancelBatch" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="post" class="sc-ikXwFM ecAtVr operation-type post">post</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">Cancels an in-progress batch. The batch will be in status `cancelling` for up to 10 minutes, before changing to `cancelled`, where it will have partial results (if any) available in the output file.</span></label></li></ul></li><li data-item-id="tag/Files" class="sc-biJonm jycHIP"><label type="tag" role="menuitem" class="sc-eHEENL btqmKr -depth1"><span title="Files" class="sc-hzUIXc ylzCN">Files</span><svg class="sc-dIsUp dvcDrG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></label><ul class="sc-uxdHp kUEEAF"><li data-item-id="tag/Files/operation/listFiles" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="get" class="sc-ikXwFM ecAtVr operation-type get">get</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">Returns a list of files.</span></label></li><li data-item-id="tag/Files/operation/createFile" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="post" class="sc-ikXwFM ecAtVr operation-type post">post</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">Upload a file that can be used across various endpoints. Individual files
can be up to 512 MB, and each project can store up to 2.5 TB of files in
total. There is no organization-wide storage limit. Uploads to this
endpoint are rate-limited to 1,000 requests per minute per authenticated
user.
- The Assistants API supports files up to 2 million tokens and of specific
file types. See the [Assistants Tools guide](/docs/assistants/tools) for
details.
- The Fine-tuning API only supports `.jsonl` files. The input also has
certain required formats for fine-tuning
[chat](/docs/api-reference/fine-tuning/chat-input) or
[completions](/docs/api-reference/fine-tuning/completions-input) models.
- The Batch API only supports `.jsonl` files up to 200 MB in size. The input
also has a specific required
[format](/docs/api-reference/batch/request-input).
- For Retrieval or `file_search` ingestion, upload files here first. If
you need to attach multiple uploaded files to the same vector store, use
[`/vector_stores/{vector_store_id}/file_batches`](/docs/api-reference/vector-stores-file-batches/createBatch)
instead of attaching them one by one. Vector store attachment has separate
limits from file upload, including 2,000 attached files per minute per
organization.
Please [contact us](https://help.openai.com/) if you need to increase these
storage limits.
</span></label></li><li data-item-id="tag/Files/operation/deleteFile" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="delete" class="sc-ikXwFM ecAtVr operation-type delete">del</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">Delete a file and remove it from all vector stores.</span></label></li><li data-item-id="tag/Files/operation/retrieveFile" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="get" class="sc-ikXwFM ecAtVr operation-type get">get</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">Returns information about a specific file.</span></label></li><li data-item-id="tag/Files/operation/downloadFile" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="get" class="sc-ikXwFM ecAtVr operation-type get">get</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">Returns the contents of the specified file.</span></label></li></ul></li><li data-item-id="tag/Uploads" class="sc-biJonm jycHIP"><label type="tag" role="menuitem" class="sc-eHEENL btqmKr -depth1"><span title="Uploads" class="sc-hzUIXc ylzCN">Uploads</span><svg class="sc-dIsUp dvcDrG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></label><ul class="sc-uxdHp kUEEAF"><li data-item-id="tag/Uploads/operation/createUpload" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="post" class="sc-ikXwFM ecAtVr operation-type post">post</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">Creates an intermediate [Upload](/docs/api-reference/uploads/object) object
that you can add [Parts](/docs/api-reference/uploads/part-object) to.
Currently, an Upload can accept at most 8 GB in total and expires after an
hour after you create it.
Once you complete the Upload, we will create a
[File](/docs/api-reference/files/object) object that contains all the parts
you uploaded. This File is usable in the rest of our platform as a regular
File object.
For certain `purpose` values, the correct `mime_type` must be specified.
Please refer to documentation for the
[supported MIME types for your use case](/docs/assistants/tools/file-search#supported-files).
For guidance on the proper filename extensions for each purpose, please
follow the documentation on [creating a
File](/docs/api-reference/files/create).
Returns the Upload object with status `pending`.
</span></label></li><li data-item-id="tag/Uploads/operation/cancelUpload" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="post" class="sc-ikXwFM ecAtVr operation-type post">post</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">Cancels the Upload. No Parts may be added after an Upload is cancelled.
Returns the Upload object with status `cancelled`.
</span></label></li><li data-item-id="tag/Uploads/operation/completeUpload" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="post" class="sc-ikXwFM ecAtVr operation-type post">post</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">Completes the [Upload](/docs/api-reference/uploads/object).
Within the returned Upload object, there is a nested [File](/docs/api-reference/files/object) object that is ready to use in the rest of the platform.
You can specify the order of the Parts by passing in an ordered list of the Part IDs.
The number of bytes uploaded upon completion must match the number of bytes initially specified when creating the Upload object. No Parts may be added after an Upload is completed.
Returns the Upload object with status `completed`, including an additional `file` property containing the created usable File object.
</span></label></li><li data-item-id="tag/Uploads/operation/addUploadPart" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="post" class="sc-ikXwFM ecAtVr operation-type post">post</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">Adds a [Part](/docs/api-reference/uploads/part-object) to an [Upload](/docs/api-reference/uploads/object) object. A Part represents a chunk of bytes from the file you are trying to upload.
Each Part can be at most 64 MB, and you can add Parts until you hit the Upload maximum of 8 GB.
It is possible to add multiple Parts in parallel. You can decide the intended order of the Parts when you [complete the Upload](/docs/api-reference/uploads/complete).
</span></label></li></ul></li><li data-item-id="tag/Images" class="sc-biJonm jycHIP"><label type="tag" role="menuitem" class="sc-eHEENL btqmKr -depth1"><span title="Images" class="sc-hzUIXc ylzCN">Images</span><svg class="sc-dIsUp dvcDrG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></label><ul class="sc-uxdHp kUEEAF"><li data-item-id="tag/Images/operation/createImageEdit" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="post" class="sc-ikXwFM ecAtVr operation-type post">post</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">Creates an edited or extended image given one or more source images and a prompt. This endpoint supports GPT Image models (`gpt-image-1.5`, `gpt-image-1`, `gpt-image-1-mini`, and `chatgpt-image-latest`) and `dall-e-2`.</span></label></li><li data-item-id="tag/Images/operation/createImage" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="post" class="sc-ikXwFM ecAtVr operation-type post">post</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">Creates an image given a prompt. [Learn more](/docs/guides/images).
</span></label></li><li data-item-id="tag/Images/operation/createImageVariation" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="post" class="sc-ikXwFM ecAtVr operation-type post">post</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">Creates a variation of a given image. This endpoint only supports `dall-e-2`.</span></label></li></ul></li><li data-item-id="tag/Models" class="sc-biJonm jycHIP"><label type="tag" role="menuitem" class="sc-eHEENL btqmKr -depth1"><span title="Models" class="sc-hzUIXc ylzCN">Models</span><svg class="sc-dIsUp dvcDrG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></label><ul class="sc-uxdHp kUEEAF"><li data-item-id="tag/Models/operation/listModels" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="get" class="sc-ikXwFM ecAtVr operation-type get">get</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">Lists the currently available models, and provides basic information about each one such as the owner and availability.</span></label></li><li data-item-id="tag/Models/operation/retrieveModel" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="get" class="sc-ikXwFM ecAtVr operation-type get">get</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">Retrieves a model instance, providing basic information about the model such as the owner and permissioning.</span></label></li><li data-item-id="tag/Models/operation/deleteModel" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="delete" class="sc-ikXwFM ecAtVr operation-type delete">del</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">Delete a fine-tuned model. You must have the Owner role in your organization to delete a model.</span></label></li></ul></li><li data-item-id="tag/Moderations" class="sc-biJonm jycHIP"><label type="tag" role="menuitem" class="sc-eHEENL btqmKr -depth1"><span title="Moderations" class="sc-hzUIXc ylzCN">Moderations</span><svg class="sc-dIsUp dvcDrG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></label><ul class="sc-uxdHp kUEEAF"><li data-item-id="tag/Moderations/operation/createModeration" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="post" class="sc-ikXwFM ecAtVr operation-type post">post</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">Classifies if text and/or image inputs are potentially harmful. Learn
more in the [moderation guide](/docs/guides/moderation).
</span></label></li></ul></li><li data-item-id="tag/Audit-Logs" class="sc-biJonm jycHIP"><label type="tag" role="menuitem" class="sc-eHEENL btqmKr -depth1"><span title="Audit Logs" class="sc-hzUIXc ylzCN">Audit Logs</span><svg class="sc-dIsUp dvcDrG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></label><ul class="sc-uxdHp kUEEAF"><li data-item-id="tag/Audit-Logs/operation/list-audit-logs" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="get" class="sc-ikXwFM ecAtVr operation-type get">get</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">List user actions and configuration changes within this organization.</span></label></li></ul></li><li data-item-id="/paths/batch_cancelled/post" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="hook" class="sc-ikXwFM ecAtVr operation-type hook">Event</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">Sent when a batch has been cancelled.
</span></label></li><li data-item-id="/paths/batch_completed/post" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="hook" class="sc-ikXwFM ecAtVr operation-type hook">Event</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">Sent when a batch has completed processing.
</span></label></li><li data-item-id="/paths/batch_expired/post" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="hook" class="sc-ikXwFM ecAtVr operation-type hook">Event</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">Sent when a batch has expired before completion.
</span></label></li><li data-item-id="/paths/batch_failed/post" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="hook" class="sc-ikXwFM ecAtVr operation-type hook">Event</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">Sent when a batch has failed.
</span></label></li><li data-item-id="/paths/eval_run_canceled/post" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="hook" class="sc-ikXwFM ecAtVr operation-type hook">Event</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">Sent when an eval run has been canceled.
</span></label></li><li data-item-id="/paths/eval_run_failed/post" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="hook" class="sc-ikXwFM ecAtVr operation-type hook">Event</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">Sent when an eval run has failed.
</span></label></li><li data-item-id="/paths/eval_run_succeeded/post" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="hook" class="sc-ikXwFM ecAtVr operation-type hook">Event</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">Sent when an eval run has succeeded.
</span></label></li><li data-item-id="/paths/fine_tuning_job_cancelled/post" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="hook" class="sc-ikXwFM ecAtVr operation-type hook">Event</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">Sent when a fine-tuning job has been cancelled.
</span></label></li><li data-item-id="/paths/fine_tuning_job_failed/post" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="hook" class="sc-ikXwFM ecAtVr operation-type hook">Event</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">Sent when a fine-tuning job has failed.
</span></label></li><li data-item-id="/paths/fine_tuning_job_succeeded/post" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="hook" class="sc-ikXwFM ecAtVr operation-type hook">Event</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">Sent when a fine-tuning job has succeeded.
</span></label></li><li data-item-id="/paths/realtime_call_incoming/post" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="hook" class="sc-ikXwFM ecAtVr operation-type hook">Event</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">Sent when Realtime API Receives a incoming SIP cal</span></label></li><li data-item-id="/paths/response_cancelled/post" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="hook" class="sc-ikXwFM ecAtVr operation-type hook">Event</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">Sent when a background response has been cancelled</span></label></li><li data-item-id="/paths/response_completed/post" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="hook" class="sc-ikXwFM ecAtVr operation-type hook">Event</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">Sent when a background response has completed succ</span></label></li><li data-item-id="/paths/response_failed/post" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="hook" class="sc-ikXwFM ecAtVr operation-type hook">Event</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">Sent when a background response has failed.
</span></label></li><li data-item-id="/paths/response_incomplete/post" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="hook" class="sc-ikXwFM ecAtVr operation-type hook">Event</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">Sent when a background response is incomplete.
</span></label></li><li data-item-id="operation/ListContainers" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="get" class="sc-ikXwFM ecAtVr operation-type get">get</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">List Containers</span></label></li><li data-item-id="operation/CreateContainer" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="post" class="sc-ikXwFM ecAtVr operation-type post">post</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">Create Container</span></label></li><li data-item-id="operation/RetrieveContainer" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="get" class="sc-ikXwFM ecAtVr operation-type get">get</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">Retrieve Container</span></label></li><li data-item-id="operation/DeleteContainer" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="delete" class="sc-ikXwFM ecAtVr operation-type delete">del</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">Delete Container</span></label></li><li data-item-id="operation/CreateContainerFile" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="post" class="sc-ikXwFM ecAtVr operation-type post">post</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">Create a Container File
You can send either a multipart/form-data request with the raw file content, or a JSON request with a file ID.
</span></label></li><li data-item-id="operation/ListContainerFiles" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="get" class="sc-ikXwFM ecAtVr operation-type get">get</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">List Container files</span></label></li><li data-item-id="operation/RetrieveContainerFile" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="get" class="sc-ikXwFM ecAtVr operation-type get">get</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">Retrieve Container File</span></label></li><li data-item-id="operation/DeleteContainerFile" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="delete" class="sc-ikXwFM ecAtVr operation-type delete">del</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">Delete Container File</span></label></li><li data-item-id="operation/RetrieveContainerFileContent" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="get" class="sc-ikXwFM ecAtVr operation-type get">get</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">Retrieve Container File Content</span></label></li><li data-item-id="operation/admin-api-keys-list" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="get" class="sc-ikXwFM ecAtVr operation-type get">get</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">List organization API keys</span></label></li><li data-item-id="operation/admin-api-keys-create" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="post" class="sc-ikXwFM ecAtVr operation-type post">post</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">Create an organization admin API key</span></label></li><li data-item-id="operation/admin-api-keys-get" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="get" class="sc-ikXwFM ecAtVr operation-type get">get</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">Retrieve a single organization API key</span></label></li><li data-item-id="operation/admin-api-keys-delete" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="delete" class="sc-ikXwFM ecAtVr operation-type delete">del</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">Delete an organization admin API key</span></label></li><li data-item-id="operation/Getinputtokencounts" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="post" class="sc-ikXwFM ecAtVr operation-type post">post</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">Returns input token counts of the request.
Returns an object with `object` set to `response.input_tokens` and an `input_tokens` count.</span></label></li><li data-item-id="operation/Compactconversation" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="post" class="sc-ikXwFM ecAtVr operation-type post">post</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">Compact a conversation. Returns a compacted response object.
Learn when and how to compact long-running conversations in the [conversation state guide](/docs/guides/conversation-state#managing-the-context-window). For ZDR-compatible compaction details, see [Compaction (advanced)](/docs/guides/conversation-state#compaction-advanced).</span></label></li><li data-item-id="operation/CancelChatSessionMethod" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="post" class="sc-ikXwFM ecAtVr operation-type post">post</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">Cancel an active ChatKit session and return its most recent metadata.
Cancelling prevents new requests from using the issued client secret.</span></label></li><li data-item-id="operation/CreateChatSessionMethod" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="post" class="sc-ikXwFM ecAtVr operation-type post">post</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">Create a ChatKit session.</span></label></li><li data-item-id="operation/ListThreadItemsMethod" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="get" class="sc-ikXwFM ecAtVr operation-type get">get</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">List items that belong to a ChatKit thread.</span></label></li><li data-item-id="operation/GetThreadMethod" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="get" class="sc-ikXwFM ecAtVr operation-type get">get</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">Retrieve a ChatKit thread by its identifier.</span></label></li><li data-item-id="operation/DeleteThreadMethod" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="delete" class="sc-ikXwFM ecAtVr operation-type delete">del</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">Delete a ChatKit thread along with its items and stored attachments.</span></label></li><li data-item-id="operation/ListThreadsMethod" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="get" class="sc-ikXwFM ecAtVr operation-type get">get</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">List ChatKit threads with optional pagination and user filters.</span></label></li><li data-item-id="tag/Certificates" class="sc-biJonm jycHIP"><label type="tag" role="menuitem" class="sc-eHEENL btqmKr -depth1"><span title="Certificates" class="sc-hzUIXc ylzCN">Certificates</span><svg class="sc-dIsUp dvcDrG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></label><ul class="sc-uxdHp kUEEAF"><li data-item-id="tag/Certificates/operation/listOrganizationCertificates" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="get" class="sc-ikXwFM ecAtVr operation-type get">get</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">List uploaded certificates for this organization.</span></label></li><li data-item-id="tag/Certificates/operation/uploadCertificate" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="post" class="sc-ikXwFM ecAtVr operation-type post">post</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">Upload a certificate to the organization. This does **not** automatically activate the certificate.
Organizations can upload up to 50 certificates.
</span></label></li><li data-item-id="tag/Certificates/operation/activateOrganizationCertificates" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="post" class="sc-ikXwFM ecAtVr operation-type post">post</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">Activate certificates at the organization level.
You can atomically and idempotently activate up to 10 certificates at a time.
</span></label></li><li data-item-id="tag/Certificates/operation/deactivateOrganizationCertificates" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="post" class="sc-ikXwFM ecAtVr operation-type post">post</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">Deactivate certificates at the organization level.
You can atomically and idempotently deactivate up to 10 certificates at a time.
</span></label></li><li data-item-id="tag/Certificates/operation/getCertificate" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="get" class="sc-ikXwFM ecAtVr operation-type get">get</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">Get a certificate that has been uploaded to the organization.
You can get a certificate regardless of whether it is active or not.
</span></label></li><li data-item-id="tag/Certificates/operation/modifyCertificate" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="post" class="sc-ikXwFM ecAtVr operation-type post">post</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">Modify a certificate. Note that only the name can be modified.
</span></label></li><li data-item-id="tag/Certificates/operation/deleteCertificate" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="delete" class="sc-ikXwFM ecAtVr operation-type delete">del</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">Delete a certificate from the organization.
The certificate must be inactive for the organization and all projects.
</span></label></li><li data-item-id="tag/Certificates/operation/listProjectCertificates" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="get" class="sc-ikXwFM ecAtVr operation-type get">get</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">List certificates for this project.</span></label></li><li data-item-id="tag/Certificates/operation/activateProjectCertificates" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="post" class="sc-ikXwFM ecAtVr operation-type post">post</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">Activate certificates at the project level.
You can atomically and idempotently activate up to 10 certificates at a time.
</span></label></li><li data-item-id="tag/Certificates/operation/deactivateProjectCertificates" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="post" class="sc-ikXwFM ecAtVr operation-type post">post</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">Deactivate certificates at the project level. You can atomically and
idempotently deactivate up to 10 certificates at a time.
</span></label></li></ul></li><li data-item-id="tag/Usage" class="sc-biJonm jycHIP"><label type="tag" role="menuitem" class="sc-eHEENL btqmKr -depth1"><span title="Usage" class="sc-hzUIXc ylzCN">Usage</span><svg class="sc-dIsUp dvcDrG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></label><ul class="sc-uxdHp kUEEAF"><li data-item-id="tag/Usage/operation/usage-costs" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="get" class="sc-ikXwFM ecAtVr operation-type get">get</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">Get costs details for the organization.</span></label></li><li data-item-id="tag/Usage/operation/usage-audio-speeches" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="get" class="sc-ikXwFM ecAtVr operation-type get">get</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">Get audio speeches usage details for the organization.</span></label></li><li data-item-id="tag/Usage/operation/usage-audio-transcriptions" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="get" class="sc-ikXwFM ecAtVr operation-type get">get</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">Get audio transcriptions usage details for the organization.</span></label></li><li data-item-id="tag/Usage/operation/usage-code-interpreter-sessions" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="get" class="sc-ikXwFM ecAtVr operation-type get">get</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">Get code interpreter sessions usage details for the organization.</span></label></li><li data-item-id="tag/Usage/operation/usage-completions" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="get" class="sc-ikXwFM ecAtVr operation-type get">get</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">Get completions usage details for the organization.</span></label></li><li data-item-id="tag/Usage/operation/usage-embeddings" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="get" class="sc-ikXwFM ecAtVr operation-type get">get</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">Get embeddings usage details for the organization.</span></label></li><li data-item-id="tag/Usage/operation/usage-images" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="get" class="sc-ikXwFM ecAtVr operation-type get">get</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">Get images usage details for the organization.</span></label></li><li data-item-id="tag/Usage/operation/usage-moderations" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="get" class="sc-ikXwFM ecAtVr operation-type get">get</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">Get moderations usage details for the organization.</span></label></li><li data-item-id="tag/Usage/operation/usage-vector-stores" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="get" class="sc-ikXwFM ecAtVr operation-type get">get</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">Get vector stores usage details for the organization.</span></label></li></ul></li><li data-item-id="tag/Groups" class="sc-biJonm jycHIP"><label type="tag" role="menuitem" class="sc-eHEENL btqmKr -depth1"><span title="Groups" class="sc-hzUIXc ylzCN">Groups</span><svg class="sc-dIsUp dvcDrG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></label><ul class="sc-uxdHp kUEEAF"><li data-item-id="tag/Groups/operation/list-groups" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="get" class="sc-ikXwFM ecAtVr operation-type get">get</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">Lists all groups in the organization.</span></label></li><li data-item-id="tag/Groups/operation/create-group" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="post" class="sc-ikXwFM ecAtVr operation-type post">post</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">Creates a new group in the organization.</span></label></li><li data-item-id="tag/Groups/operation/update-group" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="post" class="sc-ikXwFM ecAtVr operation-type post">post</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">Updates a group's information.</span></label></li><li data-item-id="tag/Groups/operation/delete-group" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="delete" class="sc-ikXwFM ecAtVr operation-type delete">del</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">Deletes a group from the organization.</span></label></li></ul></li><li data-item-id="tag/Group-organization-role-assignments" class="sc-biJonm jycHIP"><label type="tag" role="menuitem" class="sc-eHEENL btqmKr -depth1"><span title="Group organization role assignments" class="sc-hzUIXc ylzCN">Group organization role assignments</span><svg class="sc-dIsUp dvcDrG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></label><ul class="sc-uxdHp kUEEAF"><li data-item-id="tag/Group-organization-role-assignments/operation/list-group-role-assignments" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="get" class="sc-ikXwFM ecAtVr operation-type get">get</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">Lists the organization roles assigned to a group within the organization.</span></label></li><li data-item-id="tag/Group-organization-role-assignments/operation/assign-group-role" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="post" class="sc-ikXwFM ecAtVr operation-type post">post</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">Assigns an organization role to a group within the organization.</span></label></li><li data-item-id="tag/Group-organization-role-assignments/operation/unassign-group-role" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="delete" class="sc-ikXwFM ecAtVr operation-type delete">del</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">Unassigns an organization role from a group within the organization.</span></label></li></ul></li><li data-item-id="tag/Group-users" class="sc-biJonm jycHIP"><label type="tag" role="menuitem" class="sc-eHEENL btqmKr -depth1"><span title="Group users" class="sc-hzUIXc ylzCN">Group users</span><svg class="sc-dIsUp dvcDrG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></label><ul class="sc-uxdHp kUEEAF"><li data-item-id="tag/Group-users/operation/list-group-users" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="get" class="sc-ikXwFM ecAtVr operation-type get">get</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">Lists the users assigned to a group.</span></label></li><li data-item-id="tag/Group-users/operation/add-group-user" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="post" class="sc-ikXwFM ecAtVr operation-type post">post</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">Adds a user to a group.</span></label></li><li data-item-id="tag/Group-users/operation/remove-group-user" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="delete" class="sc-ikXwFM ecAtVr operation-type delete">del</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">Removes a user from a group.</span></label></li></ul></li><li data-item-id="tag/Invites" class="sc-biJonm jycHIP"><label type="tag" role="menuitem" class="sc-eHEENL btqmKr -depth1"><span title="Invites" class="sc-hzUIXc ylzCN">Invites</span><svg class="sc-dIsUp dvcDrG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></label><ul class="sc-uxdHp kUEEAF"><li data-item-id="tag/Invites/operation/list-invites" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="get" class="sc-ikXwFM ecAtVr operation-type get">get</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">Returns a list of invites in the organization.</span></label></li><li data-item-id="tag/Invites/operation/inviteUser" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="post" class="sc-ikXwFM ecAtVr operation-type post">post</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">Create an invite for a user to the organization. The invite must be accepted by the user before they have access to the organization.</span></label></li><li data-item-id="tag/Invites/operation/retrieve-invite" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="get" class="sc-ikXwFM ecAtVr operation-type get">get</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">Retrieves an invite.</span></label></li><li data-item-id="tag/Invites/operation/delete-invite" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="delete" class="sc-ikXwFM ecAtVr operation-type delete">del</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">Delete an invite. If the invite has already been accepted, it cannot be deleted.</span></label></li></ul></li><li data-item-id="tag/Projects" class="sc-biJonm jycHIP"><label type="tag" role="menuitem" class="sc-eHEENL btqmKr -depth1"><span title="Projects" class="sc-hzUIXc ylzCN">Projects</span><svg class="sc-dIsUp dvcDrG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></label><ul class="sc-uxdHp kUEEAF"><li data-item-id="tag/Projects/operation/list-projects" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="get" class="sc-ikXwFM ecAtVr operation-type get">get</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">Returns a list of projects.</span></label></li><li data-item-id="tag/Projects/operation/create-project" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="post" class="sc-ikXwFM ecAtVr operation-type post">post</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">Create a new project in the organization. Projects can be created and archived, but cannot be deleted.</span></label></li><li data-item-id="tag/Projects/operation/retrieve-project" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="get" class="sc-ikXwFM ecAtVr operation-type get">get</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">Retrieves a project.</span></label></li><li data-item-id="tag/Projects/operation/modify-project" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="post" class="sc-ikXwFM ecAtVr operation-type post">post</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">Modifies a project in the organization.</span></label></li><li data-item-id="tag/Projects/operation/list-project-api-keys" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="get" class="sc-ikXwFM ecAtVr operation-type get">get</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">Returns a list of API keys in the project.</span></label></li><li data-item-id="tag/Projects/operation/retrieve-project-api-key" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="get" class="sc-ikXwFM ecAtVr operation-type get">get</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">Retrieves an API key in the project.</span></label></li><li data-item-id="tag/Projects/operation/delete-project-api-key" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="delete" class="sc-ikXwFM ecAtVr operation-type delete">del</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">Deletes an API key from the project.
Returns confirmation of the key deletion, or an error if the key belonged to
a service account.
</span></label></li><li data-item-id="tag/Projects/operation/archive-project" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="post" class="sc-ikXwFM ecAtVr operation-type post">post</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">Archives a project in the organization. Archived projects cannot be used or updated.</span></label></li><li data-item-id="tag/Projects/operation/list-project-rate-limits" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="get" class="sc-ikXwFM ecAtVr operation-type get">get</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">Returns the rate limits per model for a project.</span></label></li><li data-item-id="tag/Projects/operation/update-project-rate-limits" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="post" class="sc-ikXwFM ecAtVr operation-type post">post</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">Updates a project rate limit.</span></label></li><li data-item-id="tag/Projects/operation/list-project-service-accounts" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="get" class="sc-ikXwFM ecAtVr operation-type get">get</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">Returns a list of service accounts in the project.</span></label></li><li data-item-id="tag/Projects/operation/create-project-service-account" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="post" class="sc-ikXwFM ecAtVr operation-type post">post</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">Creates a new service account in the project. This also returns an unredacted API key for the service account.</span></label></li><li data-item-id="tag/Projects/operation/retrieve-project-service-account" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="get" class="sc-ikXwFM ecAtVr operation-type get">get</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">Retrieves a service account in the project.</span></label></li><li data-item-id="tag/Projects/operation/delete-project-service-account" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="delete" class="sc-ikXwFM ecAtVr operation-type delete">del</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">Deletes a service account from the project.
Returns confirmation of service account deletion, or an error if the project
is archived (archived projects have no service accounts).
</span></label></li><li data-item-id="tag/Projects/operation/list-project-users" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="get" class="sc-ikXwFM ecAtVr operation-type get">get</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">Returns a list of users in the project.</span></label></li><li data-item-id="tag/Projects/operation/create-project-user" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="post" class="sc-ikXwFM ecAtVr operation-type post">post</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">Adds a user to the project. Users must already be members of the organization to be added to a project.</span></label></li><li data-item-id="tag/Projects/operation/retrieve-project-user" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="get" class="sc-ikXwFM ecAtVr operation-type get">get</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">Retrieves a user in the project.</span></label></li><li data-item-id="tag/Projects/operation/modify-project-user" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="post" class="sc-ikXwFM ecAtVr operation-type post">post</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">Modifies a user's role in the project.</span></label></li><li data-item-id="tag/Projects/operation/delete-project-user" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="delete" class="sc-ikXwFM ecAtVr operation-type delete">del</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">Deletes a user from the project.
Returns confirmation of project user deletion, or an error if the project is
archived (archived projects have no users).
</span></label></li></ul></li><li data-item-id="tag/Project-groups" class="sc-biJonm jycHIP"><label type="tag" role="menuitem" class="sc-eHEENL btqmKr -depth1"><span title="Project groups" class="sc-hzUIXc ylzCN">Project groups</span><svg class="sc-dIsUp dvcDrG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></label><ul class="sc-uxdHp kUEEAF"><li data-item-id="tag/Project-groups/operation/list-project-groups" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="get" class="sc-ikXwFM ecAtVr operation-type get">get</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">Lists the groups that have access to a project.</span></label></li><li data-item-id="tag/Project-groups/operation/add-project-group" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="post" class="sc-ikXwFM ecAtVr operation-type post">post</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">Grants a group access to a project.</span></label></li><li data-item-id="tag/Project-groups/operation/remove-project-group" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="delete" class="sc-ikXwFM ecAtVr operation-type delete">del</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">Revokes a group's access to a project.</span></label></li></ul></li><li data-item-id="tag/Roles" class="sc-biJonm jycHIP"><label type="tag" role="menuitem" class="sc-eHEENL btqmKr -depth1"><span title="Roles" class="sc-hzUIXc ylzCN">Roles</span><svg class="sc-dIsUp dvcDrG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></label><ul class="sc-uxdHp kUEEAF"><li data-item-id="tag/Roles/operation/list-roles" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="get" class="sc-ikXwFM ecAtVr operation-type get">get</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">Lists the roles configured for the organization.</span></label></li><li data-item-id="tag/Roles/operation/create-role" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="post" class="sc-ikXwFM ecAtVr operation-type post">post</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">Creates a custom role for the organization.</span></label></li><li data-item-id="tag/Roles/operation/update-role" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="post" class="sc-ikXwFM ecAtVr operation-type post">post</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">Updates an existing organization role.</span></label></li><li data-item-id="tag/Roles/operation/delete-role" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="delete" class="sc-ikXwFM ecAtVr operation-type delete">del</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">Deletes a custom role from the organization.</span></label></li><li data-item-id="tag/Roles/operation/list-project-roles" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="get" class="sc-ikXwFM ecAtVr operation-type get">get</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">Lists the roles configured for a project.</span></label></li><li data-item-id="tag/Roles/operation/create-project-role" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="post" class="sc-ikXwFM ecAtVr operation-type post">post</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">Creates a custom role for a project.</span></label></li><li data-item-id="tag/Roles/operation/update-project-role" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="post" class="sc-ikXwFM ecAtVr operation-type post">post</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">Updates an existing project role.</span></label></li><li data-item-id="tag/Roles/operation/delete-project-role" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="delete" class="sc-ikXwFM ecAtVr operation-type delete">del</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">Deletes a custom role from a project.</span></label></li></ul></li><li data-item-id="tag/Users" class="sc-biJonm jycHIP"><label type="tag" role="menuitem" class="sc-eHEENL btqmKr -depth1"><span title="Users" class="sc-hzUIXc ylzCN">Users</span><svg class="sc-dIsUp dvcDrG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></label><ul class="sc-uxdHp kUEEAF"><li data-item-id="tag/Users/operation/list-users" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="get" class="sc-ikXwFM ecAtVr operation-type get">get</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">Lists all of the users in the organization.</span></label></li><li data-item-id="tag/Users/operation/retrieve-user" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="get" class="sc-ikXwFM ecAtVr operation-type get">get</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">Retrieves a user by their identifier.</span></label></li><li data-item-id="tag/Users/operation/modify-user" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="post" class="sc-ikXwFM ecAtVr operation-type post">post</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">Modifies a user's role in the organization.</span></label></li><li data-item-id="tag/Users/operation/delete-user" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="delete" class="sc-ikXwFM ecAtVr operation-type delete">del</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">Deletes a user from the organization.</span></label></li></ul></li><li data-item-id="tag/User-organization-role-assignments" class="sc-biJonm jycHIP"><label type="tag" role="menuitem" class="sc-eHEENL btqmKr -depth1"><span title="User organization role assignments" class="sc-hzUIXc ylzCN">User organization role assignments</span><svg class="sc-dIsUp dvcDrG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></label><ul class="sc-uxdHp kUEEAF"><li data-item-id="tag/User-organization-role-assignments/operation/list-user-role-assignments" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="get" class="sc-ikXwFM ecAtVr operation-type get">get</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">Lists the organization roles assigned to a user within the organization.</span></label></li><li data-item-id="tag/User-organization-role-assignments/operation/assign-user-role" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="post" class="sc-ikXwFM ecAtVr operation-type post">post</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">Assigns an organization role to a user within the organization.</span></label></li><li data-item-id="tag/User-organization-role-assignments/operation/unassign-user-role" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="delete" class="sc-ikXwFM ecAtVr operation-type delete">del</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">Unassigns an organization role from a user within the organization.</span></label></li></ul></li><li data-item-id="tag/Project-group-role-assignments" class="sc-biJonm jycHIP"><label type="tag" role="menuitem" class="sc-eHEENL btqmKr -depth1"><span title="Project group role assignments" class="sc-hzUIXc ylzCN">Project group role assignments</span><svg class="sc-dIsUp dvcDrG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></label><ul class="sc-uxdHp kUEEAF"><li data-item-id="tag/Project-group-role-assignments/operation/list-project-group-role-assignments" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="get" class="sc-ikXwFM ecAtVr operation-type get">get</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">Lists the project roles assigned to a group within a project.</span></label></li><li data-item-id="tag/Project-group-role-assignments/operation/assign-project-group-role" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="post" class="sc-ikXwFM ecAtVr operation-type post">post</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">Assigns a project role to a group within a project.</span></label></li><li data-item-id="tag/Project-group-role-assignments/operation/unassign-project-group-role" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="delete" class="sc-ikXwFM ecAtVr operation-type delete">del</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">Unassigns a project role from a group within a project.</span></label></li></ul></li><li data-item-id="tag/Project-user-role-assignments" class="sc-biJonm jycHIP"><label type="tag" role="menuitem" class="sc-eHEENL btqmKr -depth1"><span title="Project user role assignments" class="sc-hzUIXc ylzCN">Project user role assignments</span><svg class="sc-dIsUp dvcDrG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></label><ul class="sc-uxdHp kUEEAF"><li data-item-id="tag/Project-user-role-assignments/operation/list-project-user-role-assignments" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="get" class="sc-ikXwFM ecAtVr operation-type get">get</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">Lists the project roles assigned to a user within a project.</span></label></li><li data-item-id="tag/Project-user-role-assignments/operation/assign-project-user-role" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="post" class="sc-ikXwFM ecAtVr operation-type post">post</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">Assigns a project role to a user within a project.</span></label></li><li data-item-id="tag/Project-user-role-assignments/operation/unassign-project-user-role" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="delete" class="sc-ikXwFM ecAtVr operation-type delete">del</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">Unassigns a project role from a user within a project.</span></label></li></ul></li><li data-item-id="tag/Realtime" class="sc-biJonm jycHIP"><label type="tag" role="menuitem" class="sc-eHEENL btqmKr -depth1"><span title="Realtime" class="sc-hzUIXc ylzCN">Realtime</span><svg class="sc-dIsUp dvcDrG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></label><ul class="sc-uxdHp kUEEAF"><li data-item-id="tag/Realtime/operation/create-realtime-call" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="post" class="sc-ikXwFM ecAtVr operation-type post">post</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">Create a new Realtime API call over WebRTC and receive the SDP answer needed
to complete the peer connection.</span></label></li><li data-item-id="tag/Realtime/operation/accept-realtime-call" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="post" class="sc-ikXwFM ecAtVr operation-type post">post</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">Accept an incoming SIP call and configure the realtime session that will
handle it.</span></label></li><li data-item-id="tag/Realtime/operation/hangup-realtime-call" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="post" class="sc-ikXwFM ecAtVr operation-type post">post</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">End an active Realtime API call, whether it was initiated over SIP or
WebRTC.</span></label></li><li data-item-id="tag/Realtime/operation/refer-realtime-call" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="post" class="sc-ikXwFM ecAtVr operation-type post">post</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">Transfer an active SIP call to a new destination using the SIP REFER verb.</span></label></li><li data-item-id="tag/Realtime/operation/reject-realtime-call" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="post" class="sc-ikXwFM ecAtVr operation-type post">post</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">Decline an incoming SIP call by returning a SIP status code to the caller.</span></label></li><li data-item-id="tag/Realtime/operation/create-realtime-client-secret" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="post" class="sc-ikXwFM ecAtVr operation-type post">post</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">Create a Realtime client secret with an associated session configuration.
Client secrets are short-lived tokens that can be passed to a client app,
such as a web frontend or mobile client, which grants access to the Realtime API without
leaking your main API key. You can configure a custom TTL for each client secret.
You can also attach session configuration options to the client secret, which will be
applied to any sessions created using that client secret, but these can also be overridden
by the client connection.
[Learn more about authentication with client secrets over WebRTC](/docs/guides/realtime-webrtc).
Returns the created client secret and the effective session object. The client secret is a string that looks like `ek_1234`.
</span></label></li><li data-item-id="tag/Realtime/operation/create-realtime-session" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="post" class="sc-ikXwFM ecAtVr operation-type post">post</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">Create an ephemeral API token for use in client-side applications with the
Realtime API. Can be configured with the same session parameters as the
`session.update` client event.
It responds with a session object, plus a `client_secret` key which contains
a usable ephemeral API token that can be used to authenticate browser clients
for the Realtime API.
Returns the created Realtime session object, plus an ephemeral key.
</span></label></li><li data-item-id="tag/Realtime/operation/create-realtime-transcription-session" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="post" class="sc-ikXwFM ecAtVr operation-type post">post</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">Create an ephemeral API token for use in client-side applications with the
Realtime API specifically for realtime transcriptions.
Can be configured with the same session parameters as the `transcription_session.update` client event.
It responds with a session object, plus a `client_secret` key which contains
a usable ephemeral API token that can be used to authenticate browser clients
for the Realtime API.
Returns the created Realtime transcription session object, plus an ephemeral key.
</span></label></li></ul></li><li data-item-id="tag/Responses" class="sc-biJonm jycHIP"><label type="tag" role="menuitem" class="sc-eHEENL btqmKr -depth1"><span title="Responses" class="sc-hzUIXc ylzCN">Responses</span><svg class="sc-dIsUp dvcDrG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></label><ul class="sc-uxdHp kUEEAF"><li data-item-id="tag/Responses/operation/createResponse" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="post" class="sc-ikXwFM ecAtVr operation-type post">post</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">Creates a model response. Provide [text](/docs/guides/text) or
[image](/docs/guides/images) inputs to generate [text](/docs/guides/text)
or [JSON](/docs/guides/structured-outputs) outputs. Have the model call
your own [custom code](/docs/guides/function-calling) or use built-in
[tools](/docs/guides/tools) like [web search](/docs/guides/tools-web-search)
or [file search](/docs/guides/tools-file-search) to use your own data
as input for the model's response.
</span></label></li><li data-item-id="tag/Responses/operation/getResponse" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="get" class="sc-ikXwFM ecAtVr operation-type get">get</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">Retrieves a model response with the given ID.
</span></label></li><li data-item-id="tag/Responses/operation/deleteResponse" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="delete" class="sc-ikXwFM ecAtVr operation-type delete">del</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">Deletes a model response with the given ID.
</span></label></li><li data-item-id="tag/Responses/operation/cancelResponse" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="post" class="sc-ikXwFM ecAtVr operation-type post">post</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">Cancels a model response with the given ID. Only responses created with
the `background` parameter set to `true` can be cancelled.
[Learn more](/docs/guides/background).
</span></label></li><li data-item-id="tag/Responses/operation/listInputItems" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="get" class="sc-ikXwFM ecAtVr operation-type get">get</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">Returns a list of input items for a given response.</span></label></li></ul></li><li data-item-id="tag/Vector-stores" class="sc-biJonm jycHIP"><label type="tag" role="menuitem" class="sc-eHEENL btqmKr -depth1"><span title="Vector stores" class="sc-hzUIXc ylzCN">Vector stores</span><svg class="sc-dIsUp dvcDrG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></label><ul class="sc-uxdHp kUEEAF"><li data-item-id="tag/Vector-stores/operation/listVectorStores" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="get" class="sc-ikXwFM ecAtVr operation-type get">get</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">Returns a list of vector stores.</span></label></li><li data-item-id="tag/Vector-stores/operation/createVectorStore" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="post" class="sc-ikXwFM ecAtVr operation-type post">post</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">Create a vector store.</span></label></li><li data-item-id="tag/Vector-stores/operation/getVectorStore" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="get" class="sc-ikXwFM ecAtVr operation-type get">get</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">Retrieves a vector store.</span></label></li><li data-item-id="tag/Vector-stores/operation/modifyVectorStore" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="post" class="sc-ikXwFM ecAtVr operation-type post">post</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">Modifies a vector store.</span></label></li><li data-item-id="tag/Vector-stores/operation/deleteVectorStore" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="delete" class="sc-ikXwFM ecAtVr operation-type delete">del</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">Delete a vector store.</span></label></li><li data-item-id="tag/Vector-stores/operation/createVectorStoreFileBatch" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="post" class="sc-ikXwFM ecAtVr operation-type post">post</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">Create a vector store file batch.</span></label></li><li data-item-id="tag/Vector-stores/operation/getVectorStoreFileBatch" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="get" class="sc-ikXwFM ecAtVr operation-type get">get</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">Retrieves a vector store file batch.</span></label></li><li data-item-id="tag/Vector-stores/operation/cancelVectorStoreFileBatch" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="post" class="sc-ikXwFM ecAtVr operation-type post">post</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">Cancel a vector store file batch. This attempts to cancel the processing of files in this batch as soon as possible.</span></label></li><li data-item-id="tag/Vector-stores/operation/listFilesInVectorStoreBatch" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="get" class="sc-ikXwFM ecAtVr operation-type get">get</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">Returns a list of vector store files in a batch.</span></label></li><li data-item-id="tag/Vector-stores/operation/listVectorStoreFiles" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="get" class="sc-ikXwFM ecAtVr operation-type get">get</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">Returns a list of vector store files.</span></label></li><li data-item-id="tag/Vector-stores/operation/createVectorStoreFile" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="post" class="sc-ikXwFM ecAtVr operation-type post">post</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">Create a vector store file by attaching a [File](/docs/api-reference/files) to a [vector store](/docs/api-reference/vector-stores/object).</span></label></li><li data-item-id="tag/Vector-stores/operation/getVectorStoreFile" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="get" class="sc-ikXwFM ecAtVr operation-type get">get</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">Retrieves a vector store file.</span></label></li><li data-item-id="tag/Vector-stores/operation/deleteVectorStoreFile" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="delete" class="sc-ikXwFM ecAtVr operation-type delete">del</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">Delete a vector store file. This will remove the file from the vector store but the file itself will not be deleted. To delete the file, use the [delete file](/docs/api-reference/files/delete) endpoint.</span></label></li><li data-item-id="tag/Vector-stores/operation/updateVectorStoreFileAttributes" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="post" class="sc-ikXwFM ecAtVr operation-type post">post</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">Update attributes on a vector store file.</span></label></li><li data-item-id="tag/Vector-stores/operation/retrieveVectorStoreFileContent" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="get" class="sc-ikXwFM ecAtVr operation-type get">get</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">Retrieve the parsed contents of a vector store file.</span></label></li><li data-item-id="tag/Vector-stores/operation/searchVectorStore" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="post" class="sc-ikXwFM ecAtVr operation-type post">post</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">Search a vector store for relevant chunks based on a query and file attributes filter.</span></label></li></ul></li><li data-item-id="tag/Videos" class="sc-biJonm jycHIP"><label type="tag" role="menuitem" class="sc-eHEENL btqmKr -depth1"><span title="Videos" class="sc-hzUIXc ylzCN">Videos</span><svg class="sc-dIsUp dvcDrG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></label><ul class="sc-uxdHp kUEEAF"><li data-item-id="tag/Videos/operation/createVideo" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="post" class="sc-ikXwFM ecAtVr operation-type post">post</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">Create a new video generation job from a prompt and optional reference assets.</span></label></li><li data-item-id="tag/Videos/operation/ListVideos" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="get" class="sc-ikXwFM ecAtVr operation-type get">get</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">List recently generated videos for the current project.</span></label></li><li data-item-id="tag/Videos/operation/CreateVideoCharacter" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="post" class="sc-ikXwFM ecAtVr operation-type post">post</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">Create a character from an uploaded video.</span></label></li><li data-item-id="tag/Videos/operation/GetVideoCharacter" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="get" class="sc-ikXwFM ecAtVr operation-type get">get</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">Fetch a character.</span></label></li><li data-item-id="tag/Videos/operation/CreateVideoEdit" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="post" class="sc-ikXwFM ecAtVr operation-type post">post</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">Create a new video generation job by editing a source video or existing generated video.</span></label></li><li data-item-id="tag/Videos/operation/CreateVideoExtend" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="post" class="sc-ikXwFM ecAtVr operation-type post">post</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">Create an extension of a completed video.</span></label></li><li data-item-id="tag/Videos/operation/GetVideo" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="get" class="sc-ikXwFM ecAtVr operation-type get">get</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">Fetch the latest metadata for a generated video.</span></label></li><li data-item-id="tag/Videos/operation/DeleteVideo" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="delete" class="sc-ikXwFM ecAtVr operation-type delete">del</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">Permanently delete a completed or failed video and its stored assets.</span></label></li><li data-item-id="tag/Videos/operation/RetrieveVideoContent" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="get" class="sc-ikXwFM ecAtVr operation-type get">get</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">Download the generated video bytes or a derived preview asset.
Streams the rendered video content for the specified video job.</span></label></li><li data-item-id="tag/Videos/operation/CreateVideoRemix" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="post" class="sc-ikXwFM ecAtVr operation-type post">post</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">Create a remix of a completed video using a refreshed prompt.</span></label></li></ul></li><li data-item-id="tag/Skills" class="sc-biJonm jycHIP"><label type="tag" role="menuitem" class="sc-eHEENL btqmKr -depth1"><span title="Skills" class="sc-hzUIXc ylzCN">Skills</span><svg class="sc-dIsUp dvcDrG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></label><ul class="sc-uxdHp kUEEAF"><li data-item-id="tag/Skills/operation/CreateSkill" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="post" class="sc-ikXwFM ecAtVr operation-type post">post</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">Create a new skill.</span></label></li><li data-item-id="tag/Skills/operation/ListSkills" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="get" class="sc-ikXwFM ecAtVr operation-type get">get</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">List all skills for the current project.</span></label></li><li data-item-id="tag/Skills/operation/DeleteSkill" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="delete" class="sc-ikXwFM ecAtVr operation-type delete">del</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">Delete a skill by its ID.</span></label></li><li data-item-id="tag/Skills/operation/GetSkill" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="get" class="sc-ikXwFM ecAtVr operation-type get">get</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">Get a skill by its ID.</span></label></li><li data-item-id="tag/Skills/operation/UpdateSkillDefaultVersion" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="post" class="sc-ikXwFM ecAtVr operation-type post">post</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">Update the default version pointer for a skill.</span></label></li><li data-item-id="tag/Skills/operation/GetSkillContent" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="get" class="sc-ikXwFM ecAtVr operation-type get">get</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">Download a skill zip bundle by its ID.</span></label></li><li data-item-id="tag/Skills/operation/CreateSkillVersion" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="post" class="sc-ikXwFM ecAtVr operation-type post">post</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">Create a new immutable skill version.</span></label></li><li data-item-id="tag/Skills/operation/ListSkillVersions" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="get" class="sc-ikXwFM ecAtVr operation-type get">get</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">List skill versions for a skill.</span></label></li><li data-item-id="tag/Skills/operation/GetSkillVersion" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="get" class="sc-ikXwFM ecAtVr operation-type get">get</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">Get a specific skill version.</span></label></li><li data-item-id="tag/Skills/operation/DeleteSkillVersion" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="delete" class="sc-ikXwFM ecAtVr operation-type delete">del</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">Delete a skill version.</span></label></li><li data-item-id="tag/Skills/operation/GetSkillVersionContent" class="sc-biJonm jycHIP"><label role="menuitem" class="sc-eHEENL dNhyuN -depth2"><span type="get" class="sc-ikXwFM ecAtVr operation-type get">get</span><span width="calc(100% - 38px)" class="sc-hzUIXc jYJtsM">Download a skill version zip bundle.</span></label></li></ul></li></ul><div class="sc-kYPZxB blYhnj"><a target="_blank" rel="noopener noreferrer" href="https://redocly.com/redoc/">API docs by Redocly</a></div></div></div><div class="sc-kTCsyW ceJzZm"><div class="sc-irKDMX eOSIAa"><svg class="" style="transform:translate(2px, -4px) rotate(180deg);transition:transform 0.2s ease" viewBox="0 0 926.23699 573.74994" version="1.1" x="0px" y="0px" width="15" height="15"><g transform="translate(904.92214,-879.1482)"><path d="
m -673.67664,1221.6502 -231.2455,-231.24803 55.6165,
-55.627 c 30.5891,-30.59485 56.1806,-55.627 56.8701,-55.627 0.6894,
0 79.8637,78.60862 175.9427,174.68583 l 174.6892,174.6858 174.6892,
-174.6858 c 96.079,-96.07721 175.253196,-174.68583 175.942696,
-174.68583 0.6895,0 26.281,25.03215 56.8701,
55.627 l 55.6165,55.627 -231.245496,231.24803 c -127.185,127.1864
-231.5279,231.248 -231.873,231.248 -0.3451,0 -104.688,
-104.0616 -231.873,-231.248 z
" fill="currentColor"></path></g></svg><svg class="" style="transform:translate(2px, 4px);transition:transform 0.2s ease" viewBox="0 0 926.23699 573.74994" version="1.1" x="0px" y="0px" width="15" height="15"><g transform="translate(904.92214,-879.1482)"><path d="
m -673.67664,1221.6502 -231.2455,-231.24803 55.6165,
-55.627 c 30.5891,-30.59485 56.1806,-55.627 56.8701,-55.627 0.6894,
0 79.8637,78.60862 175.9427,174.68583 l 174.6892,174.6858 174.6892,
-174.6858 c 96.079,-96.07721 175.253196,-174.68583 175.942696,
-174.68583 0.6895,0 26.281,25.03215 56.8701,
55.627 l 55.6165,55.627 -231.245496,231.24803 c -127.185,127.1864
-231.5279,231.248 -231.873,231.248 -0.3451,0 -104.688,
-104.0616 -231.873,-231.248 z
" fill="currentColor"></path></g></svg></div></div><div class="sc-jtiXyc kRuFuS api-content"><div class="sc-eCApnc jlMQbh"><div class="sc-iCoGMd gLxhOh"><div class="sc-hKFxyN juinod api-info"><h1 class="sc-fujyAs sc-dFRpbK bpZWeL fdKBSs">OpenAI API<!-- --> <span>(<!-- -->2.3.0<!-- -->)</span></h1><p>Download OpenAPI specification<!-- -->:<a download="openapi.json" target="_blank" class="sc-bsatvv gidAUi">Download</a></p><div class="sc-iJCRrE sc-ciSkZP jCdxGr QGruV"><div class="sc-euEtCV jOrOKn"><div class="sc-fHCHyC bpQNnD"> <span class="sc-gIvpjk dnRviY">URL: <a href="https://help.openai.com/">https://help.openai.com/</a></span> <span class="sc-gIvpjk dnRviY">License:<!-- --> <a href="https://github.com/openai/openai-openapi/blob/master/LICENSE">MIT</a></span> <span class="sc-gIvpjk dnRviY"><a href="https://openai.com/policies/terms-of-use">Terms of Service</a></span></div></div></div><div class="sc-iJCRrE sc-ciSkZP jCdxGr QGruV" data-role="redoc-summary"></div><div class="sc-iJCRrE sc-ciSkZP jCdxGr QGruV" data-role="redoc-description"><p>The OpenAI REST API. Please see <a href="https://platform.openai.com/docs/api-reference">https://platform.openai.com/docs/api-reference</a> for more details.</p>
</div></div></div></div><div id="tag/Assistants" data-section-id="tag/Assistants" class="sc-eCApnc jlMQbh"><div class="sc-iCoGMd gLxhOh"><div class="sc-hKFxyN juinod"><h1 class="sc-fujyAs bpZWeL"><a class="sc-crzoAE iUxAWq" href="#tag/Assistants" aria-label="tag/Assistants"></a>Assistants</h1></div></div><div class="sc-hKFxyN bJcDWV"><div class="sc-iJCRrE sc-ciSkZP jCdxGr QGruV redoc-markdown "><p>Build Assistants that can call models and use tools.</p>
</div></div></div><div id="tag/Assistants/operation/listAssistants" data-section-id="tag/Assistants/operation/listAssistants" class="sc-eCApnc liLqNm"><div data-section-id="operation/listAssistants" id="operation/listAssistants" class="sc-iCoGMd gLxhOh"><div class="sc-hKFxyN juinod"><h2 class="sc-pNWdM eftmgB"><a class="sc-crzoAE iUxAWq" href="#tag/Assistants/operation/listAssistants" aria-label="tag/Assistants/operation/listAssistants"></a>Returns a list of assistants.<!-- --> <span type="warning" class="sc-bqGGPW eSYQnm"> Deprecated </span></h2><div class="sc-fcmMJX cvfxAX"><div class="sc-jUfyBS bhDyou"><h5 class="sc-iqAclL sc-fuISkM eONCmm hZIgic">Authorizations:</h5><svg class="sc-dIsUp iPqByX" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jQAxuV ccffaZ"><span class="sc-daBunf fcvuS"><span class="sc-dsXzNU dPrSxx"><i>ApiKeyAuth</i></span></span></div></div><div><h5 class="sc-iqAclL eONCmm">query<!-- --> Parameters</h5><table class="sc-hHEiqL VCQHZ"><tbody><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="limit"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">limit</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">integer</span></div><div><span class="sc-laZMeE jWaWWE"> <!-- -->Default:<!-- --> </span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">20</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="order"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">order</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div><div><span class="sc-laZMeE jWaWWE"> <!-- -->Default:<!-- --> </span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"desc"</span></div><div><span class="sc-laZMeE jWaWWE"> <!-- -->Enum<!-- -->:</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"asc"</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"desc"</span> </div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>Sort order by the <code>created_at</code> timestamp of the objects. <code>asc</code> for ascending order and <code>desc</code> for descending order.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="after"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">after</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>A cursor for use in pagination. <code>after</code> is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list.</p>
</div></div></div></td></tr><tr class="last "><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="before"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">before</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>A cursor for use in pagination. <code>before</code> is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_foo, your subsequent call can include before=obj_foo in order to fetch the previous page of the list.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-fIxmyt DvFer">Responses</h3><div><button class="sc-htmcrh lbYftx"><svg class="sc-dIsUp dqYXmg" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-fWWYYk cMoEZ">200<!-- --> </strong><span class="sc-jcwpoC eDjFAZ"><p>OK</p>
</span></button></div></div></div><div class="sc-jSFjdj sc-gKAaRy gBjRyf gcushC"><div class="sc-EZqKI fWsqvQ"><button class="sc-eEVmNe ilvUMs"><span type="get" class="sc-fmdNqN ihNycv http-verb get">get</span><span class="sc-jXcxbT fCEUju">/assistants</span><svg class="sc-dIsUp bRmrKA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ljsmAU flIrdF"><div class="sc-jlZJtj fQkroN"><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div><div tabindex="0" role="button"><div class="sc-dTSzeu dfUAUz"><span>https://api.openai.com/v1</span>/assistants</div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Response samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-0" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-1" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-1" aria-labelledby="react-tabs-0"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-bBjRSN kQSIAz">application/json</div></div><div class="sc-jgPyTC dSaTNC"><div class="sc-jNnpgg esZIbL"><div class="sc-giAqHp hMPeqJ"><button><div class="sc-carFqZ UksDl">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iJCRrE jCdxGr sc-dPaNzc gyljjx"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"object"</span>: <span class="token string">"list"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"object"</span>: <span class="token string">"assistant"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"created_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"description"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"model"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"instructions"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"tools"</span>: <span class="token punctuation">[ ]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"tool_resources"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"code_interpreter"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"file_ids"</span>: <span class="token punctuation">[ ]</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"file_search"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"vector_store_ids"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><span class="token string">"string"</span></div></li></ul><span class="token punctuation">]</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"metadata"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"property1"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"property2"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"temperature"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"top_p"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"response_format"</span>: <span class="token string">"auto"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"first_id"</span>: <span class="token string">"asst_abc123"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"last_id"</span>: <span class="token string">"asst_abc456"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"has_more"</span>: <span class="token boolean">false</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Assistants/operation/createAssistant" data-section-id="tag/Assistants/operation/createAssistant" class="sc-eCApnc liLqNm"><div data-section-id="operation/createAssistant" id="operation/createAssistant" class="sc-iCoGMd gLxhOh"><div class="sc-hKFxyN juinod"><h2 class="sc-pNWdM eftmgB"><a class="sc-crzoAE iUxAWq" href="#tag/Assistants/operation/createAssistant" aria-label="tag/Assistants/operation/createAssistant"></a>Create an assistant with a model and instructions.<!-- --> <span type="warning" class="sc-bqGGPW eSYQnm"> Deprecated </span></h2><div class="sc-fcmMJX cvfxAX"><div class="sc-jUfyBS bhDyou"><h5 class="sc-iqAclL sc-fuISkM eONCmm hZIgic">Authorizations:</h5><svg class="sc-dIsUp iPqByX" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jQAxuV ccffaZ"><span class="sc-daBunf fcvuS"><span class="sc-dsXzNU dPrSxx"><i>ApiKeyAuth</i></span></span></div></div><h5 class="sc-iqAclL eONCmm">Request Body schema: <span class="sc-cBoqAE eKyrDP">application/json</span></h5><div class="sc-iJCRrE sc-ciSkZP jCdxGr QGruV"></div><table class="sc-hHEiqL VCQHZ"><tbody><tr class=""><td class="sc-hBMUJo sc-fFSPTT sc-gSYDnn iwcKgn cAqMTE hTttpy" kind="field" title="model"><span class="sc-iemWCZ bcnRwz"></span><button aria-label="expand properties"><span class="property-name">model</span><svg class="sc-dIsUp hGHhhO" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string or AssistantSupportedModels (string)</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>ID of the model to use. You can use the <a href="/docs/api-reference/models/list">List models</a> API to see all of your available models, or see our <a href="/docs/models">Model overview</a> for descriptions of them.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT sc-gSYDnn iwcKgn cAqMTE hTttpy" kind="field" title="name"><span class="sc-iemWCZ bcnRwz"></span><button aria-label="expand properties"><span class="property-name">name</span><svg class="sc-dIsUp hGHhhO" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string or null</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT sc-gSYDnn iwcKgn cAqMTE hTttpy" kind="field" title="description"><span class="sc-iemWCZ bcnRwz"></span><button aria-label="expand properties"><span class="property-name">description</span><svg class="sc-dIsUp hGHhhO" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string or null</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT sc-gSYDnn iwcKgn cAqMTE hTttpy" kind="field" title="instructions"><span class="sc-iemWCZ bcnRwz"></span><button aria-label="expand properties"><span class="property-name">instructions</span><svg class="sc-dIsUp hGHhhO" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string or null</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT sc-gSYDnn iwcKgn cAqMTE hTttpy" kind="field" title="reasoning_effort"><span class="sc-iemWCZ bcnRwz"></span><button aria-label="expand properties"><span class="property-name">reasoning_effort</span><svg class="sc-dIsUp hGHhhO" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">ReasoningEffort (string) or ReasoningEffort (null)</span><span class="sc-laZMeE sc-eJocfa jWaWWE bArHDh"> (<!-- -->ReasoningEffort<!-- -->) </span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT sc-gSYDnn iwcKgn cAqMTE hTttpy" kind="field" title="tools"><span class="sc-iemWCZ bcnRwz"></span><button aria-label="expand properties"><span class="property-name">tools</span><svg class="sc-dIsUp hGHhhO" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa">Array of </span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">Code interpreter tool (object) or FileSearch tool (object) or Function tool (object)</span><span> <span class="sc-laZMeE sc-FRrlG jWaWWE gHBwqe"> <!-- --><= 128 items<!-- --> </span></span></div><div><span class="sc-laZMeE jWaWWE"> <!-- -->Default:<!-- --> </span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">[]</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>A list of tool enabled on the assistant. There can be a maximum of 128 tools per assistant. Tools can be of types <code>code_interpreter</code>, <code>file_search</code>, or <code>function</code>.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT sc-gSYDnn iwcKgn cAqMTE hTttpy" kind="field" title="tool_resources"><span class="sc-iemWCZ bcnRwz"></span><button aria-label="expand properties"><span class="property-name">tool_resources</span><svg class="sc-dIsUp hGHhhO" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">object or null</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT sc-gSYDnn iwcKgn cAqMTE hTttpy" kind="field" title="metadata"><span class="sc-iemWCZ bcnRwz"></span><button aria-label="expand properties"><span class="property-name">metadata</span><svg class="sc-dIsUp hGHhhO" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">Metadata (object) or Metadata (null)</span><span class="sc-laZMeE sc-eJocfa jWaWWE bArHDh"> (<!-- -->Metadata<!-- -->) </span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT sc-gSYDnn iwcKgn cAqMTE hTttpy" kind="field" title="temperature"><span class="sc-iemWCZ bcnRwz"></span><button aria-label="expand properties"><span class="property-name">temperature</span><svg class="sc-dIsUp hGHhhO" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">number or null</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT sc-gSYDnn iwcKgn cAqMTE hTttpy" kind="field" title="top_p"><span class="sc-iemWCZ bcnRwz"></span><button aria-label="expand properties"><span class="property-name">top_p</span><svg class="sc-dIsUp hGHhhO" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">number or null</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div></div></div></td></tr><tr class="last "><td class="sc-hBMUJo sc-fFSPTT sc-gSYDnn iwcKgn cAqMTE hTttpy" kind="field" title="response_format"><span class="sc-iemWCZ bcnRwz"></span><button aria-label="expand properties"><span class="property-name">response_format</span><svg class="sc-dIsUp hGHhhO" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">(AssistantsApiResponseFormatOption (AssistantsApiResponseFormatOption (string) or Text (object) or JSON object (object) or JSON schema (object))) or null</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div></div></div></td></tr></tbody></table><div><h3 class="sc-fIxmyt DvFer">Responses</h3><div><button class="sc-htmcrh lbYftx"><svg class="sc-dIsUp dqYXmg" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-fWWYYk cMoEZ">200<!-- --> </strong><span class="sc-jcwpoC eDjFAZ"><p>OK</p>
</span></button></div></div></div><div class="sc-jSFjdj sc-gKAaRy gBjRyf gcushC"><div class="sc-EZqKI fWsqvQ"><button class="sc-eEVmNe ilvUMs"><span type="post" class="sc-fmdNqN ldMUmp http-verb post">post</span><span class="sc-jXcxbT fCEUju">/assistants</span><svg class="sc-dIsUp bRmrKA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ljsmAU flIrdF"><div class="sc-jlZJtj fQkroN"><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div><div tabindex="0" role="button"><div class="sc-dTSzeu dfUAUz"><span>https://api.openai.com/v1</span>/assistants</div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Request samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="react-tabs-2" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-3" tabindex="0" data-rttab="true">Payload</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-3" aria-labelledby="react-tabs-2"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-bBjRSN kQSIAz">application/json</div></div><div class="sc-jgPyTC dSaTNC"><div class="sc-jNnpgg esZIbL"><div class="sc-giAqHp hMPeqJ"><button><div class="sc-carFqZ UksDl">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iJCRrE jCdxGr sc-dPaNzc gyljjx"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"model"</span>: <span class="token string">"gpt-4o"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"description"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"instructions"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"reasoning_effort"</span>: <span class="token string">"none"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"tools"</span>: <span class="token punctuation">[ ]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"tool_resources"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"code_interpreter"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"file_ids"</span>: <span class="token punctuation">[ ]</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"file_search"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"vector_store_ids"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><span class="token string">"string"</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"vector_stores"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"file_ids"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><span class="token string">"string"</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"chunking_strategy"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <span class="token string">"auto"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"metadata"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"property1"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"property2"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"property1"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"property2"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"temperature"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"top_p"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"response_format"</span>: <span class="token string">"auto"</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Response samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-4" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-5" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-5" aria-labelledby="react-tabs-4"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-bBjRSN kQSIAz">application/json</div></div><div class="sc-jgPyTC dSaTNC"><div class="sc-jNnpgg esZIbL"><div class="sc-giAqHp hMPeqJ"><button><div class="sc-carFqZ UksDl">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iJCRrE jCdxGr sc-dPaNzc gyljjx"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"object"</span>: <span class="token string">"assistant"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"created_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"description"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"model"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"instructions"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"tools"</span>: <span class="token punctuation">[ ]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"tool_resources"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"code_interpreter"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"file_ids"</span>: <span class="token punctuation">[ ]</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"file_search"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"vector_store_ids"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><span class="token string">"string"</span></div></li></ul><span class="token punctuation">]</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"property1"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"property2"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"temperature"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"top_p"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"response_format"</span>: <span class="token string">"auto"</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Assistants/operation/getAssistant" data-section-id="tag/Assistants/operation/getAssistant" class="sc-eCApnc liLqNm"><div data-section-id="operation/getAssistant" id="operation/getAssistant" class="sc-iCoGMd gLxhOh"><div class="sc-hKFxyN juinod"><h2 class="sc-pNWdM eftmgB"><a class="sc-crzoAE iUxAWq" href="#tag/Assistants/operation/getAssistant" aria-label="tag/Assistants/operation/getAssistant"></a>Retrieves an assistant.<!-- --> <span type="warning" class="sc-bqGGPW eSYQnm"> Deprecated </span></h2><div class="sc-fcmMJX cvfxAX"><div class="sc-jUfyBS bhDyou"><h5 class="sc-iqAclL sc-fuISkM eONCmm hZIgic">Authorizations:</h5><svg class="sc-dIsUp iPqByX" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jQAxuV ccffaZ"><span class="sc-daBunf fcvuS"><span class="sc-dsXzNU dPrSxx"><i>ApiKeyAuth</i></span></span></div></div><div><h5 class="sc-iqAclL eONCmm">path<!-- --> Parameters</h5><table class="sc-hHEiqL VCQHZ"><tbody><tr class="last "><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="assistant_id"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">assistant_id</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The ID of the assistant to retrieve.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-fIxmyt DvFer">Responses</h3><div><button class="sc-htmcrh lbYftx"><svg class="sc-dIsUp dqYXmg" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-fWWYYk cMoEZ">200<!-- --> </strong><span class="sc-jcwpoC eDjFAZ"><p>OK</p>
</span></button></div></div></div><div class="sc-jSFjdj sc-gKAaRy gBjRyf gcushC"><div class="sc-EZqKI fWsqvQ"><button class="sc-eEVmNe ilvUMs"><span type="get" class="sc-fmdNqN ihNycv http-verb get">get</span><span class="sc-jXcxbT fCEUju">/assistants/{assistant_id}</span><svg class="sc-dIsUp bRmrKA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ljsmAU flIrdF"><div class="sc-jlZJtj fQkroN"><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div><div tabindex="0" role="button"><div class="sc-dTSzeu dfUAUz"><span>https://api.openai.com/v1</span>/assistants/{assistant_id}</div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Response samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-6" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-7" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-7" aria-labelledby="react-tabs-6"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-bBjRSN kQSIAz">application/json</div></div><div class="sc-jgPyTC dSaTNC"><div class="sc-jNnpgg esZIbL"><div class="sc-giAqHp hMPeqJ"><button><div class="sc-carFqZ UksDl">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iJCRrE jCdxGr sc-dPaNzc gyljjx"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"object"</span>: <span class="token string">"assistant"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"created_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"description"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"model"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"instructions"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"tools"</span>: <span class="token punctuation">[ ]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"tool_resources"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"code_interpreter"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"file_ids"</span>: <span class="token punctuation">[ ]</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"file_search"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"vector_store_ids"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><span class="token string">"string"</span></div></li></ul><span class="token punctuation">]</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"property1"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"property2"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"temperature"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"top_p"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"response_format"</span>: <span class="token string">"auto"</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Assistants/operation/modifyAssistant" data-section-id="tag/Assistants/operation/modifyAssistant" class="sc-eCApnc liLqNm"><div data-section-id="operation/modifyAssistant" id="operation/modifyAssistant" class="sc-iCoGMd gLxhOh"><div class="sc-hKFxyN juinod"><h2 class="sc-pNWdM eftmgB"><a class="sc-crzoAE iUxAWq" href="#tag/Assistants/operation/modifyAssistant" aria-label="tag/Assistants/operation/modifyAssistant"></a>Modifies an assistant.<!-- --> <span type="warning" class="sc-bqGGPW eSYQnm"> Deprecated </span></h2><div class="sc-fcmMJX cvfxAX"><div class="sc-jUfyBS bhDyou"><h5 class="sc-iqAclL sc-fuISkM eONCmm hZIgic">Authorizations:</h5><svg class="sc-dIsUp iPqByX" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jQAxuV ccffaZ"><span class="sc-daBunf fcvuS"><span class="sc-dsXzNU dPrSxx"><i>ApiKeyAuth</i></span></span></div></div><div><h5 class="sc-iqAclL eONCmm">path<!-- --> Parameters</h5><table class="sc-hHEiqL VCQHZ"><tbody><tr class="last "><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="assistant_id"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">assistant_id</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The ID of the assistant to modify.</p>
</div></div></div></td></tr></tbody></table></div><h5 class="sc-iqAclL eONCmm">Request Body schema: <span class="sc-cBoqAE eKyrDP">application/json</span></h5><div class="sc-iJCRrE sc-ciSkZP jCdxGr QGruV"></div><table class="sc-hHEiqL VCQHZ"><tbody><tr class=""><td class="sc-hBMUJo sc-fFSPTT sc-gSYDnn iwcKgn cAqMTE hTttpy" kind="field" title="model"><span class="sc-iemWCZ bcnRwz"></span><button aria-label="expand properties"><span class="property-name">model</span><svg class="sc-dIsUp hGHhhO" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string or AssistantSupportedModels (string)</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>ID of the model to use. You can use the <a href="/docs/api-reference/models/list">List models</a> API to see all of your available models, or see our <a href="/docs/models">Model overview</a> for descriptions of them.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT sc-gSYDnn iwcKgn cAqMTE hTttpy" kind="field" title="reasoning_effort"><span class="sc-iemWCZ bcnRwz"></span><button aria-label="expand properties"><span class="property-name">reasoning_effort</span><svg class="sc-dIsUp hGHhhO" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">ReasoningEffort (string) or ReasoningEffort (null)</span><span class="sc-laZMeE sc-eJocfa jWaWWE bArHDh"> (<!-- -->ReasoningEffort<!-- -->) </span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT sc-gSYDnn iwcKgn cAqMTE hTttpy" kind="field" title="name"><span class="sc-iemWCZ bcnRwz"></span><button aria-label="expand properties"><span class="property-name">name</span><svg class="sc-dIsUp hGHhhO" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string or null</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT sc-gSYDnn iwcKgn cAqMTE hTttpy" kind="field" title="description"><span class="sc-iemWCZ bcnRwz"></span><button aria-label="expand properties"><span class="property-name">description</span><svg class="sc-dIsUp hGHhhO" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string or null</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT sc-gSYDnn iwcKgn cAqMTE hTttpy" kind="field" title="instructions"><span class="sc-iemWCZ bcnRwz"></span><button aria-label="expand properties"><span class="property-name">instructions</span><svg class="sc-dIsUp hGHhhO" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string or null</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT sc-gSYDnn iwcKgn cAqMTE hTttpy" kind="field" title="tools"><span class="sc-iemWCZ bcnRwz"></span><button aria-label="expand properties"><span class="property-name">tools</span><svg class="sc-dIsUp hGHhhO" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa">Array of </span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">Code interpreter tool (object) or FileSearch tool (object) or Function tool (object)</span><span> <span class="sc-laZMeE sc-FRrlG jWaWWE gHBwqe"> <!-- --><= 128 items<!-- --> </span></span></div><div><span class="sc-laZMeE jWaWWE"> <!-- -->Default:<!-- --> </span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">[]</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>A list of tool enabled on the assistant. There can be a maximum of 128 tools per assistant. Tools can be of types <code>code_interpreter</code>, <code>file_search</code>, or <code>function</code>.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT sc-gSYDnn iwcKgn cAqMTE hTttpy" kind="field" title="tool_resources"><span class="sc-iemWCZ bcnRwz"></span><button aria-label="expand properties"><span class="property-name">tool_resources</span><svg class="sc-dIsUp hGHhhO" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">object or null</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT sc-gSYDnn iwcKgn cAqMTE hTttpy" kind="field" title="metadata"><span class="sc-iemWCZ bcnRwz"></span><button aria-label="expand properties"><span class="property-name">metadata</span><svg class="sc-dIsUp hGHhhO" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">Metadata (object) or Metadata (null)</span><span class="sc-laZMeE sc-eJocfa jWaWWE bArHDh"> (<!-- -->Metadata<!-- -->) </span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT sc-gSYDnn iwcKgn cAqMTE hTttpy" kind="field" title="temperature"><span class="sc-iemWCZ bcnRwz"></span><button aria-label="expand properties"><span class="property-name">temperature</span><svg class="sc-dIsUp hGHhhO" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">number or null</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT sc-gSYDnn iwcKgn cAqMTE hTttpy" kind="field" title="top_p"><span class="sc-iemWCZ bcnRwz"></span><button aria-label="expand properties"><span class="property-name">top_p</span><svg class="sc-dIsUp hGHhhO" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">number or null</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div></div></div></td></tr><tr class="last "><td class="sc-hBMUJo sc-fFSPTT sc-gSYDnn iwcKgn cAqMTE hTttpy" kind="field" title="response_format"><span class="sc-iemWCZ bcnRwz"></span><button aria-label="expand properties"><span class="property-name">response_format</span><svg class="sc-dIsUp hGHhhO" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">(AssistantsApiResponseFormatOption (AssistantsApiResponseFormatOption (string) or Text (object) or JSON object (object) or JSON schema (object))) or null</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div></div></div></td></tr></tbody></table><div><h3 class="sc-fIxmyt DvFer">Responses</h3><div><button class="sc-htmcrh lbYftx"><svg class="sc-dIsUp dqYXmg" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-fWWYYk cMoEZ">200<!-- --> </strong><span class="sc-jcwpoC eDjFAZ"><p>OK</p>
</span></button></div></div></div><div class="sc-jSFjdj sc-gKAaRy gBjRyf gcushC"><div class="sc-EZqKI fWsqvQ"><button class="sc-eEVmNe ilvUMs"><span type="post" class="sc-fmdNqN ldMUmp http-verb post">post</span><span class="sc-jXcxbT fCEUju">/assistants/{assistant_id}</span><svg class="sc-dIsUp bRmrKA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ljsmAU flIrdF"><div class="sc-jlZJtj fQkroN"><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div><div tabindex="0" role="button"><div class="sc-dTSzeu dfUAUz"><span>https://api.openai.com/v1</span>/assistants/{assistant_id}</div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Request samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="react-tabs-8" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-9" tabindex="0" data-rttab="true">Payload</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-9" aria-labelledby="react-tabs-8"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-bBjRSN kQSIAz">application/json</div></div><div class="sc-jgPyTC dSaTNC"><div class="sc-jNnpgg esZIbL"><div class="sc-giAqHp hMPeqJ"><button><div class="sc-carFqZ UksDl">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iJCRrE jCdxGr sc-dPaNzc gyljjx"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"model"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"reasoning_effort"</span>: <span class="token string">"none"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"description"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"instructions"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"tools"</span>: <span class="token punctuation">[ ]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"tool_resources"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"code_interpreter"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"file_ids"</span>: <span class="token punctuation">[ ]</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"file_search"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"vector_store_ids"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><span class="token string">"string"</span></div></li></ul><span class="token punctuation">]</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"property1"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"property2"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"temperature"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"top_p"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"response_format"</span>: <span class="token string">"auto"</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Response samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-10" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-11" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-11" aria-labelledby="react-tabs-10"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-bBjRSN kQSIAz">application/json</div></div><div class="sc-jgPyTC dSaTNC"><div class="sc-jNnpgg esZIbL"><div class="sc-giAqHp hMPeqJ"><button><div class="sc-carFqZ UksDl">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iJCRrE jCdxGr sc-dPaNzc gyljjx"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"object"</span>: <span class="token string">"assistant"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"created_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"description"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"model"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"instructions"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"tools"</span>: <span class="token punctuation">[ ]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"tool_resources"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"code_interpreter"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"file_ids"</span>: <span class="token punctuation">[ ]</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"file_search"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"vector_store_ids"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><span class="token string">"string"</span></div></li></ul><span class="token punctuation">]</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"property1"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"property2"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"temperature"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"top_p"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"response_format"</span>: <span class="token string">"auto"</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Assistants/operation/deleteAssistant" data-section-id="tag/Assistants/operation/deleteAssistant" class="sc-eCApnc liLqNm"><div data-section-id="operation/deleteAssistant" id="operation/deleteAssistant" class="sc-iCoGMd gLxhOh"><div class="sc-hKFxyN juinod"><h2 class="sc-pNWdM eftmgB"><a class="sc-crzoAE iUxAWq" href="#tag/Assistants/operation/deleteAssistant" aria-label="tag/Assistants/operation/deleteAssistant"></a>Delete an assistant.<!-- --> <span type="warning" class="sc-bqGGPW eSYQnm"> Deprecated </span></h2><div class="sc-fcmMJX cvfxAX"><div class="sc-jUfyBS bhDyou"><h5 class="sc-iqAclL sc-fuISkM eONCmm hZIgic">Authorizations:</h5><svg class="sc-dIsUp iPqByX" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jQAxuV ccffaZ"><span class="sc-daBunf fcvuS"><span class="sc-dsXzNU dPrSxx"><i>ApiKeyAuth</i></span></span></div></div><div><h5 class="sc-iqAclL eONCmm">path<!-- --> Parameters</h5><table class="sc-hHEiqL VCQHZ"><tbody><tr class="last "><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="assistant_id"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">assistant_id</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The ID of the assistant to delete.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-fIxmyt DvFer">Responses</h3><div><button class="sc-htmcrh lbYftx"><svg class="sc-dIsUp dqYXmg" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-fWWYYk cMoEZ">200<!-- --> </strong><span class="sc-jcwpoC eDjFAZ"><p>OK</p>
</span></button></div></div></div><div class="sc-jSFjdj sc-gKAaRy gBjRyf gcushC"><div class="sc-EZqKI fWsqvQ"><button class="sc-eEVmNe ilvUMs"><span type="delete" class="sc-fmdNqN bJzUtf http-verb delete">delete</span><span class="sc-jXcxbT fCEUju">/assistants/{assistant_id}</span><svg class="sc-dIsUp bRmrKA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ljsmAU flIrdF"><div class="sc-jlZJtj fQkroN"><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div><div tabindex="0" role="button"><div class="sc-dTSzeu dfUAUz"><span>https://api.openai.com/v1</span>/assistants/{assistant_id}</div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Response samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-12" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-13" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-13" aria-labelledby="react-tabs-12"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-bBjRSN kQSIAz">application/json</div></div><div class="sc-jgPyTC dSaTNC"><div class="sc-jNnpgg esZIbL"><div class="sc-giAqHp hMPeqJ"><button><div class="sc-carFqZ UksDl">Copy</div></button></div><div class="sc-iJCRrE jCdxGr sc-dPaNzc gyljjx"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"deleted"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"object"</span>: <span class="token string">"assistant.deleted"</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Assistants/operation/createThread" data-section-id="tag/Assistants/operation/createThread" class="sc-eCApnc liLqNm"><div data-section-id="operation/createThread" id="operation/createThread" class="sc-iCoGMd gLxhOh"><div class="sc-hKFxyN juinod"><h2 class="sc-pNWdM eftmgB"><a class="sc-crzoAE iUxAWq" href="#tag/Assistants/operation/createThread" aria-label="tag/Assistants/operation/createThread"></a>Create a thread.<!-- --> </h2><div class="sc-fcmMJX cvfxAX"><div class="sc-jUfyBS bhDyou"><h5 class="sc-iqAclL sc-fuISkM eONCmm hZIgic">Authorizations:</h5><svg class="sc-dIsUp iPqByX" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jQAxuV ccffaZ"><span class="sc-daBunf fcvuS"><span class="sc-dsXzNU dPrSxx"><i>ApiKeyAuth</i></span></span></div></div><h5 class="sc-iqAclL eONCmm">Request Body schema: <span class="sc-cBoqAE eKyrDP">application/json</span></h5><div class="sc-iJCRrE sc-ciSkZP jCdxGr QGruV"></div><table class="sc-hHEiqL VCQHZ"><tbody><tr class=""><td class="sc-hBMUJo sc-fFSPTT sc-gSYDnn iwcKgn cAqMTE hTttpy" kind="field" title="messages"><span class="sc-iemWCZ bcnRwz"></span><button aria-label="expand properties"><span class="property-name">messages</span><svg class="sc-dIsUp hGHhhO" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa">Array of </span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">objects</span><span class="sc-laZMeE sc-eJocfa jWaWWE bArHDh"> (<!-- -->CreateMessageRequest<!-- -->) </span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>A list of <a href="/docs/api-reference/messages">messages</a> to start the thread with.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT sc-gSYDnn iwcKgn cAqMTE hTttpy" kind="field" title="tool_resources"><span class="sc-iemWCZ bcnRwz"></span><button aria-label="expand properties"><span class="property-name">tool_resources</span><svg class="sc-dIsUp hGHhhO" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">object or null</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div></div></div></td></tr><tr class="last "><td class="sc-hBMUJo sc-fFSPTT sc-gSYDnn iwcKgn cAqMTE hTttpy" kind="field" title="metadata"><span class="sc-iemWCZ bcnRwz"></span><button aria-label="expand properties"><span class="property-name">metadata</span><svg class="sc-dIsUp hGHhhO" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">Metadata (object) or Metadata (null)</span><span class="sc-laZMeE sc-eJocfa jWaWWE bArHDh"> (<!-- -->Metadata<!-- -->) </span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div></div></div></td></tr></tbody></table><div><h3 class="sc-fIxmyt DvFer">Responses</h3><div><button class="sc-htmcrh lbYftx"><svg class="sc-dIsUp dqYXmg" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-fWWYYk cMoEZ">200<!-- --> </strong><span class="sc-jcwpoC eDjFAZ"><p>OK</p>
</span></button></div></div></div><div class="sc-jSFjdj sc-gKAaRy gBjRyf gcushC"><div class="sc-EZqKI fWsqvQ"><button class="sc-eEVmNe ilvUMs"><span type="post" class="sc-fmdNqN ldMUmp http-verb post">post</span><span class="sc-jXcxbT fCEUju">/threads</span><svg class="sc-dIsUp bRmrKA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ljsmAU flIrdF"><div class="sc-jlZJtj fQkroN"><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div><div tabindex="0" role="button"><div class="sc-dTSzeu dfUAUz"><span>https://api.openai.com/v1</span>/threads</div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Request samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="react-tabs-14" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-15" tabindex="0" data-rttab="true">Payload</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-15" aria-labelledby="react-tabs-14"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-bBjRSN kQSIAz">application/json</div></div><div class="sc-jgPyTC dSaTNC"><div class="sc-jNnpgg esZIbL"><div class="sc-giAqHp hMPeqJ"><button><div class="sc-carFqZ UksDl">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iJCRrE jCdxGr sc-dPaNzc gyljjx"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"messages"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"role"</span>: <span class="token string">"user"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"content"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"attachments"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"file_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"tools"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <span class="token string">"code_interpreter"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"metadata"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"property1"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"property2"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"tool_resources"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"code_interpreter"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"file_ids"</span>: <span class="token punctuation">[ ]</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"file_search"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"vector_store_ids"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><span class="token string">"string"</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"vector_stores"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"file_ids"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><span class="token string">"string"</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"chunking_strategy"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <span class="token string">"auto"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"metadata"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"property1"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"property2"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"property1"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"property2"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Response samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-16" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-17" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-17" aria-labelledby="react-tabs-16"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-bBjRSN kQSIAz">application/json</div></div><div class="sc-jgPyTC dSaTNC"><div class="sc-jNnpgg esZIbL"><div class="sc-giAqHp hMPeqJ"><button><div class="sc-carFqZ UksDl">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iJCRrE jCdxGr sc-dPaNzc gyljjx"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"object"</span>: <span class="token string">"thread"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"created_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"tool_resources"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"code_interpreter"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"file_ids"</span>: <span class="token punctuation">[ ]</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"file_search"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"vector_store_ids"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><span class="token string">"string"</span></div></li></ul><span class="token punctuation">]</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"property1"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"property2"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Assistants/operation/createThreadAndRun" data-section-id="tag/Assistants/operation/createThreadAndRun" class="sc-eCApnc liLqNm"><div data-section-id="operation/createThreadAndRun" id="operation/createThreadAndRun" class="sc-iCoGMd gLxhOh"><div class="sc-hKFxyN juinod"><h2 class="sc-pNWdM eftmgB"><a class="sc-crzoAE iUxAWq" href="#tag/Assistants/operation/createThreadAndRun" aria-label="tag/Assistants/operation/createThreadAndRun"></a>Create a thread and run it in one request.<!-- --> </h2><div class="sc-fcmMJX cvfxAX"><div class="sc-jUfyBS bhDyou"><h5 class="sc-iqAclL sc-fuISkM eONCmm hZIgic">Authorizations:</h5><svg class="sc-dIsUp iPqByX" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jQAxuV ccffaZ"><span class="sc-daBunf fcvuS"><span class="sc-dsXzNU dPrSxx"><i>ApiKeyAuth</i></span></span></div></div><h5 class="sc-iqAclL eONCmm">Request Body schema: <span class="sc-cBoqAE eKyrDP">application/json</span></h5><div class="sc-iJCRrE sc-ciSkZP jCdxGr QGruV"></div><table class="sc-hHEiqL VCQHZ"><tbody><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="assistant_id"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">assistant_id</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The ID of the <a href="/docs/api-reference/assistants">assistant</a> to use to execute this run.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT sc-gSYDnn iwcKgn cAqMTE hTttpy" kind="field" title="thread"><span class="sc-iemWCZ bcnRwz"></span><button aria-label="expand properties"><span class="property-name">thread</span><svg class="sc-dIsUp hGHhhO" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">object</span><span class="sc-laZMeE sc-eJocfa jWaWWE bArHDh"> (<!-- -->CreateThreadRequest<!-- -->) </span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>Options to create a new thread. If no thread is provided when running a
request, an empty thread will be created.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT sc-gSYDnn iwcKgn cAqMTE hTttpy" kind="field" title="model"><span class="sc-iemWCZ bcnRwz"></span><button aria-label="expand properties"><span class="property-name">model</span><svg class="sc-dIsUp hGHhhO" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">(string or null) or (string or null)</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The ID of the <a href="/docs/api-reference/models">Model</a> to be used to execute this run. If a value is provided here, it will override the model associated with the assistant. If not, the model associated with the assistant will be used.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="instructions"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">instructions</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string or null</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>Override the default system message of the assistant. This is useful for modifying the behavior on a per-run basis.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT sc-gSYDnn iwcKgn cAqMTE hTttpy" kind="field" title="tools"><span class="sc-iemWCZ bcnRwz"></span><button aria-label="expand properties"><span class="property-name">tools</span><svg class="sc-dIsUp hGHhhO" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa">Array of </span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">Code interpreter tool (object) or FileSearch tool (object) or Function tool (object) or null</span><span> <span class="sc-laZMeE sc-FRrlG jWaWWE gHBwqe"> <!-- --><= 20 items<!-- --> </span></span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>Override the tools the assistant can use for this run. This is useful for modifying the behavior on a per-run basis.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT sc-gSYDnn iwcKgn cAqMTE hTttpy" kind="field" title="tool_resources"><span class="sc-iemWCZ bcnRwz"></span><button aria-label="expand properties"><span class="property-name">tool_resources</span><svg class="sc-dIsUp hGHhhO" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">object or null</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>A set of resources that are used by the assistant's tools. The resources are specific to the type of tool. For example, the <code>code_interpreter</code> tool requires a list of file IDs, while the <code>file_search</code> tool requires a list of vector store IDs.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT sc-gSYDnn iwcKgn cAqMTE hTttpy" kind="field" title="metadata"><span class="sc-iemWCZ bcnRwz"></span><button aria-label="expand properties"><span class="property-name">metadata</span><svg class="sc-dIsUp hGHhhO" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">Metadata (object) or Metadata (null)</span><span class="sc-laZMeE sc-eJocfa jWaWWE bArHDh"> (<!-- -->Metadata<!-- -->) </span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="temperature"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">temperature</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">number or null</span><span> <span class="sc-laZMeE sc-FRrlG jWaWWE gHBwqe"> <!-- -->[ 0 .. 2 ]<!-- --> </span></span></div><div><span class="sc-laZMeE jWaWWE"> <!-- -->Default:<!-- --> </span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">1</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>What sampling temperature to use, between 0 and 2. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="top_p"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">top_p</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">number or null</span><span> <span class="sc-laZMeE sc-FRrlG jWaWWE gHBwqe"> <!-- -->[ 0 .. 1 ]<!-- --> </span></span></div><div><span class="sc-laZMeE jWaWWE"> <!-- -->Default:<!-- --> </span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">1</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>An alternative to sampling with temperature, called nucleus sampling, where the model considers the results of the tokens with top_p probability mass. So 0.1 means only the tokens comprising the top 10% probability mass are considered.</p>
<p>We generally recommend altering this or temperature but not both.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="stream"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">stream</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">boolean or null</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>If <code>true</code>, returns a stream of events that happen during the Run as server-sent events, terminating when the Run enters a terminal state with a <code>data: [DONE]</code> message.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="max_prompt_tokens"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">max_prompt_tokens</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">integer or null</span><span> <span class="sc-laZMeE sc-FRrlG jWaWWE gHBwqe"> <!-- -->>= 256<!-- --> </span></span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The maximum number of prompt tokens that may be used over the course of the run. The run will make a best effort to use only the number of prompt tokens specified, across multiple turns of the run. If the run exceeds the number of prompt tokens specified, the run will end with status <code>incomplete</code>. See <code>incomplete_details</code> for more info.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="max_completion_tokens"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">max_completion_tokens</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">integer or null</span><span> <span class="sc-laZMeE sc-FRrlG jWaWWE gHBwqe"> <!-- -->>= 256<!-- --> </span></span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The maximum number of completion tokens that may be used over the course of the run. The run will make a best effort to use only the number of completion tokens specified, across multiple turns of the run. If the run exceeds the number of completion tokens specified, the run will end with status <code>incomplete</code>. See <code>incomplete_details</code> for more info.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT sc-gSYDnn iwcKgn cAqMTE hTttpy" kind="field" title="truncation_strategy"><span class="sc-iemWCZ bcnRwz"></span><button aria-label="expand properties"><span class="property-name">truncation_strategy</span><svg class="sc-dIsUp hGHhhO" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">object or null</span><span class="sc-laZMeE sc-eJocfa jWaWWE bArHDh"> (<!-- -->Thread Truncation Controls<!-- -->) </span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>Controls for how a thread will be truncated prior to the run. Use this to control the initial context window of the run.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT sc-gSYDnn iwcKgn cAqMTE hTttpy" kind="field" title="tool_choice"><span class="sc-iemWCZ bcnRwz"></span><button aria-label="expand properties"><span class="property-name">tool_choice</span><svg class="sc-dIsUp hGHhhO" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">(string or null) or (AssistantsNamedToolChoice (object or null))</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>Controls which (if any) tool is called by the model.
<code>none</code> means the model will not call any tools and instead generates a message.
<code>auto</code> is the default value and means the model can pick between generating a message or calling one or more tools.
<code>required</code> means the model must call one or more tools before responding to the user.
Specifying a particular tool like <code>{"type": "file_search"}</code> or <code>{"type": "function", "function": {"name": "my_function"}}</code> forces the model to call that tool.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="parallel_tool_calls"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">parallel_tool_calls</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">boolean</span><span class="sc-laZMeE sc-eJocfa jWaWWE bArHDh"> (<!-- -->ParallelToolCalls<!-- -->) </span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>Whether to enable <a href="/docs/guides/function-calling#configuring-parallel-function-calling">parallel function calling</a> during tool use.</p>
</div></div></div></td></tr><tr class="last "><td class="sc-hBMUJo sc-fFSPTT sc-gSYDnn iwcKgn cAqMTE hTttpy" kind="field" title="response_format"><span class="sc-iemWCZ bcnRwz"></span><button aria-label="expand properties"><span class="property-name">response_format</span><svg class="sc-dIsUp hGHhhO" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">(string or null) or (Text (object or null)) or (JSON object (object or null)) or (JSON schema (object or null))</span><span class="sc-laZMeE sc-eJocfa jWaWWE bArHDh"> (<!-- -->AssistantsApiResponseFormatOption<!-- -->) </span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div></div></div></td></tr></tbody></table><div><h3 class="sc-fIxmyt DvFer">Responses</h3><div><button class="sc-htmcrh lbYftx"><svg class="sc-dIsUp dqYXmg" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-fWWYYk cMoEZ">200<!-- --> </strong><span class="sc-jcwpoC eDjFAZ"><p>OK</p>
</span></button></div></div></div><div class="sc-jSFjdj sc-gKAaRy gBjRyf gcushC"><div class="sc-EZqKI fWsqvQ"><button class="sc-eEVmNe ilvUMs"><span type="post" class="sc-fmdNqN ldMUmp http-verb post">post</span><span class="sc-jXcxbT fCEUju">/threads/runs</span><svg class="sc-dIsUp bRmrKA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ljsmAU flIrdF"><div class="sc-jlZJtj fQkroN"><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div><div tabindex="0" role="button"><div class="sc-dTSzeu dfUAUz"><span>https://api.openai.com/v1</span>/threads/runs</div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Request samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="react-tabs-18" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-19" tabindex="0" data-rttab="true">Payload</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-19" aria-labelledby="react-tabs-18"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-bBjRSN kQSIAz">application/json</div></div><div class="sc-jgPyTC dSaTNC"><div class="sc-jNnpgg esZIbL"><div class="sc-giAqHp hMPeqJ"><button><div class="sc-carFqZ UksDl">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iJCRrE jCdxGr sc-dPaNzc gyljjx"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"assistant_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"thread"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"messages"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"role"</span>: <span class="token string">"user"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"content"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"attachments"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"file_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"tools"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <span class="token string">"code_interpreter"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"metadata"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"property1"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"property2"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"tool_resources"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"code_interpreter"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"file_ids"</span>: <span class="token punctuation">[ ]</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"file_search"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"vector_store_ids"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><span class="token string">"string"</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"vector_stores"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"file_ids"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><span class="token string">"string"</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"chunking_strategy"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <span class="token string">"auto"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"metadata"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"property1"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"property2"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"metadata"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"property1"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"property2"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"model"</span>: <span class="token string">"gpt-4o"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"instructions"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"tools"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <span class="token string">"code_interpreter"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"tool_resources"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"code_interpreter"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"file_ids"</span>: <span class="token punctuation">[ ]</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"file_search"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"vector_store_ids"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><span class="token string">"string"</span></div></li></ul><span class="token punctuation">]</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"property1"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"property2"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"temperature"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"top_p"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"stream"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"max_prompt_tokens"</span>: <span class="token number">256</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"max_completion_tokens"</span>: <span class="token number">256</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"truncation_strategy"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <span class="token string">"auto"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"last_messages"</span>: <span class="token number">1</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"tool_choice"</span>: <span class="token string">"none"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"parallel_tool_calls"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"response_format"</span>: <span class="token string">"auto"</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Response samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-20" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-21" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-21" aria-labelledby="react-tabs-20"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-bBjRSN kQSIAz">application/json</div></div><div class="sc-jgPyTC dSaTNC"><div class="sc-jNnpgg esZIbL"><div class="sc-giAqHp hMPeqJ"><button><div class="sc-carFqZ UksDl">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iJCRrE jCdxGr sc-dPaNzc gyljjx"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"object"</span>: <span class="token string">"thread.run"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"created_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"thread_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"assistant_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token string">"queued"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"required_action"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <span class="token string">"submit_tool_outputs"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"submit_tool_outputs"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"tool_calls"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <span class="token string">"function"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"function"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"arguments"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"last_error"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"code"</span>: <span class="token string">"server_error"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"message"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"expires_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"started_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"cancelled_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"failed_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"completed_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"incomplete_details"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"reason"</span>: <span class="token string">"max_completion_tokens"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"model"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"instructions"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"tools"</span>: <span class="token punctuation">[ ]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"property1"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"property2"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"usage"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"completion_tokens"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"prompt_tokens"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"total_tokens"</span>: <span class="token number">0</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"temperature"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"top_p"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"max_prompt_tokens"</span>: <span class="token number">256</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"max_completion_tokens"</span>: <span class="token number">256</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"truncation_strategy"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <span class="token string">"auto"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"last_messages"</span>: <span class="token number">1</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"tool_choice"</span>: <span class="token string">"none"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"parallel_tool_calls"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"response_format"</span>: <span class="token string">"auto"</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Assistants/operation/getThread" data-section-id="tag/Assistants/operation/getThread" class="sc-eCApnc liLqNm"><div data-section-id="operation/getThread" id="operation/getThread" class="sc-iCoGMd gLxhOh"><div class="sc-hKFxyN juinod"><h2 class="sc-pNWdM eftmgB"><a class="sc-crzoAE iUxAWq" href="#tag/Assistants/operation/getThread" aria-label="tag/Assistants/operation/getThread"></a>Retrieves a thread.<!-- --> </h2><div class="sc-fcmMJX cvfxAX"><div class="sc-jUfyBS bhDyou"><h5 class="sc-iqAclL sc-fuISkM eONCmm hZIgic">Authorizations:</h5><svg class="sc-dIsUp iPqByX" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jQAxuV ccffaZ"><span class="sc-daBunf fcvuS"><span class="sc-dsXzNU dPrSxx"><i>ApiKeyAuth</i></span></span></div></div><div><h5 class="sc-iqAclL eONCmm">path<!-- --> Parameters</h5><table class="sc-hHEiqL VCQHZ"><tbody><tr class="last "><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="thread_id"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">thread_id</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The ID of the thread to retrieve.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-fIxmyt DvFer">Responses</h3><div><button class="sc-htmcrh lbYftx"><svg class="sc-dIsUp dqYXmg" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-fWWYYk cMoEZ">200<!-- --> </strong><span class="sc-jcwpoC eDjFAZ"><p>OK</p>
</span></button></div></div></div><div class="sc-jSFjdj sc-gKAaRy gBjRyf gcushC"><div class="sc-EZqKI fWsqvQ"><button class="sc-eEVmNe ilvUMs"><span type="get" class="sc-fmdNqN ihNycv http-verb get">get</span><span class="sc-jXcxbT fCEUju">/threads/{thread_id}</span><svg class="sc-dIsUp bRmrKA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ljsmAU flIrdF"><div class="sc-jlZJtj fQkroN"><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div><div tabindex="0" role="button"><div class="sc-dTSzeu dfUAUz"><span>https://api.openai.com/v1</span>/threads/{thread_id}</div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Response samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-22" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-23" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-23" aria-labelledby="react-tabs-22"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-bBjRSN kQSIAz">application/json</div></div><div class="sc-jgPyTC dSaTNC"><div class="sc-jNnpgg esZIbL"><div class="sc-giAqHp hMPeqJ"><button><div class="sc-carFqZ UksDl">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iJCRrE jCdxGr sc-dPaNzc gyljjx"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"object"</span>: <span class="token string">"thread"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"created_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"tool_resources"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"code_interpreter"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"file_ids"</span>: <span class="token punctuation">[ ]</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"file_search"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"vector_store_ids"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><span class="token string">"string"</span></div></li></ul><span class="token punctuation">]</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"property1"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"property2"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Assistants/operation/modifyThread" data-section-id="tag/Assistants/operation/modifyThread" class="sc-eCApnc liLqNm"><div data-section-id="operation/modifyThread" id="operation/modifyThread" class="sc-iCoGMd gLxhOh"><div class="sc-hKFxyN juinod"><h2 class="sc-pNWdM eftmgB"><a class="sc-crzoAE iUxAWq" href="#tag/Assistants/operation/modifyThread" aria-label="tag/Assistants/operation/modifyThread"></a>Modifies a thread.<!-- --> </h2><div class="sc-fcmMJX cvfxAX"><div class="sc-jUfyBS bhDyou"><h5 class="sc-iqAclL sc-fuISkM eONCmm hZIgic">Authorizations:</h5><svg class="sc-dIsUp iPqByX" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jQAxuV ccffaZ"><span class="sc-daBunf fcvuS"><span class="sc-dsXzNU dPrSxx"><i>ApiKeyAuth</i></span></span></div></div><div><h5 class="sc-iqAclL eONCmm">path<!-- --> Parameters</h5><table class="sc-hHEiqL VCQHZ"><tbody><tr class="last "><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="thread_id"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">thread_id</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The ID of the thread to modify. Only the <code>metadata</code> can be modified.</p>
</div></div></div></td></tr></tbody></table></div><h5 class="sc-iqAclL eONCmm">Request Body schema: <span class="sc-cBoqAE eKyrDP">application/json</span></h5><div class="sc-iJCRrE sc-ciSkZP jCdxGr QGruV"></div><table class="sc-hHEiqL VCQHZ"><tbody><tr class=""><td class="sc-hBMUJo sc-fFSPTT sc-gSYDnn iwcKgn cAqMTE hTttpy" kind="field" title="tool_resources"><span class="sc-iemWCZ bcnRwz"></span><button aria-label="expand properties"><span class="property-name">tool_resources</span><svg class="sc-dIsUp hGHhhO" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">object or null</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div></div></div></td></tr><tr class="last "><td class="sc-hBMUJo sc-fFSPTT sc-gSYDnn iwcKgn cAqMTE hTttpy" kind="field" title="metadata"><span class="sc-iemWCZ bcnRwz"></span><button aria-label="expand properties"><span class="property-name">metadata</span><svg class="sc-dIsUp hGHhhO" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">Metadata (object) or Metadata (null)</span><span class="sc-laZMeE sc-eJocfa jWaWWE bArHDh"> (<!-- -->Metadata<!-- -->) </span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div></div></div></td></tr></tbody></table><div><h3 class="sc-fIxmyt DvFer">Responses</h3><div><button class="sc-htmcrh lbYftx"><svg class="sc-dIsUp dqYXmg" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-fWWYYk cMoEZ">200<!-- --> </strong><span class="sc-jcwpoC eDjFAZ"><p>OK</p>
</span></button></div></div></div><div class="sc-jSFjdj sc-gKAaRy gBjRyf gcushC"><div class="sc-EZqKI fWsqvQ"><button class="sc-eEVmNe ilvUMs"><span type="post" class="sc-fmdNqN ldMUmp http-verb post">post</span><span class="sc-jXcxbT fCEUju">/threads/{thread_id}</span><svg class="sc-dIsUp bRmrKA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ljsmAU flIrdF"><div class="sc-jlZJtj fQkroN"><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div><div tabindex="0" role="button"><div class="sc-dTSzeu dfUAUz"><span>https://api.openai.com/v1</span>/threads/{thread_id}</div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Request samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="react-tabs-24" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-25" tabindex="0" data-rttab="true">Payload</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-25" aria-labelledby="react-tabs-24"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-bBjRSN kQSIAz">application/json</div></div><div class="sc-jgPyTC dSaTNC"><div class="sc-jNnpgg esZIbL"><div class="sc-giAqHp hMPeqJ"><button><div class="sc-carFqZ UksDl">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iJCRrE jCdxGr sc-dPaNzc gyljjx"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"tool_resources"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"code_interpreter"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"file_ids"</span>: <span class="token punctuation">[ ]</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"file_search"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"vector_store_ids"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><span class="token string">"string"</span></div></li></ul><span class="token punctuation">]</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"property1"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"property2"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Response samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-26" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-27" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-27" aria-labelledby="react-tabs-26"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-bBjRSN kQSIAz">application/json</div></div><div class="sc-jgPyTC dSaTNC"><div class="sc-jNnpgg esZIbL"><div class="sc-giAqHp hMPeqJ"><button><div class="sc-carFqZ UksDl">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iJCRrE jCdxGr sc-dPaNzc gyljjx"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"object"</span>: <span class="token string">"thread"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"created_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"tool_resources"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"code_interpreter"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"file_ids"</span>: <span class="token punctuation">[ ]</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"file_search"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"vector_store_ids"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><span class="token string">"string"</span></div></li></ul><span class="token punctuation">]</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"property1"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"property2"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Assistants/operation/deleteThread" data-section-id="tag/Assistants/operation/deleteThread" class="sc-eCApnc liLqNm"><div data-section-id="operation/deleteThread" id="operation/deleteThread" class="sc-iCoGMd gLxhOh"><div class="sc-hKFxyN juinod"><h2 class="sc-pNWdM eftmgB"><a class="sc-crzoAE iUxAWq" href="#tag/Assistants/operation/deleteThread" aria-label="tag/Assistants/operation/deleteThread"></a>Delete a thread.<!-- --> </h2><div class="sc-fcmMJX cvfxAX"><div class="sc-jUfyBS bhDyou"><h5 class="sc-iqAclL sc-fuISkM eONCmm hZIgic">Authorizations:</h5><svg class="sc-dIsUp iPqByX" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jQAxuV ccffaZ"><span class="sc-daBunf fcvuS"><span class="sc-dsXzNU dPrSxx"><i>ApiKeyAuth</i></span></span></div></div><div><h5 class="sc-iqAclL eONCmm">path<!-- --> Parameters</h5><table class="sc-hHEiqL VCQHZ"><tbody><tr class="last "><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="thread_id"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">thread_id</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The ID of the thread to delete.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-fIxmyt DvFer">Responses</h3><div><button class="sc-htmcrh lbYftx"><svg class="sc-dIsUp dqYXmg" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-fWWYYk cMoEZ">200<!-- --> </strong><span class="sc-jcwpoC eDjFAZ"><p>OK</p>
</span></button></div></div></div><div class="sc-jSFjdj sc-gKAaRy gBjRyf gcushC"><div class="sc-EZqKI fWsqvQ"><button class="sc-eEVmNe ilvUMs"><span type="delete" class="sc-fmdNqN bJzUtf http-verb delete">delete</span><span class="sc-jXcxbT fCEUju">/threads/{thread_id}</span><svg class="sc-dIsUp bRmrKA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ljsmAU flIrdF"><div class="sc-jlZJtj fQkroN"><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div><div tabindex="0" role="button"><div class="sc-dTSzeu dfUAUz"><span>https://api.openai.com/v1</span>/threads/{thread_id}</div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Response samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-28" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-29" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-29" aria-labelledby="react-tabs-28"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-bBjRSN kQSIAz">application/json</div></div><div class="sc-jgPyTC dSaTNC"><div class="sc-jNnpgg esZIbL"><div class="sc-giAqHp hMPeqJ"><button><div class="sc-carFqZ UksDl">Copy</div></button></div><div class="sc-iJCRrE jCdxGr sc-dPaNzc gyljjx"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"deleted"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"object"</span>: <span class="token string">"thread.deleted"</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Assistants/operation/listMessages" data-section-id="tag/Assistants/operation/listMessages" class="sc-eCApnc liLqNm"><div data-section-id="operation/listMessages" id="operation/listMessages" class="sc-iCoGMd gLxhOh"><div class="sc-hKFxyN juinod"><h2 class="sc-pNWdM eftmgB"><a class="sc-crzoAE iUxAWq" href="#tag/Assistants/operation/listMessages" aria-label="tag/Assistants/operation/listMessages"></a>Returns a list of messages for a given thread.<!-- --> </h2><div class="sc-fcmMJX cvfxAX"><div class="sc-jUfyBS bhDyou"><h5 class="sc-iqAclL sc-fuISkM eONCmm hZIgic">Authorizations:</h5><svg class="sc-dIsUp iPqByX" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jQAxuV ccffaZ"><span class="sc-daBunf fcvuS"><span class="sc-dsXzNU dPrSxx"><i>ApiKeyAuth</i></span></span></div></div><div><h5 class="sc-iqAclL eONCmm">path<!-- --> Parameters</h5><table class="sc-hHEiqL VCQHZ"><tbody><tr class="last "><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="thread_id"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">thread_id</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The ID of the <a href="/docs/api-reference/threads">thread</a> the messages belong to.</p>
</div></div></div></td></tr></tbody></table></div><div><h5 class="sc-iqAclL eONCmm">query<!-- --> Parameters</h5><table class="sc-hHEiqL VCQHZ"><tbody><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="limit"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">limit</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">integer</span></div><div><span class="sc-laZMeE jWaWWE"> <!-- -->Default:<!-- --> </span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">20</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="order"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">order</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div><div><span class="sc-laZMeE jWaWWE"> <!-- -->Default:<!-- --> </span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"desc"</span></div><div><span class="sc-laZMeE jWaWWE"> <!-- -->Enum<!-- -->:</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"asc"</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"desc"</span> </div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>Sort order by the <code>created_at</code> timestamp of the objects. <code>asc</code> for ascending order and <code>desc</code> for descending order.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="after"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">after</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>A cursor for use in pagination. <code>after</code> is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="before"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">before</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>A cursor for use in pagination. <code>before</code> is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_foo, your subsequent call can include before=obj_foo in order to fetch the previous page of the list.</p>
</div></div></div></td></tr><tr class="last "><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="run_id"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">run_id</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>Filter messages by the run ID that generated them.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-fIxmyt DvFer">Responses</h3><div><button class="sc-htmcrh lbYftx"><svg class="sc-dIsUp dqYXmg" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-fWWYYk cMoEZ">200<!-- --> </strong><span class="sc-jcwpoC eDjFAZ"><p>OK</p>
</span></button></div></div></div><div class="sc-jSFjdj sc-gKAaRy gBjRyf gcushC"><div class="sc-EZqKI fWsqvQ"><button class="sc-eEVmNe ilvUMs"><span type="get" class="sc-fmdNqN ihNycv http-verb get">get</span><span class="sc-jXcxbT fCEUju">/threads/{thread_id}/messages</span><svg class="sc-dIsUp bRmrKA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ljsmAU flIrdF"><div class="sc-jlZJtj fQkroN"><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div><div tabindex="0" role="button"><div class="sc-dTSzeu dfUAUz"><span>https://api.openai.com/v1</span>/threads/{thread_id}/messages</div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Response samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-30" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-31" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-31" aria-labelledby="react-tabs-30"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-bBjRSN kQSIAz">application/json</div></div><div class="sc-jgPyTC dSaTNC"><div class="sc-jNnpgg esZIbL"><div class="sc-giAqHp hMPeqJ"><button><div class="sc-carFqZ UksDl">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iJCRrE jCdxGr sc-dPaNzc gyljjx"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"object"</span>: <span class="token string">"list"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"object"</span>: <span class="token string">"thread.message"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"created_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"thread_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"status"</span>: <span class="token string">"in_progress"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"incomplete_details"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"reason"</span>: <span class="token string">"content_filter"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"completed_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"incomplete_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"role"</span>: <span class="token string">"user"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"content"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <span class="token string">"image_file"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"image_file"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"file_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"detail"</span>: <span class="token string">"auto"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"assistant_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"run_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"attachments"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"file_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"tools"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <span class="token string">"code_interpreter"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"metadata"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"property1"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"property2"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"first_id"</span>: <span class="token string">"msg_abc123"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"last_id"</span>: <span class="token string">"msg_abc123"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"has_more"</span>: <span class="token boolean">false</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Assistants/operation/createMessage" data-section-id="tag/Assistants/operation/createMessage" class="sc-eCApnc liLqNm"><div data-section-id="operation/createMessage" id="operation/createMessage" class="sc-iCoGMd gLxhOh"><div class="sc-hKFxyN juinod"><h2 class="sc-pNWdM eftmgB"><a class="sc-crzoAE iUxAWq" href="#tag/Assistants/operation/createMessage" aria-label="tag/Assistants/operation/createMessage"></a>Create a message.<!-- --> </h2><div class="sc-fcmMJX cvfxAX"><div class="sc-jUfyBS bhDyou"><h5 class="sc-iqAclL sc-fuISkM eONCmm hZIgic">Authorizations:</h5><svg class="sc-dIsUp iPqByX" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jQAxuV ccffaZ"><span class="sc-daBunf fcvuS"><span class="sc-dsXzNU dPrSxx"><i>ApiKeyAuth</i></span></span></div></div><div><h5 class="sc-iqAclL eONCmm">path<!-- --> Parameters</h5><table class="sc-hHEiqL VCQHZ"><tbody><tr class="last "><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="thread_id"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">thread_id</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The ID of the <a href="/docs/api-reference/threads">thread</a> to create a message for.</p>
</div></div></div></td></tr></tbody></table></div><h5 class="sc-iqAclL eONCmm">Request Body schema: <span class="sc-cBoqAE eKyrDP">application/json</span></h5><div class="sc-iJCRrE sc-ciSkZP jCdxGr QGruV"></div><table class="sc-hHEiqL VCQHZ"><tbody><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="role"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">role</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div><div><span class="sc-laZMeE jWaWWE"> <!-- -->Enum<!-- -->:</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"user"</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"assistant"</span> </div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The role of the entity that is creating the message. Allowed values include:</p>
<ul>
<li><code>user</code>: Indicates the message is sent by an actual user and should be used in most cases to represent user-generated messages.</li>
<li><code>assistant</code>: Indicates the message is generated by the assistant. Use this value to insert messages from the assistant into the conversation.</li>
</ul>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT sc-gSYDnn iwcKgn cAqMTE hTttpy" kind="field" title="content"><span class="sc-iemWCZ bcnRwz"></span><button aria-label="expand properties"><span class="property-name">content</span><svg class="sc-dIsUp hGHhhO" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">Text content (string) or (Array of Array of content parts (Image file (object) or Image URL (object) or Text (object)))</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT sc-gSYDnn iwcKgn cAqMTE hTttpy" kind="field" title="attachments"><span class="sc-iemWCZ bcnRwz"></span><button aria-label="expand properties"><span class="property-name">attachments</span><svg class="sc-dIsUp hGHhhO" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">Array of objects or null</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div></div></div></td></tr><tr class="last "><td class="sc-hBMUJo sc-fFSPTT sc-gSYDnn iwcKgn cAqMTE hTttpy" kind="field" title="metadata"><span class="sc-iemWCZ bcnRwz"></span><button aria-label="expand properties"><span class="property-name">metadata</span><svg class="sc-dIsUp hGHhhO" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">Metadata (object) or Metadata (null)</span><span class="sc-laZMeE sc-eJocfa jWaWWE bArHDh"> (<!-- -->Metadata<!-- -->) </span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div></div></div></td></tr></tbody></table><div><h3 class="sc-fIxmyt DvFer">Responses</h3><div><button class="sc-htmcrh lbYftx"><svg class="sc-dIsUp dqYXmg" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-fWWYYk cMoEZ">200<!-- --> </strong><span class="sc-jcwpoC eDjFAZ"><p>OK</p>
</span></button></div></div></div><div class="sc-jSFjdj sc-gKAaRy gBjRyf gcushC"><div class="sc-EZqKI fWsqvQ"><button class="sc-eEVmNe ilvUMs"><span type="post" class="sc-fmdNqN ldMUmp http-verb post">post</span><span class="sc-jXcxbT fCEUju">/threads/{thread_id}/messages</span><svg class="sc-dIsUp bRmrKA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ljsmAU flIrdF"><div class="sc-jlZJtj fQkroN"><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div><div tabindex="0" role="button"><div class="sc-dTSzeu dfUAUz"><span>https://api.openai.com/v1</span>/threads/{thread_id}/messages</div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Request samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="react-tabs-32" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-33" tabindex="0" data-rttab="true">Payload</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-33" aria-labelledby="react-tabs-32"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-bBjRSN kQSIAz">application/json</div></div><div class="sc-jgPyTC dSaTNC"><div class="sc-jNnpgg esZIbL"><div class="sc-giAqHp hMPeqJ"><button><div class="sc-carFqZ UksDl">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iJCRrE jCdxGr sc-dPaNzc gyljjx"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"role"</span>: <span class="token string">"user"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"content"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"attachments"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"file_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"tools"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <span class="token string">"code_interpreter"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"property1"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"property2"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Response samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-34" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-35" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-35" aria-labelledby="react-tabs-34"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-bBjRSN kQSIAz">application/json</div></div><div class="sc-jgPyTC dSaTNC"><div class="sc-jNnpgg esZIbL"><div class="sc-giAqHp hMPeqJ"><button><div class="sc-carFqZ UksDl">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iJCRrE jCdxGr sc-dPaNzc gyljjx"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"object"</span>: <span class="token string">"thread.message"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"created_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"thread_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token string">"in_progress"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"incomplete_details"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"reason"</span>: <span class="token string">"content_filter"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"completed_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"incomplete_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"role"</span>: <span class="token string">"user"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"content"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <span class="token string">"image_file"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"image_file"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"file_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"detail"</span>: <span class="token string">"auto"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"assistant_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"run_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"attachments"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"file_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"tools"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <span class="token string">"code_interpreter"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"property1"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"property2"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Assistants/operation/getMessage" data-section-id="tag/Assistants/operation/getMessage" class="sc-eCApnc liLqNm"><div data-section-id="operation/getMessage" id="operation/getMessage" class="sc-iCoGMd gLxhOh"><div class="sc-hKFxyN juinod"><h2 class="sc-pNWdM eftmgB"><a class="sc-crzoAE iUxAWq" href="#tag/Assistants/operation/getMessage" aria-label="tag/Assistants/operation/getMessage"></a>Retrieve a message.<!-- --> </h2><div class="sc-fcmMJX cvfxAX"><div class="sc-jUfyBS bhDyou"><h5 class="sc-iqAclL sc-fuISkM eONCmm hZIgic">Authorizations:</h5><svg class="sc-dIsUp iPqByX" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jQAxuV ccffaZ"><span class="sc-daBunf fcvuS"><span class="sc-dsXzNU dPrSxx"><i>ApiKeyAuth</i></span></span></div></div><div><h5 class="sc-iqAclL eONCmm">path<!-- --> Parameters</h5><table class="sc-hHEiqL VCQHZ"><tbody><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="thread_id"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">thread_id</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The ID of the <a href="/docs/api-reference/threads">thread</a> to which this message belongs.</p>
</div></div></div></td></tr><tr class="last "><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="message_id"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">message_id</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The ID of the message to retrieve.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-fIxmyt DvFer">Responses</h3><div><button class="sc-htmcrh lbYftx"><svg class="sc-dIsUp dqYXmg" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-fWWYYk cMoEZ">200<!-- --> </strong><span class="sc-jcwpoC eDjFAZ"><p>OK</p>
</span></button></div></div></div><div class="sc-jSFjdj sc-gKAaRy gBjRyf gcushC"><div class="sc-EZqKI fWsqvQ"><button class="sc-eEVmNe ilvUMs"><span type="get" class="sc-fmdNqN ihNycv http-verb get">get</span><span class="sc-jXcxbT fCEUju">/threads/{thread_id}/messages/{message_id}</span><svg class="sc-dIsUp bRmrKA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ljsmAU flIrdF"><div class="sc-jlZJtj fQkroN"><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div><div tabindex="0" role="button"><div class="sc-dTSzeu dfUAUz"><span>https://api.openai.com/v1</span>/threads/{thread_id}/messages/{message_id}</div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Response samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-36" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-37" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-37" aria-labelledby="react-tabs-36"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-bBjRSN kQSIAz">application/json</div></div><div class="sc-jgPyTC dSaTNC"><div class="sc-jNnpgg esZIbL"><div class="sc-giAqHp hMPeqJ"><button><div class="sc-carFqZ UksDl">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iJCRrE jCdxGr sc-dPaNzc gyljjx"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"object"</span>: <span class="token string">"thread.message"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"created_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"thread_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token string">"in_progress"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"incomplete_details"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"reason"</span>: <span class="token string">"content_filter"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"completed_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"incomplete_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"role"</span>: <span class="token string">"user"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"content"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <span class="token string">"image_file"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"image_file"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"file_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"detail"</span>: <span class="token string">"auto"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"assistant_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"run_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"attachments"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"file_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"tools"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <span class="token string">"code_interpreter"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"property1"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"property2"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Assistants/operation/modifyMessage" data-section-id="tag/Assistants/operation/modifyMessage" class="sc-eCApnc liLqNm"><div data-section-id="operation/modifyMessage" id="operation/modifyMessage" class="sc-iCoGMd gLxhOh"><div class="sc-hKFxyN juinod"><h2 class="sc-pNWdM eftmgB"><a class="sc-crzoAE iUxAWq" href="#tag/Assistants/operation/modifyMessage" aria-label="tag/Assistants/operation/modifyMessage"></a>Modifies a message.<!-- --> </h2><div class="sc-fcmMJX cvfxAX"><div class="sc-jUfyBS bhDyou"><h5 class="sc-iqAclL sc-fuISkM eONCmm hZIgic">Authorizations:</h5><svg class="sc-dIsUp iPqByX" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jQAxuV ccffaZ"><span class="sc-daBunf fcvuS"><span class="sc-dsXzNU dPrSxx"><i>ApiKeyAuth</i></span></span></div></div><div><h5 class="sc-iqAclL eONCmm">path<!-- --> Parameters</h5><table class="sc-hHEiqL VCQHZ"><tbody><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="thread_id"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">thread_id</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The ID of the thread to which this message belongs.</p>
</div></div></div></td></tr><tr class="last "><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="message_id"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">message_id</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The ID of the message to modify.</p>
</div></div></div></td></tr></tbody></table></div><h5 class="sc-iqAclL eONCmm">Request Body schema: <span class="sc-cBoqAE eKyrDP">application/json</span></h5><div class="sc-iJCRrE sc-ciSkZP jCdxGr QGruV"></div><table class="sc-hHEiqL VCQHZ"><tbody><tr class="last "><td class="sc-hBMUJo sc-fFSPTT sc-gSYDnn iwcKgn cAqMTE hTttpy" kind="field" title="metadata"><span class="sc-iemWCZ bcnRwz"></span><button aria-label="expand properties"><span class="property-name">metadata</span><svg class="sc-dIsUp hGHhhO" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">Metadata (object) or Metadata (null)</span><span class="sc-laZMeE sc-eJocfa jWaWWE bArHDh"> (<!-- -->Metadata<!-- -->) </span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div></div></div></td></tr></tbody></table><div><h3 class="sc-fIxmyt DvFer">Responses</h3><div><button class="sc-htmcrh lbYftx"><svg class="sc-dIsUp dqYXmg" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-fWWYYk cMoEZ">200<!-- --> </strong><span class="sc-jcwpoC eDjFAZ"><p>OK</p>
</span></button></div></div></div><div class="sc-jSFjdj sc-gKAaRy gBjRyf gcushC"><div class="sc-EZqKI fWsqvQ"><button class="sc-eEVmNe ilvUMs"><span type="post" class="sc-fmdNqN ldMUmp http-verb post">post</span><span class="sc-jXcxbT fCEUju">/threads/{thread_id}/messages/{message_id}</span><svg class="sc-dIsUp bRmrKA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ljsmAU flIrdF"><div class="sc-jlZJtj fQkroN"><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div><div tabindex="0" role="button"><div class="sc-dTSzeu dfUAUz"><span>https://api.openai.com/v1</span>/threads/{thread_id}/messages/{message_id}</div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Request samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="react-tabs-38" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-39" tabindex="0" data-rttab="true">Payload</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-39" aria-labelledby="react-tabs-38"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-bBjRSN kQSIAz">application/json</div></div><div class="sc-jgPyTC dSaTNC"><div class="sc-jNnpgg esZIbL"><div class="sc-giAqHp hMPeqJ"><button><div class="sc-carFqZ UksDl">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iJCRrE jCdxGr sc-dPaNzc gyljjx"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"metadata"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"property1"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"property2"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Response samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-40" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-41" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-41" aria-labelledby="react-tabs-40"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-bBjRSN kQSIAz">application/json</div></div><div class="sc-jgPyTC dSaTNC"><div class="sc-jNnpgg esZIbL"><div class="sc-giAqHp hMPeqJ"><button><div class="sc-carFqZ UksDl">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iJCRrE jCdxGr sc-dPaNzc gyljjx"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"object"</span>: <span class="token string">"thread.message"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"created_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"thread_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token string">"in_progress"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"incomplete_details"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"reason"</span>: <span class="token string">"content_filter"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"completed_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"incomplete_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"role"</span>: <span class="token string">"user"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"content"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <span class="token string">"image_file"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"image_file"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"file_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"detail"</span>: <span class="token string">"auto"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"assistant_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"run_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"attachments"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"file_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"tools"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <span class="token string">"code_interpreter"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"property1"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"property2"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Assistants/operation/deleteMessage" data-section-id="tag/Assistants/operation/deleteMessage" class="sc-eCApnc liLqNm"><div data-section-id="operation/deleteMessage" id="operation/deleteMessage" class="sc-iCoGMd gLxhOh"><div class="sc-hKFxyN juinod"><h2 class="sc-pNWdM eftmgB"><a class="sc-crzoAE iUxAWq" href="#tag/Assistants/operation/deleteMessage" aria-label="tag/Assistants/operation/deleteMessage"></a>Deletes a message.<!-- --> </h2><div class="sc-fcmMJX cvfxAX"><div class="sc-jUfyBS bhDyou"><h5 class="sc-iqAclL sc-fuISkM eONCmm hZIgic">Authorizations:</h5><svg class="sc-dIsUp iPqByX" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jQAxuV ccffaZ"><span class="sc-daBunf fcvuS"><span class="sc-dsXzNU dPrSxx"><i>ApiKeyAuth</i></span></span></div></div><div><h5 class="sc-iqAclL eONCmm">path<!-- --> Parameters</h5><table class="sc-hHEiqL VCQHZ"><tbody><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="thread_id"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">thread_id</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The ID of the thread to which this message belongs.</p>
</div></div></div></td></tr><tr class="last "><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="message_id"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">message_id</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The ID of the message to delete.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-fIxmyt DvFer">Responses</h3><div><button class="sc-htmcrh lbYftx"><svg class="sc-dIsUp dqYXmg" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-fWWYYk cMoEZ">200<!-- --> </strong><span class="sc-jcwpoC eDjFAZ"><p>OK</p>
</span></button></div></div></div><div class="sc-jSFjdj sc-gKAaRy gBjRyf gcushC"><div class="sc-EZqKI fWsqvQ"><button class="sc-eEVmNe ilvUMs"><span type="delete" class="sc-fmdNqN bJzUtf http-verb delete">delete</span><span class="sc-jXcxbT fCEUju">/threads/{thread_id}/messages/{message_id}</span><svg class="sc-dIsUp bRmrKA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ljsmAU flIrdF"><div class="sc-jlZJtj fQkroN"><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div><div tabindex="0" role="button"><div class="sc-dTSzeu dfUAUz"><span>https://api.openai.com/v1</span>/threads/{thread_id}/messages/{message_id}</div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Response samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-42" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-43" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-43" aria-labelledby="react-tabs-42"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-bBjRSN kQSIAz">application/json</div></div><div class="sc-jgPyTC dSaTNC"><div class="sc-jNnpgg esZIbL"><div class="sc-giAqHp hMPeqJ"><button><div class="sc-carFqZ UksDl">Copy</div></button></div><div class="sc-iJCRrE jCdxGr sc-dPaNzc gyljjx"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"deleted"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"object"</span>: <span class="token string">"thread.message.deleted"</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Assistants/operation/listRuns" data-section-id="tag/Assistants/operation/listRuns" class="sc-eCApnc liLqNm"><div data-section-id="operation/listRuns" id="operation/listRuns" class="sc-iCoGMd gLxhOh"><div class="sc-hKFxyN juinod"><h2 class="sc-pNWdM eftmgB"><a class="sc-crzoAE iUxAWq" href="#tag/Assistants/operation/listRuns" aria-label="tag/Assistants/operation/listRuns"></a>Returns a list of runs belonging to a thread.<!-- --> </h2><div class="sc-fcmMJX cvfxAX"><div class="sc-jUfyBS bhDyou"><h5 class="sc-iqAclL sc-fuISkM eONCmm hZIgic">Authorizations:</h5><svg class="sc-dIsUp iPqByX" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jQAxuV ccffaZ"><span class="sc-daBunf fcvuS"><span class="sc-dsXzNU dPrSxx"><i>ApiKeyAuth</i></span></span></div></div><div><h5 class="sc-iqAclL eONCmm">path<!-- --> Parameters</h5><table class="sc-hHEiqL VCQHZ"><tbody><tr class="last "><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="thread_id"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">thread_id</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The ID of the thread the run belongs to.</p>
</div></div></div></td></tr></tbody></table></div><div><h5 class="sc-iqAclL eONCmm">query<!-- --> Parameters</h5><table class="sc-hHEiqL VCQHZ"><tbody><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="limit"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">limit</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">integer</span></div><div><span class="sc-laZMeE jWaWWE"> <!-- -->Default:<!-- --> </span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">20</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="order"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">order</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div><div><span class="sc-laZMeE jWaWWE"> <!-- -->Default:<!-- --> </span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"desc"</span></div><div><span class="sc-laZMeE jWaWWE"> <!-- -->Enum<!-- -->:</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"asc"</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"desc"</span> </div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>Sort order by the <code>created_at</code> timestamp of the objects. <code>asc</code> for ascending order and <code>desc</code> for descending order.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="after"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">after</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>A cursor for use in pagination. <code>after</code> is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list.</p>
</div></div></div></td></tr><tr class="last "><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="before"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">before</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>A cursor for use in pagination. <code>before</code> is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_foo, your subsequent call can include before=obj_foo in order to fetch the previous page of the list.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-fIxmyt DvFer">Responses</h3><div><button class="sc-htmcrh lbYftx"><svg class="sc-dIsUp dqYXmg" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-fWWYYk cMoEZ">200<!-- --> </strong><span class="sc-jcwpoC eDjFAZ"><p>OK</p>
</span></button></div></div></div><div class="sc-jSFjdj sc-gKAaRy gBjRyf gcushC"><div class="sc-EZqKI fWsqvQ"><button class="sc-eEVmNe ilvUMs"><span type="get" class="sc-fmdNqN ihNycv http-verb get">get</span><span class="sc-jXcxbT fCEUju">/threads/{thread_id}/runs</span><svg class="sc-dIsUp bRmrKA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ljsmAU flIrdF"><div class="sc-jlZJtj fQkroN"><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div><div tabindex="0" role="button"><div class="sc-dTSzeu dfUAUz"><span>https://api.openai.com/v1</span>/threads/{thread_id}/runs</div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Response samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-44" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-45" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-45" aria-labelledby="react-tabs-44"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-bBjRSN kQSIAz">application/json</div></div><div class="sc-jgPyTC dSaTNC"><div class="sc-jNnpgg esZIbL"><div class="sc-giAqHp hMPeqJ"><button><div class="sc-carFqZ UksDl">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iJCRrE jCdxGr sc-dPaNzc gyljjx"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"object"</span>: <span class="token string">"list"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"object"</span>: <span class="token string">"thread.run"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"created_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"thread_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"assistant_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"status"</span>: <span class="token string">"queued"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"required_action"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <span class="token string">"submit_tool_outputs"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"submit_tool_outputs"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"tool_calls"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <span class="token string">"function"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"function"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"arguments"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"last_error"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"code"</span>: <span class="token string">"server_error"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"message"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"expires_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"started_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"cancelled_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"failed_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"completed_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"incomplete_details"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"reason"</span>: <span class="token string">"max_completion_tokens"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"model"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"instructions"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"tools"</span>: <span class="token punctuation">[ ]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"metadata"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"property1"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"property2"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"usage"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"completion_tokens"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"prompt_tokens"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"total_tokens"</span>: <span class="token number">0</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"temperature"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"top_p"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"max_prompt_tokens"</span>: <span class="token number">256</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"max_completion_tokens"</span>: <span class="token number">256</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"truncation_strategy"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <span class="token string">"auto"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"last_messages"</span>: <span class="token number">1</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"tool_choice"</span>: <span class="token string">"none"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"parallel_tool_calls"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"response_format"</span>: <span class="token string">"auto"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"first_id"</span>: <span class="token string">"run_abc123"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"last_id"</span>: <span class="token string">"run_abc456"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"has_more"</span>: <span class="token boolean">false</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Assistants/operation/createRun" data-section-id="tag/Assistants/operation/createRun" class="sc-eCApnc liLqNm"><div data-section-id="operation/createRun" id="operation/createRun" class="sc-iCoGMd gLxhOh"><div class="sc-hKFxyN juinod"><h2 class="sc-pNWdM eftmgB"><a class="sc-crzoAE iUxAWq" href="#tag/Assistants/operation/createRun" aria-label="tag/Assistants/operation/createRun"></a>Create a run.<!-- --> </h2><div class="sc-fcmMJX cvfxAX"><div class="sc-jUfyBS bhDyou"><h5 class="sc-iqAclL sc-fuISkM eONCmm hZIgic">Authorizations:</h5><svg class="sc-dIsUp iPqByX" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jQAxuV ccffaZ"><span class="sc-daBunf fcvuS"><span class="sc-dsXzNU dPrSxx"><i>ApiKeyAuth</i></span></span></div></div><div><h5 class="sc-iqAclL eONCmm">path<!-- --> Parameters</h5><table class="sc-hHEiqL VCQHZ"><tbody><tr class="last "><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="thread_id"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">thread_id</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The ID of the thread to run.</p>
</div></div></div></td></tr></tbody></table></div><div><h5 class="sc-iqAclL eONCmm">query<!-- --> Parameters</h5><table class="sc-hHEiqL VCQHZ"><tbody><tr class="last "><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="include[]"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">include[]</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa">Array of </span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">strings</span></div><div><span class="sc-laZMeE jWaWWE">Items<!-- --> <!-- -->Value<!-- -->:</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"step_details.tool_calls[*].file_search.results[*].content"</span> </div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>A list of additional fields to include in the response. Currently the only supported value is <code>step_details.tool_calls[*].file_search.results[*].content</code> to fetch the file search result content.</p>
<p>See the <a href="/docs/assistants/tools/file-search#customizing-file-search-settings">file search tool documentation</a> for more information.</p>
</div></div></div></td></tr></tbody></table></div><h5 class="sc-iqAclL eONCmm">Request Body schema: <span class="sc-cBoqAE eKyrDP">application/json</span></h5><div class="sc-iJCRrE sc-ciSkZP jCdxGr QGruV"></div><table class="sc-hHEiqL VCQHZ"><tbody><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="assistant_id"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">assistant_id</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The ID of the <a href="/docs/api-reference/assistants">assistant</a> to use to execute this run.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT sc-gSYDnn iwcKgn cAqMTE hTttpy" kind="field" title="model"><span class="sc-iemWCZ bcnRwz"></span><button aria-label="expand properties"><span class="property-name">model</span><svg class="sc-dIsUp hGHhhO" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">(string or null) or (AssistantSupportedModels (string or null))</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The ID of the <a href="/docs/api-reference/models">Model</a> to be used to execute this run. If a value is provided here, it will override the model associated with the assistant. If not, the model associated with the assistant will be used.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT sc-gSYDnn iwcKgn cAqMTE hTttpy" kind="field" title="reasoning_effort"><span class="sc-iemWCZ bcnRwz"></span><button aria-label="expand properties"><span class="property-name">reasoning_effort</span><svg class="sc-dIsUp hGHhhO" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">ReasoningEffort (string) or ReasoningEffort (null)</span><span class="sc-laZMeE sc-eJocfa jWaWWE bArHDh"> (<!-- -->ReasoningEffort<!-- -->) </span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="instructions"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">instructions</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string or null</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>Overrides the <a href="/docs/api-reference/assistants/createAssistant">instructions</a> of the assistant. This is useful for modifying the behavior on a per-run basis.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="additional_instructions"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">additional_instructions</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string or null</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>Appends additional instructions at the end of the instructions for the run. This is useful for modifying the behavior on a per-run basis without overriding other instructions.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT sc-gSYDnn iwcKgn cAqMTE hTttpy" kind="field" title="additional_messages"><span class="sc-iemWCZ bcnRwz"></span><button aria-label="expand properties"><span class="property-name">additional_messages</span><svg class="sc-dIsUp hGHhhO" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa">Array of </span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">objects or null</span><span class="sc-laZMeE sc-eJocfa jWaWWE bArHDh"> (<!-- -->CreateMessageRequest<!-- -->) </span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>Adds additional messages to the thread before creating the run.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT sc-gSYDnn iwcKgn cAqMTE hTttpy" kind="field" title="tools"><span class="sc-iemWCZ bcnRwz"></span><button aria-label="expand properties"><span class="property-name">tools</span><svg class="sc-dIsUp hGHhhO" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa">Array of </span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">Code interpreter tool (object) or FileSearch tool (object) or Function tool (object) or null</span><span> <span class="sc-laZMeE sc-FRrlG jWaWWE gHBwqe"> <!-- --><= 20 items<!-- --> </span></span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>Override the tools the assistant can use for this run. This is useful for modifying the behavior on a per-run basis.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT sc-gSYDnn iwcKgn cAqMTE hTttpy" kind="field" title="metadata"><span class="sc-iemWCZ bcnRwz"></span><button aria-label="expand properties"><span class="property-name">metadata</span><svg class="sc-dIsUp hGHhhO" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">Metadata (object) or Metadata (null)</span><span class="sc-laZMeE sc-eJocfa jWaWWE bArHDh"> (<!-- -->Metadata<!-- -->) </span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="temperature"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">temperature</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">number or null</span><span> <span class="sc-laZMeE sc-FRrlG jWaWWE gHBwqe"> <!-- -->[ 0 .. 2 ]<!-- --> </span></span></div><div><span class="sc-laZMeE jWaWWE"> <!-- -->Default:<!-- --> </span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">1</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>What sampling temperature to use, between 0 and 2. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="top_p"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">top_p</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">number or null</span><span> <span class="sc-laZMeE sc-FRrlG jWaWWE gHBwqe"> <!-- -->[ 0 .. 1 ]<!-- --> </span></span></div><div><span class="sc-laZMeE jWaWWE"> <!-- -->Default:<!-- --> </span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">1</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>An alternative to sampling with temperature, called nucleus sampling, where the model considers the results of the tokens with top_p probability mass. So 0.1 means only the tokens comprising the top 10% probability mass are considered.</p>
<p>We generally recommend altering this or temperature but not both.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="stream"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">stream</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">boolean or null</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>If <code>true</code>, returns a stream of events that happen during the Run as server-sent events, terminating when the Run enters a terminal state with a <code>data: [DONE]</code> message.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="max_prompt_tokens"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">max_prompt_tokens</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">integer or null</span><span> <span class="sc-laZMeE sc-FRrlG jWaWWE gHBwqe"> <!-- -->>= 256<!-- --> </span></span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The maximum number of prompt tokens that may be used over the course of the run. The run will make a best effort to use only the number of prompt tokens specified, across multiple turns of the run. If the run exceeds the number of prompt tokens specified, the run will end with status <code>incomplete</code>. See <code>incomplete_details</code> for more info.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="max_completion_tokens"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">max_completion_tokens</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">integer or null</span><span> <span class="sc-laZMeE sc-FRrlG jWaWWE gHBwqe"> <!-- -->>= 256<!-- --> </span></span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The maximum number of completion tokens that may be used over the course of the run. The run will make a best effort to use only the number of completion tokens specified, across multiple turns of the run. If the run exceeds the number of completion tokens specified, the run will end with status <code>incomplete</code>. See <code>incomplete_details</code> for more info.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT sc-gSYDnn iwcKgn cAqMTE hTttpy" kind="field" title="truncation_strategy"><span class="sc-iemWCZ bcnRwz"></span><button aria-label="expand properties"><span class="property-name">truncation_strategy</span><svg class="sc-dIsUp hGHhhO" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">object or null</span><span class="sc-laZMeE sc-eJocfa jWaWWE bArHDh"> (<!-- -->Thread Truncation Controls<!-- -->) </span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>Controls for how a thread will be truncated prior to the run. Use this to control the initial context window of the run.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT sc-gSYDnn iwcKgn cAqMTE hTttpy" kind="field" title="tool_choice"><span class="sc-iemWCZ bcnRwz"></span><button aria-label="expand properties"><span class="property-name">tool_choice</span><svg class="sc-dIsUp hGHhhO" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">(string or null) or (AssistantsNamedToolChoice (object or null))</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>Controls which (if any) tool is called by the model.
<code>none</code> means the model will not call any tools and instead generates a message.
<code>auto</code> is the default value and means the model can pick between generating a message or calling one or more tools.
<code>required</code> means the model must call one or more tools before responding to the user.
Specifying a particular tool like <code>{"type": "file_search"}</code> or <code>{"type": "function", "function": {"name": "my_function"}}</code> forces the model to call that tool.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="parallel_tool_calls"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">parallel_tool_calls</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">boolean</span><span class="sc-laZMeE sc-eJocfa jWaWWE bArHDh"> (<!-- -->ParallelToolCalls<!-- -->) </span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>Whether to enable <a href="/docs/guides/function-calling#configuring-parallel-function-calling">parallel function calling</a> during tool use.</p>
</div></div></div></td></tr><tr class="last "><td class="sc-hBMUJo sc-fFSPTT sc-gSYDnn iwcKgn cAqMTE hTttpy" kind="field" title="response_format"><span class="sc-iemWCZ bcnRwz"></span><button aria-label="expand properties"><span class="property-name">response_format</span><svg class="sc-dIsUp hGHhhO" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">(string or null) or (Text (object or null)) or (JSON object (object or null)) or (JSON schema (object or null))</span><span class="sc-laZMeE sc-eJocfa jWaWWE bArHDh"> (<!-- -->AssistantsApiResponseFormatOption<!-- -->) </span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div></div></div></td></tr></tbody></table><div><h3 class="sc-fIxmyt DvFer">Responses</h3><div><button class="sc-htmcrh lbYftx"><svg class="sc-dIsUp dqYXmg" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-fWWYYk cMoEZ">200<!-- --> </strong><span class="sc-jcwpoC eDjFAZ"><p>OK</p>
</span></button></div></div></div><div class="sc-jSFjdj sc-gKAaRy gBjRyf gcushC"><div class="sc-EZqKI fWsqvQ"><button class="sc-eEVmNe ilvUMs"><span type="post" class="sc-fmdNqN ldMUmp http-verb post">post</span><span class="sc-jXcxbT fCEUju">/threads/{thread_id}/runs</span><svg class="sc-dIsUp bRmrKA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ljsmAU flIrdF"><div class="sc-jlZJtj fQkroN"><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div><div tabindex="0" role="button"><div class="sc-dTSzeu dfUAUz"><span>https://api.openai.com/v1</span>/threads/{thread_id}/runs</div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Request samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="react-tabs-46" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-47" tabindex="0" data-rttab="true">Payload</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-47" aria-labelledby="react-tabs-46"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-bBjRSN kQSIAz">application/json</div></div><div class="sc-jgPyTC dSaTNC"><div class="sc-jNnpgg esZIbL"><div class="sc-giAqHp hMPeqJ"><button><div class="sc-carFqZ UksDl">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iJCRrE jCdxGr sc-dPaNzc gyljjx"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"assistant_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"model"</span>: <span class="token string">"gpt-4o"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"reasoning_effort"</span>: <span class="token string">"none"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"instructions"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"additional_instructions"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"additional_messages"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"role"</span>: <span class="token string">"user"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"content"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"attachments"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"file_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"tools"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <span class="token string">"code_interpreter"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"metadata"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"property1"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"property2"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"tools"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <span class="token string">"code_interpreter"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"property1"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"property2"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"temperature"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"top_p"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"stream"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"max_prompt_tokens"</span>: <span class="token number">256</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"max_completion_tokens"</span>: <span class="token number">256</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"truncation_strategy"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <span class="token string">"auto"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"last_messages"</span>: <span class="token number">1</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"tool_choice"</span>: <span class="token string">"none"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"parallel_tool_calls"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"response_format"</span>: <span class="token string">"auto"</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Response samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-48" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-49" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-49" aria-labelledby="react-tabs-48"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-bBjRSN kQSIAz">application/json</div></div><div class="sc-jgPyTC dSaTNC"><div class="sc-jNnpgg esZIbL"><div class="sc-giAqHp hMPeqJ"><button><div class="sc-carFqZ UksDl">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iJCRrE jCdxGr sc-dPaNzc gyljjx"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"object"</span>: <span class="token string">"thread.run"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"created_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"thread_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"assistant_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token string">"queued"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"required_action"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <span class="token string">"submit_tool_outputs"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"submit_tool_outputs"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"tool_calls"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <span class="token string">"function"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"function"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"arguments"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"last_error"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"code"</span>: <span class="token string">"server_error"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"message"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"expires_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"started_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"cancelled_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"failed_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"completed_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"incomplete_details"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"reason"</span>: <span class="token string">"max_completion_tokens"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"model"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"instructions"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"tools"</span>: <span class="token punctuation">[ ]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"property1"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"property2"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"usage"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"completion_tokens"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"prompt_tokens"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"total_tokens"</span>: <span class="token number">0</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"temperature"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"top_p"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"max_prompt_tokens"</span>: <span class="token number">256</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"max_completion_tokens"</span>: <span class="token number">256</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"truncation_strategy"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <span class="token string">"auto"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"last_messages"</span>: <span class="token number">1</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"tool_choice"</span>: <span class="token string">"none"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"parallel_tool_calls"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"response_format"</span>: <span class="token string">"auto"</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Assistants/operation/getRun" data-section-id="tag/Assistants/operation/getRun" class="sc-eCApnc liLqNm"><div data-section-id="operation/getRun" id="operation/getRun" class="sc-iCoGMd gLxhOh"><div class="sc-hKFxyN juinod"><h2 class="sc-pNWdM eftmgB"><a class="sc-crzoAE iUxAWq" href="#tag/Assistants/operation/getRun" aria-label="tag/Assistants/operation/getRun"></a>Retrieves a run.<!-- --> </h2><div class="sc-fcmMJX cvfxAX"><div class="sc-jUfyBS bhDyou"><h5 class="sc-iqAclL sc-fuISkM eONCmm hZIgic">Authorizations:</h5><svg class="sc-dIsUp iPqByX" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jQAxuV ccffaZ"><span class="sc-daBunf fcvuS"><span class="sc-dsXzNU dPrSxx"><i>ApiKeyAuth</i></span></span></div></div><div><h5 class="sc-iqAclL eONCmm">path<!-- --> Parameters</h5><table class="sc-hHEiqL VCQHZ"><tbody><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="thread_id"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">thread_id</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The ID of the <a href="/docs/api-reference/threads">thread</a> that was run.</p>
</div></div></div></td></tr><tr class="last "><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="run_id"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">run_id</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The ID of the run to retrieve.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-fIxmyt DvFer">Responses</h3><div><button class="sc-htmcrh lbYftx"><svg class="sc-dIsUp dqYXmg" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-fWWYYk cMoEZ">200<!-- --> </strong><span class="sc-jcwpoC eDjFAZ"><p>OK</p>
</span></button></div></div></div><div class="sc-jSFjdj sc-gKAaRy gBjRyf gcushC"><div class="sc-EZqKI fWsqvQ"><button class="sc-eEVmNe ilvUMs"><span type="get" class="sc-fmdNqN ihNycv http-verb get">get</span><span class="sc-jXcxbT fCEUju">/threads/{thread_id}/runs/{run_id}</span><svg class="sc-dIsUp bRmrKA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ljsmAU flIrdF"><div class="sc-jlZJtj fQkroN"><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div><div tabindex="0" role="button"><div class="sc-dTSzeu dfUAUz"><span>https://api.openai.com/v1</span>/threads/{thread_id}/runs/{run_id}</div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Response samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-50" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-51" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-51" aria-labelledby="react-tabs-50"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-bBjRSN kQSIAz">application/json</div></div><div class="sc-jgPyTC dSaTNC"><div class="sc-jNnpgg esZIbL"><div class="sc-giAqHp hMPeqJ"><button><div class="sc-carFqZ UksDl">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iJCRrE jCdxGr sc-dPaNzc gyljjx"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"object"</span>: <span class="token string">"thread.run"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"created_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"thread_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"assistant_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token string">"queued"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"required_action"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <span class="token string">"submit_tool_outputs"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"submit_tool_outputs"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"tool_calls"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <span class="token string">"function"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"function"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"arguments"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"last_error"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"code"</span>: <span class="token string">"server_error"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"message"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"expires_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"started_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"cancelled_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"failed_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"completed_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"incomplete_details"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"reason"</span>: <span class="token string">"max_completion_tokens"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"model"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"instructions"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"tools"</span>: <span class="token punctuation">[ ]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"property1"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"property2"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"usage"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"completion_tokens"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"prompt_tokens"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"total_tokens"</span>: <span class="token number">0</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"temperature"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"top_p"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"max_prompt_tokens"</span>: <span class="token number">256</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"max_completion_tokens"</span>: <span class="token number">256</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"truncation_strategy"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <span class="token string">"auto"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"last_messages"</span>: <span class="token number">1</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"tool_choice"</span>: <span class="token string">"none"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"parallel_tool_calls"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"response_format"</span>: <span class="token string">"auto"</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Assistants/operation/modifyRun" data-section-id="tag/Assistants/operation/modifyRun" class="sc-eCApnc liLqNm"><div data-section-id="operation/modifyRun" id="operation/modifyRun" class="sc-iCoGMd gLxhOh"><div class="sc-hKFxyN juinod"><h2 class="sc-pNWdM eftmgB"><a class="sc-crzoAE iUxAWq" href="#tag/Assistants/operation/modifyRun" aria-label="tag/Assistants/operation/modifyRun"></a>Modifies a run.<!-- --> </h2><div class="sc-fcmMJX cvfxAX"><div class="sc-jUfyBS bhDyou"><h5 class="sc-iqAclL sc-fuISkM eONCmm hZIgic">Authorizations:</h5><svg class="sc-dIsUp iPqByX" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jQAxuV ccffaZ"><span class="sc-daBunf fcvuS"><span class="sc-dsXzNU dPrSxx"><i>ApiKeyAuth</i></span></span></div></div><div><h5 class="sc-iqAclL eONCmm">path<!-- --> Parameters</h5><table class="sc-hHEiqL VCQHZ"><tbody><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="thread_id"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">thread_id</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The ID of the <a href="/docs/api-reference/threads">thread</a> that was run.</p>
</div></div></div></td></tr><tr class="last "><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="run_id"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">run_id</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The ID of the run to modify.</p>
</div></div></div></td></tr></tbody></table></div><h5 class="sc-iqAclL eONCmm">Request Body schema: <span class="sc-cBoqAE eKyrDP">application/json</span></h5><div class="sc-iJCRrE sc-ciSkZP jCdxGr QGruV"></div><table class="sc-hHEiqL VCQHZ"><tbody><tr class="last "><td class="sc-hBMUJo sc-fFSPTT sc-gSYDnn iwcKgn cAqMTE hTttpy" kind="field" title="metadata"><span class="sc-iemWCZ bcnRwz"></span><button aria-label="expand properties"><span class="property-name">metadata</span><svg class="sc-dIsUp hGHhhO" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">Metadata (object) or Metadata (null)</span><span class="sc-laZMeE sc-eJocfa jWaWWE bArHDh"> (<!-- -->Metadata<!-- -->) </span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div></div></div></td></tr></tbody></table><div><h3 class="sc-fIxmyt DvFer">Responses</h3><div><button class="sc-htmcrh lbYftx"><svg class="sc-dIsUp dqYXmg" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-fWWYYk cMoEZ">200<!-- --> </strong><span class="sc-jcwpoC eDjFAZ"><p>OK</p>
</span></button></div></div></div><div class="sc-jSFjdj sc-gKAaRy gBjRyf gcushC"><div class="sc-EZqKI fWsqvQ"><button class="sc-eEVmNe ilvUMs"><span type="post" class="sc-fmdNqN ldMUmp http-verb post">post</span><span class="sc-jXcxbT fCEUju">/threads/{thread_id}/runs/{run_id}</span><svg class="sc-dIsUp bRmrKA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ljsmAU flIrdF"><div class="sc-jlZJtj fQkroN"><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div><div tabindex="0" role="button"><div class="sc-dTSzeu dfUAUz"><span>https://api.openai.com/v1</span>/threads/{thread_id}/runs/{run_id}</div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Request samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="react-tabs-52" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-53" tabindex="0" data-rttab="true">Payload</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-53" aria-labelledby="react-tabs-52"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-bBjRSN kQSIAz">application/json</div></div><div class="sc-jgPyTC dSaTNC"><div class="sc-jNnpgg esZIbL"><div class="sc-giAqHp hMPeqJ"><button><div class="sc-carFqZ UksDl">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iJCRrE jCdxGr sc-dPaNzc gyljjx"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"metadata"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"property1"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"property2"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Response samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-54" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-55" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-55" aria-labelledby="react-tabs-54"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-bBjRSN kQSIAz">application/json</div></div><div class="sc-jgPyTC dSaTNC"><div class="sc-jNnpgg esZIbL"><div class="sc-giAqHp hMPeqJ"><button><div class="sc-carFqZ UksDl">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iJCRrE jCdxGr sc-dPaNzc gyljjx"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"object"</span>: <span class="token string">"thread.run"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"created_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"thread_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"assistant_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token string">"queued"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"required_action"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <span class="token string">"submit_tool_outputs"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"submit_tool_outputs"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"tool_calls"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <span class="token string">"function"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"function"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"arguments"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"last_error"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"code"</span>: <span class="token string">"server_error"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"message"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"expires_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"started_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"cancelled_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"failed_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"completed_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"incomplete_details"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"reason"</span>: <span class="token string">"max_completion_tokens"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"model"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"instructions"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"tools"</span>: <span class="token punctuation">[ ]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"property1"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"property2"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"usage"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"completion_tokens"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"prompt_tokens"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"total_tokens"</span>: <span class="token number">0</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"temperature"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"top_p"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"max_prompt_tokens"</span>: <span class="token number">256</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"max_completion_tokens"</span>: <span class="token number">256</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"truncation_strategy"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <span class="token string">"auto"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"last_messages"</span>: <span class="token number">1</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"tool_choice"</span>: <span class="token string">"none"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"parallel_tool_calls"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"response_format"</span>: <span class="token string">"auto"</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Assistants/operation/cancelRun" data-section-id="tag/Assistants/operation/cancelRun" class="sc-eCApnc liLqNm"><div data-section-id="operation/cancelRun" id="operation/cancelRun" class="sc-iCoGMd gLxhOh"><div class="sc-hKFxyN juinod"><h2 class="sc-pNWdM eftmgB"><a class="sc-crzoAE iUxAWq" href="#tag/Assistants/operation/cancelRun" aria-label="tag/Assistants/operation/cancelRun"></a>Cancels a run that is `in_progress`.<!-- --> </h2><div class="sc-fcmMJX cvfxAX"><div class="sc-jUfyBS bhDyou"><h5 class="sc-iqAclL sc-fuISkM eONCmm hZIgic">Authorizations:</h5><svg class="sc-dIsUp iPqByX" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jQAxuV ccffaZ"><span class="sc-daBunf fcvuS"><span class="sc-dsXzNU dPrSxx"><i>ApiKeyAuth</i></span></span></div></div><div><h5 class="sc-iqAclL eONCmm">path<!-- --> Parameters</h5><table class="sc-hHEiqL VCQHZ"><tbody><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="thread_id"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">thread_id</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The ID of the thread to which this run belongs.</p>
</div></div></div></td></tr><tr class="last "><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="run_id"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">run_id</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The ID of the run to cancel.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-fIxmyt DvFer">Responses</h3><div><button class="sc-htmcrh lbYftx"><svg class="sc-dIsUp dqYXmg" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-fWWYYk cMoEZ">200<!-- --> </strong><span class="sc-jcwpoC eDjFAZ"><p>OK</p>
</span></button></div></div></div><div class="sc-jSFjdj sc-gKAaRy gBjRyf gcushC"><div class="sc-EZqKI fWsqvQ"><button class="sc-eEVmNe ilvUMs"><span type="post" class="sc-fmdNqN ldMUmp http-verb post">post</span><span class="sc-jXcxbT fCEUju">/threads/{thread_id}/runs/{run_id}/cancel</span><svg class="sc-dIsUp bRmrKA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ljsmAU flIrdF"><div class="sc-jlZJtj fQkroN"><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div><div tabindex="0" role="button"><div class="sc-dTSzeu dfUAUz"><span>https://api.openai.com/v1</span>/threads/{thread_id}/runs/{run_id}/cancel</div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Response samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-56" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-57" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-57" aria-labelledby="react-tabs-56"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-bBjRSN kQSIAz">application/json</div></div><div class="sc-jgPyTC dSaTNC"><div class="sc-jNnpgg esZIbL"><div class="sc-giAqHp hMPeqJ"><button><div class="sc-carFqZ UksDl">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iJCRrE jCdxGr sc-dPaNzc gyljjx"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"object"</span>: <span class="token string">"thread.run"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"created_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"thread_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"assistant_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token string">"queued"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"required_action"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <span class="token string">"submit_tool_outputs"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"submit_tool_outputs"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"tool_calls"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <span class="token string">"function"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"function"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"arguments"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"last_error"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"code"</span>: <span class="token string">"server_error"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"message"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"expires_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"started_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"cancelled_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"failed_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"completed_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"incomplete_details"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"reason"</span>: <span class="token string">"max_completion_tokens"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"model"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"instructions"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"tools"</span>: <span class="token punctuation">[ ]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"property1"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"property2"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"usage"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"completion_tokens"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"prompt_tokens"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"total_tokens"</span>: <span class="token number">0</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"temperature"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"top_p"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"max_prompt_tokens"</span>: <span class="token number">256</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"max_completion_tokens"</span>: <span class="token number">256</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"truncation_strategy"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <span class="token string">"auto"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"last_messages"</span>: <span class="token number">1</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"tool_choice"</span>: <span class="token string">"none"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"parallel_tool_calls"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"response_format"</span>: <span class="token string">"auto"</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Assistants/operation/listRunSteps" data-section-id="tag/Assistants/operation/listRunSteps" class="sc-eCApnc liLqNm"><div data-section-id="operation/listRunSteps" id="operation/listRunSteps" class="sc-iCoGMd gLxhOh"><div class="sc-hKFxyN juinod"><h2 class="sc-pNWdM eftmgB"><a class="sc-crzoAE iUxAWq" href="#tag/Assistants/operation/listRunSteps" aria-label="tag/Assistants/operation/listRunSteps"></a>Returns a list of run steps belonging to a run.<!-- --> </h2><div class="sc-fcmMJX cvfxAX"><div class="sc-jUfyBS bhDyou"><h5 class="sc-iqAclL sc-fuISkM eONCmm hZIgic">Authorizations:</h5><svg class="sc-dIsUp iPqByX" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jQAxuV ccffaZ"><span class="sc-daBunf fcvuS"><span class="sc-dsXzNU dPrSxx"><i>ApiKeyAuth</i></span></span></div></div><div><h5 class="sc-iqAclL eONCmm">path<!-- --> Parameters</h5><table class="sc-hHEiqL VCQHZ"><tbody><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="thread_id"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">thread_id</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The ID of the thread the run and run steps belong to.</p>
</div></div></div></td></tr><tr class="last "><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="run_id"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">run_id</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The ID of the run the run steps belong to.</p>
</div></div></div></td></tr></tbody></table></div><div><h5 class="sc-iqAclL eONCmm">query<!-- --> Parameters</h5><table class="sc-hHEiqL VCQHZ"><tbody><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="limit"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">limit</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">integer</span></div><div><span class="sc-laZMeE jWaWWE"> <!-- -->Default:<!-- --> </span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">20</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="order"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">order</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div><div><span class="sc-laZMeE jWaWWE"> <!-- -->Default:<!-- --> </span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"desc"</span></div><div><span class="sc-laZMeE jWaWWE"> <!-- -->Enum<!-- -->:</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"asc"</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"desc"</span> </div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>Sort order by the <code>created_at</code> timestamp of the objects. <code>asc</code> for ascending order and <code>desc</code> for descending order.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="after"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">after</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>A cursor for use in pagination. <code>after</code> is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="before"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">before</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>A cursor for use in pagination. <code>before</code> is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_foo, your subsequent call can include before=obj_foo in order to fetch the previous page of the list.</p>
</div></div></div></td></tr><tr class="last "><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="include[]"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">include[]</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa">Array of </span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">strings</span></div><div><span class="sc-laZMeE jWaWWE">Items<!-- --> <!-- -->Value<!-- -->:</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"step_details.tool_calls[*].file_search.results[*].content"</span> </div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>A list of additional fields to include in the response. Currently the only supported value is <code>step_details.tool_calls[*].file_search.results[*].content</code> to fetch the file search result content.</p>
<p>See the <a href="/docs/assistants/tools/file-search#customizing-file-search-settings">file search tool documentation</a> for more information.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-fIxmyt DvFer">Responses</h3><div><button class="sc-htmcrh lbYftx"><svg class="sc-dIsUp dqYXmg" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-fWWYYk cMoEZ">200<!-- --> </strong><span class="sc-jcwpoC eDjFAZ"><p>OK</p>
</span></button></div></div></div><div class="sc-jSFjdj sc-gKAaRy gBjRyf gcushC"><div class="sc-EZqKI fWsqvQ"><button class="sc-eEVmNe ilvUMs"><span type="get" class="sc-fmdNqN ihNycv http-verb get">get</span><span class="sc-jXcxbT fCEUju">/threads/{thread_id}/runs/{run_id}/steps</span><svg class="sc-dIsUp bRmrKA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ljsmAU flIrdF"><div class="sc-jlZJtj fQkroN"><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div><div tabindex="0" role="button"><div class="sc-dTSzeu dfUAUz"><span>https://api.openai.com/v1</span>/threads/{thread_id}/runs/{run_id}/steps</div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Response samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-58" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-59" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-59" aria-labelledby="react-tabs-58"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-bBjRSN kQSIAz">application/json</div></div><div class="sc-jgPyTC dSaTNC"><div class="sc-jNnpgg esZIbL"><div class="sc-giAqHp hMPeqJ"><button><div class="sc-carFqZ UksDl">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iJCRrE jCdxGr sc-dPaNzc gyljjx"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"object"</span>: <span class="token string">"list"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"object"</span>: <span class="token string">"thread.run.step"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"created_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"assistant_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"thread_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"run_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <span class="token string">"message_creation"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"status"</span>: <span class="token string">"in_progress"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"step_details"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <span class="token string">"message_creation"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"message_creation"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"message_id"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"last_error"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"code"</span>: <span class="token string">"server_error"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"message"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"expired_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"cancelled_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"failed_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"completed_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"metadata"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"property1"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"property2"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"usage"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"completion_tokens"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"prompt_tokens"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"total_tokens"</span>: <span class="token number">0</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"first_id"</span>: <span class="token string">"step_abc123"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"last_id"</span>: <span class="token string">"step_abc456"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"has_more"</span>: <span class="token boolean">false</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Assistants/operation/getRunStep" data-section-id="tag/Assistants/operation/getRunStep" class="sc-eCApnc liLqNm"><div data-section-id="operation/getRunStep" id="operation/getRunStep" class="sc-iCoGMd gLxhOh"><div class="sc-hKFxyN juinod"><h2 class="sc-pNWdM eftmgB"><a class="sc-crzoAE iUxAWq" href="#tag/Assistants/operation/getRunStep" aria-label="tag/Assistants/operation/getRunStep"></a>Retrieves a run step.<!-- --> </h2><div class="sc-fcmMJX cvfxAX"><div class="sc-jUfyBS bhDyou"><h5 class="sc-iqAclL sc-fuISkM eONCmm hZIgic">Authorizations:</h5><svg class="sc-dIsUp iPqByX" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jQAxuV ccffaZ"><span class="sc-daBunf fcvuS"><span class="sc-dsXzNU dPrSxx"><i>ApiKeyAuth</i></span></span></div></div><div><h5 class="sc-iqAclL eONCmm">path<!-- --> Parameters</h5><table class="sc-hHEiqL VCQHZ"><tbody><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="thread_id"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">thread_id</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The ID of the thread to which the run and run step belongs.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="run_id"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">run_id</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The ID of the run to which the run step belongs.</p>
</div></div></div></td></tr><tr class="last "><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="step_id"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">step_id</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The ID of the run step to retrieve.</p>
</div></div></div></td></tr></tbody></table></div><div><h5 class="sc-iqAclL eONCmm">query<!-- --> Parameters</h5><table class="sc-hHEiqL VCQHZ"><tbody><tr class="last "><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="include[]"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">include[]</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa">Array of </span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">strings</span></div><div><span class="sc-laZMeE jWaWWE">Items<!-- --> <!-- -->Value<!-- -->:</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"step_details.tool_calls[*].file_search.results[*].content"</span> </div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>A list of additional fields to include in the response. Currently the only supported value is <code>step_details.tool_calls[*].file_search.results[*].content</code> to fetch the file search result content.</p>
<p>See the <a href="/docs/assistants/tools/file-search#customizing-file-search-settings">file search tool documentation</a> for more information.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-fIxmyt DvFer">Responses</h3><div><button class="sc-htmcrh lbYftx"><svg class="sc-dIsUp dqYXmg" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-fWWYYk cMoEZ">200<!-- --> </strong><span class="sc-jcwpoC eDjFAZ"><p>OK</p>
</span></button></div></div></div><div class="sc-jSFjdj sc-gKAaRy gBjRyf gcushC"><div class="sc-EZqKI fWsqvQ"><button class="sc-eEVmNe ilvUMs"><span type="get" class="sc-fmdNqN ihNycv http-verb get">get</span><span class="sc-jXcxbT fCEUju">/threads/{thread_id}/runs/{run_id}/steps/{step_id}</span><svg class="sc-dIsUp bRmrKA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ljsmAU flIrdF"><div class="sc-jlZJtj fQkroN"><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div><div tabindex="0" role="button"><div class="sc-dTSzeu dfUAUz"><span>https://api.openai.com/v1</span>/threads/{thread_id}/runs/{run_id}/steps/{step_id}</div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Response samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-60" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-61" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-61" aria-labelledby="react-tabs-60"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-bBjRSN kQSIAz">application/json</div></div><div class="sc-jgPyTC dSaTNC"><div class="sc-jNnpgg esZIbL"><div class="sc-giAqHp hMPeqJ"><button><div class="sc-carFqZ UksDl">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iJCRrE jCdxGr sc-dPaNzc gyljjx"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"object"</span>: <span class="token string">"thread.run.step"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"created_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"assistant_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"thread_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"run_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"type"</span>: <span class="token string">"message_creation"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token string">"in_progress"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"step_details"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <span class="token string">"message_creation"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"message_creation"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"message_id"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"last_error"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"code"</span>: <span class="token string">"server_error"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"message"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"expired_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"cancelled_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"failed_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"completed_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"property1"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"property2"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"usage"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"completion_tokens"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"prompt_tokens"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"total_tokens"</span>: <span class="token number">0</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Assistants/operation/submitToolOuputsToRun" data-section-id="tag/Assistants/operation/submitToolOuputsToRun" class="sc-eCApnc liLqNm"><div data-section-id="operation/submitToolOuputsToRun" id="operation/submitToolOuputsToRun" class="sc-iCoGMd gLxhOh"><div class="sc-hKFxyN juinod"><h2 class="sc-pNWdM eftmgB"><a class="sc-crzoAE iUxAWq" href="#tag/Assistants/operation/submitToolOuputsToRun" aria-label="tag/Assistants/operation/submitToolOuputsToRun"></a>When a run has the `status: "requires_action"` and `required_action.type` is `submit_tool_outputs`, this endpoint can be used to submit the outputs from the tool calls once they're all completed. All outputs must be submitted in a single request.
<!-- --> </h2><div class="sc-fcmMJX cvfxAX"><div class="sc-jUfyBS bhDyou"><h5 class="sc-iqAclL sc-fuISkM eONCmm hZIgic">Authorizations:</h5><svg class="sc-dIsUp iPqByX" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jQAxuV ccffaZ"><span class="sc-daBunf fcvuS"><span class="sc-dsXzNU dPrSxx"><i>ApiKeyAuth</i></span></span></div></div><div><h5 class="sc-iqAclL eONCmm">path<!-- --> Parameters</h5><table class="sc-hHEiqL VCQHZ"><tbody><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="thread_id"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">thread_id</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The ID of the <a href="/docs/api-reference/threads">thread</a> to which this run belongs.</p>
</div></div></div></td></tr><tr class="last "><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="run_id"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">run_id</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The ID of the run that requires the tool output submission.</p>
</div></div></div></td></tr></tbody></table></div><h5 class="sc-iqAclL eONCmm">Request Body schema: <span class="sc-cBoqAE eKyrDP">application/json</span></h5><div class="sc-iJCRrE sc-ciSkZP jCdxGr QGruV"></div><table class="sc-hHEiqL VCQHZ"><tbody><tr class=""><td class="sc-hBMUJo sc-fFSPTT sc-gSYDnn iwcKgn cAqMTE hTttpy" kind="field" title="tool_outputs"><span class="sc-iemWCZ bcnRwz"></span><button aria-label="expand properties"><span class="property-name">tool_outputs</span><svg class="sc-dIsUp hGHhhO" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa">Array of </span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">objects</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>A list of tools for which the outputs are being submitted.</p>
</div></div></div></td></tr><tr class="last "><td class="sc-hBMUJo sc-fFSPTT sc-gSYDnn iwcKgn cAqMTE hTttpy" kind="field" title="stream"><span class="sc-iemWCZ bcnRwz"></span><button aria-label="expand properties"><span class="property-name">stream</span><svg class="sc-dIsUp hGHhhO" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">boolean or null</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div></div></div></td></tr></tbody></table><div><h3 class="sc-fIxmyt DvFer">Responses</h3><div><button class="sc-htmcrh lbYftx"><svg class="sc-dIsUp dqYXmg" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-fWWYYk cMoEZ">200<!-- --> </strong><span class="sc-jcwpoC eDjFAZ"><p>OK</p>
</span></button></div></div></div><div class="sc-jSFjdj sc-gKAaRy gBjRyf gcushC"><div class="sc-EZqKI fWsqvQ"><button class="sc-eEVmNe ilvUMs"><span type="post" class="sc-fmdNqN ldMUmp http-verb post">post</span><span class="sc-jXcxbT fCEUju">/threads/{thread_id}/runs/{run_id}/submit_tool_outputs</span><svg class="sc-dIsUp bRmrKA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ljsmAU flIrdF"><div class="sc-jlZJtj fQkroN"><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div><div tabindex="0" role="button"><div class="sc-dTSzeu dfUAUz"><span>https://api.openai.com/v1</span>/threads/{thread_id}/runs/{run_id}/submit_tool_outputs</div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Request samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="react-tabs-62" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-63" tabindex="0" data-rttab="true">Payload</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-63" aria-labelledby="react-tabs-62"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-bBjRSN kQSIAz">application/json</div></div><div class="sc-jgPyTC dSaTNC"><div class="sc-jNnpgg esZIbL"><div class="sc-giAqHp hMPeqJ"><button><div class="sc-carFqZ UksDl">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iJCRrE jCdxGr sc-dPaNzc gyljjx"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"tool_outputs"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"tool_call_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"output"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"stream"</span>: <span class="token boolean">true</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Response samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-64" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-65" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-65" aria-labelledby="react-tabs-64"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-bBjRSN kQSIAz">application/json</div></div><div class="sc-jgPyTC dSaTNC"><div class="sc-jNnpgg esZIbL"><div class="sc-giAqHp hMPeqJ"><button><div class="sc-carFqZ UksDl">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iJCRrE jCdxGr sc-dPaNzc gyljjx"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"object"</span>: <span class="token string">"thread.run"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"created_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"thread_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"assistant_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token string">"queued"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"required_action"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <span class="token string">"submit_tool_outputs"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"submit_tool_outputs"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"tool_calls"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <span class="token string">"function"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"function"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"arguments"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"last_error"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"code"</span>: <span class="token string">"server_error"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"message"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"expires_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"started_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"cancelled_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"failed_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"completed_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"incomplete_details"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"reason"</span>: <span class="token string">"max_completion_tokens"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"model"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"instructions"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"tools"</span>: <span class="token punctuation">[ ]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"property1"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"property2"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"usage"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"completion_tokens"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"prompt_tokens"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"total_tokens"</span>: <span class="token number">0</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"temperature"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"top_p"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"max_prompt_tokens"</span>: <span class="token number">256</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"max_completion_tokens"</span>: <span class="token number">256</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"truncation_strategy"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <span class="token string">"auto"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"last_messages"</span>: <span class="token number">1</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"tool_choice"</span>: <span class="token string">"none"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"parallel_tool_calls"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"response_format"</span>: <span class="token string">"auto"</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Audio" data-section-id="tag/Audio" class="sc-eCApnc jlMQbh"><div class="sc-iCoGMd gLxhOh"><div class="sc-hKFxyN juinod"><h1 class="sc-fujyAs bpZWeL"><a class="sc-crzoAE iUxAWq" href="#tag/Audio" aria-label="tag/Audio"></a>Audio</h1></div></div><div class="sc-hKFxyN bJcDWV"><div class="sc-iJCRrE sc-ciSkZP jCdxGr QGruV redoc-markdown "><p>Turn audio into text or text into audio.</p>
</div></div></div><div id="tag/Audio/operation/createSpeech" data-section-id="tag/Audio/operation/createSpeech" class="sc-eCApnc liLqNm"><div data-section-id="operation/createSpeech" id="operation/createSpeech" class="sc-iCoGMd gLxhOh"><div class="sc-hKFxyN juinod"><h2 class="sc-pNWdM eftmgB"><a class="sc-crzoAE iUxAWq" href="#tag/Audio/operation/createSpeech" aria-label="tag/Audio/operation/createSpeech"></a>Generates audio from the input text.
Returns the audio file content, or a stream of audio events.
<!-- --> </h2><div class="sc-fcmMJX cvfxAX"><div class="sc-jUfyBS bhDyou"><h5 class="sc-iqAclL sc-fuISkM eONCmm hZIgic">Authorizations:</h5><svg class="sc-dIsUp iPqByX" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jQAxuV ccffaZ"><span class="sc-daBunf fcvuS"><span class="sc-dsXzNU dPrSxx"><i>ApiKeyAuth</i></span></span></div></div><h5 class="sc-iqAclL eONCmm">Request Body schema: <span class="sc-cBoqAE eKyrDP">application/json</span></h5><div class="sc-iJCRrE sc-ciSkZP jCdxGr QGruV"></div><table class="sc-hHEiqL VCQHZ"><tbody><tr class=""><td class="sc-hBMUJo sc-fFSPTT sc-gSYDnn iwcKgn cAqMTE hTttpy" kind="field" title="model"><span class="sc-iemWCZ bcnRwz"></span><button aria-label="expand properties"><span class="property-name">model</span><svg class="sc-dIsUp hGHhhO" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string or string</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>One of the available <a href="/docs/models#tts">TTS models</a>: <code>tts-1</code>, <code>tts-1-hd</code>, <code>gpt-4o-mini-tts</code>, or <code>gpt-4o-mini-tts-2025-12-15</code>.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="input"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">input</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span><span> <span class="sc-laZMeE sc-FRrlG jWaWWE gHBwqe"> <!-- --><= 4096 characters<!-- --> </span></span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The text to generate audio for. The maximum length is 4096 characters.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="instructions"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">instructions</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span><span> <span class="sc-laZMeE sc-FRrlG jWaWWE gHBwqe"> <!-- --><= 4096 characters<!-- --> </span></span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>Control the voice of your generated audio with additional instructions. Does not work with <code>tts-1</code> or <code>tts-1-hd</code>.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT sc-gSYDnn iwcKgn cAqMTE hTttpy" kind="field" title="voice"><span class="sc-iemWCZ bcnRwz"></span><button aria-label="expand properties"><span class="property-name">voice</span><svg class="sc-dIsUp hGHhhO" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">(VoiceIdsShared (VoiceIdsShared (string) or VoiceIdsShared (string))) or VoiceIdsOrCustomVoice (object)</span><span class="sc-laZMeE sc-eJocfa jWaWWE bArHDh"> (<!-- -->VoiceIdsOrCustomVoice<!-- -->) </span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The voice to use when generating the audio. Supported built-in voices are <code>alloy</code>, <code>ash</code>, <code>ballad</code>, <code>coral</code>, <code>echo</code>, <code>fable</code>, <code>onyx</code>, <code>nova</code>, <code>sage</code>, <code>shimmer</code>, <code>verse</code>, <code>marin</code>, and <code>cedar</code>. You may also provide a custom voice object with an <code>id</code>, for example <code>{ "id": "voice_1234" }</code>. Previews of the voices are available in the <a href="/docs/guides/text-to-speech#voice-options">Text to speech guide</a>.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="response_format"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">response_format</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div><div><span class="sc-laZMeE jWaWWE"> <!-- -->Default:<!-- --> </span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"mp3"</span></div><div><span class="sc-laZMeE jWaWWE"> <!-- -->Enum<!-- -->:</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"mp3"</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"opus"</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"aac"</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"flac"</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"wav"</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"pcm"</span> </div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The format to audio in. Supported formats are <code>mp3</code>, <code>opus</code>, <code>aac</code>, <code>flac</code>, <code>wav</code>, and <code>pcm</code>.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="speed"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">speed</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">number</span><span> <span class="sc-laZMeE sc-FRrlG jWaWWE gHBwqe"> <!-- -->[ 0.25 .. 4 ]<!-- --> </span></span></div><div><span class="sc-laZMeE jWaWWE"> <!-- -->Default:<!-- --> </span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">1</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The speed of the generated audio. Select a value from <code>0.25</code> to <code>4.0</code>. <code>1.0</code> is the default.</p>
</div></div></div></td></tr><tr class="last "><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="stream_format"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">stream_format</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div><div><span class="sc-laZMeE jWaWWE"> <!-- -->Default:<!-- --> </span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"audio"</span></div><div><span class="sc-laZMeE jWaWWE"> <!-- -->Enum<!-- -->:</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"sse"</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"audio"</span> </div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The format to stream the audio in. Supported formats are <code>sse</code> and <code>audio</code>. <code>sse</code> is not supported for <code>tts-1</code> or <code>tts-1-hd</code>.</p>
</div></div></div></td></tr></tbody></table><div><h3 class="sc-fIxmyt DvFer">Responses</h3><div><button class="sc-htmcrh lbYftx"><svg class="sc-dIsUp dqYXmg" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-fWWYYk cMoEZ">200<!-- --> </strong><span class="sc-jcwpoC eDjFAZ"><p>OK</p>
</span></button></div></div></div><div class="sc-jSFjdj sc-gKAaRy gBjRyf gcushC"><div class="sc-EZqKI fWsqvQ"><button class="sc-eEVmNe ilvUMs"><span type="post" class="sc-fmdNqN ldMUmp http-verb post">post</span><span class="sc-jXcxbT fCEUju">/audio/speech</span><svg class="sc-dIsUp bRmrKA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ljsmAU flIrdF"><div class="sc-jlZJtj fQkroN"><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div><div tabindex="0" role="button"><div class="sc-dTSzeu dfUAUz"><span>https://api.openai.com/v1</span>/audio/speech</div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Request samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="react-tabs-66" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-67" tabindex="0" data-rttab="true">Payload</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-67" aria-labelledby="react-tabs-66"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-bBjRSN kQSIAz">application/json</div></div><div class="sc-jgPyTC dSaTNC"><div class="sc-jNnpgg esZIbL"><div class="sc-giAqHp hMPeqJ"><button><div class="sc-carFqZ UksDl">Copy</div></button></div><div class="sc-iJCRrE jCdxGr sc-dPaNzc gyljjx"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"model"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"input"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"instructions"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"voice"</span>: <span class="token string">"ash"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"response_format"</span>: <span class="token string">"mp3"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"speed"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"stream_format"</span>: <span class="token string">"sse"</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Audio/operation/createTranscription" data-section-id="tag/Audio/operation/createTranscription" class="sc-eCApnc liLqNm"><div data-section-id="operation/createTranscription" id="operation/createTranscription" class="sc-iCoGMd gLxhOh"><div class="sc-hKFxyN juinod"><h2 class="sc-pNWdM eftmgB"><a class="sc-crzoAE iUxAWq" href="#tag/Audio/operation/createTranscription" aria-label="tag/Audio/operation/createTranscription"></a>Transcribes audio into the input language.
Returns a transcription object in `json`, `diarized_json`, or `verbose_json`
format, or a stream of transcript events.
<!-- --> </h2><div class="sc-fcmMJX cvfxAX"><div class="sc-jUfyBS bhDyou"><h5 class="sc-iqAclL sc-fuISkM eONCmm hZIgic">Authorizations:</h5><svg class="sc-dIsUp iPqByX" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jQAxuV ccffaZ"><span class="sc-daBunf fcvuS"><span class="sc-dsXzNU dPrSxx"><i>ApiKeyAuth</i></span></span></div></div><h5 class="sc-iqAclL eONCmm">Request Body schema: <span class="sc-cBoqAE eKyrDP">multipart/form-data</span></h5><div class="sc-iJCRrE sc-ciSkZP jCdxGr QGruV"></div><table class="sc-hHEiqL VCQHZ"><tbody><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="file"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">file</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa"> <!-- --><<!-- -->binary<!-- -->><!-- --> </span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The audio file object (not file name) to transcribe, in one of these formats: flac, mp3, mp4, mpeg, mpga, m4a, ogg, wav, or webm.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT sc-gSYDnn iwcKgn cAqMTE hTttpy" kind="field" title="model"><span class="sc-iemWCZ bcnRwz"></span><button aria-label="expand properties"><span class="property-name">model</span><svg class="sc-dIsUp hGHhhO" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string or string</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>ID of the model to use. The options are <code>gpt-4o-transcribe</code>, <code>gpt-4o-mini-transcribe</code>, <code>gpt-4o-mini-transcribe-2025-12-15</code>, <code>whisper-1</code> (which is powered by our open source Whisper V2 model), and <code>gpt-4o-transcribe-diarize</code>.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="language"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">language</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The language of the input audio. Supplying the input language in <a href="https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes">ISO-639-1</a> (e.g. <code>en</code>) format will improve accuracy and latency.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="prompt"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">prompt</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>An optional text to guide the model's style or continue a previous audio segment. The <a href="/docs/guides/speech-to-text#prompting">prompt</a> should match the audio language. This field is not supported when using <code>gpt-4o-transcribe-diarize</code>.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="response_format"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">response_format</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span><span class="sc-laZMeE sc-eJocfa jWaWWE bArHDh"> (<!-- -->AudioResponseFormat<!-- -->) </span></div><div><span class="sc-laZMeE jWaWWE"> <!-- -->Enum<!-- -->:</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"json"</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"text"</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"srt"</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"verbose_json"</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"vtt"</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"diarized_json"</span> </div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The format of the output, in one of these options: <code>json</code>, <code>text</code>, <code>srt</code>, <code>verbose_json</code>, <code>vtt</code>, or <code>diarized_json</code>. For <code>gpt-4o-transcribe</code> and <code>gpt-4o-mini-transcribe</code>, the only supported format is <code>json</code>. For <code>gpt-4o-transcribe-diarize</code>, the supported formats are <code>json</code>, <code>text</code>, and <code>diarized_json</code>, with <code>diarized_json</code> required to receive speaker annotations.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="temperature"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">temperature</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">number</span></div><div><span class="sc-laZMeE jWaWWE"> <!-- -->Default:<!-- --> </span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">0</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The sampling temperature, between 0 and 1. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic. If set to 0, the model will use <a href="https://en.wikipedia.org/wiki/Log_probability">log probability</a> to automatically increase the temperature until certain thresholds are hit.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="include"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">include</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa">Array of </span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">strings</span><span class="sc-laZMeE sc-eJocfa jWaWWE bArHDh"> (<!-- -->TranscriptionInclude<!-- -->) </span></div><div><span class="sc-laZMeE jWaWWE">Items<!-- --> <!-- -->Value<!-- -->:</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"logprobs"</span> </div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>Additional information to include in the transcription response.
<code>logprobs</code> will return the log probabilities of the tokens in the
response to understand the model's confidence in the transcription.
<code>logprobs</code> only works with response_format set to <code>json</code> and only with
the models <code>gpt-4o-transcribe</code>, <code>gpt-4o-mini-transcribe</code>, and <code>gpt-4o-mini-transcribe-2025-12-15</code>. This field is not supported when using <code>gpt-4o-transcribe-diarize</code>.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="timestamp_granularities"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">timestamp_granularities</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa">Array of </span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">strings</span></div><div><span class="sc-laZMeE jWaWWE"> <!-- -->Default:<!-- --> </span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">["segment"]</span></div><div><span class="sc-laZMeE jWaWWE">Items<!-- --> <!-- -->Enum<!-- -->:</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"word"</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"segment"</span> </div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The timestamp granularities to populate for this transcription. <code>response_format</code> must be set <code>verbose_json</code> to use timestamp granularities. Either or both of these options are supported: <code>word</code>, or <code>segment</code>. Note: There is no additional latency for segment timestamps, but generating word timestamps incurs additional latency.
This option is not available for <code>gpt-4o-transcribe-diarize</code>.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT sc-gSYDnn iwcKgn cAqMTE hTttpy" kind="field" title="stream"><span class="sc-iemWCZ bcnRwz"></span><button aria-label="expand properties"><span class="property-name">stream</span><svg class="sc-dIsUp hGHhhO" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">boolean or null</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT sc-gSYDnn iwcKgn cAqMTE hTttpy" kind="field" title="chunking_strategy"><span class="sc-iemWCZ bcnRwz"></span><button aria-label="expand properties"><span class="property-name">chunking_strategy</span><svg class="sc-dIsUp hGHhhO" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">(string or VadConfig (object)) or null</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="known_speaker_names"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">known_speaker_names</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa">Array of </span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">strings</span><span> <span class="sc-laZMeE sc-FRrlG jWaWWE gHBwqe"> <!-- --><= 4 items<!-- --> </span></span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>Optional list of speaker names that correspond to the audio samples provided in <code>known_speaker_references[]</code>. Each entry should be a short identifier (for example <code>customer</code> or <code>agent</code>). Up to 4 speakers are supported.</p>
</div></div></div></td></tr><tr class="last "><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="known_speaker_references"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">known_speaker_references</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa">Array of </span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">strings</span><span> <span class="sc-laZMeE sc-FRrlG jWaWWE gHBwqe"> <!-- --><= 4 items<!-- --> </span></span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>Optional list of audio samples (as <a href="https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/Data_URLs">data URLs</a>) that contain known speaker references matching <code>known_speaker_names[]</code>. Each sample must be between 2 and 10 seconds, and can use any of the same input audio formats supported by <code>file</code>.</p>
</div></div></div></td></tr></tbody></table><div><h3 class="sc-fIxmyt DvFer">Responses</h3><div><button class="sc-htmcrh lbYftx"><svg class="sc-dIsUp dqYXmg" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-fWWYYk cMoEZ">200<!-- --> </strong><span class="sc-jcwpoC eDjFAZ"><p>OK</p>
</span></button></div></div></div><div class="sc-jSFjdj sc-gKAaRy gBjRyf gcushC"><div class="sc-EZqKI fWsqvQ"><button class="sc-eEVmNe ilvUMs"><span type="post" class="sc-fmdNqN ldMUmp http-verb post">post</span><span class="sc-jXcxbT fCEUju">/audio/transcriptions</span><svg class="sc-dIsUp bRmrKA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ljsmAU flIrdF"><div class="sc-jlZJtj fQkroN"><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div><div tabindex="0" role="button"><div class="sc-dTSzeu dfUAUz"><span>https://api.openai.com/v1</span>/audio/transcriptions</div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Response samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-68" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-69" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-69" aria-labelledby="react-tabs-68"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-hiKfDv sc-khIgEk bycQNU hLNtis"><svg class="sc-jJMGnK gVpQmv" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option selected="" value="application/json">application/json</option><option value="text/event-stream">text/event-stream</option></select><label>application/json</label></div></div><div class="sc-jgPyTC dSaTNC"><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Example</span><div class="sc-hiKfDv sc-khIgEk bycQNU hLNtis"><svg class="sc-jJMGnK gVpQmv" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option selected="" value="CreateTranscriptionResponseJson">CreateTranscriptionResponseJson</option><option value="CreateTranscriptionResponseDiarizedJson">CreateTranscriptionResponseDiarizedJson</option><option value="CreateTranscriptionResponseVerboseJson">CreateTranscriptionResponseVerboseJson</option></select><label>CreateTranscriptionResponseJson</label></div></div><div><div class="sc-jNnpgg esZIbL"><div class="sc-giAqHp hMPeqJ"><button><div class="sc-carFqZ UksDl">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iJCRrE jCdxGr sc-dPaNzc gyljjx"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"text"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"logprobs"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"token"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"logprob"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"bytes"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><span class="token number">0</span></div></li></ul><span class="token punctuation">]</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"usage"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <span class="token string">"tokens"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"input_tokens"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"input_token_details"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"text_tokens"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"audio_tokens"</span>: <span class="token number">0</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"output_tokens"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"total_tokens"</span>: <span class="token number">0</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Audio/operation/createTranslation" data-section-id="tag/Audio/operation/createTranslation" class="sc-eCApnc liLqNm"><div data-section-id="operation/createTranslation" id="operation/createTranslation" class="sc-iCoGMd gLxhOh"><div class="sc-hKFxyN juinod"><h2 class="sc-pNWdM eftmgB"><a class="sc-crzoAE iUxAWq" href="#tag/Audio/operation/createTranslation" aria-label="tag/Audio/operation/createTranslation"></a>Translates audio into English.<!-- --> </h2><div class="sc-fcmMJX cvfxAX"><div class="sc-jUfyBS bhDyou"><h5 class="sc-iqAclL sc-fuISkM eONCmm hZIgic">Authorizations:</h5><svg class="sc-dIsUp iPqByX" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jQAxuV ccffaZ"><span class="sc-daBunf fcvuS"><span class="sc-dsXzNU dPrSxx"><i>ApiKeyAuth</i></span></span></div></div><h5 class="sc-iqAclL eONCmm">Request Body schema: <span class="sc-cBoqAE eKyrDP">multipart/form-data</span></h5><div class="sc-iJCRrE sc-ciSkZP jCdxGr QGruV"></div><table class="sc-hHEiqL VCQHZ"><tbody><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="file"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">file</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa"> <!-- --><<!-- -->binary<!-- -->><!-- --> </span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The audio file object (not file name) translate, in one of these formats: flac, mp3, mp4, mpeg, mpga, m4a, ogg, wav, or webm.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT sc-gSYDnn iwcKgn cAqMTE hTttpy" kind="field" title="model"><span class="sc-iemWCZ bcnRwz"></span><button aria-label="expand properties"><span class="property-name">model</span><svg class="sc-dIsUp hGHhhO" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string or string</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>ID of the model to use. Only <code>whisper-1</code> (which is powered by our open source Whisper V2 model) is currently available.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="prompt"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">prompt</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>An optional text to guide the model's style or continue a previous audio segment. The <a href="/docs/guides/speech-to-text#prompting">prompt</a> should be in English.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="response_format"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">response_format</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div><div><span class="sc-laZMeE jWaWWE"> <!-- -->Default:<!-- --> </span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"json"</span></div><div><span class="sc-laZMeE jWaWWE"> <!-- -->Enum<!-- -->:</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"json"</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"text"</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"srt"</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"verbose_json"</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"vtt"</span> </div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The format of the output, in one of these options: <code>json</code>, <code>text</code>, <code>srt</code>, <code>verbose_json</code>, or <code>vtt</code>.</p>
</div></div></div></td></tr><tr class="last "><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="temperature"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">temperature</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">number</span></div><div><span class="sc-laZMeE jWaWWE"> <!-- -->Default:<!-- --> </span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">0</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The sampling temperature, between 0 and 1. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic. If set to 0, the model will use <a href="https://en.wikipedia.org/wiki/Log_probability">log probability</a> to automatically increase the temperature until certain thresholds are hit.</p>
</div></div></div></td></tr></tbody></table><div><h3 class="sc-fIxmyt DvFer">Responses</h3><div><button class="sc-htmcrh lbYftx"><svg class="sc-dIsUp dqYXmg" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-fWWYYk cMoEZ">200<!-- --> </strong><span class="sc-jcwpoC eDjFAZ"><p>OK</p>
</span></button></div></div></div><div class="sc-jSFjdj sc-gKAaRy gBjRyf gcushC"><div class="sc-EZqKI fWsqvQ"><button class="sc-eEVmNe ilvUMs"><span type="post" class="sc-fmdNqN ldMUmp http-verb post">post</span><span class="sc-jXcxbT fCEUju">/audio/translations</span><svg class="sc-dIsUp bRmrKA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ljsmAU flIrdF"><div class="sc-jlZJtj fQkroN"><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div><div tabindex="0" role="button"><div class="sc-dTSzeu dfUAUz"><span>https://api.openai.com/v1</span>/audio/translations</div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Response samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-70" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-71" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-71" aria-labelledby="react-tabs-70"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-bBjRSN kQSIAz">application/json</div></div><div class="sc-jgPyTC dSaTNC"><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Example</span><div class="sc-hiKfDv sc-khIgEk bycQNU hLNtis"><svg class="sc-jJMGnK gVpQmv" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option selected="" value="CreateTranslationResponseJson">CreateTranslationResponseJson</option><option value="CreateTranslationResponseVerboseJson">CreateTranslationResponseVerboseJson</option></select><label>CreateTranslationResponseJson</label></div></div><div><div class="sc-jNnpgg esZIbL"><div class="sc-giAqHp hMPeqJ"><button><div class="sc-carFqZ UksDl">Copy</div></button></div><div class="sc-iJCRrE jCdxGr sc-dPaNzc gyljjx"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"text"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Audio/operation/createVoiceConsent" data-section-id="tag/Audio/operation/createVoiceConsent" class="sc-eCApnc liLqNm"><div data-section-id="operation/createVoiceConsent" id="operation/createVoiceConsent" class="sc-iCoGMd gLxhOh"><div class="sc-hKFxyN juinod"><h2 class="sc-pNWdM eftmgB"><a class="sc-crzoAE iUxAWq" href="#tag/Audio/operation/createVoiceConsent" aria-label="tag/Audio/operation/createVoiceConsent"></a>Upload a voice consent recording.<!-- --> </h2><div class="sc-iGkqmO hCTIhr"><div class="sc-iJCRrE sc-ciSkZP jCdxGr QGruV"><p>Upload a consent recording that authorizes creation of a custom voice.</p>
<p>See the <a href="/docs/guides/text-to-speech#custom-voices">custom voices guide</a> for requirements and best practices. Custom voices are limited to eligible customers.</p>
</div></div><div class="sc-fcmMJX cvfxAX"><div class="sc-jUfyBS bhDyou"><h5 class="sc-iqAclL sc-fuISkM eONCmm hZIgic">Authorizations:</h5><svg class="sc-dIsUp iPqByX" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jQAxuV ccffaZ"><span class="sc-daBunf fcvuS"><span class="sc-dsXzNU dPrSxx"><i>ApiKeyAuth</i></span></span></div></div><h5 class="sc-iqAclL eONCmm">Request Body schema: <span class="sc-cBoqAE eKyrDP">multipart/form-data</span></h5><div class="sc-iJCRrE sc-ciSkZP jCdxGr QGruV"></div><table class="sc-hHEiqL VCQHZ"><tbody><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="name"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">name</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The label to use for this consent recording.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="recording"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">recording</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa"> <!-- --><<!-- -->binary<!-- -->><!-- --> </span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The consent audio recording file. Maximum size is 10 MiB.</p>
<p>Supported MIME types:
<code>audio/mpeg</code>, <code>audio/wav</code>, <code>audio/x-wav</code>, <code>audio/ogg</code>, <code>audio/aac</code>, <code>audio/flac</code>, <code>audio/webm</code>, <code>audio/mp4</code>.</p>
</div></div></div></td></tr><tr class="last "><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="language"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">language</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The BCP 47 language tag for the consent phrase (for example, <code>en-US</code>).</p>
</div></div></div></td></tr></tbody></table><div><h3 class="sc-fIxmyt DvFer">Responses</h3><div><button class="sc-htmcrh lbYftx"><svg class="sc-dIsUp dqYXmg" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-fWWYYk cMoEZ">200<!-- --> </strong><span class="sc-jcwpoC eDjFAZ"><p>OK</p>
</span></button></div></div></div><div class="sc-jSFjdj sc-gKAaRy gBjRyf gcushC"><div class="sc-EZqKI fWsqvQ"><button class="sc-eEVmNe ilvUMs"><span type="post" class="sc-fmdNqN ldMUmp http-verb post">post</span><span class="sc-jXcxbT fCEUju">/audio/voice_consents</span><svg class="sc-dIsUp bRmrKA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ljsmAU flIrdF"><div class="sc-jlZJtj fQkroN"><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div><div tabindex="0" role="button"><div class="sc-dTSzeu dfUAUz"><span>https://api.openai.com/v1</span>/audio/voice_consents</div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Response samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-72" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-73" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-73" aria-labelledby="react-tabs-72"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-bBjRSN kQSIAz">application/json</div></div><div class="sc-jgPyTC dSaTNC"><div class="sc-jNnpgg esZIbL"><div class="sc-giAqHp hMPeqJ"><button><div class="sc-carFqZ UksDl">Copy</div></button></div><div class="sc-iJCRrE jCdxGr sc-dPaNzc gyljjx"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"object"</span>: <span class="token string">"audio.voice_consent"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">"cons_1234"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"language"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"created_at"</span>: <span class="token number">0</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Audio/operation/listVoiceConsents" data-section-id="tag/Audio/operation/listVoiceConsents" class="sc-eCApnc liLqNm"><div data-section-id="operation/listVoiceConsents" id="operation/listVoiceConsents" class="sc-iCoGMd gLxhOh"><div class="sc-hKFxyN juinod"><h2 class="sc-pNWdM eftmgB"><a class="sc-crzoAE iUxAWq" href="#tag/Audio/operation/listVoiceConsents" aria-label="tag/Audio/operation/listVoiceConsents"></a>Returns a list of voice consent recordings.<!-- --> </h2><div class="sc-iGkqmO hCTIhr"><div class="sc-iJCRrE sc-ciSkZP jCdxGr QGruV"><p>List consent recordings available to your organization for creating custom voices.</p>
<p>See the <a href="/docs/guides/text-to-speech#custom-voices">custom voices guide</a>. Custom voices are limited to eligible customers.</p>
</div></div><div class="sc-fcmMJX cvfxAX"><div class="sc-jUfyBS bhDyou"><h5 class="sc-iqAclL sc-fuISkM eONCmm hZIgic">Authorizations:</h5><svg class="sc-dIsUp iPqByX" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jQAxuV ccffaZ"><span class="sc-daBunf fcvuS"><span class="sc-dsXzNU dPrSxx"><i>ApiKeyAuth</i></span></span></div></div><div><h5 class="sc-iqAclL eONCmm">query<!-- --> Parameters</h5><table class="sc-hHEiqL VCQHZ"><tbody><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="after"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">after</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>A cursor for use in pagination. <code>after</code> is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list.</p>
</div></div></div></td></tr><tr class="last "><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="limit"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">limit</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">integer</span></div><div><span class="sc-laZMeE jWaWWE"> <!-- -->Default:<!-- --> </span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">20</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-fIxmyt DvFer">Responses</h3><div><button class="sc-htmcrh lbYftx"><svg class="sc-dIsUp dqYXmg" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-fWWYYk cMoEZ">200<!-- --> </strong><span class="sc-jcwpoC eDjFAZ"><p>OK</p>
</span></button></div></div></div><div class="sc-jSFjdj sc-gKAaRy gBjRyf gcushC"><div class="sc-EZqKI fWsqvQ"><button class="sc-eEVmNe ilvUMs"><span type="get" class="sc-fmdNqN ihNycv http-verb get">get</span><span class="sc-jXcxbT fCEUju">/audio/voice_consents</span><svg class="sc-dIsUp bRmrKA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ljsmAU flIrdF"><div class="sc-jlZJtj fQkroN"><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div><div tabindex="0" role="button"><div class="sc-dTSzeu dfUAUz"><span>https://api.openai.com/v1</span>/audio/voice_consents</div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Response samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-74" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-75" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-75" aria-labelledby="react-tabs-74"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-bBjRSN kQSIAz">application/json</div></div><div class="sc-jgPyTC dSaTNC"><div class="sc-jNnpgg esZIbL"><div class="sc-giAqHp hMPeqJ"><button><div class="sc-carFqZ UksDl">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iJCRrE jCdxGr sc-dPaNzc gyljjx"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"object"</span>: <span class="token string">"list"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"object"</span>: <span class="token string">"audio.voice_consent"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"id"</span>: <span class="token string">"cons_1234"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"language"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"created_at"</span>: <span class="token number">0</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"first_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"last_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"has_more"</span>: <span class="token boolean">true</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Audio/operation/getVoiceConsent" data-section-id="tag/Audio/operation/getVoiceConsent" class="sc-eCApnc liLqNm"><div data-section-id="operation/getVoiceConsent" id="operation/getVoiceConsent" class="sc-iCoGMd gLxhOh"><div class="sc-hKFxyN juinod"><h2 class="sc-pNWdM eftmgB"><a class="sc-crzoAE iUxAWq" href="#tag/Audio/operation/getVoiceConsent" aria-label="tag/Audio/operation/getVoiceConsent"></a>Retrieves a voice consent recording.<!-- --> </h2><div class="sc-iGkqmO hCTIhr"><div class="sc-iJCRrE sc-ciSkZP jCdxGr QGruV"><p>Retrieve consent recording metadata used for creating custom voices.</p>
<p>See the <a href="/docs/guides/text-to-speech#custom-voices">custom voices guide</a>. Custom voices are limited to eligible customers.</p>
</div></div><div class="sc-fcmMJX cvfxAX"><div class="sc-jUfyBS bhDyou"><h5 class="sc-iqAclL sc-fuISkM eONCmm hZIgic">Authorizations:</h5><svg class="sc-dIsUp iPqByX" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jQAxuV ccffaZ"><span class="sc-daBunf fcvuS"><span class="sc-dsXzNU dPrSxx"><i>ApiKeyAuth</i></span></span></div></div><div><h5 class="sc-iqAclL eONCmm">path<!-- --> Parameters</h5><table class="sc-hHEiqL VCQHZ"><tbody><tr class="last "><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="consent_id"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">consent_id</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The ID of the consent recording to retrieve.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-fIxmyt DvFer">Responses</h3><div><button class="sc-htmcrh lbYftx"><svg class="sc-dIsUp dqYXmg" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-fWWYYk cMoEZ">200<!-- --> </strong><span class="sc-jcwpoC eDjFAZ"><p>OK</p>
</span></button></div></div></div><div class="sc-jSFjdj sc-gKAaRy gBjRyf gcushC"><div class="sc-EZqKI fWsqvQ"><button class="sc-eEVmNe ilvUMs"><span type="get" class="sc-fmdNqN ihNycv http-verb get">get</span><span class="sc-jXcxbT fCEUju">/audio/voice_consents/{consent_id}</span><svg class="sc-dIsUp bRmrKA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ljsmAU flIrdF"><div class="sc-jlZJtj fQkroN"><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div><div tabindex="0" role="button"><div class="sc-dTSzeu dfUAUz"><span>https://api.openai.com/v1</span>/audio/voice_consents/{consent_id}</div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Response samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-76" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-77" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-77" aria-labelledby="react-tabs-76"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-bBjRSN kQSIAz">application/json</div></div><div class="sc-jgPyTC dSaTNC"><div class="sc-jNnpgg esZIbL"><div class="sc-giAqHp hMPeqJ"><button><div class="sc-carFqZ UksDl">Copy</div></button></div><div class="sc-iJCRrE jCdxGr sc-dPaNzc gyljjx"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"object"</span>: <span class="token string">"audio.voice_consent"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">"cons_1234"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"language"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"created_at"</span>: <span class="token number">0</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Audio/operation/updateVoiceConsent" data-section-id="tag/Audio/operation/updateVoiceConsent" class="sc-eCApnc liLqNm"><div data-section-id="operation/updateVoiceConsent" id="operation/updateVoiceConsent" class="sc-iCoGMd gLxhOh"><div class="sc-hKFxyN juinod"><h2 class="sc-pNWdM eftmgB"><a class="sc-crzoAE iUxAWq" href="#tag/Audio/operation/updateVoiceConsent" aria-label="tag/Audio/operation/updateVoiceConsent"></a>Updates a voice consent recording (metadata only).<!-- --> </h2><div class="sc-iGkqmO hCTIhr"><div class="sc-iJCRrE sc-ciSkZP jCdxGr QGruV"><p>Update consent recording metadata used for creating custom voices. This endpoint updates metadata only and does not replace the underlying audio.</p>
<p>See the <a href="/docs/guides/text-to-speech#custom-voices">custom voices guide</a>. Custom voices are limited to eligible customers.</p>
</div></div><div class="sc-fcmMJX cvfxAX"><div class="sc-jUfyBS bhDyou"><h5 class="sc-iqAclL sc-fuISkM eONCmm hZIgic">Authorizations:</h5><svg class="sc-dIsUp iPqByX" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jQAxuV ccffaZ"><span class="sc-daBunf fcvuS"><span class="sc-dsXzNU dPrSxx"><i>ApiKeyAuth</i></span></span></div></div><div><h5 class="sc-iqAclL eONCmm">path<!-- --> Parameters</h5><table class="sc-hHEiqL VCQHZ"><tbody><tr class="last "><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="consent_id"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">consent_id</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The ID of the consent recording to update.</p>
</div></div></div></td></tr></tbody></table></div><h5 class="sc-iqAclL eONCmm">Request Body schema: <span class="sc-cBoqAE eKyrDP">application/json</span></h5><div class="sc-iJCRrE sc-ciSkZP jCdxGr QGruV"></div><table class="sc-hHEiqL VCQHZ"><tbody><tr class="last "><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="name"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">name</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The updated label for this consent recording.</p>
</div></div></div></td></tr></tbody></table><div><h3 class="sc-fIxmyt DvFer">Responses</h3><div><button class="sc-htmcrh lbYftx"><svg class="sc-dIsUp dqYXmg" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-fWWYYk cMoEZ">200<!-- --> </strong><span class="sc-jcwpoC eDjFAZ"><p>OK</p>
</span></button></div></div></div><div class="sc-jSFjdj sc-gKAaRy gBjRyf gcushC"><div class="sc-EZqKI fWsqvQ"><button class="sc-eEVmNe ilvUMs"><span type="post" class="sc-fmdNqN ldMUmp http-verb post">post</span><span class="sc-jXcxbT fCEUju">/audio/voice_consents/{consent_id}</span><svg class="sc-dIsUp bRmrKA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ljsmAU flIrdF"><div class="sc-jlZJtj fQkroN"><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div><div tabindex="0" role="button"><div class="sc-dTSzeu dfUAUz"><span>https://api.openai.com/v1</span>/audio/voice_consents/{consent_id}</div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Request samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="react-tabs-78" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-79" tabindex="0" data-rttab="true">Payload</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-79" aria-labelledby="react-tabs-78"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-bBjRSN kQSIAz">application/json</div></div><div class="sc-jgPyTC dSaTNC"><div class="sc-jNnpgg esZIbL"><div class="sc-giAqHp hMPeqJ"><button><div class="sc-carFqZ UksDl">Copy</div></button></div><div class="sc-iJCRrE jCdxGr sc-dPaNzc gyljjx"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Response samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-80" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-81" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-81" aria-labelledby="react-tabs-80"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-bBjRSN kQSIAz">application/json</div></div><div class="sc-jgPyTC dSaTNC"><div class="sc-jNnpgg esZIbL"><div class="sc-giAqHp hMPeqJ"><button><div class="sc-carFqZ UksDl">Copy</div></button></div><div class="sc-iJCRrE jCdxGr sc-dPaNzc gyljjx"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"object"</span>: <span class="token string">"audio.voice_consent"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">"cons_1234"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"language"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"created_at"</span>: <span class="token number">0</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Audio/operation/deleteVoiceConsent" data-section-id="tag/Audio/operation/deleteVoiceConsent" class="sc-eCApnc liLqNm"><div data-section-id="operation/deleteVoiceConsent" id="operation/deleteVoiceConsent" class="sc-iCoGMd gLxhOh"><div class="sc-hKFxyN juinod"><h2 class="sc-pNWdM eftmgB"><a class="sc-crzoAE iUxAWq" href="#tag/Audio/operation/deleteVoiceConsent" aria-label="tag/Audio/operation/deleteVoiceConsent"></a>Deletes a voice consent recording.<!-- --> </h2><div class="sc-iGkqmO hCTIhr"><div class="sc-iJCRrE sc-ciSkZP jCdxGr QGruV"><p>Delete a consent recording that was uploaded for creating custom voices.</p>
<p>See the <a href="/docs/guides/text-to-speech#custom-voices">custom voices guide</a>. Custom voices are limited to eligible customers.</p>
</div></div><div class="sc-fcmMJX cvfxAX"><div class="sc-jUfyBS bhDyou"><h5 class="sc-iqAclL sc-fuISkM eONCmm hZIgic">Authorizations:</h5><svg class="sc-dIsUp iPqByX" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jQAxuV ccffaZ"><span class="sc-daBunf fcvuS"><span class="sc-dsXzNU dPrSxx"><i>ApiKeyAuth</i></span></span></div></div><div><h5 class="sc-iqAclL eONCmm">path<!-- --> Parameters</h5><table class="sc-hHEiqL VCQHZ"><tbody><tr class="last "><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="consent_id"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">consent_id</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The ID of the consent recording to delete.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-fIxmyt DvFer">Responses</h3><div><button class="sc-htmcrh lbYftx"><svg class="sc-dIsUp dqYXmg" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-fWWYYk cMoEZ">200<!-- --> </strong><span class="sc-jcwpoC eDjFAZ"><p>OK</p>
</span></button></div></div></div><div class="sc-jSFjdj sc-gKAaRy gBjRyf gcushC"><div class="sc-EZqKI fWsqvQ"><button class="sc-eEVmNe ilvUMs"><span type="delete" class="sc-fmdNqN bJzUtf http-verb delete">delete</span><span class="sc-jXcxbT fCEUju">/audio/voice_consents/{consent_id}</span><svg class="sc-dIsUp bRmrKA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ljsmAU flIrdF"><div class="sc-jlZJtj fQkroN"><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div><div tabindex="0" role="button"><div class="sc-dTSzeu dfUAUz"><span>https://api.openai.com/v1</span>/audio/voice_consents/{consent_id}</div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Response samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-82" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-83" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-83" aria-labelledby="react-tabs-82"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-bBjRSN kQSIAz">application/json</div></div><div class="sc-jgPyTC dSaTNC"><div class="sc-jNnpgg esZIbL"><div class="sc-giAqHp hMPeqJ"><button><div class="sc-carFqZ UksDl">Copy</div></button></div><div class="sc-iJCRrE jCdxGr sc-dPaNzc gyljjx"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">"cons_1234"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"object"</span>: <span class="token string">"audio.voice_consent"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"deleted"</span>: <span class="token boolean">true</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Audio/operation/createVoice" data-section-id="tag/Audio/operation/createVoice" class="sc-eCApnc liLqNm"><div data-section-id="operation/createVoice" id="operation/createVoice" class="sc-iCoGMd gLxhOh"><div class="sc-hKFxyN juinod"><h2 class="sc-pNWdM eftmgB"><a class="sc-crzoAE iUxAWq" href="#tag/Audio/operation/createVoice" aria-label="tag/Audio/operation/createVoice"></a>Creates a custom voice.<!-- --> </h2><div class="sc-iGkqmO hCTIhr"><div class="sc-iJCRrE sc-ciSkZP jCdxGr QGruV"><p>Create a custom voice you can use for audio output (for example, in Text-to-Speech and the Realtime API). This requires an audio sample and a previously uploaded consent recording.</p>
<p>See the <a href="/docs/guides/text-to-speech#custom-voices">custom voices guide</a> for requirements and best practices. Custom voices are limited to eligible customers.</p>
</div></div><div class="sc-fcmMJX cvfxAX"><div class="sc-jUfyBS bhDyou"><h5 class="sc-iqAclL sc-fuISkM eONCmm hZIgic">Authorizations:</h5><svg class="sc-dIsUp iPqByX" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jQAxuV ccffaZ"><span class="sc-daBunf fcvuS"><span class="sc-dsXzNU dPrSxx"><i>ApiKeyAuth</i></span></span></div></div><h5 class="sc-iqAclL eONCmm">Request Body schema: <span class="sc-cBoqAE eKyrDP">multipart/form-data</span></h5><div class="sc-iJCRrE sc-ciSkZP jCdxGr QGruV"></div><table class="sc-hHEiqL VCQHZ"><tbody><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="name"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">name</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The name of the new voice.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="audio_sample"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">audio_sample</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa"> <!-- --><<!-- -->binary<!-- -->><!-- --> </span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The sample audio recording file. Maximum size is 10 MiB.</p>
<p>Supported MIME types:
<code>audio/mpeg</code>, <code>audio/wav</code>, <code>audio/x-wav</code>, <code>audio/ogg</code>, <code>audio/aac</code>, <code>audio/flac</code>, <code>audio/webm</code>, <code>audio/mp4</code>.</p>
</div></div></div></td></tr><tr class="last "><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="consent"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">consent</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The consent recording ID (for example, <code>cons_1234</code>).</p>
</div></div></div></td></tr></tbody></table><div><h3 class="sc-fIxmyt DvFer">Responses</h3><div><button class="sc-htmcrh lbYftx"><svg class="sc-dIsUp dqYXmg" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-fWWYYk cMoEZ">200<!-- --> </strong><span class="sc-jcwpoC eDjFAZ"><p>OK</p>
</span></button></div></div></div><div class="sc-jSFjdj sc-gKAaRy gBjRyf gcushC"><div class="sc-EZqKI fWsqvQ"><button class="sc-eEVmNe ilvUMs"><span type="post" class="sc-fmdNqN ldMUmp http-verb post">post</span><span class="sc-jXcxbT fCEUju">/audio/voices</span><svg class="sc-dIsUp bRmrKA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ljsmAU flIrdF"><div class="sc-jlZJtj fQkroN"><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div><div tabindex="0" role="button"><div class="sc-dTSzeu dfUAUz"><span>https://api.openai.com/v1</span>/audio/voices</div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Response samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-84" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-85" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-85" aria-labelledby="react-tabs-84"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-bBjRSN kQSIAz">application/json</div></div><div class="sc-jgPyTC dSaTNC"><div class="sc-jNnpgg esZIbL"><div class="sc-giAqHp hMPeqJ"><button><div class="sc-carFqZ UksDl">Copy</div></button></div><div class="sc-iJCRrE jCdxGr sc-dPaNzc gyljjx"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"object"</span>: <span class="token string">"audio.voice"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"created_at"</span>: <span class="token number">0</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Chat" data-section-id="tag/Chat" class="sc-eCApnc jlMQbh"><div class="sc-iCoGMd gLxhOh"><div class="sc-hKFxyN juinod"><h1 class="sc-fujyAs bpZWeL"><a class="sc-crzoAE iUxAWq" href="#tag/Chat" aria-label="tag/Chat"></a>Chat</h1></div></div><div class="sc-hKFxyN bJcDWV"><div class="sc-iJCRrE sc-ciSkZP jCdxGr QGruV redoc-markdown "><p>Given a list of messages comprising a conversation, the model will return a response.</p>
</div></div></div><div id="tag/Chat/operation/listChatCompletions" data-section-id="tag/Chat/operation/listChatCompletions" class="sc-eCApnc liLqNm"><div data-section-id="operation/listChatCompletions" id="operation/listChatCompletions" class="sc-iCoGMd gLxhOh"><div class="sc-hKFxyN juinod"><h2 class="sc-pNWdM eftmgB"><a class="sc-crzoAE iUxAWq" href="#tag/Chat/operation/listChatCompletions" aria-label="tag/Chat/operation/listChatCompletions"></a>List stored Chat Completions. Only Chat Completions that have been stored
with the `store` parameter set to `true` will be returned.
<!-- --> </h2><div class="sc-fcmMJX cvfxAX"><div class="sc-jUfyBS bhDyou"><h5 class="sc-iqAclL sc-fuISkM eONCmm hZIgic">Authorizations:</h5><svg class="sc-dIsUp iPqByX" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jQAxuV ccffaZ"><span class="sc-daBunf fcvuS"><span class="sc-dsXzNU dPrSxx"><i>ApiKeyAuth</i></span></span></div></div><div><h5 class="sc-iqAclL eONCmm">query<!-- --> Parameters</h5><table class="sc-hHEiqL VCQHZ"><tbody><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="model"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">model</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The model used to generate the Chat Completions.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT sc-gSYDnn iwcKgn cAqMTE hTttpy" kind="field" title="metadata"><span class="sc-iemWCZ bcnRwz"></span><button aria-label="expand properties"><span class="property-name">metadata</span><svg class="sc-dIsUp hGHhhO" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">object or null</span><span class="sc-laZMeE sc-eJocfa jWaWWE bArHDh"> (<!-- -->Metadata<!-- -->) </span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>A list of metadata keys to filter the Chat Completions by. Example:</p>
<p><code>metadata[key1]=value1&metadata[key2]=value2</code></p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="after"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">after</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>Identifier for the last chat completion from the previous pagination request.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="limit"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">limit</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">integer</span></div><div><span class="sc-laZMeE jWaWWE"> <!-- -->Default:<!-- --> </span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">20</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>Number of Chat Completions to retrieve.</p>
</div></div></div></td></tr><tr class="last "><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="order"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">order</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div><div><span class="sc-laZMeE jWaWWE"> <!-- -->Default:<!-- --> </span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"asc"</span></div><div><span class="sc-laZMeE jWaWWE"> <!-- -->Enum<!-- -->:</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"asc"</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"desc"</span> </div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>Sort order for Chat Completions by timestamp. Use <code>asc</code> for ascending order or <code>desc</code> for descending order. Defaults to <code>asc</code>.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-fIxmyt DvFer">Responses</h3><div><button class="sc-htmcrh lbYftx"><svg class="sc-dIsUp dqYXmg" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-fWWYYk cMoEZ">200<!-- --> </strong><span class="sc-jcwpoC eDjFAZ"><p>A list of Chat Completions</p>
</span></button></div></div></div><div class="sc-jSFjdj sc-gKAaRy gBjRyf gcushC"><div class="sc-EZqKI fWsqvQ"><button class="sc-eEVmNe ilvUMs"><span type="get" class="sc-fmdNqN ihNycv http-verb get">get</span><span class="sc-jXcxbT fCEUju">/chat/completions</span><svg class="sc-dIsUp bRmrKA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ljsmAU flIrdF"><div class="sc-jlZJtj fQkroN"><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div><div tabindex="0" role="button"><div class="sc-dTSzeu dfUAUz"><span>https://api.openai.com/v1</span>/chat/completions</div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Response samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-86" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-87" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-87" aria-labelledby="react-tabs-86"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-bBjRSN kQSIAz">application/json</div></div><div class="sc-jgPyTC dSaTNC"><div class="sc-jNnpgg esZIbL"><div class="sc-giAqHp hMPeqJ"><button><div class="sc-carFqZ UksDl">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iJCRrE jCdxGr sc-dPaNzc gyljjx"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"object"</span>: <span class="token string">"list"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"choices"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"finish_reason"</span>: <span class="token string">"stop"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"index"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"message"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"content"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"refusal"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"tool_calls"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <span class="token string">"function"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"function"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"arguments"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"annotations"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <span class="token string">"url_citation"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"url_citation"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"end_index"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"start_index"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"url"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"title"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"role"</span>: <span class="token string">"assistant"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"function_call"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"arguments"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"name"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"audio"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"expires_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"data"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"transcript"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"logprobs"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"content"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"token"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"logprob"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"bytes"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><span class="token number">0</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"top_logprobs"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"token"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"logprob"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"bytes"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"refusal"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"token"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"logprob"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"bytes"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><span class="token number">0</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"top_logprobs"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"token"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"logprob"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"bytes"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"created"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"model"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"service_tier"</span>: <span class="token string">"auto"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"system_fingerprint"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"object"</span>: <span class="token string">"chat.completion"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"usage"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"completion_tokens"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"prompt_tokens"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"total_tokens"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"completion_tokens_details"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"accepted_prediction_tokens"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"audio_tokens"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"reasoning_tokens"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"rejected_prediction_tokens"</span>: <span class="token number">0</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"prompt_tokens_details"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"audio_tokens"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"cached_tokens"</span>: <span class="token number">0</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"first_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"last_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"has_more"</span>: <span class="token boolean">true</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Chat/operation/createChatCompletion" data-section-id="tag/Chat/operation/createChatCompletion" class="sc-eCApnc liLqNm"><div data-section-id="operation/createChatCompletion" id="operation/createChatCompletion" class="sc-iCoGMd gLxhOh"><div class="sc-hKFxyN juinod"><h2 class="sc-pNWdM eftmgB"><a class="sc-crzoAE iUxAWq" href="#tag/Chat/operation/createChatCompletion" aria-label="tag/Chat/operation/createChatCompletion"></a>**Starting a new project?** We recommend trying [Responses](/docs/api-reference/responses)
to take advantage of the latest OpenAI platform features. Compare
[Chat Completions with Responses](/docs/guides/responses-vs-chat-completions?api-mode=responses).
---
Creates a model response for the given chat conversation. Learn more in the
[text generation](/docs/guides/text-generation), [vision](/docs/guides/vision),
and [audio](/docs/guides/audio) guides.
Parameter support can differ depending on the model used to generate the
response, particularly for newer reasoning models. Parameters that are only
supported for reasoning models are noted below. For the current state of
unsupported parameters in reasoning models,
[refer to the reasoning guide](/docs/guides/reasoning).
Returns a chat completion object, or a streamed sequence of chat completion
chunk objects if the request is streamed.
<!-- --> </h2><div class="sc-fcmMJX cvfxAX"><div class="sc-jUfyBS bhDyou"><h5 class="sc-iqAclL sc-fuISkM eONCmm hZIgic">Authorizations:</h5><svg class="sc-dIsUp iPqByX" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jQAxuV ccffaZ"><span class="sc-daBunf fcvuS"><span class="sc-dsXzNU dPrSxx"><i>ApiKeyAuth</i></span></span></div></div><h5 class="sc-iqAclL eONCmm">Request Body schema: <span class="sc-cBoqAE eKyrDP">application/json</span></h5><div class="sc-iJCRrE sc-ciSkZP jCdxGr QGruV"></div><table class="sc-hHEiqL VCQHZ"><tbody><tr class=""><td class="sc-hBMUJo sc-fFSPTT sc-gSYDnn iwcKgn cAqMTE hTttpy" kind="field" title="metadata"><span class="sc-iemWCZ bcnRwz"></span><button aria-label="expand properties"><span class="property-name">metadata</span><svg class="sc-dIsUp hGHhhO" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">Metadata (object) or Metadata (null)</span><span class="sc-laZMeE sc-eJocfa jWaWWE bArHDh"> (<!-- -->Metadata<!-- -->) </span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT sc-gSYDnn iwcKgn cAqMTE hTttpy" kind="field" title="top_logprobs"><span class="sc-iemWCZ bcnRwz"></span><button aria-label="expand properties"><span class="property-name">top_logprobs</span><svg class="sc-dIsUp hGHhhO" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">(integer or null) or (integer or null)</span><span> <span class="sc-laZMeE sc-FRrlG jWaWWE gHBwqe"> <!-- -->[ 0 .. 20 ]<!-- --> </span></span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>An integer between 0 and 20 specifying the number of most likely tokens to
return at each token position, each with an associated log probability.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT sc-gSYDnn iwcKgn cAqMTE hTttpy" kind="field" title="temperature"><span class="sc-iemWCZ bcnRwz"></span><button aria-label="expand properties"><span class="property-name">temperature</span><svg class="sc-dIsUp hGHhhO" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">number or null</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT sc-gSYDnn iwcKgn cAqMTE hTttpy" kind="field" title="top_p"><span class="sc-iemWCZ bcnRwz"></span><button aria-label="expand properties"><span class="property-name">top_p</span><svg class="sc-dIsUp hGHhhO" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">number or null</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE deprecated" kind="field" title="user"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">user</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div><div><span type="warning" class="sc-bqGGPW eSYQnm"> <!-- -->Deprecated<!-- --> </span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>This field is being replaced by <code>safety_identifier</code> and <code>prompt_cache_key</code>. Use <code>prompt_cache_key</code> instead to maintain caching optimizations.
A stable identifier for your end-users.
Used to boost cache hit rates by better bucketing similar requests and to help OpenAI detect and prevent abuse. <a href="/docs/guides/safety-best-practices#safety-identifiers">Learn more</a>.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="safety_identifier"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">safety_identifier</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span><span> <span class="sc-laZMeE sc-FRrlG jWaWWE gHBwqe"> <!-- --><= 64 characters<!-- --> </span></span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>A stable identifier used to help detect users of your application that may be violating OpenAI's usage policies.
The IDs should be a string that uniquely identifies each user, with a maximum length of 64 characters. We recommend hashing their username or email address, in order to avoid sending us any identifying information. <a href="/docs/guides/safety-best-practices#safety-identifiers">Learn more</a>.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="prompt_cache_key"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">prompt_cache_key</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>Used by OpenAI to cache responses for similar requests to optimize your cache hit rates. Replaces the <code>user</code> field. <a href="/docs/guides/prompt-caching">Learn more</a>.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT sc-gSYDnn iwcKgn cAqMTE hTttpy" kind="field" title="service_tier"><span class="sc-iemWCZ bcnRwz"></span><button aria-label="expand properties"><span class="property-name">service_tier</span><svg class="sc-dIsUp hGHhhO" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">ServiceTier (string) or ServiceTier (null)</span><span class="sc-laZMeE sc-eJocfa jWaWWE bArHDh"> (<!-- -->ServiceTier<!-- -->) </span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT sc-gSYDnn iwcKgn cAqMTE hTttpy" kind="field" title="prompt_cache_retention"><span class="sc-iemWCZ bcnRwz"></span><button aria-label="expand properties"><span class="property-name">prompt_cache_retention</span><svg class="sc-dIsUp hGHhhO" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string or null</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT sc-gSYDnn iwcKgn cAqMTE hTttpy" kind="field" title="messages"><span class="sc-iemWCZ bcnRwz"></span><button aria-label="expand properties"><span class="property-name">messages</span><svg class="sc-dIsUp hGHhhO" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa">Array of </span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">any</span><span class="sc-laZMeE sc-eJocfa jWaWWE bArHDh"> (<!-- -->ChatCompletionRequestMessage<!-- -->) </span><span> <span class="sc-laZMeE sc-FRrlG jWaWWE gHBwqe"> <!-- -->non-empty<!-- --> </span></span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>A list of messages comprising the conversation so far. Depending on the
<a href="/docs/models">model</a> you use, different message types (modalities) are
supported, like <a href="/docs/guides/text-generation">text</a>,
<a href="/docs/guides/vision">images</a>, and <a href="/docs/guides/audio">audio</a>.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT sc-gSYDnn iwcKgn cAqMTE hTttpy" kind="field" title="model"><span class="sc-iemWCZ bcnRwz"></span><button aria-label="expand properties"><span class="property-name">model</span><svg class="sc-dIsUp hGHhhO" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">ModelIdsShared (string) or ModelIdsShared (string)</span><span class="sc-laZMeE sc-eJocfa jWaWWE bArHDh"> (<!-- -->ModelIdsShared<!-- -->) </span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>Model ID used to generate the response, like <code>gpt-4o</code> or <code>o3</code>. OpenAI
offers a wide range of models with different capabilities, performance
characteristics, and price points. Refer to the <a href="/docs/models">model guide</a>
to browse and compare available models.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT sc-gSYDnn iwcKgn cAqMTE hTttpy" kind="field" title="modalities"><span class="sc-iemWCZ bcnRwz"></span><button aria-label="expand properties"><span class="property-name">modalities</span><svg class="sc-dIsUp hGHhhO" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">Array of ResponseModalities (strings) or ResponseModalities (null)</span><span class="sc-laZMeE sc-eJocfa jWaWWE bArHDh"> (<!-- -->ResponseModalities<!-- -->) </span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT sc-gSYDnn iwcKgn cAqMTE hTttpy" kind="field" title="verbosity"><span class="sc-iemWCZ bcnRwz"></span><button aria-label="expand properties"><span class="property-name">verbosity</span><svg class="sc-dIsUp hGHhhO" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">Verbosity (string) or Verbosity (null)</span><span class="sc-laZMeE sc-eJocfa jWaWWE bArHDh"> (<!-- -->Verbosity<!-- -->) </span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT sc-gSYDnn iwcKgn cAqMTE hTttpy" kind="field" title="reasoning_effort"><span class="sc-iemWCZ bcnRwz"></span><button aria-label="expand properties"><span class="property-name">reasoning_effort</span><svg class="sc-dIsUp hGHhhO" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">ReasoningEffort (string) or ReasoningEffort (null)</span><span class="sc-laZMeE sc-eJocfa jWaWWE bArHDh"> (<!-- -->ReasoningEffort<!-- -->) </span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="max_completion_tokens"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">max_completion_tokens</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">integer or null</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>An upper bound for the number of tokens that can be generated for a completion, including visible output tokens and <a href="/docs/guides/reasoning">reasoning tokens</a>.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="frequency_penalty"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">frequency_penalty</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">number or null</span><span> <span class="sc-laZMeE sc-FRrlG jWaWWE gHBwqe"> <!-- -->[ -2 .. 2 ]<!-- --> </span></span></div><div><span class="sc-laZMeE jWaWWE"> <!-- -->Default:<!-- --> </span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">0</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>Number between -2.0 and 2.0. Positive values penalize new tokens based on
their existing frequency in the text so far, decreasing the model's
likelihood to repeat the same line verbatim.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="presence_penalty"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">presence_penalty</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">number or null</span><span> <span class="sc-laZMeE sc-FRrlG jWaWWE gHBwqe"> <!-- -->[ -2 .. 2 ]<!-- --> </span></span></div><div><span class="sc-laZMeE jWaWWE"> <!-- -->Default:<!-- --> </span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">0</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>Number between -2.0 and 2.0. Positive values penalize new tokens based on
whether they appear in the text so far, increasing the model's likelihood
to talk about new topics.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT sc-gSYDnn iwcKgn cAqMTE hTttpy" kind="field" title="web_search_options"><span class="sc-iemWCZ bcnRwz"></span><button aria-label="expand properties"><span class="property-name">web_search_options</span><svg class="sc-dIsUp hGHhhO" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">object</span><span class="sc-laZMeE sc-eJocfa jWaWWE bArHDh"> (<!-- -->Web search<!-- -->) </span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>This tool searches the web for relevant results to use in a response.
Learn more about the <a href="/docs/guides/tools-web-search?api-mode=chat">web search tool</a>.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT sc-gSYDnn iwcKgn cAqMTE hTttpy" kind="field" title="response_format"><span class="sc-iemWCZ bcnRwz"></span><button aria-label="expand properties"><span class="property-name">response_format</span><svg class="sc-dIsUp hGHhhO" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">any</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>An object specifying the format that the model must output.</p>
<p>Setting to <code>{ "type": "json_schema", "json_schema": {...} }</code> enables
Structured Outputs which ensures the model will match your supplied JSON
schema. Learn more in the <a href="/docs/guides/structured-outputs">Structured Outputs
guide</a>.</p>
<p>Setting to <code>{ "type": "json_object" }</code> enables the older JSON mode, which
ensures the message the model generates is valid JSON. Using <code>json_schema</code>
is preferred for models that support it.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT sc-gSYDnn iwcKgn cAqMTE hTttpy" kind="field" title="audio"><span class="sc-iemWCZ bcnRwz"></span><button aria-label="expand properties"><span class="property-name">audio</span><svg class="sc-dIsUp hGHhhO" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">object or null</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>Parameters for audio output. Required when audio output is requested with
<code>modalities: ["audio"]</code>. <a href="/docs/guides/audio">Learn more</a>.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="store"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">store</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">boolean or null</span></div><div><span class="sc-laZMeE jWaWWE"> <!-- -->Default:<!-- --> </span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">false</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>Whether or not to store the output of this chat completion request for
use in our <a href="/docs/guides/distillation">model distillation</a> or
<a href="/docs/guides/evals">evals</a> products.</p>
<p>Supports text and image inputs. Note: image inputs over 8MB will be dropped.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="stream"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">stream</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">boolean or null</span></div><div><span class="sc-laZMeE jWaWWE"> <!-- -->Default:<!-- --> </span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">false</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>If set to true, the model response data will be streamed to the client
as it is generated using <a href="https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events/Using_server-sent_events#Event_stream_format">server-sent events</a>.
See the <a href="/docs/api-reference/chat/streaming">Streaming section below</a>
for more information, along with the <a href="/docs/guides/streaming-responses">streaming responses</a>
guide for more information on how to handle the streaming events.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT sc-gSYDnn iwcKgn cAqMTE hTttpy" kind="field" title="stop"><span class="sc-iemWCZ bcnRwz"></span><button aria-label="expand properties"><span class="property-name">stop</span><svg class="sc-dIsUp hGHhhO" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">(string or null) or Array of strings</span><span class="sc-laZMeE sc-eJocfa jWaWWE bArHDh"> (<!-- -->StopConfiguration<!-- -->) </span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT sc-gSYDnn iwcKgn cAqMTE hTttpy" kind="field" title="logit_bias"><span class="sc-iemWCZ bcnRwz"></span><button aria-label="expand properties"><span class="property-name">logit_bias</span><svg class="sc-dIsUp hGHhhO" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">object or null</span></div><div><span class="sc-laZMeE jWaWWE"> <!-- -->Default:<!-- --> </span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">null</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>Modify the likelihood of specified tokens appearing in the completion.</p>
<p>Accepts a JSON object that maps tokens (specified by their token ID in the
tokenizer) to an associated bias value from -100 to 100. Mathematically,
the bias is added to the logits generated by the model prior to sampling.
The exact effect will vary per model, but values between -1 and 1 should
decrease or increase likelihood of selection; values like -100 or 100
should result in a ban or exclusive selection of the relevant token.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="logprobs"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">logprobs</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">boolean or null</span></div><div><span class="sc-laZMeE jWaWWE"> <!-- -->Default:<!-- --> </span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">false</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>Whether to return log probabilities of the output tokens or not. If true,
returns the log probabilities of each output token returned in the
<code>content</code> of <code>message</code>.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE deprecated" kind="field" title="max_tokens"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">max_tokens</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">integer or null</span></div><div><span type="warning" class="sc-bqGGPW eSYQnm"> <!-- -->Deprecated<!-- --> </span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The maximum number of <a href="/tokenizer">tokens</a> that can be generated in the
chat completion. This value can be used to control
<a href="https://openai.com/api/pricing/">costs</a> for text generated via API.</p>
<p>This value is now deprecated in favor of <code>max_completion_tokens</code>, and is
not compatible with <a href="/docs/guides/reasoning">o-series models</a>.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="n"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">n</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">integer or null</span><span> <span class="sc-laZMeE sc-FRrlG jWaWWE gHBwqe"> <!-- -->[ 1 .. 128 ]<!-- --> </span></span></div><div><span class="sc-laZMeE jWaWWE"> <!-- -->Default:<!-- --> </span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">1</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>How many chat completion choices to generate for each input message. Note that you will be charged based on the number of generated tokens across all of the choices. Keep <code>n</code> as <code>1</code> to minimize costs.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT sc-gSYDnn iwcKgn cAqMTE hTttpy" kind="field" title="prediction"><span class="sc-iemWCZ bcnRwz"></span><button aria-label="expand properties"><span class="property-name">prediction</span><svg class="sc-dIsUp hGHhhO" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">(Static Content (object or null))</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>Configuration for a <a href="/docs/guides/predicted-outputs">Predicted Output</a>,
which can greatly improve response times when large parts of the model
response are known ahead of time. This is most common when you are
regenerating a file with only minor changes to most of the content.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE deprecated" kind="field" title="seed"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">seed</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">integer or null</span><span> <span class="sc-laZMeE sc-FRrlG jWaWWE gHBwqe"> <!-- -->[ -9223372036854776000 .. 9223372036854776000 ]<!-- --> </span></span></div><div><span type="warning" class="sc-bqGGPW eSYQnm"> <!-- -->Deprecated<!-- --> </span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>This feature is in Beta.
If specified, our system will make a best effort to sample deterministically, such that repeated requests with the same <code>seed</code> and parameters should return the same result.
Determinism is not guaranteed, and you should refer to the <code>system_fingerprint</code> response parameter to monitor changes in the backend.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT sc-gSYDnn iwcKgn cAqMTE hTttpy" kind="field" title="stream_options"><span class="sc-iemWCZ bcnRwz"></span><button aria-label="expand properties"><span class="property-name">stream_options</span><svg class="sc-dIsUp hGHhhO" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">ChatCompletionStreamOptions (object) or ChatCompletionStreamOptions (null)</span><span class="sc-laZMeE sc-eJocfa jWaWWE bArHDh"> (<!-- -->ChatCompletionStreamOptions<!-- -->) </span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT sc-gSYDnn iwcKgn cAqMTE hTttpy" kind="field" title="tools"><span class="sc-iemWCZ bcnRwz"></span><button aria-label="expand properties"><span class="property-name">tools</span><svg class="sc-dIsUp hGHhhO" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa">Array of </span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">Function tool (object) or Custom tool (object)</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>A list of tools the model may call. You can provide either
<a href="/docs/guides/function-calling#custom-tools">custom tools</a> or
<a href="/docs/guides/function-calling">function tools</a>.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT sc-gSYDnn iwcKgn cAqMTE hTttpy" kind="field" title="tool_choice"><span class="sc-iemWCZ bcnRwz"></span><button aria-label="expand properties"><span class="property-name">tool_choice</span><svg class="sc-dIsUp hGHhhO" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">Tool choice mode (string) or Allowed tools (object) or Function tool choice (object) or Custom tool choice (object)</span><span class="sc-laZMeE sc-eJocfa jWaWWE bArHDh"> (<!-- -->ChatCompletionToolChoiceOption<!-- -->) </span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="parallel_tool_calls"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">parallel_tool_calls</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">boolean</span><span class="sc-laZMeE sc-eJocfa jWaWWE bArHDh"> (<!-- -->ParallelToolCalls<!-- -->) </span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>Whether to enable <a href="/docs/guides/function-calling#configuring-parallel-function-calling">parallel function calling</a> during tool use.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT sc-gSYDnn iwcKgn cAqMTE hTttpy deprecated" kind="field" title="function_call"><span class="sc-iemWCZ bcnRwz"></span><button aria-label="expand properties"><span class="property-name">function_call</span><svg class="sc-dIsUp hGHhhO" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string or ChatCompletionFunctionCallOption (object)</span></div><div><span type="warning" class="sc-bqGGPW eSYQnm"> <!-- -->Deprecated<!-- --> </span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>Deprecated in favor of <code>tool_choice</code>.</p>
<p>Controls which (if any) function is called by the model.</p>
<p><code>none</code> means the model will not call a function and instead generates a
message.</p>
<p><code>auto</code> means the model can pick between generating a message or calling a
function.</p>
<p>Specifying a particular function via <code>{"name": "my_function"}</code> forces the
model to call that function.</p>
<p><code>none</code> is the default when no functions are present. <code>auto</code> is the default
if functions are present.</p>
</div></div></div></td></tr><tr class="last "><td class="sc-hBMUJo sc-fFSPTT sc-gSYDnn iwcKgn cAqMTE hTttpy deprecated" kind="field" title="functions"><span class="sc-iemWCZ bcnRwz"></span><button aria-label="expand properties"><span class="property-name">functions</span><svg class="sc-dIsUp hGHhhO" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa">Array of </span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">objects</span><span class="sc-laZMeE sc-eJocfa jWaWWE bArHDh"> (<!-- -->ChatCompletionFunctions<!-- -->) </span><span> <span class="sc-laZMeE sc-FRrlG jWaWWE gHBwqe"> <!-- -->[ 1 .. 128 ] items<!-- --> </span></span></div><div><span type="warning" class="sc-bqGGPW eSYQnm"> <!-- -->Deprecated<!-- --> </span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>Deprecated in favor of <code>tools</code>.</p>
<p>A list of functions the model may generate JSON inputs for.</p>
</div></div></div></td></tr></tbody></table><div><h3 class="sc-fIxmyt DvFer">Responses</h3><div><button class="sc-htmcrh lbYftx"><svg class="sc-dIsUp dqYXmg" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-fWWYYk cMoEZ">200<!-- --> </strong><span class="sc-jcwpoC eDjFAZ"><p>OK</p>
</span></button></div></div></div><div class="sc-jSFjdj sc-gKAaRy gBjRyf gcushC"><div class="sc-EZqKI fWsqvQ"><button class="sc-eEVmNe ilvUMs"><span type="post" class="sc-fmdNqN ldMUmp http-verb post">post</span><span class="sc-jXcxbT fCEUju">/chat/completions</span><svg class="sc-dIsUp bRmrKA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ljsmAU flIrdF"><div class="sc-jlZJtj fQkroN"><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div><div tabindex="0" role="button"><div class="sc-dTSzeu dfUAUz"><span>https://api.openai.com/v1</span>/chat/completions</div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Request samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="react-tabs-88" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-89" tabindex="0" data-rttab="true">Payload</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-89" aria-labelledby="react-tabs-88"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-bBjRSN kQSIAz">application/json</div></div><div class="sc-jgPyTC dSaTNC"><div class="sc-jNnpgg esZIbL"><div class="sc-giAqHp hMPeqJ"><button><div class="sc-carFqZ UksDl">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iJCRrE jCdxGr sc-dPaNzc gyljjx"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"metadata"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"property1"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"property2"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"top_logprobs"</span>: <span class="token number">20</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"temperature"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"top_p"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"user"</span>: <span class="token string">"user-1234"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"safety_identifier"</span>: <span class="token string">"safety-identifier-1234"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"prompt_cache_key"</span>: <span class="token string">"prompt-cache-key-1234"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"service_tier"</span>: <span class="token string">"auto"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"prompt_cache_retention"</span>: <span class="token string">"in_memory"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"content"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"role"</span>: <span class="token string">"developer"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"name"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"model"</span>: <span class="token string">"gpt-5.4"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"modalities"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><span class="token string">"text"</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"verbosity"</span>: <span class="token string">"low"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"reasoning_effort"</span>: <span class="token string">"none"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"max_completion_tokens"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"frequency_penalty"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"presence_penalty"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"web_search_options"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"user_location"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <span class="token string">"approximate"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"approximate"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"country"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"region"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"city"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"timezone"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"search_context_size"</span>: <span class="token string">"low"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"response_format"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <span class="token string">"text"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"audio"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"voice"</span>: <span class="token string">"ash"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"format"</span>: <span class="token string">"wav"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"store"</span>: <span class="token boolean">false</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"stream"</span>: <span class="token boolean">false</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"stop"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"logit_bias"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"logprobs"</span>: <span class="token boolean">false</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"max_tokens"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"n"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"prediction"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <span class="token string">"content"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"content"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"seed"</span>: <span class="token number">-9223372036854776000</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"stream_options"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"tools"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <span class="token string">"function"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"function"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"description"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"parameters"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"strict"</span>: <span class="token boolean">false</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"tool_choice"</span>: <span class="token string">"none"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"parallel_tool_calls"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"function_call"</span>: <span class="token string">"none"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"functions"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"description"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"parameters"</span>: <span class="token punctuation">{ }</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Response samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-90" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-91" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-91" aria-labelledby="react-tabs-90"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-hiKfDv sc-khIgEk bycQNU hLNtis"><svg class="sc-jJMGnK gVpQmv" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option selected="" value="application/json">application/json</option><option value="text/event-stream">text/event-stream</option></select><label>application/json</label></div></div><div class="sc-jgPyTC dSaTNC"><div class="sc-jNnpgg esZIbL"><div class="sc-giAqHp hMPeqJ"><button><div class="sc-carFqZ UksDl">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iJCRrE jCdxGr sc-dPaNzc gyljjx"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"choices"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"finish_reason"</span>: <span class="token string">"stop"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"index"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"message"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"content"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"refusal"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"tool_calls"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <span class="token string">"function"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"function"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"arguments"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"annotations"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <span class="token string">"url_citation"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"url_citation"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"end_index"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"start_index"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"url"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"title"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"role"</span>: <span class="token string">"assistant"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"function_call"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"arguments"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"name"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"audio"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"expires_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"data"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"transcript"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"logprobs"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"content"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"token"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"logprob"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"bytes"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><span class="token number">0</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"top_logprobs"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"token"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"logprob"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"bytes"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><span class="token number">0</span></div></li></ul><span class="token punctuation">]</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"refusal"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"token"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"logprob"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"bytes"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><span class="token number">0</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"top_logprobs"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"token"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"logprob"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"bytes"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><span class="token number">0</span></div></li></ul><span class="token punctuation">]</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"created"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"model"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"service_tier"</span>: <span class="token string">"auto"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"system_fingerprint"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"object"</span>: <span class="token string">"chat.completion"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"usage"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"completion_tokens"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"prompt_tokens"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"total_tokens"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"completion_tokens_details"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"accepted_prediction_tokens"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"audio_tokens"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"reasoning_tokens"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"rejected_prediction_tokens"</span>: <span class="token number">0</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"prompt_tokens_details"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"audio_tokens"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"cached_tokens"</span>: <span class="token number">0</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Chat/operation/getChatCompletion" data-section-id="tag/Chat/operation/getChatCompletion" class="sc-eCApnc liLqNm"><div data-section-id="operation/getChatCompletion" id="operation/getChatCompletion" class="sc-iCoGMd gLxhOh"><div class="sc-hKFxyN juinod"><h2 class="sc-pNWdM eftmgB"><a class="sc-crzoAE iUxAWq" href="#tag/Chat/operation/getChatCompletion" aria-label="tag/Chat/operation/getChatCompletion"></a>Get a stored chat completion. Only Chat Completions that have been created
with the `store` parameter set to `true` will be returned.
<!-- --> </h2><div class="sc-fcmMJX cvfxAX"><div class="sc-jUfyBS bhDyou"><h5 class="sc-iqAclL sc-fuISkM eONCmm hZIgic">Authorizations:</h5><svg class="sc-dIsUp iPqByX" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jQAxuV ccffaZ"><span class="sc-daBunf fcvuS"><span class="sc-dsXzNU dPrSxx"><i>ApiKeyAuth</i></span></span></div></div><div><h5 class="sc-iqAclL eONCmm">path<!-- --> Parameters</h5><table class="sc-hHEiqL VCQHZ"><tbody><tr class="last "><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="completion_id"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">completion_id</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The ID of the chat completion to retrieve.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-fIxmyt DvFer">Responses</h3><div><button class="sc-htmcrh lbYftx"><svg class="sc-dIsUp dqYXmg" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-fWWYYk cMoEZ">200<!-- --> </strong><span class="sc-jcwpoC eDjFAZ"><p>A chat completion</p>
</span></button></div></div></div><div class="sc-jSFjdj sc-gKAaRy gBjRyf gcushC"><div class="sc-EZqKI fWsqvQ"><button class="sc-eEVmNe ilvUMs"><span type="get" class="sc-fmdNqN ihNycv http-verb get">get</span><span class="sc-jXcxbT fCEUju">/chat/completions/{completion_id}</span><svg class="sc-dIsUp bRmrKA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ljsmAU flIrdF"><div class="sc-jlZJtj fQkroN"><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div><div tabindex="0" role="button"><div class="sc-dTSzeu dfUAUz"><span>https://api.openai.com/v1</span>/chat/completions/{completion_id}</div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Response samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-92" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-93" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-93" aria-labelledby="react-tabs-92"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-bBjRSN kQSIAz">application/json</div></div><div class="sc-jgPyTC dSaTNC"><div class="sc-jNnpgg esZIbL"><div class="sc-giAqHp hMPeqJ"><button><div class="sc-carFqZ UksDl">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iJCRrE jCdxGr sc-dPaNzc gyljjx"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"choices"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"finish_reason"</span>: <span class="token string">"stop"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"index"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"message"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"content"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"refusal"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"tool_calls"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <span class="token string">"function"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"function"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"arguments"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"annotations"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <span class="token string">"url_citation"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"url_citation"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"end_index"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"start_index"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"url"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"title"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"role"</span>: <span class="token string">"assistant"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"function_call"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"arguments"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"name"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"audio"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"expires_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"data"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"transcript"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"logprobs"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"content"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"token"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"logprob"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"bytes"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><span class="token number">0</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"top_logprobs"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"token"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"logprob"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"bytes"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><span class="token number">0</span></div></li></ul><span class="token punctuation">]</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"refusal"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"token"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"logprob"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"bytes"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><span class="token number">0</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"top_logprobs"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"token"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"logprob"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"bytes"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><span class="token number">0</span></div></li></ul><span class="token punctuation">]</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"created"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"model"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"service_tier"</span>: <span class="token string">"auto"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"system_fingerprint"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"object"</span>: <span class="token string">"chat.completion"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"usage"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"completion_tokens"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"prompt_tokens"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"total_tokens"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"completion_tokens_details"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"accepted_prediction_tokens"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"audio_tokens"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"reasoning_tokens"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"rejected_prediction_tokens"</span>: <span class="token number">0</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"prompt_tokens_details"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"audio_tokens"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"cached_tokens"</span>: <span class="token number">0</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Chat/operation/updateChatCompletion" data-section-id="tag/Chat/operation/updateChatCompletion" class="sc-eCApnc liLqNm"><div data-section-id="operation/updateChatCompletion" id="operation/updateChatCompletion" class="sc-iCoGMd gLxhOh"><div class="sc-hKFxyN juinod"><h2 class="sc-pNWdM eftmgB"><a class="sc-crzoAE iUxAWq" href="#tag/Chat/operation/updateChatCompletion" aria-label="tag/Chat/operation/updateChatCompletion"></a>Modify a stored chat completion. Only Chat Completions that have been
created with the `store` parameter set to `true` can be modified. Currently,
the only supported modification is to update the `metadata` field.
<!-- --> </h2><div class="sc-fcmMJX cvfxAX"><div class="sc-jUfyBS bhDyou"><h5 class="sc-iqAclL sc-fuISkM eONCmm hZIgic">Authorizations:</h5><svg class="sc-dIsUp iPqByX" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jQAxuV ccffaZ"><span class="sc-daBunf fcvuS"><span class="sc-dsXzNU dPrSxx"><i>ApiKeyAuth</i></span></span></div></div><div><h5 class="sc-iqAclL eONCmm">path<!-- --> Parameters</h5><table class="sc-hHEiqL VCQHZ"><tbody><tr class="last "><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="completion_id"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">completion_id</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The ID of the chat completion to update.</p>
</div></div></div></td></tr></tbody></table></div><h5 class="sc-iqAclL eONCmm">Request Body schema: <span class="sc-cBoqAE eKyrDP">application/json</span></h5><div class="sc-iJCRrE sc-ciSkZP jCdxGr QGruV"></div><table class="sc-hHEiqL VCQHZ"><tbody><tr class="last "><td class="sc-hBMUJo sc-fFSPTT sc-gSYDnn iwcKgn cAqMTE hTttpy" kind="field" title="metadata"><span class="sc-iemWCZ bcnRwz"></span><button aria-label="expand properties"><span class="property-name">metadata</span><svg class="sc-dIsUp hGHhhO" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">Metadata (object) or Metadata (null)</span><span class="sc-laZMeE sc-eJocfa jWaWWE bArHDh"> (<!-- -->Metadata<!-- -->) </span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div></div></div></td></tr></tbody></table><div><h3 class="sc-fIxmyt DvFer">Responses</h3><div><button class="sc-htmcrh lbYftx"><svg class="sc-dIsUp dqYXmg" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-fWWYYk cMoEZ">200<!-- --> </strong><span class="sc-jcwpoC eDjFAZ"><p>A chat completion</p>
</span></button></div></div></div><div class="sc-jSFjdj sc-gKAaRy gBjRyf gcushC"><div class="sc-EZqKI fWsqvQ"><button class="sc-eEVmNe ilvUMs"><span type="post" class="sc-fmdNqN ldMUmp http-verb post">post</span><span class="sc-jXcxbT fCEUju">/chat/completions/{completion_id}</span><svg class="sc-dIsUp bRmrKA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ljsmAU flIrdF"><div class="sc-jlZJtj fQkroN"><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div><div tabindex="0" role="button"><div class="sc-dTSzeu dfUAUz"><span>https://api.openai.com/v1</span>/chat/completions/{completion_id}</div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Request samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="react-tabs-94" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-95" tabindex="0" data-rttab="true">Payload</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-95" aria-labelledby="react-tabs-94"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-bBjRSN kQSIAz">application/json</div></div><div class="sc-jgPyTC dSaTNC"><div class="sc-jNnpgg esZIbL"><div class="sc-giAqHp hMPeqJ"><button><div class="sc-carFqZ UksDl">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iJCRrE jCdxGr sc-dPaNzc gyljjx"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"metadata"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"property1"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"property2"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Response samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-96" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-97" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-97" aria-labelledby="react-tabs-96"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-bBjRSN kQSIAz">application/json</div></div><div class="sc-jgPyTC dSaTNC"><div class="sc-jNnpgg esZIbL"><div class="sc-giAqHp hMPeqJ"><button><div class="sc-carFqZ UksDl">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iJCRrE jCdxGr sc-dPaNzc gyljjx"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"choices"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"finish_reason"</span>: <span class="token string">"stop"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"index"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"message"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"content"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"refusal"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"tool_calls"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <span class="token string">"function"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"function"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"arguments"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"annotations"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <span class="token string">"url_citation"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"url_citation"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"end_index"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"start_index"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"url"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"title"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"role"</span>: <span class="token string">"assistant"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"function_call"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"arguments"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"name"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"audio"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"expires_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"data"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"transcript"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"logprobs"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"content"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"token"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"logprob"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"bytes"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><span class="token number">0</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"top_logprobs"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"token"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"logprob"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"bytes"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><span class="token number">0</span></div></li></ul><span class="token punctuation">]</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"refusal"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"token"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"logprob"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"bytes"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><span class="token number">0</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"top_logprobs"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"token"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"logprob"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"bytes"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><span class="token number">0</span></div></li></ul><span class="token punctuation">]</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"created"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"model"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"service_tier"</span>: <span class="token string">"auto"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"system_fingerprint"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"object"</span>: <span class="token string">"chat.completion"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"usage"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"completion_tokens"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"prompt_tokens"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"total_tokens"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"completion_tokens_details"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"accepted_prediction_tokens"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"audio_tokens"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"reasoning_tokens"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"rejected_prediction_tokens"</span>: <span class="token number">0</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"prompt_tokens_details"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"audio_tokens"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"cached_tokens"</span>: <span class="token number">0</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Chat/operation/deleteChatCompletion" data-section-id="tag/Chat/operation/deleteChatCompletion" class="sc-eCApnc liLqNm"><div data-section-id="operation/deleteChatCompletion" id="operation/deleteChatCompletion" class="sc-iCoGMd gLxhOh"><div class="sc-hKFxyN juinod"><h2 class="sc-pNWdM eftmgB"><a class="sc-crzoAE iUxAWq" href="#tag/Chat/operation/deleteChatCompletion" aria-label="tag/Chat/operation/deleteChatCompletion"></a>Delete a stored chat completion. Only Chat Completions that have been
created with the `store` parameter set to `true` can be deleted.
<!-- --> </h2><div class="sc-fcmMJX cvfxAX"><div class="sc-jUfyBS bhDyou"><h5 class="sc-iqAclL sc-fuISkM eONCmm hZIgic">Authorizations:</h5><svg class="sc-dIsUp iPqByX" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jQAxuV ccffaZ"><span class="sc-daBunf fcvuS"><span class="sc-dsXzNU dPrSxx"><i>ApiKeyAuth</i></span></span></div></div><div><h5 class="sc-iqAclL eONCmm">path<!-- --> Parameters</h5><table class="sc-hHEiqL VCQHZ"><tbody><tr class="last "><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="completion_id"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">completion_id</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The ID of the chat completion to delete.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-fIxmyt DvFer">Responses</h3><div><button class="sc-htmcrh lbYftx"><svg class="sc-dIsUp dqYXmg" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-fWWYYk cMoEZ">200<!-- --> </strong><span class="sc-jcwpoC eDjFAZ"><p>The chat completion was deleted successfully.</p>
</span></button></div></div></div><div class="sc-jSFjdj sc-gKAaRy gBjRyf gcushC"><div class="sc-EZqKI fWsqvQ"><button class="sc-eEVmNe ilvUMs"><span type="delete" class="sc-fmdNqN bJzUtf http-verb delete">delete</span><span class="sc-jXcxbT fCEUju">/chat/completions/{completion_id}</span><svg class="sc-dIsUp bRmrKA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ljsmAU flIrdF"><div class="sc-jlZJtj fQkroN"><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div><div tabindex="0" role="button"><div class="sc-dTSzeu dfUAUz"><span>https://api.openai.com/v1</span>/chat/completions/{completion_id}</div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Response samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-98" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-99" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-99" aria-labelledby="react-tabs-98"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-bBjRSN kQSIAz">application/json</div></div><div class="sc-jgPyTC dSaTNC"><div class="sc-jNnpgg esZIbL"><div class="sc-giAqHp hMPeqJ"><button><div class="sc-carFqZ UksDl">Copy</div></button></div><div class="sc-iJCRrE jCdxGr sc-dPaNzc gyljjx"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"object"</span>: <span class="token string">"chat.completion.deleted"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"deleted"</span>: <span class="token boolean">true</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Chat/operation/getChatCompletionMessages" data-section-id="tag/Chat/operation/getChatCompletionMessages" class="sc-eCApnc liLqNm"><div data-section-id="operation/getChatCompletionMessages" id="operation/getChatCompletionMessages" class="sc-iCoGMd gLxhOh"><div class="sc-hKFxyN juinod"><h2 class="sc-pNWdM eftmgB"><a class="sc-crzoAE iUxAWq" href="#tag/Chat/operation/getChatCompletionMessages" aria-label="tag/Chat/operation/getChatCompletionMessages"></a>Get the messages in a stored chat completion. Only Chat Completions that
have been created with the `store` parameter set to `true` will be
returned.
<!-- --> </h2><div class="sc-fcmMJX cvfxAX"><div class="sc-jUfyBS bhDyou"><h5 class="sc-iqAclL sc-fuISkM eONCmm hZIgic">Authorizations:</h5><svg class="sc-dIsUp iPqByX" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jQAxuV ccffaZ"><span class="sc-daBunf fcvuS"><span class="sc-dsXzNU dPrSxx"><i>ApiKeyAuth</i></span></span></div></div><div><h5 class="sc-iqAclL eONCmm">path<!-- --> Parameters</h5><table class="sc-hHEiqL VCQHZ"><tbody><tr class="last "><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="completion_id"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">completion_id</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The ID of the chat completion to retrieve messages from.</p>
</div></div></div></td></tr></tbody></table></div><div><h5 class="sc-iqAclL eONCmm">query<!-- --> Parameters</h5><table class="sc-hHEiqL VCQHZ"><tbody><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="after"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">after</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>Identifier for the last message from the previous pagination request.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="limit"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">limit</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">integer</span></div><div><span class="sc-laZMeE jWaWWE"> <!-- -->Default:<!-- --> </span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">20</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>Number of messages to retrieve.</p>
</div></div></div></td></tr><tr class="last "><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="order"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">order</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div><div><span class="sc-laZMeE jWaWWE"> <!-- -->Default:<!-- --> </span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"asc"</span></div><div><span class="sc-laZMeE jWaWWE"> <!-- -->Enum<!-- -->:</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"asc"</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"desc"</span> </div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>Sort order for messages by timestamp. Use <code>asc</code> for ascending order or <code>desc</code> for descending order. Defaults to <code>asc</code>.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-fIxmyt DvFer">Responses</h3><div><button class="sc-htmcrh lbYftx"><svg class="sc-dIsUp dqYXmg" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-fWWYYk cMoEZ">200<!-- --> </strong><span class="sc-jcwpoC eDjFAZ"><p>A list of messages</p>
</span></button></div></div></div><div class="sc-jSFjdj sc-gKAaRy gBjRyf gcushC"><div class="sc-EZqKI fWsqvQ"><button class="sc-eEVmNe ilvUMs"><span type="get" class="sc-fmdNqN ihNycv http-verb get">get</span><span class="sc-jXcxbT fCEUju">/chat/completions/{completion_id}/messages</span><svg class="sc-dIsUp bRmrKA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ljsmAU flIrdF"><div class="sc-jlZJtj fQkroN"><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div><div tabindex="0" role="button"><div class="sc-dTSzeu dfUAUz"><span>https://api.openai.com/v1</span>/chat/completions/{completion_id}/messages</div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Response samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-100" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-101" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-101" aria-labelledby="react-tabs-100"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-bBjRSN kQSIAz">application/json</div></div><div class="sc-jgPyTC dSaTNC"><div class="sc-jNnpgg esZIbL"><div class="sc-giAqHp hMPeqJ"><button><div class="sc-carFqZ UksDl">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iJCRrE jCdxGr sc-dPaNzc gyljjx"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"object"</span>: <span class="token string">"list"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"content"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"refusal"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"tool_calls"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <span class="token string">"function"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"function"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"arguments"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"annotations"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <span class="token string">"url_citation"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"url_citation"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"end_index"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"start_index"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"url"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"title"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"role"</span>: <span class="token string">"assistant"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"function_call"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"arguments"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"name"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"audio"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"expires_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"data"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"transcript"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"content_parts"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <span class="token string">"text"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"text"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"first_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"last_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"has_more"</span>: <span class="token boolean">true</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Conversations" data-section-id="tag/Conversations" class="sc-eCApnc jlMQbh"><div class="sc-iCoGMd gLxhOh"><div class="sc-hKFxyN juinod"><h1 class="sc-fujyAs bpZWeL"><a class="sc-crzoAE iUxAWq" href="#tag/Conversations" aria-label="tag/Conversations"></a>Conversations</h1></div></div><div class="sc-hKFxyN bJcDWV"><div class="sc-iJCRrE sc-ciSkZP jCdxGr QGruV redoc-markdown "><p>Manage conversations and conversation items.</p>
</div></div></div><div id="tag/Conversations/operation/createConversationItems" data-section-id="tag/Conversations/operation/createConversationItems" class="sc-eCApnc liLqNm"><div data-section-id="operation/createConversationItems" id="operation/createConversationItems" class="sc-iCoGMd gLxhOh"><div class="sc-hKFxyN juinod"><h2 class="sc-pNWdM eftmgB"><a class="sc-crzoAE iUxAWq" href="#tag/Conversations/operation/createConversationItems" aria-label="tag/Conversations/operation/createConversationItems"></a>Create items in a conversation with the given ID.<!-- --> </h2><div class="sc-fcmMJX cvfxAX"><div class="sc-jUfyBS bhDyou"><h5 class="sc-iqAclL sc-fuISkM eONCmm hZIgic">Authorizations:</h5><svg class="sc-dIsUp iPqByX" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jQAxuV ccffaZ"><span class="sc-daBunf fcvuS"><span class="sc-dsXzNU dPrSxx"><i>ApiKeyAuth</i></span></span></div></div><div><h5 class="sc-iqAclL eONCmm">path<!-- --> Parameters</h5><table class="sc-hHEiqL VCQHZ"><tbody><tr class="last "><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="conversation_id"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">conversation_id</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><span class="sc-laZMeE jWaWWE"> <!-- -->Example:<!-- --> </span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">conv_123</span></div><div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The ID of the conversation to add the item to.</p>
</div></div></div></td></tr></tbody></table></div><div><h5 class="sc-iqAclL eONCmm">query<!-- --> Parameters</h5><table class="sc-hHEiqL VCQHZ"><tbody><tr class="last "><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="include"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">include</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa">Array of </span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">strings</span><span class="sc-laZMeE sc-eJocfa jWaWWE bArHDh"> (<!-- -->IncludeEnum<!-- -->) </span></div><div><span class="sc-laZMeE jWaWWE">Items<!-- --> <!-- -->Enum<!-- -->:</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"file_search_call.results"</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"web_search_call.results"</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"web_search_call.action.sources"</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"message.input_image.image_url"</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"computer_call_output.output.image_url"</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"code_interpreter_call.outputs"</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"reasoning.encrypted_content"</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"message.output_text.logprobs"</span> </div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>Additional fields to include in the response. See the <code>include</code>
parameter for <a href="/docs/api-reference/conversations/list-items#conversations_list_items-include">listing Conversation items above</a> for more information.</p>
</div></div></div></td></tr></tbody></table></div><h5 class="sc-iqAclL eONCmm">Request Body schema: <span class="sc-cBoqAE eKyrDP">application/json</span></h5><div class="sc-iJCRrE sc-ciSkZP jCdxGr QGruV"></div><table class="sc-hHEiqL VCQHZ"><tbody><tr class="last "><td class="sc-hBMUJo sc-fFSPTT sc-gSYDnn iwcKgn cAqMTE hTttpy" kind="field" title="items"><span class="sc-iemWCZ bcnRwz"></span><button aria-label="expand properties"><span class="property-name">items</span><svg class="sc-dIsUp hGHhhO" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa">Array of </span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">any</span><span class="sc-laZMeE sc-eJocfa jWaWWE bArHDh"> (<!-- -->InputItem<!-- -->) </span><span> <span class="sc-laZMeE sc-FRrlG jWaWWE gHBwqe"> <!-- --><= 20 items<!-- --> </span></span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The items to add to the conversation. You may add up to 20 items at a time.</p>
</div></div></div></td></tr></tbody></table><div><h3 class="sc-fIxmyt DvFer">Responses</h3><div><button class="sc-htmcrh lbYftx"><svg class="sc-dIsUp dqYXmg" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-fWWYYk cMoEZ">200<!-- --> </strong><span class="sc-jcwpoC eDjFAZ"><p>OK</p>
</span></button></div></div></div><div class="sc-jSFjdj sc-gKAaRy gBjRyf gcushC"><div class="sc-EZqKI fWsqvQ"><button class="sc-eEVmNe ilvUMs"><span type="post" class="sc-fmdNqN ldMUmp http-verb post">post</span><span class="sc-jXcxbT fCEUju">/conversations/{conversation_id}/items</span><svg class="sc-dIsUp bRmrKA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ljsmAU flIrdF"><div class="sc-jlZJtj fQkroN"><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div><div tabindex="0" role="button"><div class="sc-dTSzeu dfUAUz"><span>https://api.openai.com/v1</span>/conversations/{conversation_id}/items</div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Request samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="react-tabs-102" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-103" tabindex="0" data-rttab="true">Payload</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-103" aria-labelledby="react-tabs-102"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-bBjRSN kQSIAz">application/json</div></div><div class="sc-jgPyTC dSaTNC"><div class="sc-jNnpgg esZIbL"><div class="sc-giAqHp hMPeqJ"><button><div class="sc-carFqZ UksDl">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iJCRrE jCdxGr sc-dPaNzc gyljjx"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"items"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"role"</span>: <span class="token string">"user"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"content"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"phase"</span>: <span class="token string">"commentary"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <span class="token string">"message"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Response samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-104" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-105" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-105" aria-labelledby="react-tabs-104"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-bBjRSN kQSIAz">application/json</div></div><div class="sc-jgPyTC dSaTNC"><div class="sc-jNnpgg esZIbL"><div class="sc-giAqHp hMPeqJ"><button><div class="sc-carFqZ UksDl">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iJCRrE jCdxGr sc-dPaNzc gyljjx"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"object"</span>: <span class="token string">"list"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <span class="token string">"message"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"status"</span>: <span class="token string">"in_progress"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"role"</span>: <span class="token string">"unknown"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"content"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <span class="token string">"input_text"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"text"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"phase"</span>: <span class="token string">"commentary"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"has_more"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"first_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"last_id"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Conversations/operation/listConversationItems" data-section-id="tag/Conversations/operation/listConversationItems" class="sc-eCApnc liLqNm"><div data-section-id="operation/listConversationItems" id="operation/listConversationItems" class="sc-iCoGMd gLxhOh"><div class="sc-hKFxyN juinod"><h2 class="sc-pNWdM eftmgB"><a class="sc-crzoAE iUxAWq" href="#tag/Conversations/operation/listConversationItems" aria-label="tag/Conversations/operation/listConversationItems"></a>List all items for a conversation with the given ID.<!-- --> </h2><div class="sc-fcmMJX cvfxAX"><div class="sc-jUfyBS bhDyou"><h5 class="sc-iqAclL sc-fuISkM eONCmm hZIgic">Authorizations:</h5><svg class="sc-dIsUp iPqByX" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jQAxuV ccffaZ"><span class="sc-daBunf fcvuS"><span class="sc-dsXzNU dPrSxx"><i>ApiKeyAuth</i></span></span></div></div><div><h5 class="sc-iqAclL eONCmm">path<!-- --> Parameters</h5><table class="sc-hHEiqL VCQHZ"><tbody><tr class="last "><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="conversation_id"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">conversation_id</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><span class="sc-laZMeE jWaWWE"> <!-- -->Example:<!-- --> </span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">conv_123</span></div><div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The ID of the conversation to list items for.</p>
</div></div></div></td></tr></tbody></table></div><div><h5 class="sc-iqAclL eONCmm">query<!-- --> Parameters</h5><table class="sc-hHEiqL VCQHZ"><tbody><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="limit"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">limit</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">integer</span></div><div><span class="sc-laZMeE jWaWWE"> <!-- -->Default:<!-- --> </span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">20</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>A limit on the number of objects to be returned. Limit can range between
1 and 100, and the default is 20.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="order"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">order</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div><div><span class="sc-laZMeE jWaWWE"> <!-- -->Enum<!-- -->:</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"asc"</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"desc"</span> </div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The order to return the input items in. Default is <code>desc</code>.</p>
<ul>
<li><code>asc</code>: Return the input items in ascending order.</li>
<li><code>desc</code>: Return the input items in descending order.</li>
</ul>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="after"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">after</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>An item ID to list items after, used in pagination.</p>
</div></div></div></td></tr><tr class="last "><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="include"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">include</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa">Array of </span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">strings</span><span class="sc-laZMeE sc-eJocfa jWaWWE bArHDh"> (<!-- -->IncludeEnum<!-- -->) </span></div><div><span class="sc-laZMeE jWaWWE">Items<!-- --> <!-- -->Enum<!-- -->:</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"file_search_call.results"</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"web_search_call.results"</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"web_search_call.action.sources"</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"message.input_image.image_url"</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"computer_call_output.output.image_url"</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"code_interpreter_call.outputs"</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"reasoning.encrypted_content"</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"message.output_text.logprobs"</span> </div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>Specify additional output data to include in the model response. Currently supported values are:</p>
<ul>
<li><code>web_search_call.action.sources</code>: Include the sources of the web search tool call.</li>
<li><code>code_interpreter_call.outputs</code>: Includes the outputs of python code execution in code interpreter tool call items.</li>
<li><code>computer_call_output.output.image_url</code>: Include image urls from the computer call output.</li>
<li><code>file_search_call.results</code>: Include the search results of the file search tool call.</li>
<li><code>message.input_image.image_url</code>: Include image urls from the input message.</li>
<li><code>message.output_text.logprobs</code>: Include logprobs with assistant messages.</li>
<li><code>reasoning.encrypted_content</code>: Includes an encrypted version of reasoning tokens in reasoning item outputs. This enables reasoning items to be used in multi-turn conversations when using the Responses API statelessly (like when the <code>store</code> parameter is set to <code>false</code>, or when an organization is enrolled in the zero data retention program).</li>
</ul>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-fIxmyt DvFer">Responses</h3><div><button class="sc-htmcrh lbYftx"><svg class="sc-dIsUp dqYXmg" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-fWWYYk cMoEZ">200<!-- --> </strong><span class="sc-jcwpoC eDjFAZ"><p>OK</p>
</span></button></div></div></div><div class="sc-jSFjdj sc-gKAaRy gBjRyf gcushC"><div class="sc-EZqKI fWsqvQ"><button class="sc-eEVmNe ilvUMs"><span type="get" class="sc-fmdNqN ihNycv http-verb get">get</span><span class="sc-jXcxbT fCEUju">/conversations/{conversation_id}/items</span><svg class="sc-dIsUp bRmrKA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ljsmAU flIrdF"><div class="sc-jlZJtj fQkroN"><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div><div tabindex="0" role="button"><div class="sc-dTSzeu dfUAUz"><span>https://api.openai.com/v1</span>/conversations/{conversation_id}/items</div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Response samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-106" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-107" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-107" aria-labelledby="react-tabs-106"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-bBjRSN kQSIAz">application/json</div></div><div class="sc-jgPyTC dSaTNC"><div class="sc-jNnpgg esZIbL"><div class="sc-giAqHp hMPeqJ"><button><div class="sc-carFqZ UksDl">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iJCRrE jCdxGr sc-dPaNzc gyljjx"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"object"</span>: <span class="token string">"list"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <span class="token string">"message"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"status"</span>: <span class="token string">"in_progress"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"role"</span>: <span class="token string">"unknown"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"content"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <span class="token string">"input_text"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"text"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"phase"</span>: <span class="token string">"commentary"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"has_more"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"first_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"last_id"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Conversations/operation/getConversationItem" data-section-id="tag/Conversations/operation/getConversationItem" class="sc-eCApnc liLqNm"><div data-section-id="operation/getConversationItem" id="operation/getConversationItem" class="sc-iCoGMd gLxhOh"><div class="sc-hKFxyN juinod"><h2 class="sc-pNWdM eftmgB"><a class="sc-crzoAE iUxAWq" href="#tag/Conversations/operation/getConversationItem" aria-label="tag/Conversations/operation/getConversationItem"></a>Get a single item from a conversation with the given IDs.<!-- --> </h2><div class="sc-fcmMJX cvfxAX"><div class="sc-jUfyBS bhDyou"><h5 class="sc-iqAclL sc-fuISkM eONCmm hZIgic">Authorizations:</h5><svg class="sc-dIsUp iPqByX" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jQAxuV ccffaZ"><span class="sc-daBunf fcvuS"><span class="sc-dsXzNU dPrSxx"><i>ApiKeyAuth</i></span></span></div></div><div><h5 class="sc-iqAclL eONCmm">path<!-- --> Parameters</h5><table class="sc-hHEiqL VCQHZ"><tbody><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="conversation_id"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">conversation_id</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><span class="sc-laZMeE jWaWWE"> <!-- -->Example:<!-- --> </span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">conv_123</span></div><div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The ID of the conversation that contains the item.</p>
</div></div></div></td></tr><tr class="last "><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="item_id"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">item_id</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><span class="sc-laZMeE jWaWWE"> <!-- -->Example:<!-- --> </span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">msg_abc</span></div><div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The ID of the item to retrieve.</p>
</div></div></div></td></tr></tbody></table></div><div><h5 class="sc-iqAclL eONCmm">query<!-- --> Parameters</h5><table class="sc-hHEiqL VCQHZ"><tbody><tr class="last "><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="include"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">include</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa">Array of </span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">strings</span><span class="sc-laZMeE sc-eJocfa jWaWWE bArHDh"> (<!-- -->IncludeEnum<!-- -->) </span></div><div><span class="sc-laZMeE jWaWWE">Items<!-- --> <!-- -->Enum<!-- -->:</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"file_search_call.results"</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"web_search_call.results"</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"web_search_call.action.sources"</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"message.input_image.image_url"</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"computer_call_output.output.image_url"</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"code_interpreter_call.outputs"</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"reasoning.encrypted_content"</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"message.output_text.logprobs"</span> </div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>Additional fields to include in the response. See the <code>include</code>
parameter for <a href="/docs/api-reference/conversations/list-items#conversations_list_items-include">listing Conversation items above</a> for more information.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-fIxmyt DvFer">Responses</h3><div><button class="sc-htmcrh lbYftx"><svg class="sc-dIsUp dqYXmg" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-fWWYYk cMoEZ">200<!-- --> </strong><span class="sc-jcwpoC eDjFAZ"><p>OK</p>
</span></button></div></div></div><div class="sc-jSFjdj sc-gKAaRy gBjRyf gcushC"><div class="sc-EZqKI fWsqvQ"><button class="sc-eEVmNe ilvUMs"><span type="get" class="sc-fmdNqN ihNycv http-verb get">get</span><span class="sc-jXcxbT fCEUju">/conversations/{conversation_id}/items/{item_id}</span><svg class="sc-dIsUp bRmrKA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ljsmAU flIrdF"><div class="sc-jlZJtj fQkroN"><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div><div tabindex="0" role="button"><div class="sc-dTSzeu dfUAUz"><span>https://api.openai.com/v1</span>/conversations/{conversation_id}/items/{item_id}</div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Response samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-108" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-109" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-109" aria-labelledby="react-tabs-108"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-bBjRSN kQSIAz">application/json</div></div><div class="sc-jgPyTC dSaTNC"><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Example</span><div class="sc-hiKfDv sc-khIgEk bycQNU hLNtis"><svg class="sc-jJMGnK gVpQmv" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option selected="" value="Message">Message</option><option value="FunctionToolCallResource">FunctionToolCallResource</option><option value="FunctionToolCallOutputResource">FunctionToolCallOutputResource</option><option value="FileSearchToolCall">FileSearchToolCall</option><option value="WebSearchToolCall">WebSearchToolCall</option><option value="ImageGenToolCall">ImageGenToolCall</option><option value="ComputerToolCall">ComputerToolCall</option><option value="ComputerToolCallOutputResource">ComputerToolCallOutputResource</option><option value="ToolSearchCall">ToolSearchCall</option><option value="ToolSearchOutput">ToolSearchOutput</option><option value="ReasoningItem">ReasoningItem</option><option value="CompactionBody">CompactionBody</option><option value="CodeInterpreterToolCall">CodeInterpreterToolCall</option><option value="LocalShellToolCall">LocalShellToolCall</option><option value="LocalShellToolCallOutput">LocalShellToolCallOutput</option><option value="FunctionShellCall">FunctionShellCall</option><option value="FunctionShellCallOutput">FunctionShellCallOutput</option><option value="ApplyPatchToolCall">ApplyPatchToolCall</option><option value="ApplyPatchToolCallOutput">ApplyPatchToolCallOutput</option><option value="MCPListTools">MCPListTools</option><option value="MCPApprovalRequest">MCPApprovalRequest</option><option value="MCPApprovalResponseResource">MCPApprovalResponseResource</option><option value="MCPToolCall">MCPToolCall</option><option value="CustomToolCall">CustomToolCall</option><option value="CustomToolCallOutput">CustomToolCallOutput</option></select><label>Message</label></div></div><div><div class="sc-jNnpgg esZIbL"><div class="sc-giAqHp hMPeqJ"><button><div class="sc-carFqZ UksDl">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iJCRrE jCdxGr sc-dPaNzc gyljjx"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"type"</span>: <span class="token string">"Message"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token string">"in_progress"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"role"</span>: <span class="token string">"unknown"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"content"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <span class="token string">"input_text"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"text"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"phase"</span>: <span class="token string">"commentary"</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Conversations/operation/deleteConversationItem" data-section-id="tag/Conversations/operation/deleteConversationItem" class="sc-eCApnc liLqNm"><div data-section-id="operation/deleteConversationItem" id="operation/deleteConversationItem" class="sc-iCoGMd gLxhOh"><div class="sc-hKFxyN juinod"><h2 class="sc-pNWdM eftmgB"><a class="sc-crzoAE iUxAWq" href="#tag/Conversations/operation/deleteConversationItem" aria-label="tag/Conversations/operation/deleteConversationItem"></a>Delete an item from a conversation with the given IDs.<!-- --> </h2><div class="sc-fcmMJX cvfxAX"><div class="sc-jUfyBS bhDyou"><h5 class="sc-iqAclL sc-fuISkM eONCmm hZIgic">Authorizations:</h5><svg class="sc-dIsUp iPqByX" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jQAxuV ccffaZ"><span class="sc-daBunf fcvuS"><span class="sc-dsXzNU dPrSxx"><i>ApiKeyAuth</i></span></span></div></div><div><h5 class="sc-iqAclL eONCmm">path<!-- --> Parameters</h5><table class="sc-hHEiqL VCQHZ"><tbody><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="conversation_id"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">conversation_id</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><span class="sc-laZMeE jWaWWE"> <!-- -->Example:<!-- --> </span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">conv_123</span></div><div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The ID of the conversation that contains the item.</p>
</div></div></div></td></tr><tr class="last "><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="item_id"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">item_id</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><span class="sc-laZMeE jWaWWE"> <!-- -->Example:<!-- --> </span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">msg_abc</span></div><div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The ID of the item to delete.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-fIxmyt DvFer">Responses</h3><div><button class="sc-htmcrh lbYftx"><svg class="sc-dIsUp dqYXmg" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-fWWYYk cMoEZ">200<!-- --> </strong><span class="sc-jcwpoC eDjFAZ"><p>OK</p>
</span></button></div></div></div><div class="sc-jSFjdj sc-gKAaRy gBjRyf gcushC"><div class="sc-EZqKI fWsqvQ"><button class="sc-eEVmNe ilvUMs"><span type="delete" class="sc-fmdNqN bJzUtf http-verb delete">delete</span><span class="sc-jXcxbT fCEUju">/conversations/{conversation_id}/items/{item_id}</span><svg class="sc-dIsUp bRmrKA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ljsmAU flIrdF"><div class="sc-jlZJtj fQkroN"><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div><div tabindex="0" role="button"><div class="sc-dTSzeu dfUAUz"><span>https://api.openai.com/v1</span>/conversations/{conversation_id}/items/{item_id}</div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Response samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-110" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-111" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-111" aria-labelledby="react-tabs-110"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-bBjRSN kQSIAz">application/json</div></div><div class="sc-jgPyTC dSaTNC"><div class="sc-jNnpgg esZIbL"><div class="sc-giAqHp hMPeqJ"><button><div class="sc-carFqZ UksDl">Copy</div></button></div><div class="sc-iJCRrE jCdxGr sc-dPaNzc gyljjx"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"object"</span>: <span class="token string">"conversation"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"created_at"</span>: <span class="token number">0</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Conversations/operation/createConversation" data-section-id="tag/Conversations/operation/createConversation" class="sc-eCApnc liLqNm"><div data-section-id="operation/createConversation" id="operation/createConversation" class="sc-iCoGMd gLxhOh"><div class="sc-hKFxyN juinod"><h2 class="sc-pNWdM eftmgB"><a class="sc-crzoAE iUxAWq" href="#tag/Conversations/operation/createConversation" aria-label="tag/Conversations/operation/createConversation"></a>Create a conversation.<!-- --> </h2><div class="sc-fcmMJX cvfxAX"><div class="sc-jUfyBS bhDyou"><h5 class="sc-iqAclL sc-fuISkM eONCmm hZIgic">Authorizations:</h5><svg class="sc-dIsUp iPqByX" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jQAxuV ccffaZ"><span class="sc-daBunf fcvuS"><span class="sc-dsXzNU dPrSxx"><i>ApiKeyAuth</i></span></span></div></div><h5 class="sc-iqAclL eONCmm">Request Body schema: <span class="sc-cBoqAE eKyrDP">application/json</span></h5><div class="sc-iJCRrE sc-ciSkZP jCdxGr QGruV"></div><table class="sc-hHEiqL VCQHZ"><tbody><tr class=""><td class="sc-hBMUJo sc-fFSPTT sc-gSYDnn iwcKgn cAqMTE hTttpy" kind="field" title="metadata"><span class="sc-iemWCZ bcnRwz"></span><button aria-label="expand properties"><span class="property-name">metadata</span><svg class="sc-dIsUp hGHhhO" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">(Metadata (Metadata (object) or Metadata (null))) or null</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div></div></div></td></tr><tr class="last "><td class="sc-hBMUJo sc-fFSPTT sc-gSYDnn iwcKgn cAqMTE hTttpy" kind="field" title="items"><span class="sc-iemWCZ bcnRwz"></span><button aria-label="expand properties"><span class="property-name">items</span><svg class="sc-dIsUp hGHhhO" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">Array of InputItem (any) or null</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div></div></div></td></tr></tbody></table><div><h3 class="sc-fIxmyt DvFer">Responses</h3><div><button class="sc-htmcrh lbYftx"><svg class="sc-dIsUp dqYXmg" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-fWWYYk cMoEZ">200<!-- --> </strong><span class="sc-jcwpoC eDjFAZ"><p>Success</p>
</span></button></div></div></div><div class="sc-jSFjdj sc-gKAaRy gBjRyf gcushC"><div class="sc-EZqKI fWsqvQ"><button class="sc-eEVmNe ilvUMs"><span type="post" class="sc-fmdNqN ldMUmp http-verb post">post</span><span class="sc-jXcxbT fCEUju">/conversations</span><svg class="sc-dIsUp bRmrKA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ljsmAU flIrdF"><div class="sc-jlZJtj fQkroN"><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div><div tabindex="0" role="button"><div class="sc-dTSzeu dfUAUz"><span>https://api.openai.com/v1</span>/conversations</div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Request samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="react-tabs-112" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-113" tabindex="0" data-rttab="true">Payload</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-113" aria-labelledby="react-tabs-112"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-bBjRSN kQSIAz">application/json</div></div><div class="sc-jgPyTC dSaTNC"><div class="sc-jNnpgg esZIbL"><div class="sc-giAqHp hMPeqJ"><button><div class="sc-carFqZ UksDl">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iJCRrE jCdxGr sc-dPaNzc gyljjx"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"metadata"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"property1"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"property2"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"items"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"role"</span>: <span class="token string">"user"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"content"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"phase"</span>: <span class="token string">"commentary"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <span class="token string">"message"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Response samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-114" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-115" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-115" aria-labelledby="react-tabs-114"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-bBjRSN kQSIAz">application/json</div></div><div class="sc-jgPyTC dSaTNC"><div class="sc-jNnpgg esZIbL"><div class="sc-giAqHp hMPeqJ"><button><div class="sc-carFqZ UksDl">Copy</div></button></div><div class="sc-iJCRrE jCdxGr sc-dPaNzc gyljjx"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"object"</span>: <span class="token string">"conversation"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"created_at"</span>: <span class="token number">0</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Conversations/operation/getConversation" data-section-id="tag/Conversations/operation/getConversation" class="sc-eCApnc liLqNm"><div data-section-id="operation/getConversation" id="operation/getConversation" class="sc-iCoGMd gLxhOh"><div class="sc-hKFxyN juinod"><h2 class="sc-pNWdM eftmgB"><a class="sc-crzoAE iUxAWq" href="#tag/Conversations/operation/getConversation" aria-label="tag/Conversations/operation/getConversation"></a>Get a conversation<!-- --> </h2><div class="sc-fcmMJX cvfxAX"><div class="sc-jUfyBS bhDyou"><h5 class="sc-iqAclL sc-fuISkM eONCmm hZIgic">Authorizations:</h5><svg class="sc-dIsUp iPqByX" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jQAxuV ccffaZ"><span class="sc-daBunf fcvuS"><span class="sc-dsXzNU dPrSxx"><i>ApiKeyAuth</i></span></span></div></div><div><h5 class="sc-iqAclL eONCmm">path<!-- --> Parameters</h5><table class="sc-hHEiqL VCQHZ"><tbody><tr class="last "><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="conversation_id"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">conversation_id</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><span class="sc-laZMeE jWaWWE"> <!-- -->Example:<!-- --> </span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">conv_123</span></div><div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The ID of the conversation to retrieve.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-fIxmyt DvFer">Responses</h3><div><button class="sc-htmcrh lbYftx"><svg class="sc-dIsUp dqYXmg" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-fWWYYk cMoEZ">200<!-- --> </strong><span class="sc-jcwpoC eDjFAZ"><p>Success</p>
</span></button></div></div></div><div class="sc-jSFjdj sc-gKAaRy gBjRyf gcushC"><div class="sc-EZqKI fWsqvQ"><button class="sc-eEVmNe ilvUMs"><span type="get" class="sc-fmdNqN ihNycv http-verb get">get</span><span class="sc-jXcxbT fCEUju">/conversations/{conversation_id}</span><svg class="sc-dIsUp bRmrKA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ljsmAU flIrdF"><div class="sc-jlZJtj fQkroN"><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div><div tabindex="0" role="button"><div class="sc-dTSzeu dfUAUz"><span>https://api.openai.com/v1</span>/conversations/{conversation_id}</div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Response samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-116" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-117" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-117" aria-labelledby="react-tabs-116"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-bBjRSN kQSIAz">application/json</div></div><div class="sc-jgPyTC dSaTNC"><div class="sc-jNnpgg esZIbL"><div class="sc-giAqHp hMPeqJ"><button><div class="sc-carFqZ UksDl">Copy</div></button></div><div class="sc-iJCRrE jCdxGr sc-dPaNzc gyljjx"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"object"</span>: <span class="token string">"conversation"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"created_at"</span>: <span class="token number">0</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Conversations/operation/deleteConversation" data-section-id="tag/Conversations/operation/deleteConversation" class="sc-eCApnc liLqNm"><div data-section-id="operation/deleteConversation" id="operation/deleteConversation" class="sc-iCoGMd gLxhOh"><div class="sc-hKFxyN juinod"><h2 class="sc-pNWdM eftmgB"><a class="sc-crzoAE iUxAWq" href="#tag/Conversations/operation/deleteConversation" aria-label="tag/Conversations/operation/deleteConversation"></a>Delete a conversation. Items in the conversation will not be deleted.<!-- --> </h2><div class="sc-fcmMJX cvfxAX"><div class="sc-jUfyBS bhDyou"><h5 class="sc-iqAclL sc-fuISkM eONCmm hZIgic">Authorizations:</h5><svg class="sc-dIsUp iPqByX" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jQAxuV ccffaZ"><span class="sc-daBunf fcvuS"><span class="sc-dsXzNU dPrSxx"><i>ApiKeyAuth</i></span></span></div></div><div><h5 class="sc-iqAclL eONCmm">path<!-- --> Parameters</h5><table class="sc-hHEiqL VCQHZ"><tbody><tr class="last "><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="conversation_id"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">conversation_id</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><span class="sc-laZMeE jWaWWE"> <!-- -->Example:<!-- --> </span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">conv_123</span></div><div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The ID of the conversation to delete.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-fIxmyt DvFer">Responses</h3><div><button class="sc-htmcrh lbYftx"><svg class="sc-dIsUp dqYXmg" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-fWWYYk cMoEZ">200<!-- --> </strong><span class="sc-jcwpoC eDjFAZ"><p>Success</p>
</span></button></div></div></div><div class="sc-jSFjdj sc-gKAaRy gBjRyf gcushC"><div class="sc-EZqKI fWsqvQ"><button class="sc-eEVmNe ilvUMs"><span type="delete" class="sc-fmdNqN bJzUtf http-verb delete">delete</span><span class="sc-jXcxbT fCEUju">/conversations/{conversation_id}</span><svg class="sc-dIsUp bRmrKA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ljsmAU flIrdF"><div class="sc-jlZJtj fQkroN"><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div><div tabindex="0" role="button"><div class="sc-dTSzeu dfUAUz"><span>https://api.openai.com/v1</span>/conversations/{conversation_id}</div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Response samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-118" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-119" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-119" aria-labelledby="react-tabs-118"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-bBjRSN kQSIAz">application/json</div></div><div class="sc-jgPyTC dSaTNC"><div class="sc-jNnpgg esZIbL"><div class="sc-giAqHp hMPeqJ"><button><div class="sc-carFqZ UksDl">Copy</div></button></div><div class="sc-iJCRrE jCdxGr sc-dPaNzc gyljjx"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"object"</span>: <span class="token string">"conversation.deleted"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"deleted"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Conversations/operation/updateConversation" data-section-id="tag/Conversations/operation/updateConversation" class="sc-eCApnc liLqNm"><div data-section-id="operation/updateConversation" id="operation/updateConversation" class="sc-iCoGMd gLxhOh"><div class="sc-hKFxyN juinod"><h2 class="sc-pNWdM eftmgB"><a class="sc-crzoAE iUxAWq" href="#tag/Conversations/operation/updateConversation" aria-label="tag/Conversations/operation/updateConversation"></a>Update a conversation<!-- --> </h2><div class="sc-fcmMJX cvfxAX"><div class="sc-jUfyBS bhDyou"><h5 class="sc-iqAclL sc-fuISkM eONCmm hZIgic">Authorizations:</h5><svg class="sc-dIsUp iPqByX" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jQAxuV ccffaZ"><span class="sc-daBunf fcvuS"><span class="sc-dsXzNU dPrSxx"><i>ApiKeyAuth</i></span></span></div></div><div><h5 class="sc-iqAclL eONCmm">path<!-- --> Parameters</h5><table class="sc-hHEiqL VCQHZ"><tbody><tr class="last "><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="conversation_id"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">conversation_id</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><span class="sc-laZMeE jWaWWE"> <!-- -->Example:<!-- --> </span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">conv_123</span></div><div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The ID of the conversation to update.</p>
</div></div></div></td></tr></tbody></table></div><h5 class="sc-iqAclL eONCmm">Request Body schema: <span class="sc-cBoqAE eKyrDP">application/json</span></h5><div class="sc-iJCRrE sc-ciSkZP jCdxGr QGruV"></div><table class="sc-hHEiqL VCQHZ"><tbody><tr class="last "><td class="sc-hBMUJo sc-fFSPTT sc-gSYDnn iwcKgn cAqMTE hTttpy" kind="field" title="metadata"><span class="sc-iemWCZ bcnRwz"></span><button aria-label="expand properties"><span class="property-name">metadata</span><svg class="sc-dIsUp hGHhhO" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">Metadata (object) or Metadata (null)</span><span class="sc-laZMeE sc-eJocfa jWaWWE bArHDh"> (<!-- -->Metadata<!-- -->) </span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format, and querying for objects via API or the dashboard.
Keys are strings with a maximum length of 64 characters. Values are strings with a maximum length of 512 characters.</p>
</div></div></div></td></tr></tbody></table><div><h3 class="sc-fIxmyt DvFer">Responses</h3><div><button class="sc-htmcrh lbYftx"><svg class="sc-dIsUp dqYXmg" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-fWWYYk cMoEZ">200<!-- --> </strong><span class="sc-jcwpoC eDjFAZ"><p>Success</p>
</span></button></div></div></div><div class="sc-jSFjdj sc-gKAaRy gBjRyf gcushC"><div class="sc-EZqKI fWsqvQ"><button class="sc-eEVmNe ilvUMs"><span type="post" class="sc-fmdNqN ldMUmp http-verb post">post</span><span class="sc-jXcxbT fCEUju">/conversations/{conversation_id}</span><svg class="sc-dIsUp bRmrKA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ljsmAU flIrdF"><div class="sc-jlZJtj fQkroN"><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div><div tabindex="0" role="button"><div class="sc-dTSzeu dfUAUz"><span>https://api.openai.com/v1</span>/conversations/{conversation_id}</div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Request samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="react-tabs-120" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-121" tabindex="0" data-rttab="true">Payload</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-121" aria-labelledby="react-tabs-120"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-bBjRSN kQSIAz">application/json</div></div><div class="sc-jgPyTC dSaTNC"><div class="sc-jNnpgg esZIbL"><div class="sc-giAqHp hMPeqJ"><button><div class="sc-carFqZ UksDl">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iJCRrE jCdxGr sc-dPaNzc gyljjx"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"metadata"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"property1"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"property2"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Response samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-122" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-123" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-123" aria-labelledby="react-tabs-122"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-bBjRSN kQSIAz">application/json</div></div><div class="sc-jgPyTC dSaTNC"><div class="sc-jNnpgg esZIbL"><div class="sc-giAqHp hMPeqJ"><button><div class="sc-carFqZ UksDl">Copy</div></button></div><div class="sc-iJCRrE jCdxGr sc-dPaNzc gyljjx"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"object"</span>: <span class="token string">"conversation"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"created_at"</span>: <span class="token number">0</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Completions" data-section-id="tag/Completions" class="sc-eCApnc jlMQbh"><div class="sc-iCoGMd gLxhOh"><div class="sc-hKFxyN juinod"><h1 class="sc-fujyAs bpZWeL"><a class="sc-crzoAE iUxAWq" href="#tag/Completions" aria-label="tag/Completions"></a>Completions</h1></div></div><div class="sc-hKFxyN bJcDWV"><div class="sc-iJCRrE sc-ciSkZP jCdxGr QGruV redoc-markdown "><p>Given a prompt, the model will return one or more predicted completions, and can also return the probabilities of alternative tokens at each position.</p>
</div></div></div><div id="tag/Completions/operation/createCompletion" data-section-id="tag/Completions/operation/createCompletion" class="sc-eCApnc liLqNm"><div data-section-id="operation/createCompletion" id="operation/createCompletion" class="sc-iCoGMd gLxhOh"><div class="sc-hKFxyN juinod"><h2 class="sc-pNWdM eftmgB"><a class="sc-crzoAE iUxAWq" href="#tag/Completions/operation/createCompletion" aria-label="tag/Completions/operation/createCompletion"></a>Creates a completion for the provided prompt and parameters.
Returns a completion object, or a sequence of completion objects if the request is streamed.
<!-- --> </h2><div class="sc-fcmMJX cvfxAX"><div class="sc-jUfyBS bhDyou"><h5 class="sc-iqAclL sc-fuISkM eONCmm hZIgic">Authorizations:</h5><svg class="sc-dIsUp iPqByX" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jQAxuV ccffaZ"><span class="sc-daBunf fcvuS"><span class="sc-dsXzNU dPrSxx"><i>ApiKeyAuth</i></span></span></div></div><h5 class="sc-iqAclL eONCmm">Request Body schema: <span class="sc-cBoqAE eKyrDP">application/json</span></h5><div class="sc-iJCRrE sc-ciSkZP jCdxGr QGruV"></div><table class="sc-hHEiqL VCQHZ"><tbody><tr class=""><td class="sc-hBMUJo sc-fFSPTT sc-gSYDnn iwcKgn cAqMTE hTttpy" kind="field" title="model"><span class="sc-iemWCZ bcnRwz"></span><button aria-label="expand properties"><span class="property-name">model</span><svg class="sc-dIsUp hGHhhO" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string or string</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>ID of the model to use. You can use the <a href="/docs/api-reference/models/list">List models</a> API to see all of your available models, or see our <a href="/docs/models">Model overview</a> for descriptions of them.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT sc-gSYDnn iwcKgn cAqMTE hTttpy" kind="field" title="prompt"><span class="sc-iemWCZ bcnRwz"></span><button aria-label="expand properties"><span class="property-name">prompt</span><svg class="sc-dIsUp hGHhhO" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">(string or null) or (Array of strings or null) or (Array of integers or null) or (Array of integers or null)</span></div><div><span class="sc-laZMeE jWaWWE"> <!-- -->Default:<!-- --> </span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"<|endoftext|>"</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The prompt(s) to generate completions for, encoded as a string, array of strings, array of tokens, or array of token arrays.</p>
<p>Note that <|endoftext|> is the document separator that the model sees during training, so if a prompt is not specified the model will generate as if from the beginning of a new document.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="best_of"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">best_of</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">integer or null</span><span> <span class="sc-laZMeE sc-FRrlG jWaWWE gHBwqe"> <!-- -->[ 0 .. 20 ]<!-- --> </span></span></div><div><span class="sc-laZMeE jWaWWE"> <!-- -->Default:<!-- --> </span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">1</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>Generates <code>best_of</code> completions server-side and returns the "best" (the one with the highest log probability per token). Results cannot be streamed.</p>
<p>When used with <code>n</code>, <code>best_of</code> controls the number of candidate completions and <code>n</code> specifies how many to return – <code>best_of</code> must be greater than <code>n</code>.</p>
<p><strong>Note:</strong> Because this parameter generates many completions, it can quickly consume your token quota. Use carefully and ensure that you have reasonable settings for <code>max_tokens</code> and <code>stop</code>.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="echo"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">echo</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">boolean or null</span></div><div><span class="sc-laZMeE jWaWWE"> <!-- -->Default:<!-- --> </span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">false</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>Echo back the prompt in addition to the completion</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="frequency_penalty"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">frequency_penalty</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">number or null</span><span> <span class="sc-laZMeE sc-FRrlG jWaWWE gHBwqe"> <!-- -->[ -2 .. 2 ]<!-- --> </span></span></div><div><span class="sc-laZMeE jWaWWE"> <!-- -->Default:<!-- --> </span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">0</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>Number between -2.0 and 2.0. Positive values penalize new tokens based on their existing frequency in the text so far, decreasing the model's likelihood to repeat the same line verbatim.</p>
<p><a href="/docs/guides/text-generation">See more information about frequency and presence penalties.</a></p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT sc-gSYDnn iwcKgn cAqMTE hTttpy" kind="field" title="logit_bias"><span class="sc-iemWCZ bcnRwz"></span><button aria-label="expand properties"><span class="property-name">logit_bias</span><svg class="sc-dIsUp hGHhhO" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">object or null</span></div><div><span class="sc-laZMeE jWaWWE"> <!-- -->Default:<!-- --> </span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">null</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>Modify the likelihood of specified tokens appearing in the completion.</p>
<p>Accepts a JSON object that maps tokens (specified by their token ID in the GPT tokenizer) to an associated bias value from -100 to 100. You can use this <a href="/tokenizer?view=bpe">tokenizer tool</a> to convert text to token IDs. Mathematically, the bias is added to the logits generated by the model prior to sampling. The exact effect will vary per model, but values between -1 and 1 should decrease or increase likelihood of selection; values like -100 or 100 should result in a ban or exclusive selection of the relevant token.</p>
<p>As an example, you can pass <code>{"50256": -100}</code> to prevent the <|endoftext|> token from being generated.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="logprobs"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">logprobs</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">integer or null</span><span> <span class="sc-laZMeE sc-FRrlG jWaWWE gHBwqe"> <!-- -->[ 0 .. 5 ]<!-- --> </span></span></div><div><span class="sc-laZMeE jWaWWE"> <!-- -->Default:<!-- --> </span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">null</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>Include the log probabilities on the <code>logprobs</code> most likely output tokens, as well the chosen tokens. For example, if <code>logprobs</code> is 5, the API will return a list of the 5 most likely tokens. The API will always return the <code>logprob</code> of the sampled token, so there may be up to <code>logprobs+1</code> elements in the response.</p>
<p>The maximum value for <code>logprobs</code> is 5.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="max_tokens"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">max_tokens</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">integer or null</span><span> <span class="sc-laZMeE sc-FRrlG jWaWWE gHBwqe"> <!-- -->>= 0<!-- --> </span></span></div><div><span class="sc-laZMeE jWaWWE"> <!-- -->Default:<!-- --> </span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">16</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The maximum number of <a href="/tokenizer">tokens</a> that can be generated in the completion.</p>
<p>The token count of your prompt plus <code>max_tokens</code> cannot exceed the model's context length. <a href="https://cookbook.openai.com/examples/how_to_count_tokens_with_tiktoken">Example Python code</a> for counting tokens.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="n"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">n</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">integer or null</span><span> <span class="sc-laZMeE sc-FRrlG jWaWWE gHBwqe"> <!-- -->[ 1 .. 128 ]<!-- --> </span></span></div><div><span class="sc-laZMeE jWaWWE"> <!-- -->Default:<!-- --> </span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">1</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>How many completions to generate for each prompt.</p>
<p><strong>Note:</strong> Because this parameter generates many completions, it can quickly consume your token quota. Use carefully and ensure that you have reasonable settings for <code>max_tokens</code> and <code>stop</code>.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="presence_penalty"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">presence_penalty</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">number or null</span><span> <span class="sc-laZMeE sc-FRrlG jWaWWE gHBwqe"> <!-- -->[ -2 .. 2 ]<!-- --> </span></span></div><div><span class="sc-laZMeE jWaWWE"> <!-- -->Default:<!-- --> </span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">0</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>Number between -2.0 and 2.0. Positive values penalize new tokens based on whether they appear in the text so far, increasing the model's likelihood to talk about new topics.</p>
<p><a href="/docs/guides/text-generation">See more information about frequency and presence penalties.</a></p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="seed"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">seed</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">integer or null</span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa"> <!-- --><<!-- -->int64<!-- -->><!-- --> </span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>If specified, our system will make a best effort to sample deterministically, such that repeated requests with the same <code>seed</code> and parameters should return the same result.</p>
<p>Determinism is not guaranteed, and you should refer to the <code>system_fingerprint</code> response parameter to monitor changes in the backend.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT sc-gSYDnn iwcKgn cAqMTE hTttpy" kind="field" title="stop"><span class="sc-iemWCZ bcnRwz"></span><button aria-label="expand properties"><span class="property-name">stop</span><svg class="sc-dIsUp hGHhhO" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">(string or null) or Array of strings</span><span class="sc-laZMeE sc-eJocfa jWaWWE bArHDh"> (<!-- -->StopConfiguration<!-- -->) </span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="stream"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">stream</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">boolean or null</span></div><div><span class="sc-laZMeE jWaWWE"> <!-- -->Default:<!-- --> </span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">false</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>Whether to stream back partial progress. If set, tokens will be sent as data-only <a href="https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events/Using_server-sent_events#Event_stream_format">server-sent events</a> as they become available, with the stream terminated by a <code>data: [DONE]</code> message. <a href="https://cookbook.openai.com/examples/how_to_stream_completions">Example Python code</a>.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT sc-gSYDnn iwcKgn cAqMTE hTttpy" kind="field" title="stream_options"><span class="sc-iemWCZ bcnRwz"></span><button aria-label="expand properties"><span class="property-name">stream_options</span><svg class="sc-dIsUp hGHhhO" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">ChatCompletionStreamOptions (object) or ChatCompletionStreamOptions (null)</span><span class="sc-laZMeE sc-eJocfa jWaWWE bArHDh"> (<!-- -->ChatCompletionStreamOptions<!-- -->) </span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="suffix"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">suffix</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string or null</span></div><div><span class="sc-laZMeE jWaWWE"> <!-- -->Default:<!-- --> </span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">null</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The suffix that comes after a completion of inserted text.</p>
<p>This parameter is only supported for <code>gpt-3.5-turbo-instruct</code>.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="temperature"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">temperature</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">number or null</span><span> <span class="sc-laZMeE sc-FRrlG jWaWWE gHBwqe"> <!-- -->[ 0 .. 2 ]<!-- --> </span></span></div><div><span class="sc-laZMeE jWaWWE"> <!-- -->Default:<!-- --> </span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">1</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>What sampling temperature to use, between 0 and 2. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic.</p>
<p>We generally recommend altering this or <code>top_p</code> but not both.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="top_p"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">top_p</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">number or null</span><span> <span class="sc-laZMeE sc-FRrlG jWaWWE gHBwqe"> <!-- -->[ 0 .. 1 ]<!-- --> </span></span></div><div><span class="sc-laZMeE jWaWWE"> <!-- -->Default:<!-- --> </span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">1</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>An alternative to sampling with temperature, called nucleus sampling, where the model considers the results of the tokens with top_p probability mass. So 0.1 means only the tokens comprising the top 10% probability mass are considered.</p>
<p>We generally recommend altering this or <code>temperature</code> but not both.</p>
</div></div></div></td></tr><tr class="last "><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="user"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">user</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>A unique identifier representing your end-user, which can help OpenAI to monitor and detect abuse. <a href="/docs/guides/safety-best-practices#end-user-ids">Learn more</a>.</p>
</div></div></div></td></tr></tbody></table><div><h3 class="sc-fIxmyt DvFer">Responses</h3><div><button class="sc-htmcrh lbYftx"><svg class="sc-dIsUp dqYXmg" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-fWWYYk cMoEZ">200<!-- --> </strong><span class="sc-jcwpoC eDjFAZ"><p>OK</p>
</span></button></div></div></div><div class="sc-jSFjdj sc-gKAaRy gBjRyf gcushC"><div class="sc-EZqKI fWsqvQ"><button class="sc-eEVmNe ilvUMs"><span type="post" class="sc-fmdNqN ldMUmp http-verb post">post</span><span class="sc-jXcxbT fCEUju">/completions</span><svg class="sc-dIsUp bRmrKA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ljsmAU flIrdF"><div class="sc-jlZJtj fQkroN"><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div><div tabindex="0" role="button"><div class="sc-dTSzeu dfUAUz"><span>https://api.openai.com/v1</span>/completions</div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Request samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="react-tabs-124" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-125" tabindex="0" data-rttab="true">Payload</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-125" aria-labelledby="react-tabs-124"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-bBjRSN kQSIAz">application/json</div></div><div class="sc-jgPyTC dSaTNC"><div class="sc-jNnpgg esZIbL"><div class="sc-giAqHp hMPeqJ"><button><div class="sc-carFqZ UksDl">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iJCRrE jCdxGr sc-dPaNzc gyljjx"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"model"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"prompt"</span>: <span class="token string">"<|endoftext|>"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"best_of"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"echo"</span>: <span class="token boolean">false</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"frequency_penalty"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"logit_bias"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"logprobs"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"max_tokens"</span>: <span class="token number">16</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"n"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"presence_penalty"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"seed"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"stop"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"stream"</span>: <span class="token boolean">false</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"stream_options"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"suffix"</span>: <span class="token string">"test."</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"temperature"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"top_p"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"user"</span>: <span class="token string">"user-1234"</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Response samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-126" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-127" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-127" aria-labelledby="react-tabs-126"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-bBjRSN kQSIAz">application/json</div></div><div class="sc-jgPyTC dSaTNC"><div class="sc-jNnpgg esZIbL"><div class="sc-giAqHp hMPeqJ"><button><div class="sc-carFqZ UksDl">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iJCRrE jCdxGr sc-dPaNzc gyljjx"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"choices"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"finish_reason"</span>: <span class="token string">"stop"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"index"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"logprobs"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"text_offset"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><span class="token number">0</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"token_logprobs"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><span class="token number">0</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"tokens"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><span class="token string">"string"</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"top_logprobs"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"property1"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"property2"</span>: <span class="token number">0</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"text"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"created"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"model"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"system_fingerprint"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"object"</span>: <span class="token string">"text_completion"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"usage"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"completion_tokens"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"prompt_tokens"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"total_tokens"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"completion_tokens_details"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"accepted_prediction_tokens"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"audio_tokens"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"reasoning_tokens"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"rejected_prediction_tokens"</span>: <span class="token number">0</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"prompt_tokens_details"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"audio_tokens"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"cached_tokens"</span>: <span class="token number">0</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Embeddings" data-section-id="tag/Embeddings" class="sc-eCApnc jlMQbh"><div class="sc-iCoGMd gLxhOh"><div class="sc-hKFxyN juinod"><h1 class="sc-fujyAs bpZWeL"><a class="sc-crzoAE iUxAWq" href="#tag/Embeddings" aria-label="tag/Embeddings"></a>Embeddings</h1></div></div><div class="sc-hKFxyN bJcDWV"><div class="sc-iJCRrE sc-ciSkZP jCdxGr QGruV redoc-markdown "><p>Get a vector representation of a given input that can be easily consumed by machine learning models and algorithms.</p>
</div></div></div><div id="tag/Embeddings/operation/createEmbedding" data-section-id="tag/Embeddings/operation/createEmbedding" class="sc-eCApnc liLqNm"><div data-section-id="operation/createEmbedding" id="operation/createEmbedding" class="sc-iCoGMd gLxhOh"><div class="sc-hKFxyN juinod"><h2 class="sc-pNWdM eftmgB"><a class="sc-crzoAE iUxAWq" href="#tag/Embeddings/operation/createEmbedding" aria-label="tag/Embeddings/operation/createEmbedding"></a>Creates an embedding vector representing the input text.<!-- --> </h2><div class="sc-fcmMJX cvfxAX"><div class="sc-jUfyBS bhDyou"><h5 class="sc-iqAclL sc-fuISkM eONCmm hZIgic">Authorizations:</h5><svg class="sc-dIsUp iPqByX" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jQAxuV ccffaZ"><span class="sc-daBunf fcvuS"><span class="sc-dsXzNU dPrSxx"><i>ApiKeyAuth</i></span></span></div></div><h5 class="sc-iqAclL eONCmm">Request Body schema: <span class="sc-cBoqAE eKyrDP">application/json</span></h5><div class="sc-iJCRrE sc-ciSkZP jCdxGr QGruV"></div><table class="sc-hHEiqL VCQHZ"><tbody><tr class=""><td class="sc-hBMUJo sc-fFSPTT sc-gSYDnn iwcKgn cAqMTE hTttpy" kind="field" title="input"><span class="sc-iemWCZ bcnRwz"></span><button aria-label="expand properties"><span class="property-name">input</span><svg class="sc-dIsUp hGHhhO" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string (string) or Array of array (strings) or Array of array (integers) or Array of array (integers)</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>Input text to embed, encoded as a string or array of tokens. To embed multiple inputs in a single request, pass an array of strings or array of token arrays. The input must not exceed the max input tokens for the model (8192 tokens for all embedding models), cannot be an empty string, and any array must be 2048 dimensions or less. <a href="https://cookbook.openai.com/examples/how_to_count_tokens_with_tiktoken">Example Python code</a> for counting tokens. In addition to the per-input token limit, all embedding models enforce a maximum of 300,000 tokens summed across all inputs in a single request.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT sc-gSYDnn iwcKgn cAqMTE hTttpy" kind="field" title="model"><span class="sc-iemWCZ bcnRwz"></span><button aria-label="expand properties"><span class="property-name">model</span><svg class="sc-dIsUp hGHhhO" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string or string</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>ID of the model to use. You can use the <a href="/docs/api-reference/models/list">List models</a> API to see all of your available models, or see our <a href="/docs/models">Model overview</a> for descriptions of them.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="encoding_format"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">encoding_format</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div><div><span class="sc-laZMeE jWaWWE"> <!-- -->Default:<!-- --> </span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"float"</span></div><div><span class="sc-laZMeE jWaWWE"> <!-- -->Enum<!-- -->:</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"float"</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"base64"</span> </div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The format to return the embeddings in. Can be either <code>float</code> or <a href="https://pypi.org/project/pybase64/"><code>base64</code></a>.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="dimensions"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">dimensions</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">integer</span><span> <span class="sc-laZMeE sc-FRrlG jWaWWE gHBwqe"> <!-- -->>= 1<!-- --> </span></span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The number of dimensions the resulting output embeddings should have. Only supported in <code>text-embedding-3</code> and later models.</p>
</div></div></div></td></tr><tr class="last "><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="user"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">user</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>A unique identifier representing your end-user, which can help OpenAI to monitor and detect abuse. <a href="/docs/guides/safety-best-practices#end-user-ids">Learn more</a>.</p>
</div></div></div></td></tr></tbody></table><div><h3 class="sc-fIxmyt DvFer">Responses</h3><div><button class="sc-htmcrh lbYftx"><svg class="sc-dIsUp dqYXmg" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-fWWYYk cMoEZ">200<!-- --> </strong><span class="sc-jcwpoC eDjFAZ"><p>OK</p>
</span></button></div></div></div><div class="sc-jSFjdj sc-gKAaRy gBjRyf gcushC"><div class="sc-EZqKI fWsqvQ"><button class="sc-eEVmNe ilvUMs"><span type="post" class="sc-fmdNqN ldMUmp http-verb post">post</span><span class="sc-jXcxbT fCEUju">/embeddings</span><svg class="sc-dIsUp bRmrKA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ljsmAU flIrdF"><div class="sc-jlZJtj fQkroN"><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div><div tabindex="0" role="button"><div class="sc-dTSzeu dfUAUz"><span>https://api.openai.com/v1</span>/embeddings</div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Request samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="react-tabs-128" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-129" tabindex="0" data-rttab="true">Payload</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-129" aria-labelledby="react-tabs-128"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-bBjRSN kQSIAz">application/json</div></div><div class="sc-jgPyTC dSaTNC"><div class="sc-jNnpgg esZIbL"><div class="sc-giAqHp hMPeqJ"><button><div class="sc-carFqZ UksDl">Copy</div></button></div><div class="sc-iJCRrE jCdxGr sc-dPaNzc gyljjx"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"input"</span>: <span class="token string">"The quick brown fox jumped over the lazy dog"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"model"</span>: <span class="token string">"text-embedding-3-small"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"encoding_format"</span>: <span class="token string">"float"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"dimensions"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"user"</span>: <span class="token string">"user-1234"</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Response samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-130" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-131" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-131" aria-labelledby="react-tabs-130"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-bBjRSN kQSIAz">application/json</div></div><div class="sc-jgPyTC dSaTNC"><div class="sc-jNnpgg esZIbL"><div class="sc-giAqHp hMPeqJ"><button><div class="sc-carFqZ UksDl">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iJCRrE jCdxGr sc-dPaNzc gyljjx"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"index"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"embedding"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><span class="token number">0</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"object"</span>: <span class="token string">"embedding"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"model"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"object"</span>: <span class="token string">"list"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"usage"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"prompt_tokens"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"total_tokens"</span>: <span class="token number">0</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Evals" data-section-id="tag/Evals" class="sc-eCApnc jlMQbh"><div class="sc-iCoGMd gLxhOh"><div class="sc-hKFxyN juinod"><h1 class="sc-fujyAs bpZWeL"><a class="sc-crzoAE iUxAWq" href="#tag/Evals" aria-label="tag/Evals"></a>Evals</h1></div></div><div class="sc-hKFxyN bJcDWV"><div class="sc-iJCRrE sc-ciSkZP jCdxGr QGruV redoc-markdown "><p>Manage and run evals in the OpenAI platform.</p>
</div></div></div><div id="tag/Evals/operation/listEvals" data-section-id="tag/Evals/operation/listEvals" class="sc-eCApnc liLqNm"><div data-section-id="operation/listEvals" id="operation/listEvals" class="sc-iCoGMd gLxhOh"><div class="sc-hKFxyN juinod"><h2 class="sc-pNWdM eftmgB"><a class="sc-crzoAE iUxAWq" href="#tag/Evals/operation/listEvals" aria-label="tag/Evals/operation/listEvals"></a>List evaluations for a project.
<!-- --> </h2><div class="sc-fcmMJX cvfxAX"><div class="sc-jUfyBS bhDyou"><h5 class="sc-iqAclL sc-fuISkM eONCmm hZIgic">Authorizations:</h5><svg class="sc-dIsUp iPqByX" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jQAxuV ccffaZ"><span class="sc-daBunf fcvuS"><span class="sc-dsXzNU dPrSxx"><i>ApiKeyAuth</i></span></span></div></div><div><h5 class="sc-iqAclL eONCmm">query<!-- --> Parameters</h5><table class="sc-hHEiqL VCQHZ"><tbody><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="after"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">after</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>Identifier for the last eval from the previous pagination request.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="limit"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">limit</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">integer</span></div><div><span class="sc-laZMeE jWaWWE"> <!-- -->Default:<!-- --> </span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">20</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>Number of evals to retrieve.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="order"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">order</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div><div><span class="sc-laZMeE jWaWWE"> <!-- -->Default:<!-- --> </span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"asc"</span></div><div><span class="sc-laZMeE jWaWWE"> <!-- -->Enum<!-- -->:</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"asc"</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"desc"</span> </div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>Sort order for evals by timestamp. Use <code>asc</code> for ascending order or <code>desc</code> for descending order.</p>
</div></div></div></td></tr><tr class="last "><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="order_by"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">order_by</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div><div><span class="sc-laZMeE jWaWWE"> <!-- -->Default:<!-- --> </span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"created_at"</span></div><div><span class="sc-laZMeE jWaWWE"> <!-- -->Enum<!-- -->:</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"created_at"</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"updated_at"</span> </div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>Evals can be ordered by creation time or last updated time. Use
<code>created_at</code> for creation time or <code>updated_at</code> for last updated time.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-fIxmyt DvFer">Responses</h3><div><button class="sc-htmcrh lbYftx"><svg class="sc-dIsUp dqYXmg" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-fWWYYk cMoEZ">200<!-- --> </strong><span class="sc-jcwpoC eDjFAZ"><p>A list of evals</p>
</span></button></div></div></div><div class="sc-jSFjdj sc-gKAaRy gBjRyf gcushC"><div class="sc-EZqKI fWsqvQ"><button class="sc-eEVmNe ilvUMs"><span type="get" class="sc-fmdNqN ihNycv http-verb get">get</span><span class="sc-jXcxbT fCEUju">/evals</span><svg class="sc-dIsUp bRmrKA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ljsmAU flIrdF"><div class="sc-jlZJtj fQkroN"><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div><div tabindex="0" role="button"><div class="sc-dTSzeu dfUAUz"><span>https://api.openai.com/v1</span>/evals</div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Response samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-132" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-133" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-133" aria-labelledby="react-tabs-132"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-bBjRSN kQSIAz">application/json</div></div><div class="sc-jgPyTC dSaTNC"><div class="sc-jNnpgg esZIbL"><div class="sc-giAqHp hMPeqJ"><button><div class="sc-carFqZ UksDl">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iJCRrE jCdxGr sc-dPaNzc gyljjx"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"object"</span>: <span class="token string">"list"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"object"</span>: <span class="token string">"eval"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"name"</span>: <span class="token string">"Chatbot effectiveness Evaluation"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"data_source_config"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <span class="token string">"custom"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"schema"</span>: <span class="token string">"{\n \"type\": \"object\",\n \"properties\": {\n \"item\": {\n \"type\": \"object\",\n \"properties\": {\n \"label\": {\"type\": \"string\"},\n },\n \"required\": [\"label\"]\n }\n },\n \"required\": [\"item\"]\n}\n"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"testing_criteria"</span>: <span class="token string">"eval"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"created_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"metadata"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"property1"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"property2"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"first_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"last_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"has_more"</span>: <span class="token boolean">true</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Evals/operation/createEval" data-section-id="tag/Evals/operation/createEval" class="sc-eCApnc liLqNm"><div data-section-id="operation/createEval" id="operation/createEval" class="sc-iCoGMd gLxhOh"><div class="sc-hKFxyN juinod"><h2 class="sc-pNWdM eftmgB"><a class="sc-crzoAE iUxAWq" href="#tag/Evals/operation/createEval" aria-label="tag/Evals/operation/createEval"></a>Create the structure of an evaluation that can be used to test a model's performance.
An evaluation is a set of testing criteria and the config for a data source, which dictates the schema of the data used in the evaluation. After creating an evaluation, you can run it on different models and model parameters. We support several types of graders and datasources.
For more information, see the [Evals guide](/docs/guides/evals).
<!-- --> </h2><div class="sc-fcmMJX cvfxAX"><div class="sc-jUfyBS bhDyou"><h5 class="sc-iqAclL sc-fuISkM eONCmm hZIgic">Authorizations:</h5><svg class="sc-dIsUp iPqByX" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jQAxuV ccffaZ"><span class="sc-daBunf fcvuS"><span class="sc-dsXzNU dPrSxx"><i>ApiKeyAuth</i></span></span></div></div><h5 class="sc-iqAclL eONCmm">Request Body schema: <span class="sc-cBoqAE eKyrDP">application/json</span></h5><div class="sc-iJCRrE sc-ciSkZP jCdxGr QGruV"></div><table class="sc-hHEiqL VCQHZ"><tbody><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="name"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">name</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The name of the evaluation.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT sc-gSYDnn iwcKgn cAqMTE hTttpy" kind="field" title="metadata"><span class="sc-iemWCZ bcnRwz"></span><button aria-label="expand properties"><span class="property-name">metadata</span><svg class="sc-dIsUp hGHhhO" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">Metadata (object) or Metadata (null)</span><span class="sc-laZMeE sc-eJocfa jWaWWE bArHDh"> (<!-- -->Metadata<!-- -->) </span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT sc-gSYDnn iwcKgn cAqMTE hTttpy" kind="field" title="data_source_config"><span class="sc-iemWCZ bcnRwz"></span><button aria-label="expand properties"><span class="property-name">data_source_config</span><svg class="sc-dIsUp hGHhhO" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">CustomDataSourceConfig (object) or LogsDataSourceConfig (object) or StoredCompletionsDataSourceConfig (object)</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The configuration for the data source used for the evaluation runs. Dictates the schema of the data used in the evaluation.</p>
</div></div></div></td></tr><tr class="last "><td class="sc-hBMUJo sc-fFSPTT sc-gSYDnn iwcKgn cAqMTE hTttpy" kind="field" title="testing_criteria"><span class="sc-iemWCZ bcnRwz"></span><button aria-label="expand properties"><span class="property-name">testing_criteria</span><svg class="sc-dIsUp hGHhhO" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa">Array of </span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">LabelModelGrader (object) or StringCheckGrader (object) or TextSimilarityGrader (object) or PythonGrader (object) or ScoreModelGrader (object)</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>A list of graders for all eval runs in this group. Graders can reference variables in the data source using double curly braces notation, like <code>{{item.variable_name}}</code>. To reference the model's output, use the <code>sample</code> namespace (ie, <code>{{sample.output_text}}</code>).</p>
</div></div></div></td></tr></tbody></table><div><h3 class="sc-fIxmyt DvFer">Responses</h3><div><button class="sc-htmcrh lbYftx"><svg class="sc-dIsUp dqYXmg" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-fWWYYk cMoEZ">201<!-- --> </strong><span class="sc-jcwpoC eDjFAZ"><p>OK</p>
</span></button></div></div></div><div class="sc-jSFjdj sc-gKAaRy gBjRyf gcushC"><div class="sc-EZqKI fWsqvQ"><button class="sc-eEVmNe ilvUMs"><span type="post" class="sc-fmdNqN ldMUmp http-verb post">post</span><span class="sc-jXcxbT fCEUju">/evals</span><svg class="sc-dIsUp bRmrKA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ljsmAU flIrdF"><div class="sc-jlZJtj fQkroN"><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div><div tabindex="0" role="button"><div class="sc-dTSzeu dfUAUz"><span>https://api.openai.com/v1</span>/evals</div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Request samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="react-tabs-134" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-135" tabindex="0" data-rttab="true">Payload</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-135" aria-labelledby="react-tabs-134"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-bBjRSN kQSIAz">application/json</div></div><div class="sc-jgPyTC dSaTNC"><div class="sc-jNnpgg esZIbL"><div class="sc-giAqHp hMPeqJ"><button><div class="sc-carFqZ UksDl">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iJCRrE jCdxGr sc-dPaNzc gyljjx"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"property1"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"property2"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"data_source_config"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <span class="token string">"custom"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"item_schema"</span>: <span class="token string">"{\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\"type\": \"string\"},\n \"age\": {\"type\": \"integer\"}\n },\n \"required\": [\"name\", \"age\"]\n}\n"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"include_sample_schema"</span>: <span class="token boolean">false</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"testing_criteria"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <span class="token string">"label_model"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"model"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"input"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"role"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"content"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"labels"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><span class="token string">"string"</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"passing_labels"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><span class="token string">"string"</span></div></li></ul><span class="token punctuation">]</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Response samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-136" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-137" tabindex="0" data-rttab="true">201</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-137" aria-labelledby="react-tabs-136"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-bBjRSN kQSIAz">application/json</div></div><div class="sc-jgPyTC dSaTNC"><div class="sc-jNnpgg esZIbL"><div class="sc-giAqHp hMPeqJ"><button><div class="sc-carFqZ UksDl">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iJCRrE jCdxGr sc-dPaNzc gyljjx"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"object"</span>: <span class="token string">"eval"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">"Chatbot effectiveness Evaluation"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"data_source_config"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <span class="token string">"custom"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"schema"</span>: <span class="token string">"{\n \"type\": \"object\",\n \"properties\": {\n \"item\": {\n \"type\": \"object\",\n \"properties\": {\n \"label\": {\"type\": \"string\"},\n },\n \"required\": [\"label\"]\n }\n },\n \"required\": [\"item\"]\n}\n"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"testing_criteria"</span>: <span class="token string">"eval"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"created_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"property1"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"property2"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Evals/operation/getEval" data-section-id="tag/Evals/operation/getEval" class="sc-eCApnc liLqNm"><div data-section-id="operation/getEval" id="operation/getEval" class="sc-iCoGMd gLxhOh"><div class="sc-hKFxyN juinod"><h2 class="sc-pNWdM eftmgB"><a class="sc-crzoAE iUxAWq" href="#tag/Evals/operation/getEval" aria-label="tag/Evals/operation/getEval"></a>Get an evaluation by ID.
<!-- --> </h2><div class="sc-fcmMJX cvfxAX"><div class="sc-jUfyBS bhDyou"><h5 class="sc-iqAclL sc-fuISkM eONCmm hZIgic">Authorizations:</h5><svg class="sc-dIsUp iPqByX" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jQAxuV ccffaZ"><span class="sc-daBunf fcvuS"><span class="sc-dsXzNU dPrSxx"><i>ApiKeyAuth</i></span></span></div></div><div><h5 class="sc-iqAclL eONCmm">path<!-- --> Parameters</h5><table class="sc-hHEiqL VCQHZ"><tbody><tr class="last "><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="eval_id"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">eval_id</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The ID of the evaluation to retrieve.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-fIxmyt DvFer">Responses</h3><div><button class="sc-htmcrh lbYftx"><svg class="sc-dIsUp dqYXmg" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-fWWYYk cMoEZ">200<!-- --> </strong><span class="sc-jcwpoC eDjFAZ"><p>The evaluation</p>
</span></button></div></div></div><div class="sc-jSFjdj sc-gKAaRy gBjRyf gcushC"><div class="sc-EZqKI fWsqvQ"><button class="sc-eEVmNe ilvUMs"><span type="get" class="sc-fmdNqN ihNycv http-verb get">get</span><span class="sc-jXcxbT fCEUju">/evals/{eval_id}</span><svg class="sc-dIsUp bRmrKA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ljsmAU flIrdF"><div class="sc-jlZJtj fQkroN"><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div><div tabindex="0" role="button"><div class="sc-dTSzeu dfUAUz"><span>https://api.openai.com/v1</span>/evals/{eval_id}</div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Response samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-138" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-139" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-139" aria-labelledby="react-tabs-138"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-bBjRSN kQSIAz">application/json</div></div><div class="sc-jgPyTC dSaTNC"><div class="sc-jNnpgg esZIbL"><div class="sc-giAqHp hMPeqJ"><button><div class="sc-carFqZ UksDl">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iJCRrE jCdxGr sc-dPaNzc gyljjx"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"object"</span>: <span class="token string">"eval"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">"Chatbot effectiveness Evaluation"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"data_source_config"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <span class="token string">"custom"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"schema"</span>: <span class="token string">"{\n \"type\": \"object\",\n \"properties\": {\n \"item\": {\n \"type\": \"object\",\n \"properties\": {\n \"label\": {\"type\": \"string\"},\n },\n \"required\": [\"label\"]\n }\n },\n \"required\": [\"item\"]\n}\n"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"testing_criteria"</span>: <span class="token string">"eval"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"created_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"property1"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"property2"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Evals/operation/updateEval" data-section-id="tag/Evals/operation/updateEval" class="sc-eCApnc liLqNm"><div data-section-id="operation/updateEval" id="operation/updateEval" class="sc-iCoGMd gLxhOh"><div class="sc-hKFxyN juinod"><h2 class="sc-pNWdM eftmgB"><a class="sc-crzoAE iUxAWq" href="#tag/Evals/operation/updateEval" aria-label="tag/Evals/operation/updateEval"></a>Update certain properties of an evaluation.
<!-- --> </h2><div class="sc-fcmMJX cvfxAX"><div class="sc-jUfyBS bhDyou"><h5 class="sc-iqAclL sc-fuISkM eONCmm hZIgic">Authorizations:</h5><svg class="sc-dIsUp iPqByX" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jQAxuV ccffaZ"><span class="sc-daBunf fcvuS"><span class="sc-dsXzNU dPrSxx"><i>ApiKeyAuth</i></span></span></div></div><div><h5 class="sc-iqAclL eONCmm">path<!-- --> Parameters</h5><table class="sc-hHEiqL VCQHZ"><tbody><tr class="last "><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="eval_id"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">eval_id</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The ID of the evaluation to update.</p>
</div></div></div></td></tr></tbody></table></div><h5 class="sc-iqAclL eONCmm">Request Body schema: <span class="sc-cBoqAE eKyrDP">application/json</span></h5><div class="sc-iJCRrE sc-ciSkZP jCdxGr QGruV"><p>Request to update an evaluation</p>
</div><table class="sc-hHEiqL VCQHZ"><tbody><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="name"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">name</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>Rename the evaluation.</p>
</div></div></div></td></tr><tr class="last "><td class="sc-hBMUJo sc-fFSPTT sc-gSYDnn iwcKgn cAqMTE hTttpy" kind="field" title="metadata"><span class="sc-iemWCZ bcnRwz"></span><button aria-label="expand properties"><span class="property-name">metadata</span><svg class="sc-dIsUp hGHhhO" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">Metadata (object) or Metadata (null)</span><span class="sc-laZMeE sc-eJocfa jWaWWE bArHDh"> (<!-- -->Metadata<!-- -->) </span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div></div></div></td></tr></tbody></table><div><h3 class="sc-fIxmyt DvFer">Responses</h3><div><button class="sc-htmcrh lbYftx"><svg class="sc-dIsUp dqYXmg" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-fWWYYk cMoEZ">200<!-- --> </strong><span class="sc-jcwpoC eDjFAZ"><p>The updated evaluation</p>
</span></button></div></div></div><div class="sc-jSFjdj sc-gKAaRy gBjRyf gcushC"><div class="sc-EZqKI fWsqvQ"><button class="sc-eEVmNe ilvUMs"><span type="post" class="sc-fmdNqN ldMUmp http-verb post">post</span><span class="sc-jXcxbT fCEUju">/evals/{eval_id}</span><svg class="sc-dIsUp bRmrKA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ljsmAU flIrdF"><div class="sc-jlZJtj fQkroN"><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div><div tabindex="0" role="button"><div class="sc-dTSzeu dfUAUz"><span>https://api.openai.com/v1</span>/evals/{eval_id}</div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Request samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="react-tabs-140" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-141" tabindex="0" data-rttab="true">Payload</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-141" aria-labelledby="react-tabs-140"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-bBjRSN kQSIAz">application/json</div></div><div class="sc-jgPyTC dSaTNC"><div class="sc-jNnpgg esZIbL"><div class="sc-giAqHp hMPeqJ"><button><div class="sc-carFqZ UksDl">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iJCRrE jCdxGr sc-dPaNzc gyljjx"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"property1"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"property2"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Response samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-142" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-143" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-143" aria-labelledby="react-tabs-142"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-bBjRSN kQSIAz">application/json</div></div><div class="sc-jgPyTC dSaTNC"><div class="sc-jNnpgg esZIbL"><div class="sc-giAqHp hMPeqJ"><button><div class="sc-carFqZ UksDl">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iJCRrE jCdxGr sc-dPaNzc gyljjx"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"object"</span>: <span class="token string">"eval"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">"Chatbot effectiveness Evaluation"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"data_source_config"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <span class="token string">"custom"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"schema"</span>: <span class="token string">"{\n \"type\": \"object\",\n \"properties\": {\n \"item\": {\n \"type\": \"object\",\n \"properties\": {\n \"label\": {\"type\": \"string\"},\n },\n \"required\": [\"label\"]\n }\n },\n \"required\": [\"item\"]\n}\n"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"testing_criteria"</span>: <span class="token string">"eval"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"created_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"property1"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"property2"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Evals/operation/deleteEval" data-section-id="tag/Evals/operation/deleteEval" class="sc-eCApnc liLqNm"><div data-section-id="operation/deleteEval" id="operation/deleteEval" class="sc-iCoGMd gLxhOh"><div class="sc-hKFxyN juinod"><h2 class="sc-pNWdM eftmgB"><a class="sc-crzoAE iUxAWq" href="#tag/Evals/operation/deleteEval" aria-label="tag/Evals/operation/deleteEval"></a>Delete an evaluation.
<!-- --> </h2><div class="sc-fcmMJX cvfxAX"><div class="sc-jUfyBS bhDyou"><h5 class="sc-iqAclL sc-fuISkM eONCmm hZIgic">Authorizations:</h5><svg class="sc-dIsUp iPqByX" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jQAxuV ccffaZ"><span class="sc-daBunf fcvuS"><span class="sc-dsXzNU dPrSxx"><i>ApiKeyAuth</i></span></span></div></div><div><h5 class="sc-iqAclL eONCmm">path<!-- --> Parameters</h5><table class="sc-hHEiqL VCQHZ"><tbody><tr class="last "><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="eval_id"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">eval_id</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The ID of the evaluation to delete.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-fIxmyt DvFer">Responses</h3><div><button class="sc-htmcrh lbYftx"><svg class="sc-dIsUp dqYXmg" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-fWWYYk cMoEZ">200<!-- --> </strong><span class="sc-jcwpoC eDjFAZ"><p>Successfully deleted the evaluation.</p>
</span></button></div><div><button class="sc-htmcrh NAUPn"><svg class="sc-dIsUp dVWHLw" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-fWWYYk cMoEZ">404<!-- --> </strong><span class="sc-jcwpoC eDjFAZ"><p>Evaluation not found.</p>
</span></button></div></div></div><div class="sc-jSFjdj sc-gKAaRy gBjRyf gcushC"><div class="sc-EZqKI fWsqvQ"><button class="sc-eEVmNe ilvUMs"><span type="delete" class="sc-fmdNqN bJzUtf http-verb delete">delete</span><span class="sc-jXcxbT fCEUju">/evals/{eval_id}</span><svg class="sc-dIsUp bRmrKA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ljsmAU flIrdF"><div class="sc-jlZJtj fQkroN"><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div><div tabindex="0" role="button"><div class="sc-dTSzeu dfUAUz"><span>https://api.openai.com/v1</span>/evals/{eval_id}</div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Response samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-144" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-145" tabindex="0" data-rttab="true">200</li><li class="tab-error" role="tab" id="react-tabs-146" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-147" data-rttab="true">404</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-145" aria-labelledby="react-tabs-144"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-bBjRSN kQSIAz">application/json</div></div><div class="sc-jgPyTC dSaTNC"><div class="sc-jNnpgg esZIbL"><div class="sc-giAqHp hMPeqJ"><button><div class="sc-carFqZ UksDl">Copy</div></button></div><div class="sc-iJCRrE jCdxGr sc-dPaNzc gyljjx"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"object"</span>: <span class="token string">"eval.deleted"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"deleted"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"eval_id"</span>: <span class="token string">"eval_abc123"</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-147" aria-labelledby="react-tabs-146"></div></div></div></div></div></div><div id="tag/Evals/operation/getEvalRuns" data-section-id="tag/Evals/operation/getEvalRuns" class="sc-eCApnc liLqNm"><div data-section-id="operation/getEvalRuns" id="operation/getEvalRuns" class="sc-iCoGMd gLxhOh"><div class="sc-hKFxyN juinod"><h2 class="sc-pNWdM eftmgB"><a class="sc-crzoAE iUxAWq" href="#tag/Evals/operation/getEvalRuns" aria-label="tag/Evals/operation/getEvalRuns"></a>Get a list of runs for an evaluation.
<!-- --> </h2><div class="sc-fcmMJX cvfxAX"><div class="sc-jUfyBS bhDyou"><h5 class="sc-iqAclL sc-fuISkM eONCmm hZIgic">Authorizations:</h5><svg class="sc-dIsUp iPqByX" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jQAxuV ccffaZ"><span class="sc-daBunf fcvuS"><span class="sc-dsXzNU dPrSxx"><i>ApiKeyAuth</i></span></span></div></div><div><h5 class="sc-iqAclL eONCmm">path<!-- --> Parameters</h5><table class="sc-hHEiqL VCQHZ"><tbody><tr class="last "><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="eval_id"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">eval_id</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The ID of the evaluation to retrieve runs for.</p>
</div></div></div></td></tr></tbody></table></div><div><h5 class="sc-iqAclL eONCmm">query<!-- --> Parameters</h5><table class="sc-hHEiqL VCQHZ"><tbody><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="after"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">after</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>Identifier for the last run from the previous pagination request.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="limit"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">limit</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">integer</span></div><div><span class="sc-laZMeE jWaWWE"> <!-- -->Default:<!-- --> </span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">20</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>Number of runs to retrieve.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="order"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">order</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div><div><span class="sc-laZMeE jWaWWE"> <!-- -->Default:<!-- --> </span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"asc"</span></div><div><span class="sc-laZMeE jWaWWE"> <!-- -->Enum<!-- -->:</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"asc"</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"desc"</span> </div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>Sort order for runs by timestamp. Use <code>asc</code> for ascending order or <code>desc</code> for descending order. Defaults to <code>asc</code>.</p>
</div></div></div></td></tr><tr class="last "><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="status"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">status</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div><div><span class="sc-laZMeE jWaWWE"> <!-- -->Enum<!-- -->:</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"queued"</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"in_progress"</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"completed"</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"canceled"</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"failed"</span> </div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>Filter runs by status. One of <code>queued</code> | <code>in_progress</code> | <code>failed</code> | <code>completed</code> | <code>canceled</code>.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-fIxmyt DvFer">Responses</h3><div><button class="sc-htmcrh lbYftx"><svg class="sc-dIsUp dqYXmg" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-fWWYYk cMoEZ">200<!-- --> </strong><span class="sc-jcwpoC eDjFAZ"><p>A list of runs for the evaluation</p>
</span></button></div></div></div><div class="sc-jSFjdj sc-gKAaRy gBjRyf gcushC"><div class="sc-EZqKI fWsqvQ"><button class="sc-eEVmNe ilvUMs"><span type="get" class="sc-fmdNqN ihNycv http-verb get">get</span><span class="sc-jXcxbT fCEUju">/evals/{eval_id}/runs</span><svg class="sc-dIsUp bRmrKA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ljsmAU flIrdF"><div class="sc-jlZJtj fQkroN"><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div><div tabindex="0" role="button"><div class="sc-dTSzeu dfUAUz"><span>https://api.openai.com/v1</span>/evals/{eval_id}/runs</div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Response samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-148" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-149" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-149" aria-labelledby="react-tabs-148"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-bBjRSN kQSIAz">application/json</div></div><div class="sc-jgPyTC dSaTNC"><div class="sc-jNnpgg esZIbL"><div class="sc-giAqHp hMPeqJ"><button><div class="sc-carFqZ UksDl">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iJCRrE jCdxGr sc-dPaNzc gyljjx"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"object"</span>: <span class="token string">"list"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"object"</span>: <span class="token string">"eval.run"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"eval_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"status"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"model"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"created_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"report_url"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"result_counts"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"total"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"errored"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"failed"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"passed"</span>: <span class="token number">0</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"per_model_usage"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"model_name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"invocation_count"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"prompt_tokens"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"completion_tokens"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"total_tokens"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"cached_tokens"</span>: <span class="token number">0</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"per_testing_criteria_results"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"testing_criteria"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"passed"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"failed"</span>: <span class="token number">0</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"data_source"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <span class="token string">"jsonl"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"source"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <span class="token string">"file_content"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"content"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"item"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"sample"</span>: <span class="token punctuation">{ }</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"metadata"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"property1"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"property2"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"error"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"code"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"message"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"first_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"last_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"has_more"</span>: <span class="token boolean">true</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Evals/operation/createEvalRun" data-section-id="tag/Evals/operation/createEvalRun" class="sc-eCApnc liLqNm"><div data-section-id="operation/createEvalRun" id="operation/createEvalRun" class="sc-iCoGMd gLxhOh"><div class="sc-hKFxyN juinod"><h2 class="sc-pNWdM eftmgB"><a class="sc-crzoAE iUxAWq" href="#tag/Evals/operation/createEvalRun" aria-label="tag/Evals/operation/createEvalRun"></a>Kicks off a new run for a given evaluation, specifying the data source, and what model configuration to use to test. The datasource will be validated against the schema specified in the config of the evaluation.
<!-- --> </h2><div class="sc-fcmMJX cvfxAX"><div class="sc-jUfyBS bhDyou"><h5 class="sc-iqAclL sc-fuISkM eONCmm hZIgic">Authorizations:</h5><svg class="sc-dIsUp iPqByX" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jQAxuV ccffaZ"><span class="sc-daBunf fcvuS"><span class="sc-dsXzNU dPrSxx"><i>ApiKeyAuth</i></span></span></div></div><div><h5 class="sc-iqAclL eONCmm">path<!-- --> Parameters</h5><table class="sc-hHEiqL VCQHZ"><tbody><tr class="last "><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="eval_id"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">eval_id</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The ID of the evaluation to create a run for.</p>
</div></div></div></td></tr></tbody></table></div><h5 class="sc-iqAclL eONCmm">Request Body schema: <span class="sc-cBoqAE eKyrDP">application/json</span></h5><div class="sc-iJCRrE sc-ciSkZP jCdxGr QGruV"></div><table class="sc-hHEiqL VCQHZ"><tbody><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="name"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">name</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The name of the run.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT sc-gSYDnn iwcKgn cAqMTE hTttpy" kind="field" title="metadata"><span class="sc-iemWCZ bcnRwz"></span><button aria-label="expand properties"><span class="property-name">metadata</span><svg class="sc-dIsUp hGHhhO" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">Metadata (object) or Metadata (null)</span><span class="sc-laZMeE sc-eJocfa jWaWWE bArHDh"> (<!-- -->Metadata<!-- -->) </span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div></div></div></td></tr><tr class="last "><td class="sc-hBMUJo sc-fFSPTT sc-gSYDnn iwcKgn cAqMTE hTttpy" kind="field" title="data_source"><span class="sc-iemWCZ bcnRwz"></span><button aria-label="expand properties"><span class="property-name">data_source</span><svg class="sc-dIsUp hGHhhO" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">JsonlRunDataSource (object) or CompletionsRunDataSource (object) or ResponsesRunDataSource (object)</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>Details about the run's data source.</p>
</div></div></div></td></tr></tbody></table><div><h3 class="sc-fIxmyt DvFer">Responses</h3><div><button class="sc-htmcrh lbYftx"><svg class="sc-dIsUp dqYXmg" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-fWWYYk cMoEZ">201<!-- --> </strong><span class="sc-jcwpoC eDjFAZ"><p>Successfully created a run for the evaluation</p>
</span></button></div><div><button class="sc-htmcrh NAUPn"><svg class="sc-dIsUp dVWHLw" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-fWWYYk cMoEZ">400<!-- --> </strong><span class="sc-jcwpoC eDjFAZ"><p>Bad request (for example, missing eval object)</p>
</span></button></div></div></div><div class="sc-jSFjdj sc-gKAaRy gBjRyf gcushC"><div class="sc-EZqKI fWsqvQ"><button class="sc-eEVmNe ilvUMs"><span type="post" class="sc-fmdNqN ldMUmp http-verb post">post</span><span class="sc-jXcxbT fCEUju">/evals/{eval_id}/runs</span><svg class="sc-dIsUp bRmrKA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ljsmAU flIrdF"><div class="sc-jlZJtj fQkroN"><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div><div tabindex="0" role="button"><div class="sc-dTSzeu dfUAUz"><span>https://api.openai.com/v1</span>/evals/{eval_id}/runs</div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Request samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="react-tabs-150" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-151" tabindex="0" data-rttab="true">Payload</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-151" aria-labelledby="react-tabs-150"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-bBjRSN kQSIAz">application/json</div></div><div class="sc-jgPyTC dSaTNC"><div class="sc-jNnpgg esZIbL"><div class="sc-giAqHp hMPeqJ"><button><div class="sc-carFqZ UksDl">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iJCRrE jCdxGr sc-dPaNzc gyljjx"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"property1"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"property2"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"data_source"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <span class="token string">"jsonl"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"source"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <span class="token string">"file_content"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"content"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"item"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"sample"</span>: <span class="token punctuation">{ }</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Response samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-152" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-153" tabindex="0" data-rttab="true">201</li><li class="tab-error" role="tab" id="react-tabs-154" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-155" data-rttab="true">400</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-153" aria-labelledby="react-tabs-152"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-bBjRSN kQSIAz">application/json</div></div><div class="sc-jgPyTC dSaTNC"><div class="sc-jNnpgg esZIbL"><div class="sc-giAqHp hMPeqJ"><button><div class="sc-carFqZ UksDl">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iJCRrE jCdxGr sc-dPaNzc gyljjx"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"object"</span>: <span class="token string">"eval.run"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"eval_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"model"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"created_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"report_url"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result_counts"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"total"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"errored"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"failed"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"passed"</span>: <span class="token number">0</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"per_model_usage"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"model_name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"invocation_count"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"prompt_tokens"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"completion_tokens"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"total_tokens"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"cached_tokens"</span>: <span class="token number">0</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"per_testing_criteria_results"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"testing_criteria"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"passed"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"failed"</span>: <span class="token number">0</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"data_source"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <span class="token string">"jsonl"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"source"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <span class="token string">"file_content"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"content"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"item"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"sample"</span>: <span class="token punctuation">{ }</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"property1"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"property2"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"error"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"code"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"message"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-155" aria-labelledby="react-tabs-154"></div></div></div></div></div></div><div id="tag/Evals/operation/getEvalRun" data-section-id="tag/Evals/operation/getEvalRun" class="sc-eCApnc liLqNm"><div data-section-id="operation/getEvalRun" id="operation/getEvalRun" class="sc-iCoGMd gLxhOh"><div class="sc-hKFxyN juinod"><h2 class="sc-pNWdM eftmgB"><a class="sc-crzoAE iUxAWq" href="#tag/Evals/operation/getEvalRun" aria-label="tag/Evals/operation/getEvalRun"></a>Get an evaluation run by ID.
<!-- --> </h2><div class="sc-fcmMJX cvfxAX"><div class="sc-jUfyBS bhDyou"><h5 class="sc-iqAclL sc-fuISkM eONCmm hZIgic">Authorizations:</h5><svg class="sc-dIsUp iPqByX" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jQAxuV ccffaZ"><span class="sc-daBunf fcvuS"><span class="sc-dsXzNU dPrSxx"><i>ApiKeyAuth</i></span></span></div></div><div><h5 class="sc-iqAclL eONCmm">path<!-- --> Parameters</h5><table class="sc-hHEiqL VCQHZ"><tbody><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="eval_id"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">eval_id</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The ID of the evaluation to retrieve runs for.</p>
</div></div></div></td></tr><tr class="last "><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="run_id"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">run_id</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The ID of the run to retrieve.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-fIxmyt DvFer">Responses</h3><div><button class="sc-htmcrh lbYftx"><svg class="sc-dIsUp dqYXmg" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-fWWYYk cMoEZ">200<!-- --> </strong><span class="sc-jcwpoC eDjFAZ"><p>The evaluation run</p>
</span></button></div></div></div><div class="sc-jSFjdj sc-gKAaRy gBjRyf gcushC"><div class="sc-EZqKI fWsqvQ"><button class="sc-eEVmNe ilvUMs"><span type="get" class="sc-fmdNqN ihNycv http-verb get">get</span><span class="sc-jXcxbT fCEUju">/evals/{eval_id}/runs/{run_id}</span><svg class="sc-dIsUp bRmrKA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ljsmAU flIrdF"><div class="sc-jlZJtj fQkroN"><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div><div tabindex="0" role="button"><div class="sc-dTSzeu dfUAUz"><span>https://api.openai.com/v1</span>/evals/{eval_id}/runs/{run_id}</div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Response samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-156" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-157" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-157" aria-labelledby="react-tabs-156"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-bBjRSN kQSIAz">application/json</div></div><div class="sc-jgPyTC dSaTNC"><div class="sc-jNnpgg esZIbL"><div class="sc-giAqHp hMPeqJ"><button><div class="sc-carFqZ UksDl">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iJCRrE jCdxGr sc-dPaNzc gyljjx"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"object"</span>: <span class="token string">"eval.run"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"eval_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"model"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"created_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"report_url"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result_counts"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"total"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"errored"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"failed"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"passed"</span>: <span class="token number">0</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"per_model_usage"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"model_name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"invocation_count"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"prompt_tokens"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"completion_tokens"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"total_tokens"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"cached_tokens"</span>: <span class="token number">0</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"per_testing_criteria_results"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"testing_criteria"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"passed"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"failed"</span>: <span class="token number">0</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"data_source"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <span class="token string">"jsonl"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"source"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <span class="token string">"file_content"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"content"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"item"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"sample"</span>: <span class="token punctuation">{ }</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"property1"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"property2"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"error"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"code"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"message"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Evals/operation/cancelEvalRun" data-section-id="tag/Evals/operation/cancelEvalRun" class="sc-eCApnc liLqNm"><div data-section-id="operation/cancelEvalRun" id="operation/cancelEvalRun" class="sc-iCoGMd gLxhOh"><div class="sc-hKFxyN juinod"><h2 class="sc-pNWdM eftmgB"><a class="sc-crzoAE iUxAWq" href="#tag/Evals/operation/cancelEvalRun" aria-label="tag/Evals/operation/cancelEvalRun"></a>Cancel an ongoing evaluation run.
<!-- --> </h2><div class="sc-fcmMJX cvfxAX"><div class="sc-jUfyBS bhDyou"><h5 class="sc-iqAclL sc-fuISkM eONCmm hZIgic">Authorizations:</h5><svg class="sc-dIsUp iPqByX" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jQAxuV ccffaZ"><span class="sc-daBunf fcvuS"><span class="sc-dsXzNU dPrSxx"><i>ApiKeyAuth</i></span></span></div></div><div><h5 class="sc-iqAclL eONCmm">path<!-- --> Parameters</h5><table class="sc-hHEiqL VCQHZ"><tbody><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="eval_id"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">eval_id</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The ID of the evaluation whose run you want to cancel.</p>
</div></div></div></td></tr><tr class="last "><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="run_id"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">run_id</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The ID of the run to cancel.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-fIxmyt DvFer">Responses</h3><div><button class="sc-htmcrh lbYftx"><svg class="sc-dIsUp dqYXmg" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-fWWYYk cMoEZ">200<!-- --> </strong><span class="sc-jcwpoC eDjFAZ"><p>The canceled eval run object</p>
</span></button></div></div></div><div class="sc-jSFjdj sc-gKAaRy gBjRyf gcushC"><div class="sc-EZqKI fWsqvQ"><button class="sc-eEVmNe ilvUMs"><span type="post" class="sc-fmdNqN ldMUmp http-verb post">post</span><span class="sc-jXcxbT fCEUju">/evals/{eval_id}/runs/{run_id}</span><svg class="sc-dIsUp bRmrKA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ljsmAU flIrdF"><div class="sc-jlZJtj fQkroN"><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div><div tabindex="0" role="button"><div class="sc-dTSzeu dfUAUz"><span>https://api.openai.com/v1</span>/evals/{eval_id}/runs/{run_id}</div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Response samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-158" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-159" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-159" aria-labelledby="react-tabs-158"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-bBjRSN kQSIAz">application/json</div></div><div class="sc-jgPyTC dSaTNC"><div class="sc-jNnpgg esZIbL"><div class="sc-giAqHp hMPeqJ"><button><div class="sc-carFqZ UksDl">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iJCRrE jCdxGr sc-dPaNzc gyljjx"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"object"</span>: <span class="token string">"eval.run"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"eval_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"model"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"created_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"report_url"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result_counts"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"total"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"errored"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"failed"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"passed"</span>: <span class="token number">0</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"per_model_usage"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"model_name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"invocation_count"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"prompt_tokens"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"completion_tokens"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"total_tokens"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"cached_tokens"</span>: <span class="token number">0</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"per_testing_criteria_results"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"testing_criteria"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"passed"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"failed"</span>: <span class="token number">0</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"data_source"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <span class="token string">"jsonl"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"source"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <span class="token string">"file_content"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"content"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"item"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"sample"</span>: <span class="token punctuation">{ }</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"property1"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"property2"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"error"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"code"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"message"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Evals/operation/deleteEvalRun" data-section-id="tag/Evals/operation/deleteEvalRun" class="sc-eCApnc liLqNm"><div data-section-id="operation/deleteEvalRun" id="operation/deleteEvalRun" class="sc-iCoGMd gLxhOh"><div class="sc-hKFxyN juinod"><h2 class="sc-pNWdM eftmgB"><a class="sc-crzoAE iUxAWq" href="#tag/Evals/operation/deleteEvalRun" aria-label="tag/Evals/operation/deleteEvalRun"></a>Delete an eval run.
<!-- --> </h2><div class="sc-fcmMJX cvfxAX"><div class="sc-jUfyBS bhDyou"><h5 class="sc-iqAclL sc-fuISkM eONCmm hZIgic">Authorizations:</h5><svg class="sc-dIsUp iPqByX" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jQAxuV ccffaZ"><span class="sc-daBunf fcvuS"><span class="sc-dsXzNU dPrSxx"><i>ApiKeyAuth</i></span></span></div></div><div><h5 class="sc-iqAclL eONCmm">path<!-- --> Parameters</h5><table class="sc-hHEiqL VCQHZ"><tbody><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="eval_id"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">eval_id</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The ID of the evaluation to delete the run from.</p>
</div></div></div></td></tr><tr class="last "><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="run_id"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">run_id</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The ID of the run to delete.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-fIxmyt DvFer">Responses</h3><div><button class="sc-htmcrh lbYftx"><svg class="sc-dIsUp dqYXmg" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-fWWYYk cMoEZ">200<!-- --> </strong><span class="sc-jcwpoC eDjFAZ"><p>Successfully deleted the eval run</p>
</span></button></div><div><button class="sc-htmcrh NAUPn"><svg class="sc-dIsUp dVWHLw" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-fWWYYk cMoEZ">404<!-- --> </strong><span class="sc-jcwpoC eDjFAZ"><p>Run not found</p>
</span></button></div></div></div><div class="sc-jSFjdj sc-gKAaRy gBjRyf gcushC"><div class="sc-EZqKI fWsqvQ"><button class="sc-eEVmNe ilvUMs"><span type="delete" class="sc-fmdNqN bJzUtf http-verb delete">delete</span><span class="sc-jXcxbT fCEUju">/evals/{eval_id}/runs/{run_id}</span><svg class="sc-dIsUp bRmrKA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ljsmAU flIrdF"><div class="sc-jlZJtj fQkroN"><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div><div tabindex="0" role="button"><div class="sc-dTSzeu dfUAUz"><span>https://api.openai.com/v1</span>/evals/{eval_id}/runs/{run_id}</div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Response samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-160" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-161" tabindex="0" data-rttab="true">200</li><li class="tab-error" role="tab" id="react-tabs-162" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-163" data-rttab="true">404</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-161" aria-labelledby="react-tabs-160"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-bBjRSN kQSIAz">application/json</div></div><div class="sc-jgPyTC dSaTNC"><div class="sc-jNnpgg esZIbL"><div class="sc-giAqHp hMPeqJ"><button><div class="sc-carFqZ UksDl">Copy</div></button></div><div class="sc-iJCRrE jCdxGr sc-dPaNzc gyljjx"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"object"</span>: <span class="token string">"eval.run.deleted"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"deleted"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"run_id"</span>: <span class="token string">"evalrun_677469f564d48190807532a852da3afb"</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-163" aria-labelledby="react-tabs-162"></div></div></div></div></div></div><div id="tag/Evals/operation/getEvalRunOutputItems" data-section-id="tag/Evals/operation/getEvalRunOutputItems" class="sc-eCApnc liLqNm"><div data-section-id="operation/getEvalRunOutputItems" id="operation/getEvalRunOutputItems" class="sc-iCoGMd gLxhOh"><div class="sc-hKFxyN juinod"><h2 class="sc-pNWdM eftmgB"><a class="sc-crzoAE iUxAWq" href="#tag/Evals/operation/getEvalRunOutputItems" aria-label="tag/Evals/operation/getEvalRunOutputItems"></a>Get a list of output items for an evaluation run.
<!-- --> </h2><div class="sc-fcmMJX cvfxAX"><div class="sc-jUfyBS bhDyou"><h5 class="sc-iqAclL sc-fuISkM eONCmm hZIgic">Authorizations:</h5><svg class="sc-dIsUp iPqByX" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jQAxuV ccffaZ"><span class="sc-daBunf fcvuS"><span class="sc-dsXzNU dPrSxx"><i>ApiKeyAuth</i></span></span></div></div><div><h5 class="sc-iqAclL eONCmm">path<!-- --> Parameters</h5><table class="sc-hHEiqL VCQHZ"><tbody><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="eval_id"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">eval_id</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The ID of the evaluation to retrieve runs for.</p>
</div></div></div></td></tr><tr class="last "><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="run_id"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">run_id</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The ID of the run to retrieve output items for.</p>
</div></div></div></td></tr></tbody></table></div><div><h5 class="sc-iqAclL eONCmm">query<!-- --> Parameters</h5><table class="sc-hHEiqL VCQHZ"><tbody><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="after"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">after</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>Identifier for the last output item from the previous pagination request.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="limit"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">limit</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">integer</span></div><div><span class="sc-laZMeE jWaWWE"> <!-- -->Default:<!-- --> </span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">20</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>Number of output items to retrieve.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="status"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">status</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div><div><span class="sc-laZMeE jWaWWE"> <!-- -->Enum<!-- -->:</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"fail"</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"pass"</span> </div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>Filter output items by status. Use <code>failed</code> to filter by failed output
items or <code>pass</code> to filter by passed output items.</p>
</div></div></div></td></tr><tr class="last "><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="order"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">order</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div><div><span class="sc-laZMeE jWaWWE"> <!-- -->Default:<!-- --> </span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"asc"</span></div><div><span class="sc-laZMeE jWaWWE"> <!-- -->Enum<!-- -->:</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"asc"</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"desc"</span> </div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>Sort order for output items by timestamp. Use <code>asc</code> for ascending order or <code>desc</code> for descending order. Defaults to <code>asc</code>.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-fIxmyt DvFer">Responses</h3><div><button class="sc-htmcrh lbYftx"><svg class="sc-dIsUp dqYXmg" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-fWWYYk cMoEZ">200<!-- --> </strong><span class="sc-jcwpoC eDjFAZ"><p>A list of output items for the evaluation run</p>
</span></button></div></div></div><div class="sc-jSFjdj sc-gKAaRy gBjRyf gcushC"><div class="sc-EZqKI fWsqvQ"><button class="sc-eEVmNe ilvUMs"><span type="get" class="sc-fmdNqN ihNycv http-verb get">get</span><span class="sc-jXcxbT fCEUju">/evals/{eval_id}/runs/{run_id}/output_items</span><svg class="sc-dIsUp bRmrKA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ljsmAU flIrdF"><div class="sc-jlZJtj fQkroN"><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div><div tabindex="0" role="button"><div class="sc-dTSzeu dfUAUz"><span>https://api.openai.com/v1</span>/evals/{eval_id}/runs/{run_id}/output_items</div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Response samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-164" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-165" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-165" aria-labelledby="react-tabs-164"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-bBjRSN kQSIAz">application/json</div></div><div class="sc-jgPyTC dSaTNC"><div class="sc-jNnpgg esZIbL"><div class="sc-giAqHp hMPeqJ"><button><div class="sc-carFqZ UksDl">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iJCRrE jCdxGr sc-dPaNzc gyljjx"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"object"</span>: <span class="token string">"list"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"object"</span>: <span class="token string">"eval.run.output_item"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"run_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"eval_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"created_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"status"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"datasource_item_id"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"datasource_item"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"results"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"score"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"passed"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"sample"</span>: <span class="token punctuation">{ }</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"sample"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"input"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"role"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"content"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"output"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"role"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"content"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"finish_reason"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"model"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"usage"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"total_tokens"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"completion_tokens"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"prompt_tokens"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"cached_tokens"</span>: <span class="token number">0</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"error"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"code"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"message"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"temperature"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"max_completion_tokens"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"top_p"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"seed"</span>: <span class="token number">0</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"first_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"last_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"has_more"</span>: <span class="token boolean">true</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Evals/operation/getEvalRunOutputItem" data-section-id="tag/Evals/operation/getEvalRunOutputItem" class="sc-eCApnc liLqNm"><div data-section-id="operation/getEvalRunOutputItem" id="operation/getEvalRunOutputItem" class="sc-iCoGMd gLxhOh"><div class="sc-hKFxyN juinod"><h2 class="sc-pNWdM eftmgB"><a class="sc-crzoAE iUxAWq" href="#tag/Evals/operation/getEvalRunOutputItem" aria-label="tag/Evals/operation/getEvalRunOutputItem"></a>Get an evaluation run output item by ID.
<!-- --> </h2><div class="sc-fcmMJX cvfxAX"><div class="sc-jUfyBS bhDyou"><h5 class="sc-iqAclL sc-fuISkM eONCmm hZIgic">Authorizations:</h5><svg class="sc-dIsUp iPqByX" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jQAxuV ccffaZ"><span class="sc-daBunf fcvuS"><span class="sc-dsXzNU dPrSxx"><i>ApiKeyAuth</i></span></span></div></div><div><h5 class="sc-iqAclL eONCmm">path<!-- --> Parameters</h5><table class="sc-hHEiqL VCQHZ"><tbody><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="eval_id"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">eval_id</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The ID of the evaluation to retrieve runs for.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="run_id"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">run_id</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The ID of the run to retrieve.</p>
</div></div></div></td></tr><tr class="last "><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="output_item_id"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">output_item_id</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The ID of the output item to retrieve.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-fIxmyt DvFer">Responses</h3><div><button class="sc-htmcrh lbYftx"><svg class="sc-dIsUp dqYXmg" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-fWWYYk cMoEZ">200<!-- --> </strong><span class="sc-jcwpoC eDjFAZ"><p>The evaluation run output item</p>
</span></button></div></div></div><div class="sc-jSFjdj sc-gKAaRy gBjRyf gcushC"><div class="sc-EZqKI fWsqvQ"><button class="sc-eEVmNe ilvUMs"><span type="get" class="sc-fmdNqN ihNycv http-verb get">get</span><span class="sc-jXcxbT fCEUju">/evals/{eval_id}/runs/{run_id}/output_items/{output_item_id}</span><svg class="sc-dIsUp bRmrKA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ljsmAU flIrdF"><div class="sc-jlZJtj fQkroN"><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div><div tabindex="0" role="button"><div class="sc-dTSzeu dfUAUz"><span>https://api.openai.com/v1</span>/evals/{eval_id}/runs/{run_id}/output_items/{output_item_id}</div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Response samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-166" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-167" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-167" aria-labelledby="react-tabs-166"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-bBjRSN kQSIAz">application/json</div></div><div class="sc-jgPyTC dSaTNC"><div class="sc-jNnpgg esZIbL"><div class="sc-giAqHp hMPeqJ"><button><div class="sc-carFqZ UksDl">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iJCRrE jCdxGr sc-dPaNzc gyljjx"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"object"</span>: <span class="token string">"eval.run.output_item"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"run_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"eval_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"created_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"datasource_item_id"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"datasource_item"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"results"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"score"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"passed"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"sample"</span>: <span class="token punctuation">{ }</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"sample"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"input"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"role"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"content"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"output"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"role"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"content"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"finish_reason"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"model"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"usage"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"total_tokens"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"completion_tokens"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"prompt_tokens"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"cached_tokens"</span>: <span class="token number">0</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"error"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"code"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"message"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"temperature"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"max_completion_tokens"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"top_p"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"seed"</span>: <span class="token number">0</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Fine-tuning" data-section-id="tag/Fine-tuning" class="sc-eCApnc jlMQbh"><div class="sc-iCoGMd gLxhOh"><div class="sc-hKFxyN juinod"><h1 class="sc-fujyAs bpZWeL"><a class="sc-crzoAE iUxAWq" href="#tag/Fine-tuning" aria-label="tag/Fine-tuning"></a>Fine-tuning</h1></div></div><div class="sc-hKFxyN bJcDWV"><div class="sc-iJCRrE sc-ciSkZP jCdxGr QGruV redoc-markdown "><p>Manage fine-tuning jobs to tailor a model to your specific training data.</p>
</div></div></div><div id="tag/Fine-tuning/operation/runGrader" data-section-id="tag/Fine-tuning/operation/runGrader" class="sc-eCApnc liLqNm"><div data-section-id="operation/runGrader" id="operation/runGrader" class="sc-iCoGMd gLxhOh"><div class="sc-hKFxyN juinod"><h2 class="sc-pNWdM eftmgB"><a class="sc-crzoAE iUxAWq" href="#tag/Fine-tuning/operation/runGrader" aria-label="tag/Fine-tuning/operation/runGrader"></a>Run a grader.
<!-- --> </h2><div class="sc-fcmMJX cvfxAX"><div class="sc-jUfyBS bhDyou"><h5 class="sc-iqAclL sc-fuISkM eONCmm hZIgic">Authorizations:</h5><svg class="sc-dIsUp iPqByX" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jQAxuV ccffaZ"><span class="sc-daBunf fcvuS"><span class="sc-dsXzNU dPrSxx"><i>ApiKeyAuth</i></span></span></div></div><h5 class="sc-iqAclL eONCmm">Request Body schema: <span class="sc-cBoqAE eKyrDP">application/json</span></h5><div class="sc-iJCRrE sc-ciSkZP jCdxGr QGruV"></div><table class="sc-hHEiqL VCQHZ"><tbody><tr class=""><td class="sc-hBMUJo sc-fFSPTT sc-gSYDnn iwcKgn cAqMTE hTttpy" kind="field" title="grader"><span class="sc-iemWCZ bcnRwz"></span><button aria-label="expand properties"><span class="property-name">grader</span><svg class="sc-dIsUp hGHhhO" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">StringCheckGrader (object) or TextSimilarityGrader (object) or PythonGrader (object) or ScoreModelGrader (object) or MultiGrader (object)</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The grader used for the fine-tuning job.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="item"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">item</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">object</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The dataset item provided to the grader. This will be used to populate
the <code>item</code> namespace. See <a href="/docs/guides/graders">the guide</a> for more details. </p>
</div></div></div></td></tr><tr class="last "><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="model_sample"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">model_sample</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The model sample to be evaluated. This value will be used to populate
the <code>sample</code> namespace. See <a href="/docs/guides/graders">the guide</a> for more details.
The <code>output_json</code> variable will be populated if the model sample is a
valid JSON string.</p>
</div></div></div></td></tr></tbody></table><div><h3 class="sc-fIxmyt DvFer">Responses</h3><div><button class="sc-htmcrh lbYftx"><svg class="sc-dIsUp dqYXmg" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-fWWYYk cMoEZ">200<!-- --> </strong><span class="sc-jcwpoC eDjFAZ"><p>OK</p>
</span></button></div></div></div><div class="sc-jSFjdj sc-gKAaRy gBjRyf gcushC"><div class="sc-EZqKI fWsqvQ"><button class="sc-eEVmNe ilvUMs"><span type="post" class="sc-fmdNqN ldMUmp http-verb post">post</span><span class="sc-jXcxbT fCEUju">/fine_tuning/alpha/graders/run</span><svg class="sc-dIsUp bRmrKA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ljsmAU flIrdF"><div class="sc-jlZJtj fQkroN"><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div><div tabindex="0" role="button"><div class="sc-dTSzeu dfUAUz"><span>https://api.openai.com/v1</span>/fine_tuning/alpha/graders/run</div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Request samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="react-tabs-168" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-169" tabindex="0" data-rttab="true">Payload</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-169" aria-labelledby="react-tabs-168"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-bBjRSN kQSIAz">application/json</div></div><div class="sc-jgPyTC dSaTNC"><div class="sc-jNnpgg esZIbL"><div class="sc-giAqHp hMPeqJ"><button><div class="sc-carFqZ UksDl">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iJCRrE jCdxGr sc-dPaNzc gyljjx"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"grader"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <span class="token string">"string_check"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"input"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"reference"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"operation"</span>: <span class="token string">"eq"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"item"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"model_sample"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Response samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-170" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-171" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-171" aria-labelledby="react-tabs-170"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-bBjRSN kQSIAz">application/json</div></div><div class="sc-jgPyTC dSaTNC"><div class="sc-jNnpgg esZIbL"><div class="sc-giAqHp hMPeqJ"><button><div class="sc-carFqZ UksDl">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iJCRrE jCdxGr sc-dPaNzc gyljjx"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"reward"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"errors"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"formula_parse_error"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"sample_parse_error"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"truncated_observation_error"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"unresponsive_reward_error"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"invalid_variable_error"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"other_error"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"python_grader_server_error"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"python_grader_server_error_type"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"python_grader_runtime_error"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"python_grader_runtime_error_details"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"model_grader_server_error"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"model_grader_refusal_error"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"model_grader_parse_error"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"model_grader_server_error_details"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"execution_time"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"scores"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"property1"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"property2"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"token_usage"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"sampled_model_name"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"sub_rewards"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"property1"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"property2"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"model_grader_token_usage_per_model"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"property1"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"property2"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Fine-tuning/operation/validateGrader" data-section-id="tag/Fine-tuning/operation/validateGrader" class="sc-eCApnc liLqNm"><div data-section-id="operation/validateGrader" id="operation/validateGrader" class="sc-iCoGMd gLxhOh"><div class="sc-hKFxyN juinod"><h2 class="sc-pNWdM eftmgB"><a class="sc-crzoAE iUxAWq" href="#tag/Fine-tuning/operation/validateGrader" aria-label="tag/Fine-tuning/operation/validateGrader"></a>Validate a grader.
<!-- --> </h2><div class="sc-fcmMJX cvfxAX"><div class="sc-jUfyBS bhDyou"><h5 class="sc-iqAclL sc-fuISkM eONCmm hZIgic">Authorizations:</h5><svg class="sc-dIsUp iPqByX" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jQAxuV ccffaZ"><span class="sc-daBunf fcvuS"><span class="sc-dsXzNU dPrSxx"><i>ApiKeyAuth</i></span></span></div></div><h5 class="sc-iqAclL eONCmm">Request Body schema: <span class="sc-cBoqAE eKyrDP">application/json</span></h5><div class="sc-iJCRrE sc-ciSkZP jCdxGr QGruV"></div><table class="sc-hHEiqL VCQHZ"><tbody><tr class="last "><td class="sc-hBMUJo sc-fFSPTT sc-gSYDnn iwcKgn cAqMTE hTttpy" kind="field" title="grader"><span class="sc-iemWCZ bcnRwz"></span><button aria-label="expand properties"><span class="property-name">grader</span><svg class="sc-dIsUp hGHhhO" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">StringCheckGrader (object) or TextSimilarityGrader (object) or PythonGrader (object) or ScoreModelGrader (object) or MultiGrader (object)</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The grader used for the fine-tuning job.</p>
</div></div></div></td></tr></tbody></table><div><h3 class="sc-fIxmyt DvFer">Responses</h3><div><button class="sc-htmcrh lbYftx"><svg class="sc-dIsUp dqYXmg" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-fWWYYk cMoEZ">200<!-- --> </strong><span class="sc-jcwpoC eDjFAZ"><p>OK</p>
</span></button></div></div></div><div class="sc-jSFjdj sc-gKAaRy gBjRyf gcushC"><div class="sc-EZqKI fWsqvQ"><button class="sc-eEVmNe ilvUMs"><span type="post" class="sc-fmdNqN ldMUmp http-verb post">post</span><span class="sc-jXcxbT fCEUju">/fine_tuning/alpha/graders/validate</span><svg class="sc-dIsUp bRmrKA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ljsmAU flIrdF"><div class="sc-jlZJtj fQkroN"><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div><div tabindex="0" role="button"><div class="sc-dTSzeu dfUAUz"><span>https://api.openai.com/v1</span>/fine_tuning/alpha/graders/validate</div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Request samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="react-tabs-172" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-173" tabindex="0" data-rttab="true">Payload</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-173" aria-labelledby="react-tabs-172"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-bBjRSN kQSIAz">application/json</div></div><div class="sc-jgPyTC dSaTNC"><div class="sc-jNnpgg esZIbL"><div class="sc-giAqHp hMPeqJ"><button><div class="sc-carFqZ UksDl">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iJCRrE jCdxGr sc-dPaNzc gyljjx"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"grader"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <span class="token string">"string_check"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"input"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"reference"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"operation"</span>: <span class="token string">"eq"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Response samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-174" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-175" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-175" aria-labelledby="react-tabs-174"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-bBjRSN kQSIAz">application/json</div></div><div class="sc-jgPyTC dSaTNC"><div class="sc-jNnpgg esZIbL"><div class="sc-giAqHp hMPeqJ"><button><div class="sc-carFqZ UksDl">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iJCRrE jCdxGr sc-dPaNzc gyljjx"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"grader"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <span class="token string">"string_check"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"input"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"reference"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"operation"</span>: <span class="token string">"eq"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Fine-tuning/operation/listFineTuningCheckpointPermissions" data-section-id="tag/Fine-tuning/operation/listFineTuningCheckpointPermissions" class="sc-eCApnc liLqNm"><div data-section-id="operation/listFineTuningCheckpointPermissions" id="operation/listFineTuningCheckpointPermissions" class="sc-iCoGMd gLxhOh"><div class="sc-hKFxyN juinod"><h2 class="sc-pNWdM eftmgB"><a class="sc-crzoAE iUxAWq" href="#tag/Fine-tuning/operation/listFineTuningCheckpointPermissions" aria-label="tag/Fine-tuning/operation/listFineTuningCheckpointPermissions"></a>**NOTE:** This endpoint requires an [admin API key](../admin-api-keys).
Organization owners can use this endpoint to view all permissions for a fine-tuned model checkpoint.
<!-- --> </h2><div class="sc-fcmMJX cvfxAX"><div class="sc-jUfyBS bhDyou"><h5 class="sc-iqAclL sc-fuISkM eONCmm hZIgic">Authorizations:</h5><svg class="sc-dIsUp iPqByX" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jQAxuV ccffaZ"><span class="sc-daBunf fcvuS"><span class="sc-dsXzNU dPrSxx"><i>ApiKeyAuth</i></span></span></div></div><div><h5 class="sc-iqAclL eONCmm">path<!-- --> Parameters</h5><table class="sc-hHEiqL VCQHZ"><tbody><tr class="last "><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="fine_tuned_model_checkpoint"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">fine_tuned_model_checkpoint</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><span class="sc-laZMeE jWaWWE"> <!-- -->Example:<!-- --> </span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">ft-AF1WoRqd3aJAHsqc9NY7iL8F</span></div><div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The ID of the fine-tuned model checkpoint to get permissions for.</p>
</div></div></div></td></tr></tbody></table></div><div><h5 class="sc-iqAclL eONCmm">query<!-- --> Parameters</h5><table class="sc-hHEiqL VCQHZ"><tbody><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="project_id"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">project_id</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The ID of the project to get permissions for.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="after"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">after</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>Identifier for the last permission ID from the previous pagination request.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="limit"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">limit</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">integer</span></div><div><span class="sc-laZMeE jWaWWE"> <!-- -->Default:<!-- --> </span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">10</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>Number of permissions to retrieve.</p>
</div></div></div></td></tr><tr class="last "><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="order"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">order</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div><div><span class="sc-laZMeE jWaWWE"> <!-- -->Default:<!-- --> </span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"descending"</span></div><div><span class="sc-laZMeE jWaWWE"> <!-- -->Enum<!-- -->:</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"ascending"</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"descending"</span> </div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The order in which to retrieve permissions.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-fIxmyt DvFer">Responses</h3><div><button class="sc-htmcrh lbYftx"><svg class="sc-dIsUp dqYXmg" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-fWWYYk cMoEZ">200<!-- --> </strong><span class="sc-jcwpoC eDjFAZ"><p>OK</p>
</span></button></div></div></div><div class="sc-jSFjdj sc-gKAaRy gBjRyf gcushC"><div class="sc-EZqKI fWsqvQ"><button class="sc-eEVmNe ilvUMs"><span type="get" class="sc-fmdNqN ihNycv http-verb get">get</span><span class="sc-jXcxbT fCEUju">/fine_tuning/checkpoints/{fine_tuned_model_checkpoint}/permissions</span><svg class="sc-dIsUp bRmrKA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ljsmAU flIrdF"><div class="sc-jlZJtj fQkroN"><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div><div tabindex="0" role="button"><div class="sc-dTSzeu dfUAUz"><span>https://api.openai.com/v1</span>/fine_tuning/checkpoints/{fine_tuned_model_checkpoint}/permissions</div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Response samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-176" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-177" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-177" aria-labelledby="react-tabs-176"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-bBjRSN kQSIAz">application/json</div></div><div class="sc-jgPyTC dSaTNC"><div class="sc-jNnpgg esZIbL"><div class="sc-giAqHp hMPeqJ"><button><div class="sc-carFqZ UksDl">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iJCRrE jCdxGr sc-dPaNzc gyljjx"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"created_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"project_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"object"</span>: <span class="token string">"checkpoint.permission"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"object"</span>: <span class="token string">"list"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"first_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"last_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"has_more"</span>: <span class="token boolean">true</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Fine-tuning/operation/createFineTuningCheckpointPermission" data-section-id="tag/Fine-tuning/operation/createFineTuningCheckpointPermission" class="sc-eCApnc liLqNm"><div data-section-id="operation/createFineTuningCheckpointPermission" id="operation/createFineTuningCheckpointPermission" class="sc-iCoGMd gLxhOh"><div class="sc-hKFxyN juinod"><h2 class="sc-pNWdM eftmgB"><a class="sc-crzoAE iUxAWq" href="#tag/Fine-tuning/operation/createFineTuningCheckpointPermission" aria-label="tag/Fine-tuning/operation/createFineTuningCheckpointPermission"></a>**NOTE:** Calling this endpoint requires an [admin API key](../admin-api-keys).
This enables organization owners to share fine-tuned models with other projects in their organization.
<!-- --> </h2><div class="sc-fcmMJX cvfxAX"><div class="sc-jUfyBS bhDyou"><h5 class="sc-iqAclL sc-fuISkM eONCmm hZIgic">Authorizations:</h5><svg class="sc-dIsUp iPqByX" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jQAxuV ccffaZ"><span class="sc-daBunf fcvuS"><span class="sc-dsXzNU dPrSxx"><i>ApiKeyAuth</i></span></span></div></div><div><h5 class="sc-iqAclL eONCmm">path<!-- --> Parameters</h5><table class="sc-hHEiqL VCQHZ"><tbody><tr class="last "><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="fine_tuned_model_checkpoint"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">fine_tuned_model_checkpoint</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><span class="sc-laZMeE jWaWWE"> <!-- -->Example:<!-- --> </span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">ft:gpt-4o-mini-2024-07-18:org:weather:B7R9VjQd</span></div><div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The ID of the fine-tuned model checkpoint to create a permission for.</p>
</div></div></div></td></tr></tbody></table></div><h5 class="sc-iqAclL eONCmm">Request Body schema: <span class="sc-cBoqAE eKyrDP">application/json</span></h5><div class="sc-iJCRrE sc-ciSkZP jCdxGr QGruV"></div><table class="sc-hHEiqL VCQHZ"><tbody><tr class="last "><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="project_ids"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">project_ids</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa">Array of </span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">strings</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The project identifiers to grant access to.</p>
</div></div></div></td></tr></tbody></table><div><h3 class="sc-fIxmyt DvFer">Responses</h3><div><button class="sc-htmcrh lbYftx"><svg class="sc-dIsUp dqYXmg" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-fWWYYk cMoEZ">200<!-- --> </strong><span class="sc-jcwpoC eDjFAZ"><p>OK</p>
</span></button></div></div></div><div class="sc-jSFjdj sc-gKAaRy gBjRyf gcushC"><div class="sc-EZqKI fWsqvQ"><button class="sc-eEVmNe ilvUMs"><span type="post" class="sc-fmdNqN ldMUmp http-verb post">post</span><span class="sc-jXcxbT fCEUju">/fine_tuning/checkpoints/{fine_tuned_model_checkpoint}/permissions</span><svg class="sc-dIsUp bRmrKA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ljsmAU flIrdF"><div class="sc-jlZJtj fQkroN"><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div><div tabindex="0" role="button"><div class="sc-dTSzeu dfUAUz"><span>https://api.openai.com/v1</span>/fine_tuning/checkpoints/{fine_tuned_model_checkpoint}/permissions</div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Request samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="react-tabs-178" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-179" tabindex="0" data-rttab="true">Payload</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-179" aria-labelledby="react-tabs-178"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-bBjRSN kQSIAz">application/json</div></div><div class="sc-jgPyTC dSaTNC"><div class="sc-jNnpgg esZIbL"><div class="sc-giAqHp hMPeqJ"><button><div class="sc-carFqZ UksDl">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iJCRrE jCdxGr sc-dPaNzc gyljjx"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"project_ids"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><span class="token string">"string"</span></div></li></ul><span class="token punctuation">]</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Response samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-180" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-181" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-181" aria-labelledby="react-tabs-180"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-bBjRSN kQSIAz">application/json</div></div><div class="sc-jgPyTC dSaTNC"><div class="sc-jNnpgg esZIbL"><div class="sc-giAqHp hMPeqJ"><button><div class="sc-carFqZ UksDl">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iJCRrE jCdxGr sc-dPaNzc gyljjx"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"created_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"project_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"object"</span>: <span class="token string">"checkpoint.permission"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"object"</span>: <span class="token string">"list"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"first_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"last_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"has_more"</span>: <span class="token boolean">true</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Fine-tuning/operation/deleteFineTuningCheckpointPermission" data-section-id="tag/Fine-tuning/operation/deleteFineTuningCheckpointPermission" class="sc-eCApnc liLqNm"><div data-section-id="operation/deleteFineTuningCheckpointPermission" id="operation/deleteFineTuningCheckpointPermission" class="sc-iCoGMd gLxhOh"><div class="sc-hKFxyN juinod"><h2 class="sc-pNWdM eftmgB"><a class="sc-crzoAE iUxAWq" href="#tag/Fine-tuning/operation/deleteFineTuningCheckpointPermission" aria-label="tag/Fine-tuning/operation/deleteFineTuningCheckpointPermission"></a>**NOTE:** This endpoint requires an [admin API key](../admin-api-keys).
Organization owners can use this endpoint to delete a permission for a fine-tuned model checkpoint.
<!-- --> </h2><div class="sc-fcmMJX cvfxAX"><div class="sc-jUfyBS bhDyou"><h5 class="sc-iqAclL sc-fuISkM eONCmm hZIgic">Authorizations:</h5><svg class="sc-dIsUp iPqByX" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jQAxuV ccffaZ"><span class="sc-daBunf fcvuS"><span class="sc-dsXzNU dPrSxx"><i>ApiKeyAuth</i></span></span></div></div><div><h5 class="sc-iqAclL eONCmm">path<!-- --> Parameters</h5><table class="sc-hHEiqL VCQHZ"><tbody><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="fine_tuned_model_checkpoint"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">fine_tuned_model_checkpoint</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><span class="sc-laZMeE jWaWWE"> <!-- -->Example:<!-- --> </span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">ft:gpt-4o-mini-2024-07-18:org:weather:B7R9VjQd</span></div><div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The ID of the fine-tuned model checkpoint to delete a permission for.</p>
</div></div></div></td></tr><tr class="last "><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="permission_id"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">permission_id</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><span class="sc-laZMeE jWaWWE"> <!-- -->Example:<!-- --> </span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">cp_zc4Q7MP6XxulcVzj4MZdwsAB</span></div><div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The ID of the fine-tuned model checkpoint permission to delete.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-fIxmyt DvFer">Responses</h3><div><button class="sc-htmcrh lbYftx"><svg class="sc-dIsUp dqYXmg" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-fWWYYk cMoEZ">200<!-- --> </strong><span class="sc-jcwpoC eDjFAZ"><p>OK</p>
</span></button></div></div></div><div class="sc-jSFjdj sc-gKAaRy gBjRyf gcushC"><div class="sc-EZqKI fWsqvQ"><button class="sc-eEVmNe ilvUMs"><span type="delete" class="sc-fmdNqN bJzUtf http-verb delete">delete</span><span class="sc-jXcxbT fCEUju">/fine_tuning/checkpoints/{fine_tuned_model_checkpoint}/permissions/{permission_id}</span><svg class="sc-dIsUp bRmrKA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ljsmAU flIrdF"><div class="sc-jlZJtj fQkroN"><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div><div tabindex="0" role="button"><div class="sc-dTSzeu dfUAUz"><span>https://api.openai.com/v1</span>/fine_tuning/checkpoints/{fine_tuned_model_checkpoint}/permissions/{permission_id}</div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Response samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-182" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-183" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-183" aria-labelledby="react-tabs-182"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-bBjRSN kQSIAz">application/json</div></div><div class="sc-jgPyTC dSaTNC"><div class="sc-jNnpgg esZIbL"><div class="sc-giAqHp hMPeqJ"><button><div class="sc-carFqZ UksDl">Copy</div></button></div><div class="sc-iJCRrE jCdxGr sc-dPaNzc gyljjx"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"object"</span>: <span class="token string">"checkpoint.permission"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"deleted"</span>: <span class="token boolean">true</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Fine-tuning/operation/createFineTuningJob" data-section-id="tag/Fine-tuning/operation/createFineTuningJob" class="sc-eCApnc liLqNm"><div data-section-id="operation/createFineTuningJob" id="operation/createFineTuningJob" class="sc-iCoGMd gLxhOh"><div class="sc-hKFxyN juinod"><h2 class="sc-pNWdM eftmgB"><a class="sc-crzoAE iUxAWq" href="#tag/Fine-tuning/operation/createFineTuningJob" aria-label="tag/Fine-tuning/operation/createFineTuningJob"></a>Creates a fine-tuning job which begins the process of creating a new model from a given dataset.
Response includes details of the enqueued job including job status and the name of the fine-tuned models once complete.
[Learn more about fine-tuning](/docs/guides/model-optimization)
<!-- --> </h2><div class="sc-fcmMJX cvfxAX"><div class="sc-jUfyBS bhDyou"><h5 class="sc-iqAclL sc-fuISkM eONCmm hZIgic">Authorizations:</h5><svg class="sc-dIsUp iPqByX" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jQAxuV ccffaZ"><span class="sc-daBunf fcvuS"><span class="sc-dsXzNU dPrSxx"><i>ApiKeyAuth</i></span></span></div></div><h5 class="sc-iqAclL eONCmm">Request Body schema: <span class="sc-cBoqAE eKyrDP">application/json</span></h5><div class="sc-iJCRrE sc-ciSkZP jCdxGr QGruV"></div><table class="sc-hHEiqL VCQHZ"><tbody><tr class=""><td class="sc-hBMUJo sc-fFSPTT sc-gSYDnn iwcKgn cAqMTE hTttpy" kind="field" title="model"><span class="sc-iemWCZ bcnRwz"></span><button aria-label="expand properties"><span class="property-name">model</span><svg class="sc-dIsUp hGHhhO" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string or string</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The name of the model to fine-tune. You can select one of the
<a href="/docs/guides/fine-tuning#which-models-can-be-fine-tuned">supported models</a>.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="training_file"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">training_file</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The ID of an uploaded file that contains training data.</p>
<p>See <a href="/docs/api-reference/files/create">upload file</a> for how to upload a file.</p>
<p>Your dataset must be formatted as a JSONL file. Additionally, you must upload your file with the purpose <code>fine-tune</code>.</p>
<p>The contents of the file should differ depending on if the model uses the <a href="/docs/api-reference/fine-tuning/chat-input">chat</a>, <a href="/docs/api-reference/fine-tuning/completions-input">completions</a> format, or if the fine-tuning method uses the <a href="/docs/api-reference/fine-tuning/preference-input">preference</a> format.</p>
<p>See the <a href="/docs/guides/model-optimization">fine-tuning guide</a> for more details.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT sc-gSYDnn iwcKgn cAqMTE hTttpy deprecated" kind="field" title="hyperparameters"><span class="sc-iemWCZ bcnRwz"></span><button aria-label="expand properties"><span class="property-name">hyperparameters</span><svg class="sc-dIsUp hGHhhO" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">object</span></div><div><span type="warning" class="sc-bqGGPW eSYQnm"> <!-- -->Deprecated<!-- --> </span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The hyperparameters used for the fine-tuning job.
This value is now deprecated in favor of <code>method</code>, and should be passed in under the <code>method</code> parameter.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="suffix"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">suffix</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string or null</span><span> <span class="sc-laZMeE sc-FRrlG jWaWWE gHBwqe"> <!-- -->[ 1 .. 64 ] characters<!-- --> </span></span></div><div><span class="sc-laZMeE jWaWWE"> <!-- -->Default:<!-- --> </span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">null</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>A string of up to 64 characters that will be added to your fine-tuned model name.</p>
<p>For example, a <code>suffix</code> of "custom-model-name" would produce a model name like <code>ft:gpt-4o-mini:openai:custom-model-name:7p4lURel</code>.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="validation_file"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">validation_file</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string or null</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The ID of an uploaded file that contains validation data.</p>
<p>If you provide this file, the data is used to generate validation
metrics periodically during fine-tuning. These metrics can be viewed in
the fine-tuning results file.
The same data should not be present in both train and validation files.</p>
<p>Your dataset must be formatted as a JSONL file. You must upload your file with the purpose <code>fine-tune</code>.</p>
<p>See the <a href="/docs/guides/model-optimization">fine-tuning guide</a> for more details.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT sc-gSYDnn iwcKgn cAqMTE hTttpy" kind="field" title="integrations"><span class="sc-iemWCZ bcnRwz"></span><button aria-label="expand properties"><span class="property-name">integrations</span><svg class="sc-dIsUp hGHhhO" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa">Array of </span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">objects or null</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>A list of integrations to enable for your fine-tuning job.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="seed"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">seed</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">integer or null</span><span> <span class="sc-laZMeE sc-FRrlG jWaWWE gHBwqe"> <!-- -->[ 0 .. 2147483647 ]<!-- --> </span></span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The seed controls the reproducibility of the job. Passing in the same seed and job parameters should produce the same results, but may differ in rare cases.
If a seed is not specified, one will be generated for you.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT sc-gSYDnn iwcKgn cAqMTE hTttpy" kind="field" title="method"><span class="sc-iemWCZ bcnRwz"></span><button aria-label="expand properties"><span class="property-name">method</span><svg class="sc-dIsUp hGHhhO" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">object</span><span class="sc-laZMeE sc-eJocfa jWaWWE bArHDh"> (<!-- -->FineTuneMethod<!-- -->) </span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The method used for fine-tuning.</p>
</div></div></div></td></tr><tr class="last "><td class="sc-hBMUJo sc-fFSPTT sc-gSYDnn iwcKgn cAqMTE hTttpy" kind="field" title="metadata"><span class="sc-iemWCZ bcnRwz"></span><button aria-label="expand properties"><span class="property-name">metadata</span><svg class="sc-dIsUp hGHhhO" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">Metadata (object) or Metadata (null)</span><span class="sc-laZMeE sc-eJocfa jWaWWE bArHDh"> (<!-- -->Metadata<!-- -->) </span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div></div></div></td></tr></tbody></table><div><h3 class="sc-fIxmyt DvFer">Responses</h3><div><button class="sc-htmcrh lbYftx"><svg class="sc-dIsUp dqYXmg" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-fWWYYk cMoEZ">200<!-- --> </strong><span class="sc-jcwpoC eDjFAZ"><p>OK</p>
</span></button></div></div></div><div class="sc-jSFjdj sc-gKAaRy gBjRyf gcushC"><div class="sc-EZqKI fWsqvQ"><button class="sc-eEVmNe ilvUMs"><span type="post" class="sc-fmdNqN ldMUmp http-verb post">post</span><span class="sc-jXcxbT fCEUju">/fine_tuning/jobs</span><svg class="sc-dIsUp bRmrKA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ljsmAU flIrdF"><div class="sc-jlZJtj fQkroN"><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div><div tabindex="0" role="button"><div class="sc-dTSzeu dfUAUz"><span>https://api.openai.com/v1</span>/fine_tuning/jobs</div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Request samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="react-tabs-184" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-185" tabindex="0" data-rttab="true">Payload</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-185" aria-labelledby="react-tabs-184"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-bBjRSN kQSIAz">application/json</div></div><div class="sc-jgPyTC dSaTNC"><div class="sc-jNnpgg esZIbL"><div class="sc-giAqHp hMPeqJ"><button><div class="sc-carFqZ UksDl">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iJCRrE jCdxGr sc-dPaNzc gyljjx"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"model"</span>: <span class="token string">"gpt-4o-mini"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"training_file"</span>: <span class="token string">"file-abc123"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"hyperparameters"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"batch_size"</span>: <span class="token string">"auto"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"learning_rate_multiplier"</span>: <span class="token string">"auto"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"n_epochs"</span>: <span class="token string">"auto"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"suffix"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"validation_file"</span>: <span class="token string">"file-abc123"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"integrations"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <span class="token string">"wandb"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"wandb"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"project"</span>: <span class="token string">"my-wandb-project"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"entity"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"tags"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><span class="token string">"custom-tag"</span></div></li></ul><span class="token punctuation">]</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"seed"</span>: <span class="token number">42</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"method"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <span class="token string">"supervised"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"supervised"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"hyperparameters"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"batch_size"</span>: <span class="token string">"auto"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"learning_rate_multiplier"</span>: <span class="token string">"auto"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"n_epochs"</span>: <span class="token string">"auto"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"dpo"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"hyperparameters"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"beta"</span>: <span class="token string">"auto"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"batch_size"</span>: <span class="token string">"auto"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"learning_rate_multiplier"</span>: <span class="token string">"auto"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"n_epochs"</span>: <span class="token string">"auto"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"reinforcement"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"grader"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <span class="token string">"string_check"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"input"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"reference"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"operation"</span>: <span class="token string">"eq"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"hyperparameters"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"batch_size"</span>: <span class="token string">"auto"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"learning_rate_multiplier"</span>: <span class="token string">"auto"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"n_epochs"</span>: <span class="token string">"auto"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"reasoning_effort"</span>: <span class="token string">"default"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"compute_multiplier"</span>: <span class="token string">"auto"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"eval_interval"</span>: <span class="token string">"auto"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"eval_samples"</span>: <span class="token string">"auto"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"property1"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"property2"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Response samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-186" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-187" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-187" aria-labelledby="react-tabs-186"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-bBjRSN kQSIAz">application/json</div></div><div class="sc-jgPyTC dSaTNC"><div class="sc-jNnpgg esZIbL"><div class="sc-giAqHp hMPeqJ"><button><div class="sc-carFqZ UksDl">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iJCRrE jCdxGr sc-dPaNzc gyljjx"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"created_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"error"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"code"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"message"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"param"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"fine_tuned_model"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"finished_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"hyperparameters"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"batch_size"</span>: <span class="token string">"auto"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"learning_rate_multiplier"</span>: <span class="token string">"auto"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"n_epochs"</span>: <span class="token string">"auto"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"model"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"object"</span>: <span class="token string">"fine_tuning.job"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"organization_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result_files"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><span class="token string">"file-abc123"</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token string">"validating_files"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"trained_tokens"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"training_file"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"validation_file"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"integrations"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <span class="token string">"wandb"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"wandb"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"project"</span>: <span class="token string">"my-wandb-project"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"entity"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"tags"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><span class="token string">"custom-tag"</span></div></li></ul><span class="token punctuation">]</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"seed"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"estimated_finish"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"method"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <span class="token string">"supervised"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"supervised"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"hyperparameters"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"batch_size"</span>: <span class="token string">"auto"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"learning_rate_multiplier"</span>: <span class="token string">"auto"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"n_epochs"</span>: <span class="token string">"auto"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"dpo"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"hyperparameters"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"beta"</span>: <span class="token string">"auto"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"batch_size"</span>: <span class="token string">"auto"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"learning_rate_multiplier"</span>: <span class="token string">"auto"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"n_epochs"</span>: <span class="token string">"auto"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"reinforcement"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"grader"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <span class="token string">"string_check"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"input"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"reference"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"operation"</span>: <span class="token string">"eq"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"hyperparameters"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"batch_size"</span>: <span class="token string">"auto"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"learning_rate_multiplier"</span>: <span class="token string">"auto"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"n_epochs"</span>: <span class="token string">"auto"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"reasoning_effort"</span>: <span class="token string">"default"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"compute_multiplier"</span>: <span class="token string">"auto"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"eval_interval"</span>: <span class="token string">"auto"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"eval_samples"</span>: <span class="token string">"auto"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"property1"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"property2"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Fine-tuning/operation/listPaginatedFineTuningJobs" data-section-id="tag/Fine-tuning/operation/listPaginatedFineTuningJobs" class="sc-eCApnc liLqNm"><div data-section-id="operation/listPaginatedFineTuningJobs" id="operation/listPaginatedFineTuningJobs" class="sc-iCoGMd gLxhOh"><div class="sc-hKFxyN juinod"><h2 class="sc-pNWdM eftmgB"><a class="sc-crzoAE iUxAWq" href="#tag/Fine-tuning/operation/listPaginatedFineTuningJobs" aria-label="tag/Fine-tuning/operation/listPaginatedFineTuningJobs"></a>List your organization's fine-tuning jobs
<!-- --> </h2><div class="sc-fcmMJX cvfxAX"><div class="sc-jUfyBS bhDyou"><h5 class="sc-iqAclL sc-fuISkM eONCmm hZIgic">Authorizations:</h5><svg class="sc-dIsUp iPqByX" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jQAxuV ccffaZ"><span class="sc-daBunf fcvuS"><span class="sc-dsXzNU dPrSxx"><i>ApiKeyAuth</i></span></span></div></div><div><h5 class="sc-iqAclL eONCmm">query<!-- --> Parameters</h5><table class="sc-hHEiqL VCQHZ"><tbody><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="after"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">after</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>Identifier for the last job from the previous pagination request.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="limit"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">limit</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">integer</span></div><div><span class="sc-laZMeE jWaWWE"> <!-- -->Default:<!-- --> </span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">20</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>Number of fine-tuning jobs to retrieve.</p>
</div></div></div></td></tr><tr class="last "><td class="sc-hBMUJo sc-fFSPTT sc-gSYDnn iwcKgn cAqMTE hTttpy" kind="field" title="metadata"><span class="sc-iemWCZ bcnRwz"></span><button aria-label="expand properties"><span class="property-name">metadata</span><svg class="sc-dIsUp hGHhhO" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">object or null</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>Optional metadata filter. To filter, use the syntax <code>metadata[k]=v</code>. Alternatively, set <code>metadata=null</code> to indicate no metadata.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-fIxmyt DvFer">Responses</h3><div><button class="sc-htmcrh lbYftx"><svg class="sc-dIsUp dqYXmg" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-fWWYYk cMoEZ">200<!-- --> </strong><span class="sc-jcwpoC eDjFAZ"><p>OK</p>
</span></button></div></div></div><div class="sc-jSFjdj sc-gKAaRy gBjRyf gcushC"><div class="sc-EZqKI fWsqvQ"><button class="sc-eEVmNe ilvUMs"><span type="get" class="sc-fmdNqN ihNycv http-verb get">get</span><span class="sc-jXcxbT fCEUju">/fine_tuning/jobs</span><svg class="sc-dIsUp bRmrKA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ljsmAU flIrdF"><div class="sc-jlZJtj fQkroN"><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div><div tabindex="0" role="button"><div class="sc-dTSzeu dfUAUz"><span>https://api.openai.com/v1</span>/fine_tuning/jobs</div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Response samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-188" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-189" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-189" aria-labelledby="react-tabs-188"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-bBjRSN kQSIAz">application/json</div></div><div class="sc-jgPyTC dSaTNC"><div class="sc-jNnpgg esZIbL"><div class="sc-giAqHp hMPeqJ"><button><div class="sc-carFqZ UksDl">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iJCRrE jCdxGr sc-dPaNzc gyljjx"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"created_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"error"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"code"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"message"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"param"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"fine_tuned_model"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"finished_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"hyperparameters"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"batch_size"</span>: <span class="token string">"auto"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"learning_rate_multiplier"</span>: <span class="token string">"auto"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"n_epochs"</span>: <span class="token string">"auto"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"model"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"object"</span>: <span class="token string">"fine_tuning.job"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"organization_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"result_files"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><span class="token string">"file-abc123"</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"status"</span>: <span class="token string">"validating_files"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"trained_tokens"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"training_file"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"validation_file"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"integrations"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <span class="token string">"wandb"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"wandb"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"project"</span>: <span class="token string">"my-wandb-project"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"entity"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"tags"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><span class="token string">"custom-tag"</span></div></li></ul><span class="token punctuation">]</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"seed"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"estimated_finish"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"method"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <span class="token string">"supervised"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"supervised"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"hyperparameters"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"batch_size"</span>: <span class="token string">"auto"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"learning_rate_multiplier"</span>: <span class="token string">"auto"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"n_epochs"</span>: <span class="token string">"auto"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"dpo"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"hyperparameters"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"beta"</span>: <span class="token string">"auto"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"batch_size"</span>: <span class="token string">"auto"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"learning_rate_multiplier"</span>: <span class="token string">"auto"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"n_epochs"</span>: <span class="token string">"auto"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"reinforcement"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"grader"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <span class="token string">"string_check"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"input"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"reference"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"operation"</span>: <span class="token string">"eq"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"hyperparameters"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"batch_size"</span>: <span class="token string">"auto"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"learning_rate_multiplier"</span>: <span class="token string">"auto"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"n_epochs"</span>: <span class="token string">"auto"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"reasoning_effort"</span>: <span class="token string">"default"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"compute_multiplier"</span>: <span class="token string">"auto"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"eval_interval"</span>: <span class="token string">"auto"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"eval_samples"</span>: <span class="token string">"auto"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"metadata"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"property1"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"property2"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"has_more"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"object"</span>: <span class="token string">"list"</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Fine-tuning/operation/retrieveFineTuningJob" data-section-id="tag/Fine-tuning/operation/retrieveFineTuningJob" class="sc-eCApnc liLqNm"><div data-section-id="operation/retrieveFineTuningJob" id="operation/retrieveFineTuningJob" class="sc-iCoGMd gLxhOh"><div class="sc-hKFxyN juinod"><h2 class="sc-pNWdM eftmgB"><a class="sc-crzoAE iUxAWq" href="#tag/Fine-tuning/operation/retrieveFineTuningJob" aria-label="tag/Fine-tuning/operation/retrieveFineTuningJob"></a>Get info about a fine-tuning job.
[Learn more about fine-tuning](/docs/guides/model-optimization)
<!-- --> </h2><div class="sc-fcmMJX cvfxAX"><div class="sc-jUfyBS bhDyou"><h5 class="sc-iqAclL sc-fuISkM eONCmm hZIgic">Authorizations:</h5><svg class="sc-dIsUp iPqByX" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jQAxuV ccffaZ"><span class="sc-daBunf fcvuS"><span class="sc-dsXzNU dPrSxx"><i>ApiKeyAuth</i></span></span></div></div><div><h5 class="sc-iqAclL eONCmm">path<!-- --> Parameters</h5><table class="sc-hHEiqL VCQHZ"><tbody><tr class="last "><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="fine_tuning_job_id"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">fine_tuning_job_id</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><span class="sc-laZMeE jWaWWE"> <!-- -->Example:<!-- --> </span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">ft-AF1WoRqd3aJAHsqc9NY7iL8F</span></div><div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The ID of the fine-tuning job.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-fIxmyt DvFer">Responses</h3><div><button class="sc-htmcrh lbYftx"><svg class="sc-dIsUp dqYXmg" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-fWWYYk cMoEZ">200<!-- --> </strong><span class="sc-jcwpoC eDjFAZ"><p>OK</p>
</span></button></div></div></div><div class="sc-jSFjdj sc-gKAaRy gBjRyf gcushC"><div class="sc-EZqKI fWsqvQ"><button class="sc-eEVmNe ilvUMs"><span type="get" class="sc-fmdNqN ihNycv http-verb get">get</span><span class="sc-jXcxbT fCEUju">/fine_tuning/jobs/{fine_tuning_job_id}</span><svg class="sc-dIsUp bRmrKA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ljsmAU flIrdF"><div class="sc-jlZJtj fQkroN"><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div><div tabindex="0" role="button"><div class="sc-dTSzeu dfUAUz"><span>https://api.openai.com/v1</span>/fine_tuning/jobs/{fine_tuning_job_id}</div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Response samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-190" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-191" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-191" aria-labelledby="react-tabs-190"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-bBjRSN kQSIAz">application/json</div></div><div class="sc-jgPyTC dSaTNC"><div class="sc-jNnpgg esZIbL"><div class="sc-giAqHp hMPeqJ"><button><div class="sc-carFqZ UksDl">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iJCRrE jCdxGr sc-dPaNzc gyljjx"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"created_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"error"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"code"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"message"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"param"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"fine_tuned_model"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"finished_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"hyperparameters"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"batch_size"</span>: <span class="token string">"auto"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"learning_rate_multiplier"</span>: <span class="token string">"auto"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"n_epochs"</span>: <span class="token string">"auto"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"model"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"object"</span>: <span class="token string">"fine_tuning.job"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"organization_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result_files"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><span class="token string">"file-abc123"</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token string">"validating_files"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"trained_tokens"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"training_file"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"validation_file"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"integrations"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <span class="token string">"wandb"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"wandb"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"project"</span>: <span class="token string">"my-wandb-project"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"entity"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"tags"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><span class="token string">"custom-tag"</span></div></li></ul><span class="token punctuation">]</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"seed"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"estimated_finish"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"method"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <span class="token string">"supervised"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"supervised"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"hyperparameters"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"batch_size"</span>: <span class="token string">"auto"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"learning_rate_multiplier"</span>: <span class="token string">"auto"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"n_epochs"</span>: <span class="token string">"auto"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"dpo"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"hyperparameters"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"beta"</span>: <span class="token string">"auto"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"batch_size"</span>: <span class="token string">"auto"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"learning_rate_multiplier"</span>: <span class="token string">"auto"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"n_epochs"</span>: <span class="token string">"auto"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"reinforcement"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"grader"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <span class="token string">"string_check"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"input"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"reference"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"operation"</span>: <span class="token string">"eq"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"hyperparameters"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"batch_size"</span>: <span class="token string">"auto"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"learning_rate_multiplier"</span>: <span class="token string">"auto"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"n_epochs"</span>: <span class="token string">"auto"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"reasoning_effort"</span>: <span class="token string">"default"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"compute_multiplier"</span>: <span class="token string">"auto"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"eval_interval"</span>: <span class="token string">"auto"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"eval_samples"</span>: <span class="token string">"auto"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"property1"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"property2"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Fine-tuning/operation/cancelFineTuningJob" data-section-id="tag/Fine-tuning/operation/cancelFineTuningJob" class="sc-eCApnc liLqNm"><div data-section-id="operation/cancelFineTuningJob" id="operation/cancelFineTuningJob" class="sc-iCoGMd gLxhOh"><div class="sc-hKFxyN juinod"><h2 class="sc-pNWdM eftmgB"><a class="sc-crzoAE iUxAWq" href="#tag/Fine-tuning/operation/cancelFineTuningJob" aria-label="tag/Fine-tuning/operation/cancelFineTuningJob"></a>Immediately cancel a fine-tune job.
<!-- --> </h2><div class="sc-fcmMJX cvfxAX"><div class="sc-jUfyBS bhDyou"><h5 class="sc-iqAclL sc-fuISkM eONCmm hZIgic">Authorizations:</h5><svg class="sc-dIsUp iPqByX" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jQAxuV ccffaZ"><span class="sc-daBunf fcvuS"><span class="sc-dsXzNU dPrSxx"><i>ApiKeyAuth</i></span></span></div></div><div><h5 class="sc-iqAclL eONCmm">path<!-- --> Parameters</h5><table class="sc-hHEiqL VCQHZ"><tbody><tr class="last "><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="fine_tuning_job_id"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">fine_tuning_job_id</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><span class="sc-laZMeE jWaWWE"> <!-- -->Example:<!-- --> </span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">ft-AF1WoRqd3aJAHsqc9NY7iL8F</span></div><div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The ID of the fine-tuning job to cancel.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-fIxmyt DvFer">Responses</h3><div><button class="sc-htmcrh lbYftx"><svg class="sc-dIsUp dqYXmg" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-fWWYYk cMoEZ">200<!-- --> </strong><span class="sc-jcwpoC eDjFAZ"><p>OK</p>
</span></button></div></div></div><div class="sc-jSFjdj sc-gKAaRy gBjRyf gcushC"><div class="sc-EZqKI fWsqvQ"><button class="sc-eEVmNe ilvUMs"><span type="post" class="sc-fmdNqN ldMUmp http-verb post">post</span><span class="sc-jXcxbT fCEUju">/fine_tuning/jobs/{fine_tuning_job_id}/cancel</span><svg class="sc-dIsUp bRmrKA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ljsmAU flIrdF"><div class="sc-jlZJtj fQkroN"><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div><div tabindex="0" role="button"><div class="sc-dTSzeu dfUAUz"><span>https://api.openai.com/v1</span>/fine_tuning/jobs/{fine_tuning_job_id}/cancel</div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Response samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-192" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-193" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-193" aria-labelledby="react-tabs-192"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-bBjRSN kQSIAz">application/json</div></div><div class="sc-jgPyTC dSaTNC"><div class="sc-jNnpgg esZIbL"><div class="sc-giAqHp hMPeqJ"><button><div class="sc-carFqZ UksDl">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iJCRrE jCdxGr sc-dPaNzc gyljjx"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"created_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"error"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"code"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"message"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"param"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"fine_tuned_model"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"finished_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"hyperparameters"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"batch_size"</span>: <span class="token string">"auto"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"learning_rate_multiplier"</span>: <span class="token string">"auto"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"n_epochs"</span>: <span class="token string">"auto"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"model"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"object"</span>: <span class="token string">"fine_tuning.job"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"organization_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result_files"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><span class="token string">"file-abc123"</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token string">"validating_files"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"trained_tokens"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"training_file"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"validation_file"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"integrations"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <span class="token string">"wandb"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"wandb"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"project"</span>: <span class="token string">"my-wandb-project"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"entity"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"tags"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><span class="token string">"custom-tag"</span></div></li></ul><span class="token punctuation">]</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"seed"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"estimated_finish"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"method"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <span class="token string">"supervised"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"supervised"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"hyperparameters"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"batch_size"</span>: <span class="token string">"auto"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"learning_rate_multiplier"</span>: <span class="token string">"auto"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"n_epochs"</span>: <span class="token string">"auto"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"dpo"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"hyperparameters"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"beta"</span>: <span class="token string">"auto"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"batch_size"</span>: <span class="token string">"auto"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"learning_rate_multiplier"</span>: <span class="token string">"auto"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"n_epochs"</span>: <span class="token string">"auto"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"reinforcement"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"grader"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <span class="token string">"string_check"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"input"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"reference"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"operation"</span>: <span class="token string">"eq"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"hyperparameters"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"batch_size"</span>: <span class="token string">"auto"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"learning_rate_multiplier"</span>: <span class="token string">"auto"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"n_epochs"</span>: <span class="token string">"auto"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"reasoning_effort"</span>: <span class="token string">"default"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"compute_multiplier"</span>: <span class="token string">"auto"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"eval_interval"</span>: <span class="token string">"auto"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"eval_samples"</span>: <span class="token string">"auto"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"property1"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"property2"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Fine-tuning/operation/listFineTuningJobCheckpoints" data-section-id="tag/Fine-tuning/operation/listFineTuningJobCheckpoints" class="sc-eCApnc liLqNm"><div data-section-id="operation/listFineTuningJobCheckpoints" id="operation/listFineTuningJobCheckpoints" class="sc-iCoGMd gLxhOh"><div class="sc-hKFxyN juinod"><h2 class="sc-pNWdM eftmgB"><a class="sc-crzoAE iUxAWq" href="#tag/Fine-tuning/operation/listFineTuningJobCheckpoints" aria-label="tag/Fine-tuning/operation/listFineTuningJobCheckpoints"></a>List checkpoints for a fine-tuning job.
<!-- --> </h2><div class="sc-fcmMJX cvfxAX"><div class="sc-jUfyBS bhDyou"><h5 class="sc-iqAclL sc-fuISkM eONCmm hZIgic">Authorizations:</h5><svg class="sc-dIsUp iPqByX" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jQAxuV ccffaZ"><span class="sc-daBunf fcvuS"><span class="sc-dsXzNU dPrSxx"><i>ApiKeyAuth</i></span></span></div></div><div><h5 class="sc-iqAclL eONCmm">path<!-- --> Parameters</h5><table class="sc-hHEiqL VCQHZ"><tbody><tr class="last "><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="fine_tuning_job_id"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">fine_tuning_job_id</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><span class="sc-laZMeE jWaWWE"> <!-- -->Example:<!-- --> </span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">ft-AF1WoRqd3aJAHsqc9NY7iL8F</span></div><div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The ID of the fine-tuning job to get checkpoints for.</p>
</div></div></div></td></tr></tbody></table></div><div><h5 class="sc-iqAclL eONCmm">query<!-- --> Parameters</h5><table class="sc-hHEiqL VCQHZ"><tbody><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="after"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">after</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>Identifier for the last checkpoint ID from the previous pagination request.</p>
</div></div></div></td></tr><tr class="last "><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="limit"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">limit</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">integer</span></div><div><span class="sc-laZMeE jWaWWE"> <!-- -->Default:<!-- --> </span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">10</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>Number of checkpoints to retrieve.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-fIxmyt DvFer">Responses</h3><div><button class="sc-htmcrh lbYftx"><svg class="sc-dIsUp dqYXmg" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-fWWYYk cMoEZ">200<!-- --> </strong><span class="sc-jcwpoC eDjFAZ"><p>OK</p>
</span></button></div></div></div><div class="sc-jSFjdj sc-gKAaRy gBjRyf gcushC"><div class="sc-EZqKI fWsqvQ"><button class="sc-eEVmNe ilvUMs"><span type="get" class="sc-fmdNqN ihNycv http-verb get">get</span><span class="sc-jXcxbT fCEUju">/fine_tuning/jobs/{fine_tuning_job_id}/checkpoints</span><svg class="sc-dIsUp bRmrKA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ljsmAU flIrdF"><div class="sc-jlZJtj fQkroN"><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div><div tabindex="0" role="button"><div class="sc-dTSzeu dfUAUz"><span>https://api.openai.com/v1</span>/fine_tuning/jobs/{fine_tuning_job_id}/checkpoints</div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Response samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-194" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-195" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-195" aria-labelledby="react-tabs-194"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-bBjRSN kQSIAz">application/json</div></div><div class="sc-jgPyTC dSaTNC"><div class="sc-jNnpgg esZIbL"><div class="sc-giAqHp hMPeqJ"><button><div class="sc-carFqZ UksDl">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iJCRrE jCdxGr sc-dPaNzc gyljjx"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"created_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"fine_tuned_model_checkpoint"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"step_number"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"metrics"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"step"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"train_loss"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"train_mean_token_accuracy"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"valid_loss"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"valid_mean_token_accuracy"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"full_valid_loss"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"full_valid_mean_token_accuracy"</span>: <span class="token number">0</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"fine_tuning_job_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"object"</span>: <span class="token string">"fine_tuning.job.checkpoint"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"object"</span>: <span class="token string">"list"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"first_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"last_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"has_more"</span>: <span class="token boolean">true</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Fine-tuning/operation/listFineTuningEvents" data-section-id="tag/Fine-tuning/operation/listFineTuningEvents" class="sc-eCApnc liLqNm"><div data-section-id="operation/listFineTuningEvents" id="operation/listFineTuningEvents" class="sc-iCoGMd gLxhOh"><div class="sc-hKFxyN juinod"><h2 class="sc-pNWdM eftmgB"><a class="sc-crzoAE iUxAWq" href="#tag/Fine-tuning/operation/listFineTuningEvents" aria-label="tag/Fine-tuning/operation/listFineTuningEvents"></a>Get status updates for a fine-tuning job.
<!-- --> </h2><div class="sc-fcmMJX cvfxAX"><div class="sc-jUfyBS bhDyou"><h5 class="sc-iqAclL sc-fuISkM eONCmm hZIgic">Authorizations:</h5><svg class="sc-dIsUp iPqByX" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jQAxuV ccffaZ"><span class="sc-daBunf fcvuS"><span class="sc-dsXzNU dPrSxx"><i>ApiKeyAuth</i></span></span></div></div><div><h5 class="sc-iqAclL eONCmm">path<!-- --> Parameters</h5><table class="sc-hHEiqL VCQHZ"><tbody><tr class="last "><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="fine_tuning_job_id"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">fine_tuning_job_id</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><span class="sc-laZMeE jWaWWE"> <!-- -->Example:<!-- --> </span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">ft-AF1WoRqd3aJAHsqc9NY7iL8F</span></div><div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The ID of the fine-tuning job to get events for.</p>
</div></div></div></td></tr></tbody></table></div><div><h5 class="sc-iqAclL eONCmm">query<!-- --> Parameters</h5><table class="sc-hHEiqL VCQHZ"><tbody><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="after"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">after</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>Identifier for the last event from the previous pagination request.</p>
</div></div></div></td></tr><tr class="last "><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="limit"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">limit</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">integer</span></div><div><span class="sc-laZMeE jWaWWE"> <!-- -->Default:<!-- --> </span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">20</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>Number of events to retrieve.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-fIxmyt DvFer">Responses</h3><div><button class="sc-htmcrh lbYftx"><svg class="sc-dIsUp dqYXmg" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-fWWYYk cMoEZ">200<!-- --> </strong><span class="sc-jcwpoC eDjFAZ"><p>OK</p>
</span></button></div></div></div><div class="sc-jSFjdj sc-gKAaRy gBjRyf gcushC"><div class="sc-EZqKI fWsqvQ"><button class="sc-eEVmNe ilvUMs"><span type="get" class="sc-fmdNqN ihNycv http-verb get">get</span><span class="sc-jXcxbT fCEUju">/fine_tuning/jobs/{fine_tuning_job_id}/events</span><svg class="sc-dIsUp bRmrKA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ljsmAU flIrdF"><div class="sc-jlZJtj fQkroN"><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div><div tabindex="0" role="button"><div class="sc-dTSzeu dfUAUz"><span>https://api.openai.com/v1</span>/fine_tuning/jobs/{fine_tuning_job_id}/events</div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Response samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-196" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-197" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-197" aria-labelledby="react-tabs-196"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-bBjRSN kQSIAz">application/json</div></div><div class="sc-jgPyTC dSaTNC"><div class="sc-jNnpgg esZIbL"><div class="sc-giAqHp hMPeqJ"><button><div class="sc-carFqZ UksDl">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iJCRrE jCdxGr sc-dPaNzc gyljjx"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"object"</span>: <span class="token string">"fine_tuning.job.event"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"created_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"level"</span>: <span class="token string">"info"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"message"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <span class="token string">"message"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"data"</span>: <span class="token punctuation">{ }</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"object"</span>: <span class="token string">"list"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"has_more"</span>: <span class="token boolean">true</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Fine-tuning/operation/pauseFineTuningJob" data-section-id="tag/Fine-tuning/operation/pauseFineTuningJob" class="sc-eCApnc liLqNm"><div data-section-id="operation/pauseFineTuningJob" id="operation/pauseFineTuningJob" class="sc-iCoGMd gLxhOh"><div class="sc-hKFxyN juinod"><h2 class="sc-pNWdM eftmgB"><a class="sc-crzoAE iUxAWq" href="#tag/Fine-tuning/operation/pauseFineTuningJob" aria-label="tag/Fine-tuning/operation/pauseFineTuningJob"></a>Pause a fine-tune job.
<!-- --> </h2><div class="sc-fcmMJX cvfxAX"><div class="sc-jUfyBS bhDyou"><h5 class="sc-iqAclL sc-fuISkM eONCmm hZIgic">Authorizations:</h5><svg class="sc-dIsUp iPqByX" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jQAxuV ccffaZ"><span class="sc-daBunf fcvuS"><span class="sc-dsXzNU dPrSxx"><i>ApiKeyAuth</i></span></span></div></div><div><h5 class="sc-iqAclL eONCmm">path<!-- --> Parameters</h5><table class="sc-hHEiqL VCQHZ"><tbody><tr class="last "><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="fine_tuning_job_id"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">fine_tuning_job_id</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><span class="sc-laZMeE jWaWWE"> <!-- -->Example:<!-- --> </span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">ft-AF1WoRqd3aJAHsqc9NY7iL8F</span></div><div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The ID of the fine-tuning job to pause.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-fIxmyt DvFer">Responses</h3><div><button class="sc-htmcrh lbYftx"><svg class="sc-dIsUp dqYXmg" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-fWWYYk cMoEZ">200<!-- --> </strong><span class="sc-jcwpoC eDjFAZ"><p>OK</p>
</span></button></div></div></div><div class="sc-jSFjdj sc-gKAaRy gBjRyf gcushC"><div class="sc-EZqKI fWsqvQ"><button class="sc-eEVmNe ilvUMs"><span type="post" class="sc-fmdNqN ldMUmp http-verb post">post</span><span class="sc-jXcxbT fCEUju">/fine_tuning/jobs/{fine_tuning_job_id}/pause</span><svg class="sc-dIsUp bRmrKA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ljsmAU flIrdF"><div class="sc-jlZJtj fQkroN"><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div><div tabindex="0" role="button"><div class="sc-dTSzeu dfUAUz"><span>https://api.openai.com/v1</span>/fine_tuning/jobs/{fine_tuning_job_id}/pause</div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Response samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-198" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-199" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-199" aria-labelledby="react-tabs-198"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-bBjRSN kQSIAz">application/json</div></div><div class="sc-jgPyTC dSaTNC"><div class="sc-jNnpgg esZIbL"><div class="sc-giAqHp hMPeqJ"><button><div class="sc-carFqZ UksDl">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iJCRrE jCdxGr sc-dPaNzc gyljjx"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"created_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"error"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"code"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"message"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"param"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"fine_tuned_model"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"finished_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"hyperparameters"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"batch_size"</span>: <span class="token string">"auto"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"learning_rate_multiplier"</span>: <span class="token string">"auto"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"n_epochs"</span>: <span class="token string">"auto"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"model"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"object"</span>: <span class="token string">"fine_tuning.job"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"organization_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result_files"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><span class="token string">"file-abc123"</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token string">"validating_files"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"trained_tokens"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"training_file"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"validation_file"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"integrations"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <span class="token string">"wandb"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"wandb"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"project"</span>: <span class="token string">"my-wandb-project"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"entity"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"tags"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><span class="token string">"custom-tag"</span></div></li></ul><span class="token punctuation">]</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"seed"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"estimated_finish"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"method"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <span class="token string">"supervised"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"supervised"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"hyperparameters"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"batch_size"</span>: <span class="token string">"auto"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"learning_rate_multiplier"</span>: <span class="token string">"auto"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"n_epochs"</span>: <span class="token string">"auto"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"dpo"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"hyperparameters"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"beta"</span>: <span class="token string">"auto"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"batch_size"</span>: <span class="token string">"auto"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"learning_rate_multiplier"</span>: <span class="token string">"auto"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"n_epochs"</span>: <span class="token string">"auto"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"reinforcement"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"grader"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <span class="token string">"string_check"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"input"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"reference"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"operation"</span>: <span class="token string">"eq"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"hyperparameters"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"batch_size"</span>: <span class="token string">"auto"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"learning_rate_multiplier"</span>: <span class="token string">"auto"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"n_epochs"</span>: <span class="token string">"auto"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"reasoning_effort"</span>: <span class="token string">"default"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"compute_multiplier"</span>: <span class="token string">"auto"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"eval_interval"</span>: <span class="token string">"auto"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"eval_samples"</span>: <span class="token string">"auto"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"property1"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"property2"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Fine-tuning/operation/resumeFineTuningJob" data-section-id="tag/Fine-tuning/operation/resumeFineTuningJob" class="sc-eCApnc liLqNm"><div data-section-id="operation/resumeFineTuningJob" id="operation/resumeFineTuningJob" class="sc-iCoGMd gLxhOh"><div class="sc-hKFxyN juinod"><h2 class="sc-pNWdM eftmgB"><a class="sc-crzoAE iUxAWq" href="#tag/Fine-tuning/operation/resumeFineTuningJob" aria-label="tag/Fine-tuning/operation/resumeFineTuningJob"></a>Resume a fine-tune job.
<!-- --> </h2><div class="sc-fcmMJX cvfxAX"><div class="sc-jUfyBS bhDyou"><h5 class="sc-iqAclL sc-fuISkM eONCmm hZIgic">Authorizations:</h5><svg class="sc-dIsUp iPqByX" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jQAxuV ccffaZ"><span class="sc-daBunf fcvuS"><span class="sc-dsXzNU dPrSxx"><i>ApiKeyAuth</i></span></span></div></div><div><h5 class="sc-iqAclL eONCmm">path<!-- --> Parameters</h5><table class="sc-hHEiqL VCQHZ"><tbody><tr class="last "><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="fine_tuning_job_id"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">fine_tuning_job_id</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><span class="sc-laZMeE jWaWWE"> <!-- -->Example:<!-- --> </span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">ft-AF1WoRqd3aJAHsqc9NY7iL8F</span></div><div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The ID of the fine-tuning job to resume.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-fIxmyt DvFer">Responses</h3><div><button class="sc-htmcrh lbYftx"><svg class="sc-dIsUp dqYXmg" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-fWWYYk cMoEZ">200<!-- --> </strong><span class="sc-jcwpoC eDjFAZ"><p>OK</p>
</span></button></div></div></div><div class="sc-jSFjdj sc-gKAaRy gBjRyf gcushC"><div class="sc-EZqKI fWsqvQ"><button class="sc-eEVmNe ilvUMs"><span type="post" class="sc-fmdNqN ldMUmp http-verb post">post</span><span class="sc-jXcxbT fCEUju">/fine_tuning/jobs/{fine_tuning_job_id}/resume</span><svg class="sc-dIsUp bRmrKA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ljsmAU flIrdF"><div class="sc-jlZJtj fQkroN"><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div><div tabindex="0" role="button"><div class="sc-dTSzeu dfUAUz"><span>https://api.openai.com/v1</span>/fine_tuning/jobs/{fine_tuning_job_id}/resume</div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Response samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-200" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-201" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-201" aria-labelledby="react-tabs-200"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-bBjRSN kQSIAz">application/json</div></div><div class="sc-jgPyTC dSaTNC"><div class="sc-jNnpgg esZIbL"><div class="sc-giAqHp hMPeqJ"><button><div class="sc-carFqZ UksDl">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iJCRrE jCdxGr sc-dPaNzc gyljjx"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"created_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"error"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"code"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"message"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"param"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"fine_tuned_model"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"finished_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"hyperparameters"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"batch_size"</span>: <span class="token string">"auto"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"learning_rate_multiplier"</span>: <span class="token string">"auto"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"n_epochs"</span>: <span class="token string">"auto"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"model"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"object"</span>: <span class="token string">"fine_tuning.job"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"organization_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result_files"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><span class="token string">"file-abc123"</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token string">"validating_files"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"trained_tokens"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"training_file"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"validation_file"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"integrations"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <span class="token string">"wandb"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"wandb"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"project"</span>: <span class="token string">"my-wandb-project"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"entity"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"tags"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><span class="token string">"custom-tag"</span></div></li></ul><span class="token punctuation">]</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"seed"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"estimated_finish"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"method"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <span class="token string">"supervised"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"supervised"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"hyperparameters"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"batch_size"</span>: <span class="token string">"auto"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"learning_rate_multiplier"</span>: <span class="token string">"auto"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"n_epochs"</span>: <span class="token string">"auto"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"dpo"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"hyperparameters"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"beta"</span>: <span class="token string">"auto"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"batch_size"</span>: <span class="token string">"auto"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"learning_rate_multiplier"</span>: <span class="token string">"auto"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"n_epochs"</span>: <span class="token string">"auto"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"reinforcement"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"grader"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <span class="token string">"string_check"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"input"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"reference"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"operation"</span>: <span class="token string">"eq"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"hyperparameters"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"batch_size"</span>: <span class="token string">"auto"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"learning_rate_multiplier"</span>: <span class="token string">"auto"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"n_epochs"</span>: <span class="token string">"auto"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"reasoning_effort"</span>: <span class="token string">"default"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"compute_multiplier"</span>: <span class="token string">"auto"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"eval_interval"</span>: <span class="token string">"auto"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"eval_samples"</span>: <span class="token string">"auto"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"property1"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"property2"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Graders" data-section-id="tag/Graders" class="sc-eCApnc jlMQbh"><div class="sc-iCoGMd gLxhOh"><div class="sc-hKFxyN juinod"><h1 class="sc-fujyAs bpZWeL"><a class="sc-crzoAE iUxAWq" href="#tag/Graders" aria-label="tag/Graders"></a>Graders</h1></div></div><div class="sc-hKFxyN bJcDWV"><div class="sc-iJCRrE sc-ciSkZP jCdxGr QGruV redoc-markdown "><p>Manage and run graders in the OpenAI platform.</p>
</div></div></div><div id="tag/Batch" data-section-id="tag/Batch" class="sc-eCApnc jlMQbh"><div class="sc-iCoGMd gLxhOh"><div class="sc-hKFxyN juinod"><h1 class="sc-fujyAs bpZWeL"><a class="sc-crzoAE iUxAWq" href="#tag/Batch" aria-label="tag/Batch"></a>Batch</h1></div></div><div class="sc-hKFxyN bJcDWV"><div class="sc-iJCRrE sc-ciSkZP jCdxGr QGruV redoc-markdown "><p>Create large batches of API requests to run asynchronously.</p>
</div></div></div><div id="tag/Batch/operation/createBatch" data-section-id="tag/Batch/operation/createBatch" class="sc-eCApnc liLqNm"><div data-section-id="operation/createBatch" id="operation/createBatch" class="sc-iCoGMd gLxhOh"><div class="sc-hKFxyN juinod"><h2 class="sc-pNWdM eftmgB"><a class="sc-crzoAE iUxAWq" href="#tag/Batch/operation/createBatch" aria-label="tag/Batch/operation/createBatch"></a>Creates and executes a batch from an uploaded file of requests<!-- --> </h2><div class="sc-fcmMJX cvfxAX"><div class="sc-jUfyBS bhDyou"><h5 class="sc-iqAclL sc-fuISkM eONCmm hZIgic">Authorizations:</h5><svg class="sc-dIsUp iPqByX" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jQAxuV ccffaZ"><span class="sc-daBunf fcvuS"><span class="sc-dsXzNU dPrSxx"><i>ApiKeyAuth</i></span></span></div></div><h5 class="sc-iqAclL eONCmm">Request Body schema: <span class="sc-cBoqAE eKyrDP">application/json</span></h5><div class="sc-iJCRrE sc-ciSkZP jCdxGr QGruV"></div><table class="sc-hHEiqL VCQHZ"><tbody><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="input_file_id"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">input_file_id</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The ID of an uploaded file that contains requests for the new batch.</p>
<p>See <a href="/docs/api-reference/files/create">upload file</a> for how to upload a file.</p>
<p>Your input file must be formatted as a <a href="/docs/api-reference/batch/request-input">JSONL file</a>, and must be uploaded with the purpose <code>batch</code>. The file can contain up to 50,000 requests, and can be up to 200 MB in size.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="endpoint"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">endpoint</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div><div><span class="sc-laZMeE jWaWWE"> <!-- -->Enum<!-- -->:</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"/v1/responses"</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"/v1/chat/completions"</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"/v1/embeddings"</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"/v1/completions"</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"/v1/moderations"</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"/v1/images/generations"</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"/v1/images/edits"</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"/v1/videos"</span> </div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The endpoint to be used for all requests in the batch. Currently <code>/v1/responses</code>, <code>/v1/chat/completions</code>, <code>/v1/embeddings</code>, <code>/v1/completions</code>, <code>/v1/moderations</code>, <code>/v1/images/generations</code>, <code>/v1/images/edits</code>, and <code>/v1/videos</code> are supported. Note that <code>/v1/embeddings</code> batches are also restricted to a maximum of 50,000 embedding inputs across all requests in the batch.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="completion_window"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">completion_window</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div><div><span class="sc-laZMeE jWaWWE"> <!-- -->Value<!-- -->:</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"24h"</span> </div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The time frame within which the batch should be processed. Currently only <code>24h</code> is supported.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT sc-gSYDnn iwcKgn cAqMTE hTttpy" kind="field" title="metadata"><span class="sc-iemWCZ bcnRwz"></span><button aria-label="expand properties"><span class="property-name">metadata</span><svg class="sc-dIsUp hGHhhO" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">Metadata (object) or Metadata (null)</span><span class="sc-laZMeE sc-eJocfa jWaWWE bArHDh"> (<!-- -->Metadata<!-- -->) </span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div></div></div></td></tr><tr class="last "><td class="sc-hBMUJo sc-fFSPTT sc-gSYDnn iwcKgn cAqMTE hTttpy" kind="field" title="output_expires_after"><span class="sc-iemWCZ bcnRwz"></span><button aria-label="expand properties"><span class="property-name">output_expires_after</span><svg class="sc-dIsUp hGHhhO" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">object</span><span class="sc-laZMeE sc-eJocfa jWaWWE bArHDh"> (<!-- -->BatchFileExpirationAfter<!-- -->) </span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The expiration policy for the output and/or error file that are generated for a batch.</p>
</div></div></div></td></tr></tbody></table><div><h3 class="sc-fIxmyt DvFer">Responses</h3><div><button class="sc-htmcrh lbYftx"><svg class="sc-dIsUp dqYXmg" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-fWWYYk cMoEZ">200<!-- --> </strong><span class="sc-jcwpoC eDjFAZ"><p>Batch created successfully.</p>
</span></button></div></div></div><div class="sc-jSFjdj sc-gKAaRy gBjRyf gcushC"><div class="sc-EZqKI fWsqvQ"><button class="sc-eEVmNe ilvUMs"><span type="post" class="sc-fmdNqN ldMUmp http-verb post">post</span><span class="sc-jXcxbT fCEUju">/batches</span><svg class="sc-dIsUp bRmrKA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ljsmAU flIrdF"><div class="sc-jlZJtj fQkroN"><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div><div tabindex="0" role="button"><div class="sc-dTSzeu dfUAUz"><span>https://api.openai.com/v1</span>/batches</div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Request samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="react-tabs-202" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-203" tabindex="0" data-rttab="true">Payload</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-203" aria-labelledby="react-tabs-202"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-bBjRSN kQSIAz">application/json</div></div><div class="sc-jgPyTC dSaTNC"><div class="sc-jNnpgg esZIbL"><div class="sc-giAqHp hMPeqJ"><button><div class="sc-carFqZ UksDl">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iJCRrE jCdxGr sc-dPaNzc gyljjx"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"input_file_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"endpoint"</span>: <span class="token string">"/v1/responses"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"completion_window"</span>: <span class="token string">"24h"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"property1"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"property2"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"output_expires_after"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"anchor"</span>: <span class="token string">"created_at"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"seconds"</span>: <span class="token number">3600</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Response samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-204" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-205" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-205" aria-labelledby="react-tabs-204"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-bBjRSN kQSIAz">application/json</div></div><div class="sc-jgPyTC dSaTNC"><div class="sc-jNnpgg esZIbL"><div class="sc-giAqHp hMPeqJ"><button><div class="sc-carFqZ UksDl">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iJCRrE jCdxGr sc-dPaNzc gyljjx"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"object"</span>: <span class="token string">"batch"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"endpoint"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"model"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"object"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"data"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"code"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"message"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"param"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"line"</span>: <span class="token number">0</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"input_file_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"completion_window"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token string">"validating"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"output_file_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"error_file_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"created_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"in_progress_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"expires_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"finalizing_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"completed_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"failed_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"expired_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"cancelling_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"cancelled_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"request_counts"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"total"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"completed"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"failed"</span>: <span class="token number">0</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"usage"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"input_tokens"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"input_tokens_details"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"cached_tokens"</span>: <span class="token number">0</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"output_tokens"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"output_tokens_details"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"reasoning_tokens"</span>: <span class="token number">0</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"total_tokens"</span>: <span class="token number">0</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"property1"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"property2"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Batch/operation/listBatches" data-section-id="tag/Batch/operation/listBatches" class="sc-eCApnc liLqNm"><div data-section-id="operation/listBatches" id="operation/listBatches" class="sc-iCoGMd gLxhOh"><div class="sc-hKFxyN juinod"><h2 class="sc-pNWdM eftmgB"><a class="sc-crzoAE iUxAWq" href="#tag/Batch/operation/listBatches" aria-label="tag/Batch/operation/listBatches"></a>List your organization's batches.<!-- --> </h2><div class="sc-fcmMJX cvfxAX"><div class="sc-jUfyBS bhDyou"><h5 class="sc-iqAclL sc-fuISkM eONCmm hZIgic">Authorizations:</h5><svg class="sc-dIsUp iPqByX" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jQAxuV ccffaZ"><span class="sc-daBunf fcvuS"><span class="sc-dsXzNU dPrSxx"><i>ApiKeyAuth</i></span></span></div></div><div><h5 class="sc-iqAclL eONCmm">query<!-- --> Parameters</h5><table class="sc-hHEiqL VCQHZ"><tbody><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="after"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">after</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>A cursor for use in pagination. <code>after</code> is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list.</p>
</div></div></div></td></tr><tr class="last "><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="limit"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">limit</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">integer</span></div><div><span class="sc-laZMeE jWaWWE"> <!-- -->Default:<!-- --> </span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">20</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-fIxmyt DvFer">Responses</h3><div><button class="sc-htmcrh lbYftx"><svg class="sc-dIsUp dqYXmg" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-fWWYYk cMoEZ">200<!-- --> </strong><span class="sc-jcwpoC eDjFAZ"><p>Batch listed successfully.</p>
</span></button></div></div></div><div class="sc-jSFjdj sc-gKAaRy gBjRyf gcushC"><div class="sc-EZqKI fWsqvQ"><button class="sc-eEVmNe ilvUMs"><span type="get" class="sc-fmdNqN ihNycv http-verb get">get</span><span class="sc-jXcxbT fCEUju">/batches</span><svg class="sc-dIsUp bRmrKA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ljsmAU flIrdF"><div class="sc-jlZJtj fQkroN"><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div><div tabindex="0" role="button"><div class="sc-dTSzeu dfUAUz"><span>https://api.openai.com/v1</span>/batches</div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Response samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-206" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-207" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-207" aria-labelledby="react-tabs-206"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-bBjRSN kQSIAz">application/json</div></div><div class="sc-jgPyTC dSaTNC"><div class="sc-jNnpgg esZIbL"><div class="sc-giAqHp hMPeqJ"><button><div class="sc-carFqZ UksDl">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iJCRrE jCdxGr sc-dPaNzc gyljjx"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"object"</span>: <span class="token string">"batch"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"endpoint"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"model"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"errors"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"object"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"data"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"code"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"message"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"param"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"line"</span>: <span class="token number">0</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"input_file_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"completion_window"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"status"</span>: <span class="token string">"validating"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"output_file_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"error_file_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"created_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"in_progress_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"expires_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"finalizing_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"completed_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"failed_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"expired_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"cancelling_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"cancelled_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"request_counts"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"total"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"completed"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"failed"</span>: <span class="token number">0</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"usage"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"input_tokens"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"input_tokens_details"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"cached_tokens"</span>: <span class="token number">0</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"output_tokens"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"output_tokens_details"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"reasoning_tokens"</span>: <span class="token number">0</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"total_tokens"</span>: <span class="token number">0</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"metadata"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"property1"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"property2"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"first_id"</span>: <span class="token string">"batch_abc123"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"last_id"</span>: <span class="token string">"batch_abc456"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"has_more"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"object"</span>: <span class="token string">"list"</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Batch/operation/retrieveBatch" data-section-id="tag/Batch/operation/retrieveBatch" class="sc-eCApnc liLqNm"><div data-section-id="operation/retrieveBatch" id="operation/retrieveBatch" class="sc-iCoGMd gLxhOh"><div class="sc-hKFxyN juinod"><h2 class="sc-pNWdM eftmgB"><a class="sc-crzoAE iUxAWq" href="#tag/Batch/operation/retrieveBatch" aria-label="tag/Batch/operation/retrieveBatch"></a>Retrieves a batch.<!-- --> </h2><div class="sc-fcmMJX cvfxAX"><div class="sc-jUfyBS bhDyou"><h5 class="sc-iqAclL sc-fuISkM eONCmm hZIgic">Authorizations:</h5><svg class="sc-dIsUp iPqByX" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jQAxuV ccffaZ"><span class="sc-daBunf fcvuS"><span class="sc-dsXzNU dPrSxx"><i>ApiKeyAuth</i></span></span></div></div><div><h5 class="sc-iqAclL eONCmm">path<!-- --> Parameters</h5><table class="sc-hHEiqL VCQHZ"><tbody><tr class="last "><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="batch_id"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">batch_id</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The ID of the batch to retrieve.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-fIxmyt DvFer">Responses</h3><div><button class="sc-htmcrh lbYftx"><svg class="sc-dIsUp dqYXmg" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-fWWYYk cMoEZ">200<!-- --> </strong><span class="sc-jcwpoC eDjFAZ"><p>Batch retrieved successfully.</p>
</span></button></div></div></div><div class="sc-jSFjdj sc-gKAaRy gBjRyf gcushC"><div class="sc-EZqKI fWsqvQ"><button class="sc-eEVmNe ilvUMs"><span type="get" class="sc-fmdNqN ihNycv http-verb get">get</span><span class="sc-jXcxbT fCEUju">/batches/{batch_id}</span><svg class="sc-dIsUp bRmrKA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ljsmAU flIrdF"><div class="sc-jlZJtj fQkroN"><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div><div tabindex="0" role="button"><div class="sc-dTSzeu dfUAUz"><span>https://api.openai.com/v1</span>/batches/{batch_id}</div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Response samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-208" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-209" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-209" aria-labelledby="react-tabs-208"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-bBjRSN kQSIAz">application/json</div></div><div class="sc-jgPyTC dSaTNC"><div class="sc-jNnpgg esZIbL"><div class="sc-giAqHp hMPeqJ"><button><div class="sc-carFqZ UksDl">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iJCRrE jCdxGr sc-dPaNzc gyljjx"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"object"</span>: <span class="token string">"batch"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"endpoint"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"model"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"object"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"data"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"code"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"message"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"param"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"line"</span>: <span class="token number">0</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"input_file_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"completion_window"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token string">"validating"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"output_file_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"error_file_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"created_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"in_progress_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"expires_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"finalizing_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"completed_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"failed_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"expired_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"cancelling_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"cancelled_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"request_counts"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"total"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"completed"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"failed"</span>: <span class="token number">0</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"usage"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"input_tokens"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"input_tokens_details"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"cached_tokens"</span>: <span class="token number">0</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"output_tokens"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"output_tokens_details"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"reasoning_tokens"</span>: <span class="token number">0</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"total_tokens"</span>: <span class="token number">0</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"property1"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"property2"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Batch/operation/cancelBatch" data-section-id="tag/Batch/operation/cancelBatch" class="sc-eCApnc liLqNm"><div data-section-id="operation/cancelBatch" id="operation/cancelBatch" class="sc-iCoGMd gLxhOh"><div class="sc-hKFxyN juinod"><h2 class="sc-pNWdM eftmgB"><a class="sc-crzoAE iUxAWq" href="#tag/Batch/operation/cancelBatch" aria-label="tag/Batch/operation/cancelBatch"></a>Cancels an in-progress batch. The batch will be in status `cancelling` for up to 10 minutes, before changing to `cancelled`, where it will have partial results (if any) available in the output file.<!-- --> </h2><div class="sc-fcmMJX cvfxAX"><div class="sc-jUfyBS bhDyou"><h5 class="sc-iqAclL sc-fuISkM eONCmm hZIgic">Authorizations:</h5><svg class="sc-dIsUp iPqByX" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jQAxuV ccffaZ"><span class="sc-daBunf fcvuS"><span class="sc-dsXzNU dPrSxx"><i>ApiKeyAuth</i></span></span></div></div><div><h5 class="sc-iqAclL eONCmm">path<!-- --> Parameters</h5><table class="sc-hHEiqL VCQHZ"><tbody><tr class="last "><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="batch_id"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">batch_id</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The ID of the batch to cancel.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-fIxmyt DvFer">Responses</h3><div><button class="sc-htmcrh lbYftx"><svg class="sc-dIsUp dqYXmg" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-fWWYYk cMoEZ">200<!-- --> </strong><span class="sc-jcwpoC eDjFAZ"><p>Batch is cancelling. Returns the cancelling batch's details.</p>
</span></button></div></div></div><div class="sc-jSFjdj sc-gKAaRy gBjRyf gcushC"><div class="sc-EZqKI fWsqvQ"><button class="sc-eEVmNe ilvUMs"><span type="post" class="sc-fmdNqN ldMUmp http-verb post">post</span><span class="sc-jXcxbT fCEUju">/batches/{batch_id}/cancel</span><svg class="sc-dIsUp bRmrKA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ljsmAU flIrdF"><div class="sc-jlZJtj fQkroN"><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div><div tabindex="0" role="button"><div class="sc-dTSzeu dfUAUz"><span>https://api.openai.com/v1</span>/batches/{batch_id}/cancel</div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Response samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-210" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-211" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-211" aria-labelledby="react-tabs-210"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-bBjRSN kQSIAz">application/json</div></div><div class="sc-jgPyTC dSaTNC"><div class="sc-jNnpgg esZIbL"><div class="sc-giAqHp hMPeqJ"><button><div class="sc-carFqZ UksDl">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iJCRrE jCdxGr sc-dPaNzc gyljjx"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"object"</span>: <span class="token string">"batch"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"endpoint"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"model"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"object"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"data"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"code"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"message"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"param"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"line"</span>: <span class="token number">0</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"input_file_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"completion_window"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token string">"validating"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"output_file_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"error_file_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"created_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"in_progress_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"expires_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"finalizing_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"completed_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"failed_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"expired_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"cancelling_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"cancelled_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"request_counts"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"total"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"completed"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"failed"</span>: <span class="token number">0</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"usage"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"input_tokens"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"input_tokens_details"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"cached_tokens"</span>: <span class="token number">0</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"output_tokens"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"output_tokens_details"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"reasoning_tokens"</span>: <span class="token number">0</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"total_tokens"</span>: <span class="token number">0</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"property1"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"property2"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Files" data-section-id="tag/Files" class="sc-eCApnc jlMQbh"><div class="sc-iCoGMd gLxhOh"><div class="sc-hKFxyN juinod"><h1 class="sc-fujyAs bpZWeL"><a class="sc-crzoAE iUxAWq" href="#tag/Files" aria-label="tag/Files"></a>Files</h1></div></div><div class="sc-hKFxyN bJcDWV"><div class="sc-iJCRrE sc-ciSkZP jCdxGr QGruV redoc-markdown "><p>Files are used to upload documents that can be used with features like Assistants and Fine-tuning.</p>
</div></div></div><div id="tag/Files/operation/listFiles" data-section-id="tag/Files/operation/listFiles" class="sc-eCApnc liLqNm"><div data-section-id="operation/listFiles" id="operation/listFiles" class="sc-iCoGMd gLxhOh"><div class="sc-hKFxyN juinod"><h2 class="sc-pNWdM eftmgB"><a class="sc-crzoAE iUxAWq" href="#tag/Files/operation/listFiles" aria-label="tag/Files/operation/listFiles"></a>Returns a list of files.<!-- --> </h2><div class="sc-fcmMJX cvfxAX"><div class="sc-jUfyBS bhDyou"><h5 class="sc-iqAclL sc-fuISkM eONCmm hZIgic">Authorizations:</h5><svg class="sc-dIsUp iPqByX" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jQAxuV ccffaZ"><span class="sc-daBunf fcvuS"><span class="sc-dsXzNU dPrSxx"><i>ApiKeyAuth</i></span></span></div></div><div><h5 class="sc-iqAclL eONCmm">query<!-- --> Parameters</h5><table class="sc-hHEiqL VCQHZ"><tbody><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="purpose"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">purpose</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>Only return files with the given purpose.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="limit"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">limit</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">integer</span></div><div><span class="sc-laZMeE jWaWWE"> <!-- -->Default:<!-- --> </span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">10000</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>A limit on the number of objects to be returned. Limit can range between 1 and 10,000, and the default is 10,000.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="order"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">order</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div><div><span class="sc-laZMeE jWaWWE"> <!-- -->Default:<!-- --> </span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"desc"</span></div><div><span class="sc-laZMeE jWaWWE"> <!-- -->Enum<!-- -->:</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"asc"</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"desc"</span> </div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>Sort order by the <code>created_at</code> timestamp of the objects. <code>asc</code> for ascending order and <code>desc</code> for descending order.</p>
</div></div></div></td></tr><tr class="last "><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="after"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">after</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>A cursor for use in pagination. <code>after</code> is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-fIxmyt DvFer">Responses</h3><div><button class="sc-htmcrh lbYftx"><svg class="sc-dIsUp dqYXmg" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-fWWYYk cMoEZ">200<!-- --> </strong><span class="sc-jcwpoC eDjFAZ"><p>OK</p>
</span></button></div></div></div><div class="sc-jSFjdj sc-gKAaRy gBjRyf gcushC"><div class="sc-EZqKI fWsqvQ"><button class="sc-eEVmNe ilvUMs"><span type="get" class="sc-fmdNqN ihNycv http-verb get">get</span><span class="sc-jXcxbT fCEUju">/files</span><svg class="sc-dIsUp bRmrKA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ljsmAU flIrdF"><div class="sc-jlZJtj fQkroN"><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div><div tabindex="0" role="button"><div class="sc-dTSzeu dfUAUz"><span>https://api.openai.com/v1</span>/files</div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Response samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-212" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-213" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-213" aria-labelledby="react-tabs-212"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-bBjRSN kQSIAz">application/json</div></div><div class="sc-jgPyTC dSaTNC"><div class="sc-jNnpgg esZIbL"><div class="sc-giAqHp hMPeqJ"><button><div class="sc-carFqZ UksDl">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iJCRrE jCdxGr sc-dPaNzc gyljjx"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"object"</span>: <span class="token string">"list"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"bytes"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"created_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"expires_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"filename"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"object"</span>: <span class="token string">"file"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"purpose"</span>: <span class="token string">"assistants"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"status"</span>: <span class="token string">"uploaded"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"status_details"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"first_id"</span>: <span class="token string">"file-abc123"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"last_id"</span>: <span class="token string">"file-abc456"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"has_more"</span>: <span class="token boolean">false</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Files/operation/createFile" data-section-id="tag/Files/operation/createFile" class="sc-eCApnc liLqNm"><div data-section-id="operation/createFile" id="operation/createFile" class="sc-iCoGMd gLxhOh"><div class="sc-hKFxyN juinod"><h2 class="sc-pNWdM eftmgB"><a class="sc-crzoAE iUxAWq" href="#tag/Files/operation/createFile" aria-label="tag/Files/operation/createFile"></a>Upload a file that can be used across various endpoints. Individual files
can be up to 512 MB, and each project can store up to 2.5 TB of files in
total. There is no organization-wide storage limit. Uploads to this
endpoint are rate-limited to 1,000 requests per minute per authenticated
user.
- The Assistants API supports files up to 2 million tokens and of specific
file types. See the [Assistants Tools guide](/docs/assistants/tools) for
details.
- The Fine-tuning API only supports `.jsonl` files. The input also has
certain required formats for fine-tuning
[chat](/docs/api-reference/fine-tuning/chat-input) or
[completions](/docs/api-reference/fine-tuning/completions-input) models.
- The Batch API only supports `.jsonl` files up to 200 MB in size. The input
also has a specific required
[format](/docs/api-reference/batch/request-input).
- For Retrieval or `file_search` ingestion, upload files here first. If
you need to attach multiple uploaded files to the same vector store, use
[`/vector_stores/{vector_store_id}/file_batches`](/docs/api-reference/vector-stores-file-batches/createBatch)
instead of attaching them one by one. Vector store attachment has separate
limits from file upload, including 2,000 attached files per minute per
organization.
Please [contact us](https://help.openai.com/) if you need to increase these
storage limits.
<!-- --> </h2><div class="sc-fcmMJX cvfxAX"><div class="sc-jUfyBS bhDyou"><h5 class="sc-iqAclL sc-fuISkM eONCmm hZIgic">Authorizations:</h5><svg class="sc-dIsUp iPqByX" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jQAxuV ccffaZ"><span class="sc-daBunf fcvuS"><span class="sc-dsXzNU dPrSxx"><i>ApiKeyAuth</i></span></span></div></div><h5 class="sc-iqAclL eONCmm">Request Body schema: <span class="sc-cBoqAE eKyrDP">multipart/form-data</span></h5><div class="sc-iJCRrE sc-ciSkZP jCdxGr QGruV"></div><table class="sc-hHEiqL VCQHZ"><tbody><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="file"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">file</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa"> <!-- --><<!-- -->binary<!-- -->><!-- --> </span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The File object (not file name) to be uploaded.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="purpose"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">purpose</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div><div><span class="sc-laZMeE jWaWWE"> <!-- -->Enum<!-- -->:</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"assistants"</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"batch"</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"fine-tune"</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"vision"</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"user_data"</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"evals"</span> </div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The intended purpose of the uploaded file. One of:</p>
<ul>
<li><code>assistants</code>: Used in the Assistants API</li>
<li><code>batch</code>: Used in the Batch API</li>
<li><code>fine-tune</code>: Used for fine-tuning</li>
<li><code>vision</code>: Images used for vision fine-tuning</li>
<li><code>user_data</code>: Flexible file type for any purpose</li>
<li><code>evals</code>: Used for eval data sets</li>
</ul>
</div></div></div></td></tr><tr class="last "><td class="sc-hBMUJo sc-fFSPTT sc-gSYDnn iwcKgn cAqMTE hTttpy" kind="field" title="expires_after"><span class="sc-iemWCZ bcnRwz"></span><button aria-label="expand properties"><span class="property-name">expires_after</span><svg class="sc-dIsUp hGHhhO" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">object</span><span class="sc-laZMeE sc-eJocfa jWaWWE bArHDh"> (<!-- -->FileExpirationAfter<!-- -->) </span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The expiration policy for a file. By default, files with <code>purpose=batch</code> expire after 30 days and all other files are persisted until they are manually deleted.</p>
</div></div></div></td></tr></tbody></table><div><h3 class="sc-fIxmyt DvFer">Responses</h3><div><button class="sc-htmcrh lbYftx"><svg class="sc-dIsUp dqYXmg" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-fWWYYk cMoEZ">200<!-- --> </strong><span class="sc-jcwpoC eDjFAZ"><p>OK</p>
</span></button></div></div></div><div class="sc-jSFjdj sc-gKAaRy gBjRyf gcushC"><div class="sc-EZqKI fWsqvQ"><button class="sc-eEVmNe ilvUMs"><span type="post" class="sc-fmdNqN ldMUmp http-verb post">post</span><span class="sc-jXcxbT fCEUju">/files</span><svg class="sc-dIsUp bRmrKA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ljsmAU flIrdF"><div class="sc-jlZJtj fQkroN"><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div><div tabindex="0" role="button"><div class="sc-dTSzeu dfUAUz"><span>https://api.openai.com/v1</span>/files</div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Response samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-214" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-215" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-215" aria-labelledby="react-tabs-214"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-bBjRSN kQSIAz">application/json</div></div><div class="sc-jgPyTC dSaTNC"><div class="sc-jNnpgg esZIbL"><div class="sc-giAqHp hMPeqJ"><button><div class="sc-carFqZ UksDl">Copy</div></button></div><div class="sc-iJCRrE jCdxGr sc-dPaNzc gyljjx"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"bytes"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"created_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"expires_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"filename"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"object"</span>: <span class="token string">"file"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"purpose"</span>: <span class="token string">"assistants"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token string">"uploaded"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status_details"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Files/operation/deleteFile" data-section-id="tag/Files/operation/deleteFile" class="sc-eCApnc liLqNm"><div data-section-id="operation/deleteFile" id="operation/deleteFile" class="sc-iCoGMd gLxhOh"><div class="sc-hKFxyN juinod"><h2 class="sc-pNWdM eftmgB"><a class="sc-crzoAE iUxAWq" href="#tag/Files/operation/deleteFile" aria-label="tag/Files/operation/deleteFile"></a>Delete a file and remove it from all vector stores.<!-- --> </h2><div class="sc-fcmMJX cvfxAX"><div class="sc-jUfyBS bhDyou"><h5 class="sc-iqAclL sc-fuISkM eONCmm hZIgic">Authorizations:</h5><svg class="sc-dIsUp iPqByX" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jQAxuV ccffaZ"><span class="sc-daBunf fcvuS"><span class="sc-dsXzNU dPrSxx"><i>ApiKeyAuth</i></span></span></div></div><div><h5 class="sc-iqAclL eONCmm">path<!-- --> Parameters</h5><table class="sc-hHEiqL VCQHZ"><tbody><tr class="last "><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="file_id"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">file_id</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The ID of the file to use for this request.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-fIxmyt DvFer">Responses</h3><div><button class="sc-htmcrh lbYftx"><svg class="sc-dIsUp dqYXmg" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-fWWYYk cMoEZ">200<!-- --> </strong><span class="sc-jcwpoC eDjFAZ"><p>OK</p>
</span></button></div></div></div><div class="sc-jSFjdj sc-gKAaRy gBjRyf gcushC"><div class="sc-EZqKI fWsqvQ"><button class="sc-eEVmNe ilvUMs"><span type="delete" class="sc-fmdNqN bJzUtf http-verb delete">delete</span><span class="sc-jXcxbT fCEUju">/files/{file_id}</span><svg class="sc-dIsUp bRmrKA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ljsmAU flIrdF"><div class="sc-jlZJtj fQkroN"><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div><div tabindex="0" role="button"><div class="sc-dTSzeu dfUAUz"><span>https://api.openai.com/v1</span>/files/{file_id}</div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Response samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-216" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-217" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-217" aria-labelledby="react-tabs-216"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-bBjRSN kQSIAz">application/json</div></div><div class="sc-jgPyTC dSaTNC"><div class="sc-jNnpgg esZIbL"><div class="sc-giAqHp hMPeqJ"><button><div class="sc-carFqZ UksDl">Copy</div></button></div><div class="sc-iJCRrE jCdxGr sc-dPaNzc gyljjx"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"object"</span>: <span class="token string">"file"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"deleted"</span>: <span class="token boolean">true</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Files/operation/retrieveFile" data-section-id="tag/Files/operation/retrieveFile" class="sc-eCApnc liLqNm"><div data-section-id="operation/retrieveFile" id="operation/retrieveFile" class="sc-iCoGMd gLxhOh"><div class="sc-hKFxyN juinod"><h2 class="sc-pNWdM eftmgB"><a class="sc-crzoAE iUxAWq" href="#tag/Files/operation/retrieveFile" aria-label="tag/Files/operation/retrieveFile"></a>Returns information about a specific file.<!-- --> </h2><div class="sc-fcmMJX cvfxAX"><div class="sc-jUfyBS bhDyou"><h5 class="sc-iqAclL sc-fuISkM eONCmm hZIgic">Authorizations:</h5><svg class="sc-dIsUp iPqByX" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jQAxuV ccffaZ"><span class="sc-daBunf fcvuS"><span class="sc-dsXzNU dPrSxx"><i>ApiKeyAuth</i></span></span></div></div><div><h5 class="sc-iqAclL eONCmm">path<!-- --> Parameters</h5><table class="sc-hHEiqL VCQHZ"><tbody><tr class="last "><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="file_id"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">file_id</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The ID of the file to use for this request.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-fIxmyt DvFer">Responses</h3><div><button class="sc-htmcrh lbYftx"><svg class="sc-dIsUp dqYXmg" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-fWWYYk cMoEZ">200<!-- --> </strong><span class="sc-jcwpoC eDjFAZ"><p>OK</p>
</span></button></div></div></div><div class="sc-jSFjdj sc-gKAaRy gBjRyf gcushC"><div class="sc-EZqKI fWsqvQ"><button class="sc-eEVmNe ilvUMs"><span type="get" class="sc-fmdNqN ihNycv http-verb get">get</span><span class="sc-jXcxbT fCEUju">/files/{file_id}</span><svg class="sc-dIsUp bRmrKA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ljsmAU flIrdF"><div class="sc-jlZJtj fQkroN"><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div><div tabindex="0" role="button"><div class="sc-dTSzeu dfUAUz"><span>https://api.openai.com/v1</span>/files/{file_id}</div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Response samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-218" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-219" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-219" aria-labelledby="react-tabs-218"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-bBjRSN kQSIAz">application/json</div></div><div class="sc-jgPyTC dSaTNC"><div class="sc-jNnpgg esZIbL"><div class="sc-giAqHp hMPeqJ"><button><div class="sc-carFqZ UksDl">Copy</div></button></div><div class="sc-iJCRrE jCdxGr sc-dPaNzc gyljjx"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"bytes"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"created_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"expires_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"filename"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"object"</span>: <span class="token string">"file"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"purpose"</span>: <span class="token string">"assistants"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token string">"uploaded"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status_details"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Files/operation/downloadFile" data-section-id="tag/Files/operation/downloadFile" class="sc-eCApnc liLqNm"><div data-section-id="operation/downloadFile" id="operation/downloadFile" class="sc-iCoGMd gLxhOh"><div class="sc-hKFxyN juinod"><h2 class="sc-pNWdM eftmgB"><a class="sc-crzoAE iUxAWq" href="#tag/Files/operation/downloadFile" aria-label="tag/Files/operation/downloadFile"></a>Returns the contents of the specified file.<!-- --> </h2><div class="sc-fcmMJX cvfxAX"><div class="sc-jUfyBS bhDyou"><h5 class="sc-iqAclL sc-fuISkM eONCmm hZIgic">Authorizations:</h5><svg class="sc-dIsUp iPqByX" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jQAxuV ccffaZ"><span class="sc-daBunf fcvuS"><span class="sc-dsXzNU dPrSxx"><i>ApiKeyAuth</i></span></span></div></div><div><h5 class="sc-iqAclL eONCmm">path<!-- --> Parameters</h5><table class="sc-hHEiqL VCQHZ"><tbody><tr class="last "><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="file_id"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">file_id</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The ID of the file to use for this request.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-fIxmyt DvFer">Responses</h3><div><button class="sc-htmcrh lbYftx"><svg class="sc-dIsUp dqYXmg" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-fWWYYk cMoEZ">200<!-- --> </strong><span class="sc-jcwpoC eDjFAZ"><p>OK</p>
</span></button></div></div></div><div class="sc-jSFjdj sc-gKAaRy gBjRyf gcushC"><div class="sc-EZqKI fWsqvQ"><button class="sc-eEVmNe ilvUMs"><span type="get" class="sc-fmdNqN ihNycv http-verb get">get</span><span class="sc-jXcxbT fCEUju">/files/{file_id}/content</span><svg class="sc-dIsUp bRmrKA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ljsmAU flIrdF"><div class="sc-jlZJtj fQkroN"><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div><div tabindex="0" role="button"><div class="sc-dTSzeu dfUAUz"><span>https://api.openai.com/v1</span>/files/{file_id}/content</div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Response samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-220" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-221" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-221" aria-labelledby="react-tabs-220"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-bBjRSN kQSIAz">application/json</div></div><div class="sc-jgPyTC dSaTNC"><div class="sc-jNnpgg esZIbL"><div class="sc-giAqHp hMPeqJ"><button><div class="sc-carFqZ UksDl">Copy</div></button></div><div class="sc-iJCRrE jCdxGr sc-dPaNzc gyljjx"><div class="redoc-json"><code><span class="token string">"string"</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Uploads" data-section-id="tag/Uploads" class="sc-eCApnc jlMQbh"><div class="sc-iCoGMd gLxhOh"><div class="sc-hKFxyN juinod"><h1 class="sc-fujyAs bpZWeL"><a class="sc-crzoAE iUxAWq" href="#tag/Uploads" aria-label="tag/Uploads"></a>Uploads</h1></div></div><div class="sc-hKFxyN bJcDWV"><div class="sc-iJCRrE sc-ciSkZP jCdxGr QGruV redoc-markdown "><p>Use Uploads to upload large files in multiple parts.</p>
</div></div></div><div id="tag/Uploads/operation/createUpload" data-section-id="tag/Uploads/operation/createUpload" class="sc-eCApnc liLqNm"><div data-section-id="operation/createUpload" id="operation/createUpload" class="sc-iCoGMd gLxhOh"><div class="sc-hKFxyN juinod"><h2 class="sc-pNWdM eftmgB"><a class="sc-crzoAE iUxAWq" href="#tag/Uploads/operation/createUpload" aria-label="tag/Uploads/operation/createUpload"></a>Creates an intermediate [Upload](/docs/api-reference/uploads/object) object
that you can add [Parts](/docs/api-reference/uploads/part-object) to.
Currently, an Upload can accept at most 8 GB in total and expires after an
hour after you create it.
Once you complete the Upload, we will create a
[File](/docs/api-reference/files/object) object that contains all the parts
you uploaded. This File is usable in the rest of our platform as a regular
File object.
For certain `purpose` values, the correct `mime_type` must be specified.
Please refer to documentation for the
[supported MIME types for your use case](/docs/assistants/tools/file-search#supported-files).
For guidance on the proper filename extensions for each purpose, please
follow the documentation on [creating a
File](/docs/api-reference/files/create).
Returns the Upload object with status `pending`.
<!-- --> </h2><div class="sc-fcmMJX cvfxAX"><div class="sc-jUfyBS bhDyou"><h5 class="sc-iqAclL sc-fuISkM eONCmm hZIgic">Authorizations:</h5><svg class="sc-dIsUp iPqByX" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jQAxuV ccffaZ"><span class="sc-daBunf fcvuS"><span class="sc-dsXzNU dPrSxx"><i>ApiKeyAuth</i></span></span></div></div><h5 class="sc-iqAclL eONCmm">Request Body schema: <span class="sc-cBoqAE eKyrDP">application/json</span></h5><div class="sc-iJCRrE sc-ciSkZP jCdxGr QGruV"></div><table class="sc-hHEiqL VCQHZ"><tbody><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="filename"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">filename</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The name of the file to upload.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="purpose"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">purpose</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div><div><span class="sc-laZMeE jWaWWE"> <!-- -->Enum<!-- -->:</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"assistants"</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"batch"</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"fine-tune"</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"vision"</span> </div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The intended purpose of the uploaded file.</p>
<p>See the <a href="/docs/api-reference/files/create#files-create-purpose">documentation on File
purposes</a>.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="bytes"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">bytes</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">integer</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The number of bytes in the file you are uploading.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="mime_type"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">mime_type</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The MIME type of the file.</p>
<p>This must fall within the supported MIME types for your file purpose. See
the supported MIME types for assistants and vision.</p>
</div></div></div></td></tr><tr class="last "><td class="sc-hBMUJo sc-fFSPTT sc-gSYDnn iwcKgn cAqMTE hTttpy" kind="field" title="expires_after"><span class="sc-iemWCZ bcnRwz"></span><button aria-label="expand properties"><span class="property-name">expires_after</span><svg class="sc-dIsUp hGHhhO" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">object</span><span class="sc-laZMeE sc-eJocfa jWaWWE bArHDh"> (<!-- -->FileExpirationAfter<!-- -->) </span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The expiration policy for a file. By default, files with <code>purpose=batch</code> expire after 30 days and all other files are persisted until they are manually deleted.</p>
</div></div></div></td></tr></tbody></table><div><h3 class="sc-fIxmyt DvFer">Responses</h3><div><button class="sc-htmcrh lbYftx"><svg class="sc-dIsUp dqYXmg" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-fWWYYk cMoEZ">200<!-- --> </strong><span class="sc-jcwpoC eDjFAZ"><p>OK</p>
</span></button></div></div></div><div class="sc-jSFjdj sc-gKAaRy gBjRyf gcushC"><div class="sc-EZqKI fWsqvQ"><button class="sc-eEVmNe ilvUMs"><span type="post" class="sc-fmdNqN ldMUmp http-verb post">post</span><span class="sc-jXcxbT fCEUju">/uploads</span><svg class="sc-dIsUp bRmrKA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ljsmAU flIrdF"><div class="sc-jlZJtj fQkroN"><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div><div tabindex="0" role="button"><div class="sc-dTSzeu dfUAUz"><span>https://api.openai.com/v1</span>/uploads</div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Request samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="react-tabs-222" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-223" tabindex="0" data-rttab="true">Payload</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-223" aria-labelledby="react-tabs-222"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-bBjRSN kQSIAz">application/json</div></div><div class="sc-jgPyTC dSaTNC"><div class="sc-jNnpgg esZIbL"><div class="sc-giAqHp hMPeqJ"><button><div class="sc-carFqZ UksDl">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iJCRrE jCdxGr sc-dPaNzc gyljjx"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"filename"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"purpose"</span>: <span class="token string">"assistants"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"bytes"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"mime_type"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"expires_after"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"anchor"</span>: <span class="token string">"created_at"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"seconds"</span>: <span class="token number">3600</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Response samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-224" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-225" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-225" aria-labelledby="react-tabs-224"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-bBjRSN kQSIAz">application/json</div></div><div class="sc-jgPyTC dSaTNC"><div class="sc-jNnpgg esZIbL"><div class="sc-giAqHp hMPeqJ"><button><div class="sc-carFqZ UksDl">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iJCRrE jCdxGr sc-dPaNzc gyljjx"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"created_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"filename"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"bytes"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"purpose"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token string">"pending"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"expires_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"object"</span>: <span class="token string">"upload"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"file"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"bytes"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"created_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"expires_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"filename"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"object"</span>: <span class="token string">"file"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"purpose"</span>: <span class="token string">"assistants"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"status"</span>: <span class="token string">"uploaded"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"status_details"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Uploads/operation/cancelUpload" data-section-id="tag/Uploads/operation/cancelUpload" class="sc-eCApnc liLqNm"><div data-section-id="operation/cancelUpload" id="operation/cancelUpload" class="sc-iCoGMd gLxhOh"><div class="sc-hKFxyN juinod"><h2 class="sc-pNWdM eftmgB"><a class="sc-crzoAE iUxAWq" href="#tag/Uploads/operation/cancelUpload" aria-label="tag/Uploads/operation/cancelUpload"></a>Cancels the Upload. No Parts may be added after an Upload is cancelled.
Returns the Upload object with status `cancelled`.
<!-- --> </h2><div class="sc-fcmMJX cvfxAX"><div class="sc-jUfyBS bhDyou"><h5 class="sc-iqAclL sc-fuISkM eONCmm hZIgic">Authorizations:</h5><svg class="sc-dIsUp iPqByX" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jQAxuV ccffaZ"><span class="sc-daBunf fcvuS"><span class="sc-dsXzNU dPrSxx"><i>ApiKeyAuth</i></span></span></div></div><div><h5 class="sc-iqAclL eONCmm">path<!-- --> Parameters</h5><table class="sc-hHEiqL VCQHZ"><tbody><tr class="last "><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="upload_id"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">upload_id</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><span class="sc-laZMeE jWaWWE"> <!-- -->Example:<!-- --> </span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">upload_abc123</span></div><div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The ID of the Upload.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-fIxmyt DvFer">Responses</h3><div><button class="sc-htmcrh lbYftx"><svg class="sc-dIsUp dqYXmg" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-fWWYYk cMoEZ">200<!-- --> </strong><span class="sc-jcwpoC eDjFAZ"><p>OK</p>
</span></button></div></div></div><div class="sc-jSFjdj sc-gKAaRy gBjRyf gcushC"><div class="sc-EZqKI fWsqvQ"><button class="sc-eEVmNe ilvUMs"><span type="post" class="sc-fmdNqN ldMUmp http-verb post">post</span><span class="sc-jXcxbT fCEUju">/uploads/{upload_id}/cancel</span><svg class="sc-dIsUp bRmrKA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ljsmAU flIrdF"><div class="sc-jlZJtj fQkroN"><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div><div tabindex="0" role="button"><div class="sc-dTSzeu dfUAUz"><span>https://api.openai.com/v1</span>/uploads/{upload_id}/cancel</div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Response samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-226" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-227" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-227" aria-labelledby="react-tabs-226"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-bBjRSN kQSIAz">application/json</div></div><div class="sc-jgPyTC dSaTNC"><div class="sc-jNnpgg esZIbL"><div class="sc-giAqHp hMPeqJ"><button><div class="sc-carFqZ UksDl">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iJCRrE jCdxGr sc-dPaNzc gyljjx"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"created_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"filename"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"bytes"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"purpose"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token string">"pending"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"expires_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"object"</span>: <span class="token string">"upload"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"file"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"bytes"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"created_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"expires_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"filename"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"object"</span>: <span class="token string">"file"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"purpose"</span>: <span class="token string">"assistants"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"status"</span>: <span class="token string">"uploaded"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"status_details"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Uploads/operation/completeUpload" data-section-id="tag/Uploads/operation/completeUpload" class="sc-eCApnc liLqNm"><div data-section-id="operation/completeUpload" id="operation/completeUpload" class="sc-iCoGMd gLxhOh"><div class="sc-hKFxyN juinod"><h2 class="sc-pNWdM eftmgB"><a class="sc-crzoAE iUxAWq" href="#tag/Uploads/operation/completeUpload" aria-label="tag/Uploads/operation/completeUpload"></a>Completes the [Upload](/docs/api-reference/uploads/object).
Within the returned Upload object, there is a nested [File](/docs/api-reference/files/object) object that is ready to use in the rest of the platform.
You can specify the order of the Parts by passing in an ordered list of the Part IDs.
The number of bytes uploaded upon completion must match the number of bytes initially specified when creating the Upload object. No Parts may be added after an Upload is completed.
Returns the Upload object with status `completed`, including an additional `file` property containing the created usable File object.
<!-- --> </h2><div class="sc-fcmMJX cvfxAX"><div class="sc-jUfyBS bhDyou"><h5 class="sc-iqAclL sc-fuISkM eONCmm hZIgic">Authorizations:</h5><svg class="sc-dIsUp iPqByX" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jQAxuV ccffaZ"><span class="sc-daBunf fcvuS"><span class="sc-dsXzNU dPrSxx"><i>ApiKeyAuth</i></span></span></div></div><div><h5 class="sc-iqAclL eONCmm">path<!-- --> Parameters</h5><table class="sc-hHEiqL VCQHZ"><tbody><tr class="last "><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="upload_id"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">upload_id</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><span class="sc-laZMeE jWaWWE"> <!-- -->Example:<!-- --> </span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">upload_abc123</span></div><div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The ID of the Upload.</p>
</div></div></div></td></tr></tbody></table></div><h5 class="sc-iqAclL eONCmm">Request Body schema: <span class="sc-cBoqAE eKyrDP">application/json</span></h5><div class="sc-iJCRrE sc-ciSkZP jCdxGr QGruV"></div><table class="sc-hHEiqL VCQHZ"><tbody><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="part_ids"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">part_ids</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa">Array of </span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">strings</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The ordered list of Part IDs.</p>
</div></div></div></td></tr><tr class="last "><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="md5"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">md5</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The optional md5 checksum for the file contents to verify if the bytes uploaded matches what you expect.</p>
</div></div></div></td></tr></tbody></table><div><h3 class="sc-fIxmyt DvFer">Responses</h3><div><button class="sc-htmcrh lbYftx"><svg class="sc-dIsUp dqYXmg" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-fWWYYk cMoEZ">200<!-- --> </strong><span class="sc-jcwpoC eDjFAZ"><p>OK</p>
</span></button></div></div></div><div class="sc-jSFjdj sc-gKAaRy gBjRyf gcushC"><div class="sc-EZqKI fWsqvQ"><button class="sc-eEVmNe ilvUMs"><span type="post" class="sc-fmdNqN ldMUmp http-verb post">post</span><span class="sc-jXcxbT fCEUju">/uploads/{upload_id}/complete</span><svg class="sc-dIsUp bRmrKA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ljsmAU flIrdF"><div class="sc-jlZJtj fQkroN"><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div><div tabindex="0" role="button"><div class="sc-dTSzeu dfUAUz"><span>https://api.openai.com/v1</span>/uploads/{upload_id}/complete</div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Request samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="react-tabs-228" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-229" tabindex="0" data-rttab="true">Payload</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-229" aria-labelledby="react-tabs-228"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-bBjRSN kQSIAz">application/json</div></div><div class="sc-jgPyTC dSaTNC"><div class="sc-jNnpgg esZIbL"><div class="sc-giAqHp hMPeqJ"><button><div class="sc-carFqZ UksDl">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iJCRrE jCdxGr sc-dPaNzc gyljjx"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"part_ids"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><span class="token string">"string"</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"md5"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Response samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-230" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-231" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-231" aria-labelledby="react-tabs-230"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-bBjRSN kQSIAz">application/json</div></div><div class="sc-jgPyTC dSaTNC"><div class="sc-jNnpgg esZIbL"><div class="sc-giAqHp hMPeqJ"><button><div class="sc-carFqZ UksDl">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iJCRrE jCdxGr sc-dPaNzc gyljjx"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"created_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"filename"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"bytes"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"purpose"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token string">"pending"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"expires_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"object"</span>: <span class="token string">"upload"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"file"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"bytes"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"created_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"expires_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"filename"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"object"</span>: <span class="token string">"file"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"purpose"</span>: <span class="token string">"assistants"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"status"</span>: <span class="token string">"uploaded"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"status_details"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Uploads/operation/addUploadPart" data-section-id="tag/Uploads/operation/addUploadPart" class="sc-eCApnc liLqNm"><div data-section-id="operation/addUploadPart" id="operation/addUploadPart" class="sc-iCoGMd gLxhOh"><div class="sc-hKFxyN juinod"><h2 class="sc-pNWdM eftmgB"><a class="sc-crzoAE iUxAWq" href="#tag/Uploads/operation/addUploadPart" aria-label="tag/Uploads/operation/addUploadPart"></a>Adds a [Part](/docs/api-reference/uploads/part-object) to an [Upload](/docs/api-reference/uploads/object) object. A Part represents a chunk of bytes from the file you are trying to upload.
Each Part can be at most 64 MB, and you can add Parts until you hit the Upload maximum of 8 GB.
It is possible to add multiple Parts in parallel. You can decide the intended order of the Parts when you [complete the Upload](/docs/api-reference/uploads/complete).
<!-- --> </h2><div class="sc-fcmMJX cvfxAX"><div class="sc-jUfyBS bhDyou"><h5 class="sc-iqAclL sc-fuISkM eONCmm hZIgic">Authorizations:</h5><svg class="sc-dIsUp iPqByX" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jQAxuV ccffaZ"><span class="sc-daBunf fcvuS"><span class="sc-dsXzNU dPrSxx"><i>ApiKeyAuth</i></span></span></div></div><div><h5 class="sc-iqAclL eONCmm">path<!-- --> Parameters</h5><table class="sc-hHEiqL VCQHZ"><tbody><tr class="last "><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="upload_id"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">upload_id</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><span class="sc-laZMeE jWaWWE"> <!-- -->Example:<!-- --> </span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">upload_abc123</span></div><div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The ID of the Upload.</p>
</div></div></div></td></tr></tbody></table></div><h5 class="sc-iqAclL eONCmm">Request Body schema: <span class="sc-cBoqAE eKyrDP">multipart/form-data</span></h5><div class="sc-iJCRrE sc-ciSkZP jCdxGr QGruV"></div><table class="sc-hHEiqL VCQHZ"><tbody><tr class="last "><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="data"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">data</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa"> <!-- --><<!-- -->binary<!-- -->><!-- --> </span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The chunk of bytes for this Part.</p>
</div></div></div></td></tr></tbody></table><div><h3 class="sc-fIxmyt DvFer">Responses</h3><div><button class="sc-htmcrh lbYftx"><svg class="sc-dIsUp dqYXmg" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-fWWYYk cMoEZ">200<!-- --> </strong><span class="sc-jcwpoC eDjFAZ"><p>OK</p>
</span></button></div></div></div><div class="sc-jSFjdj sc-gKAaRy gBjRyf gcushC"><div class="sc-EZqKI fWsqvQ"><button class="sc-eEVmNe ilvUMs"><span type="post" class="sc-fmdNqN ldMUmp http-verb post">post</span><span class="sc-jXcxbT fCEUju">/uploads/{upload_id}/parts</span><svg class="sc-dIsUp bRmrKA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ljsmAU flIrdF"><div class="sc-jlZJtj fQkroN"><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div><div tabindex="0" role="button"><div class="sc-dTSzeu dfUAUz"><span>https://api.openai.com/v1</span>/uploads/{upload_id}/parts</div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Response samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-232" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-233" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-233" aria-labelledby="react-tabs-232"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-bBjRSN kQSIAz">application/json</div></div><div class="sc-jgPyTC dSaTNC"><div class="sc-jNnpgg esZIbL"><div class="sc-giAqHp hMPeqJ"><button><div class="sc-carFqZ UksDl">Copy</div></button></div><div class="sc-iJCRrE jCdxGr sc-dPaNzc gyljjx"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"created_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"upload_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"object"</span>: <span class="token string">"upload.part"</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Images" data-section-id="tag/Images" class="sc-eCApnc jlMQbh"><div class="sc-iCoGMd gLxhOh"><div class="sc-hKFxyN juinod"><h1 class="sc-fujyAs bpZWeL"><a class="sc-crzoAE iUxAWq" href="#tag/Images" aria-label="tag/Images"></a>Images</h1></div></div><div class="sc-hKFxyN bJcDWV"><div class="sc-iJCRrE sc-ciSkZP jCdxGr QGruV redoc-markdown "><p>Given a prompt and/or an input image, the model will generate a new image.</p>
</div></div></div><div id="tag/Images/operation/createImageEdit" data-section-id="tag/Images/operation/createImageEdit" class="sc-eCApnc liLqNm"><div data-section-id="operation/createImageEdit" id="operation/createImageEdit" class="sc-iCoGMd gLxhOh"><div class="sc-hKFxyN juinod"><h2 class="sc-pNWdM eftmgB"><a class="sc-crzoAE iUxAWq" href="#tag/Images/operation/createImageEdit" aria-label="tag/Images/operation/createImageEdit"></a>Creates an edited or extended image given one or more source images and a prompt. This endpoint supports GPT Image models (`gpt-image-1.5`, `gpt-image-1`, `gpt-image-1-mini`, and `chatgpt-image-latest`) and `dall-e-2`.<!-- --> </h2><div class="sc-iGkqmO hCTIhr"><div class="sc-iJCRrE sc-ciSkZP jCdxGr QGruV"><p>You can call this endpoint with either:</p>
<ul>
<li><code>multipart/form-data</code>: use binary uploads via <code>image</code> (and optional <code>mask</code>).</li>
<li><code>application/json</code>: use <code>images</code> (and optional <code>mask</code>) as references with either <code>image_url</code> or <code>file_id</code>.</li>
</ul>
<p>Note that JSON requests use <code>images</code> (array) instead of the multipart <code>image</code> field.</p>
</div></div><div class="sc-fcmMJX cvfxAX"><div class="sc-jUfyBS bhDyou"><h5 class="sc-iqAclL sc-fuISkM eONCmm hZIgic">Authorizations:</h5><svg class="sc-dIsUp iPqByX" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jQAxuV ccffaZ"><span class="sc-daBunf fcvuS"><span class="sc-dsXzNU dPrSxx"><i>ApiKeyAuth</i></span></span></div></div><h5 class="sc-iqAclL eONCmm">Request Body schema: <div class="sc-hiKfDv sc-gXfVKN bycQNU dhIYNk"><svg class="sc-jJMGnK hzcSs" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option selected="" value="multipart/form-data">multipart/form-data</option><option value="application/json">application/json</option></select><label>multipart/form-data</label></div></h5><div class="sc-iJCRrE sc-ciSkZP jCdxGr QGruV"></div><table class="sc-hHEiqL VCQHZ"><tbody><tr class=""><td class="sc-hBMUJo sc-fFSPTT sc-gSYDnn iwcKgn cAqMTE hTttpy" kind="field" title="image"><span class="sc-iemWCZ bcnRwz"></span><button aria-label="expand properties"><span class="property-name">image</span><svg class="sc-dIsUp hGHhhO" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string or Array of strings</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The image(s) to edit. Must be a supported image file or an array of images.</p>
<p>For the GPT image models (<code>gpt-image-1</code>, <code>gpt-image-1-mini</code>, and <code>gpt-image-1.5</code>), each image should be a <code>png</code>, <code>webp</code>, or <code>jpg</code>
file less than 50MB. You can provide up to 16 images.
<code>chatgpt-image-latest</code> follows the same input constraints as GPT image models.</p>
<p>For <code>dall-e-2</code>, you can only provide one image, and it should be a square
<code>png</code> file less than 4MB.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="prompt"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">prompt</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>A text description of the desired image(s). The maximum length is 1000 characters for <code>dall-e-2</code>, and 32000 characters for the GPT image models.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="mask"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">mask</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa"> <!-- --><<!-- -->binary<!-- -->><!-- --> </span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>An additional image whose fully transparent areas (e.g. where alpha is zero) indicate where <code>image</code> should be edited. If there are multiple images provided, the mask will be applied on the first image. Must be a valid PNG file, less than 4MB, and have the same dimensions as <code>image</code>.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="background"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">background</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string or null</span></div><div><span class="sc-laZMeE jWaWWE"> <!-- -->Default:<!-- --> </span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"auto"</span></div><div><span class="sc-laZMeE jWaWWE"> <!-- -->Enum<!-- -->:</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"transparent"</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"opaque"</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"auto"</span> </div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>Allows to set transparency for the background of the generated image(s).
This parameter is only supported for the GPT image models. Must be one of
<code>transparent</code>, <code>opaque</code> or <code>auto</code> (default value). When <code>auto</code> is used, the
model will automatically determine the best background for the image.</p>
<p>If <code>transparent</code>, the output format needs to support transparency, so it
should be set to either <code>png</code> (default value) or <code>webp</code>.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT sc-gSYDnn iwcKgn cAqMTE hTttpy" kind="field" title="model"><span class="sc-iemWCZ bcnRwz"></span><button aria-label="expand properties"><span class="property-name">model</span><svg class="sc-dIsUp hGHhhO" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">(string or null) or (string or null)</span></div><div><span class="sc-laZMeE jWaWWE"> <!-- -->Default:<!-- --> </span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"gpt-image-1.5"</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The model to use for image generation. Defaults to <code>gpt-image-1.5</code>.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="n"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">n</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">integer or null</span><span> <span class="sc-laZMeE sc-FRrlG jWaWWE gHBwqe"> <!-- -->[ 1 .. 10 ]<!-- --> </span></span></div><div><span class="sc-laZMeE jWaWWE"> <!-- -->Default:<!-- --> </span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">1</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The number of images to generate. Must be between 1 and 10.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="size"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">size</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string or null</span></div><div><span class="sc-laZMeE jWaWWE"> <!-- -->Default:<!-- --> </span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"1024x1024"</span></div><div><span class="sc-laZMeE jWaWWE"> <!-- -->Enum<!-- -->:</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"256x256"</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"512x512"</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"1024x1024"</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"1536x1024"</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"1024x1536"</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"auto"</span> </div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The size of the generated images. Must be one of <code>1024x1024</code>, <code>1536x1024</code> (landscape), <code>1024x1536</code> (portrait), or <code>auto</code> (default value) for the GPT image models, and one of <code>256x256</code>, <code>512x512</code>, or <code>1024x1024</code> for <code>dall-e-2</code>.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="response_format"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">response_format</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string or null</span></div><div><span class="sc-laZMeE jWaWWE"> <!-- -->Enum<!-- -->:</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"url"</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"b64_json"</span> </div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The format in which the generated images are returned. Must be one of <code>url</code> or <code>b64_json</code>. URLs are only valid for 60 minutes after the image has been generated. This parameter is only supported for <code>dall-e-2</code> (default is <code>url</code> for <code>dall-e-2</code>), as GPT image models always return base64-encoded images.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="output_format"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">output_format</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string or null</span></div><div><span class="sc-laZMeE jWaWWE"> <!-- -->Default:<!-- --> </span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"png"</span></div><div><span class="sc-laZMeE jWaWWE"> <!-- -->Enum<!-- -->:</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"png"</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"jpeg"</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"webp"</span> </div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The format in which the generated images are returned. This parameter is
only supported for the GPT image models. Must be one of <code>png</code>, <code>jpeg</code>, or <code>webp</code>.
The default value is <code>png</code>.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="output_compression"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">output_compression</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">integer or null</span></div><div><span class="sc-laZMeE jWaWWE"> <!-- -->Default:<!-- --> </span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">100</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The compression level (0-100%) for the generated images. This parameter
is only supported for the GPT image models with the <code>webp</code> or <code>jpeg</code> output
formats, and defaults to 100.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="user"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">user</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>A unique identifier representing your end-user, which can help OpenAI to monitor and detect abuse. <a href="/docs/guides/safety-best-practices#end-user-ids">Learn more</a>.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT sc-gSYDnn iwcKgn cAqMTE hTttpy" kind="field" title="input_fidelity"><span class="sc-iemWCZ bcnRwz"></span><button aria-label="expand properties"><span class="property-name">input_fidelity</span><svg class="sc-dIsUp hGHhhO" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">InputFidelity (string) or null</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="stream"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">stream</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">boolean or null</span></div><div><span class="sc-laZMeE jWaWWE"> <!-- -->Default:<!-- --> </span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">false</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>Edit the image in streaming mode. Defaults to <code>false</code>. See the
<a href="/docs/guides/image-generation">Image generation guide</a> for more information.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT sc-gSYDnn iwcKgn cAqMTE hTttpy" kind="field" title="partial_images"><span class="sc-iemWCZ bcnRwz"></span><button aria-label="expand properties"><span class="property-name">partial_images</span><svg class="sc-dIsUp hGHhhO" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">PartialImages (integer) or PartialImages (null)</span><span class="sc-laZMeE sc-eJocfa jWaWWE bArHDh"> (<!-- -->PartialImages<!-- -->) </span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div></div></div></td></tr><tr class="last "><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="quality"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">quality</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string or null</span></div><div><span class="sc-laZMeE jWaWWE"> <!-- -->Default:<!-- --> </span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"auto"</span></div><div><span class="sc-laZMeE jWaWWE"> <!-- -->Enum<!-- -->:</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"standard"</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"low"</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"medium"</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"high"</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"auto"</span> </div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The quality of the image that will be generated for GPT image models. Defaults to <code>auto</code>.</p>
</div></div></div></td></tr></tbody></table><div><h3 class="sc-fIxmyt DvFer">Responses</h3><div><button class="sc-htmcrh lbYftx"><svg class="sc-dIsUp dqYXmg" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-fWWYYk cMoEZ">200<!-- --> </strong><span class="sc-jcwpoC eDjFAZ"><p>OK</p>
</span></button></div></div></div><div class="sc-jSFjdj sc-gKAaRy gBjRyf gcushC"><div class="sc-EZqKI fWsqvQ"><button class="sc-eEVmNe ilvUMs"><span type="post" class="sc-fmdNqN ldMUmp http-verb post">post</span><span class="sc-jXcxbT fCEUju">/images/edits</span><svg class="sc-dIsUp bRmrKA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ljsmAU flIrdF"><div class="sc-jlZJtj fQkroN"><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div><div tabindex="0" role="button"><div class="sc-dTSzeu dfUAUz"><span>https://api.openai.com/v1</span>/images/edits</div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Request samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="react-tabs-234" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-235" tabindex="0" data-rttab="true">Payload</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-235" aria-labelledby="react-tabs-234"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-hiKfDv sc-khIgEk bycQNU hLNtis"><svg class="sc-jJMGnK gVpQmv" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option selected="" value="multipart/form-data">multipart/form-data</option><option value="application/json">application/json</option></select><label>multipart/form-data</label></div></div><div class="sc-jgPyTC dSaTNC"><div class="sc-ezzafa kiAqTA"><div class="sc-giAqHp hMPeqJ"><button><div class="sc-carFqZ UksDl">Copy</div></button></div><pre class="sc-bYwzuL sc-kLojOw eMUKnN bOBJeo"><span class="token punctuation">{</span>
<span class="token string">"model"</span><span class="token punctuation">:</span> <span class="token string">"gpt-image-1.5"</span><span class="token punctuation">,</span>
<span class="token string">"prompt"</span><span class="token punctuation">:</span> <span class="token string">"Add a watercolor effect to this image"</span><span class="token punctuation">,</span>
<span class="token string">"image"</span><span class="token punctuation">:</span> <span class="token string">"<binary image file>"</span><span class="token punctuation">,</span>
<span class="token string">"size"</span><span class="token punctuation">:</span> <span class="token string">"1024x1024"</span><span class="token punctuation">,</span>
<span class="token string">"quality"</span><span class="token punctuation">:</span> <span class="token string">"high"</span>
<span class="token punctuation">}</span></pre></div></div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Response samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-236" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-237" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-237" aria-labelledby="react-tabs-236"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-hiKfDv sc-khIgEk bycQNU hLNtis"><svg class="sc-jJMGnK gVpQmv" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option selected="" value="application/json">application/json</option><option value="text/event-stream">text/event-stream</option></select><label>application/json</label></div></div><div class="sc-jgPyTC dSaTNC"><div class="sc-jNnpgg esZIbL"><div class="sc-giAqHp hMPeqJ"><button><div class="sc-carFqZ UksDl">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iJCRrE jCdxGr sc-dPaNzc gyljjx"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"created"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"b64_json"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"url"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"revised_prompt"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"background"</span>: <span class="token string">"transparent"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"output_format"</span>: <span class="token string">"png"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"size"</span>: <span class="token string">"1024x1024"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"quality"</span>: <span class="token string">"low"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"usage"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"input_tokens"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"total_tokens"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"output_tokens"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"output_tokens_details"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"image_tokens"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"text_tokens"</span>: <span class="token number">0</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"input_tokens_details"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"text_tokens"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"image_tokens"</span>: <span class="token number">0</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Images/operation/createImage" data-section-id="tag/Images/operation/createImage" class="sc-eCApnc liLqNm"><div data-section-id="operation/createImage" id="operation/createImage" class="sc-iCoGMd gLxhOh"><div class="sc-hKFxyN juinod"><h2 class="sc-pNWdM eftmgB"><a class="sc-crzoAE iUxAWq" href="#tag/Images/operation/createImage" aria-label="tag/Images/operation/createImage"></a>Creates an image given a prompt. [Learn more](/docs/guides/images).
<!-- --> </h2><div class="sc-fcmMJX cvfxAX"><div class="sc-jUfyBS bhDyou"><h5 class="sc-iqAclL sc-fuISkM eONCmm hZIgic">Authorizations:</h5><svg class="sc-dIsUp iPqByX" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jQAxuV ccffaZ"><span class="sc-daBunf fcvuS"><span class="sc-dsXzNU dPrSxx"><i>ApiKeyAuth</i></span></span></div></div><h5 class="sc-iqAclL eONCmm">Request Body schema: <span class="sc-cBoqAE eKyrDP">application/json</span></h5><div class="sc-iJCRrE sc-ciSkZP jCdxGr QGruV"></div><table class="sc-hHEiqL VCQHZ"><tbody><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="prompt"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">prompt</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>A text description of the desired image(s). The maximum length is 32000 characters for the GPT image models, 1000 characters for <code>dall-e-2</code> and 4000 characters for <code>dall-e-3</code>.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT sc-gSYDnn iwcKgn cAqMTE hTttpy" kind="field" title="model"><span class="sc-iemWCZ bcnRwz"></span><button aria-label="expand properties"><span class="property-name">model</span><svg class="sc-dIsUp hGHhhO" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">(string or null) or (string or null)</span></div><div><span class="sc-laZMeE jWaWWE"> <!-- -->Default:<!-- --> </span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"dall-e-2"</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The model to use for image generation. One of <code>dall-e-2</code>, <code>dall-e-3</code>, or a GPT image model (<code>gpt-image-1</code>, <code>gpt-image-1-mini</code>, <code>gpt-image-1.5</code>). Defaults to <code>dall-e-2</code> unless a parameter specific to the GPT image models is used.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="n"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">n</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">integer or null</span><span> <span class="sc-laZMeE sc-FRrlG jWaWWE gHBwqe"> <!-- -->[ 1 .. 10 ]<!-- --> </span></span></div><div><span class="sc-laZMeE jWaWWE"> <!-- -->Default:<!-- --> </span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">1</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The number of images to generate. Must be between 1 and 10. For <code>dall-e-3</code>, only <code>n=1</code> is supported.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="quality"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">quality</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string or null</span></div><div><span class="sc-laZMeE jWaWWE"> <!-- -->Default:<!-- --> </span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"auto"</span></div><div><span class="sc-laZMeE jWaWWE"> <!-- -->Enum<!-- -->:</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"standard"</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"hd"</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"low"</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"medium"</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"high"</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"auto"</span> </div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The quality of the image that will be generated.</p>
<ul>
<li><code>auto</code> (default value) will automatically select the best quality for the given model.</li>
<li><code>high</code>, <code>medium</code> and <code>low</code> are supported for the GPT image models.</li>
<li><code>hd</code> and <code>standard</code> are supported for <code>dall-e-3</code>.</li>
<li><code>standard</code> is the only option for <code>dall-e-2</code>.</li>
</ul>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="response_format"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">response_format</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string or null</span></div><div><span class="sc-laZMeE jWaWWE"> <!-- -->Default:<!-- --> </span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"url"</span></div><div><span class="sc-laZMeE jWaWWE"> <!-- -->Enum<!-- -->:</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"url"</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"b64_json"</span> </div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The format in which generated images with <code>dall-e-2</code> and <code>dall-e-3</code> are returned. Must be one of <code>url</code> or <code>b64_json</code>. URLs are only valid for 60 minutes after the image has been generated. This parameter isn't supported for the GPT image models, which always return base64-encoded images.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="output_format"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">output_format</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string or null</span></div><div><span class="sc-laZMeE jWaWWE"> <!-- -->Default:<!-- --> </span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"png"</span></div><div><span class="sc-laZMeE jWaWWE"> <!-- -->Enum<!-- -->:</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"png"</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"jpeg"</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"webp"</span> </div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The format in which the generated images are returned. This parameter is only supported for the GPT image models. Must be one of <code>png</code>, <code>jpeg</code>, or <code>webp</code>.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="output_compression"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">output_compression</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">integer or null</span></div><div><span class="sc-laZMeE jWaWWE"> <!-- -->Default:<!-- --> </span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">100</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The compression level (0-100%) for the generated images. This parameter is only supported for the GPT image models with the <code>webp</code> or <code>jpeg</code> output formats, and defaults to 100.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="stream"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">stream</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">boolean or null</span></div><div><span class="sc-laZMeE jWaWWE"> <!-- -->Default:<!-- --> </span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">false</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>Generate the image in streaming mode. Defaults to <code>false</code>. See the
<a href="/docs/guides/image-generation">Image generation guide</a> for more information.
This parameter is only supported for the GPT image models.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT sc-gSYDnn iwcKgn cAqMTE hTttpy" kind="field" title="partial_images"><span class="sc-iemWCZ bcnRwz"></span><button aria-label="expand properties"><span class="property-name">partial_images</span><svg class="sc-dIsUp hGHhhO" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">PartialImages (integer) or PartialImages (null)</span><span class="sc-laZMeE sc-eJocfa jWaWWE bArHDh"> (<!-- -->PartialImages<!-- -->) </span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="size"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">size</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string or null</span></div><div><span class="sc-laZMeE jWaWWE"> <!-- -->Default:<!-- --> </span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"auto"</span></div><div><span class="sc-laZMeE jWaWWE"> <!-- -->Enum<!-- -->:</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"auto"</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"1024x1024"</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"1536x1024"</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"1024x1536"</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"256x256"</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"512x512"</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"1792x1024"</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"1024x1792"</span> </div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The size of the generated images. Must be one of <code>1024x1024</code>, <code>1536x1024</code> (landscape), <code>1024x1536</code> (portrait), or <code>auto</code> (default value) for the GPT image models, one of <code>256x256</code>, <code>512x512</code>, or <code>1024x1024</code> for <code>dall-e-2</code>, and one of <code>1024x1024</code>, <code>1792x1024</code>, or <code>1024x1792</code> for <code>dall-e-3</code>.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="moderation"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">moderation</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string or null</span></div><div><span class="sc-laZMeE jWaWWE"> <!-- -->Default:<!-- --> </span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"auto"</span></div><div><span class="sc-laZMeE jWaWWE"> <!-- -->Enum<!-- -->:</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"low"</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"auto"</span> </div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>Control the content-moderation level for images generated by the GPT image models. Must be either <code>low</code> for less restrictive filtering or <code>auto</code> (default value).</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="background"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">background</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string or null</span></div><div><span class="sc-laZMeE jWaWWE"> <!-- -->Default:<!-- --> </span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"auto"</span></div><div><span class="sc-laZMeE jWaWWE"> <!-- -->Enum<!-- -->:</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"transparent"</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"opaque"</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"auto"</span> </div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>Allows to set transparency for the background of the generated image(s).
This parameter is only supported for the GPT image models. Must be one of
<code>transparent</code>, <code>opaque</code> or <code>auto</code> (default value). When <code>auto</code> is used, the
model will automatically determine the best background for the image.</p>
<p>If <code>transparent</code>, the output format needs to support transparency, so it
should be set to either <code>png</code> (default value) or <code>webp</code>.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="style"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">style</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string or null</span></div><div><span class="sc-laZMeE jWaWWE"> <!-- -->Default:<!-- --> </span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"vivid"</span></div><div><span class="sc-laZMeE jWaWWE"> <!-- -->Enum<!-- -->:</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"vivid"</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"natural"</span> </div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The style of the generated images. This parameter is only supported for <code>dall-e-3</code>. Must be one of <code>vivid</code> or <code>natural</code>. Vivid causes the model to lean towards generating hyper-real and dramatic images. Natural causes the model to produce more natural, less hyper-real looking images.</p>
</div></div></div></td></tr><tr class="last "><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="user"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">user</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>A unique identifier representing your end-user, which can help OpenAI to monitor and detect abuse. <a href="/docs/guides/safety-best-practices#end-user-ids">Learn more</a>.</p>
</div></div></div></td></tr></tbody></table><div><h3 class="sc-fIxmyt DvFer">Responses</h3><div><button class="sc-htmcrh lbYftx"><svg class="sc-dIsUp dqYXmg" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-fWWYYk cMoEZ">200<!-- --> </strong><span class="sc-jcwpoC eDjFAZ"><p>OK</p>
</span></button></div></div></div><div class="sc-jSFjdj sc-gKAaRy gBjRyf gcushC"><div class="sc-EZqKI fWsqvQ"><button class="sc-eEVmNe ilvUMs"><span type="post" class="sc-fmdNqN ldMUmp http-verb post">post</span><span class="sc-jXcxbT fCEUju">/images/generations</span><svg class="sc-dIsUp bRmrKA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ljsmAU flIrdF"><div class="sc-jlZJtj fQkroN"><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div><div tabindex="0" role="button"><div class="sc-dTSzeu dfUAUz"><span>https://api.openai.com/v1</span>/images/generations</div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Request samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="react-tabs-238" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-239" tabindex="0" data-rttab="true">Payload</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-239" aria-labelledby="react-tabs-238"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-bBjRSN kQSIAz">application/json</div></div><div class="sc-jgPyTC dSaTNC"><div class="sc-jNnpgg esZIbL"><div class="sc-giAqHp hMPeqJ"><button><div class="sc-carFqZ UksDl">Copy</div></button></div><div class="sc-iJCRrE jCdxGr sc-dPaNzc gyljjx"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"prompt"</span>: <span class="token string">"A cute baby sea otter"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"model"</span>: <span class="token string">"gpt-image-1.5"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"n"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"quality"</span>: <span class="token string">"medium"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"response_format"</span>: <span class="token string">"url"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"output_format"</span>: <span class="token string">"png"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"output_compression"</span>: <span class="token number">100</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"stream"</span>: <span class="token boolean">false</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"partial_images"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"size"</span>: <span class="token string">"1024x1024"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"moderation"</span>: <span class="token string">"low"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"background"</span>: <span class="token string">"transparent"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"style"</span>: <span class="token string">"vivid"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"user"</span>: <span class="token string">"user-1234"</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Response samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-240" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-241" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-241" aria-labelledby="react-tabs-240"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-hiKfDv sc-khIgEk bycQNU hLNtis"><svg class="sc-jJMGnK gVpQmv" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option selected="" value="application/json">application/json</option><option value="text/event-stream">text/event-stream</option></select><label>application/json</label></div></div><div class="sc-jgPyTC dSaTNC"><div class="sc-jNnpgg esZIbL"><div class="sc-giAqHp hMPeqJ"><button><div class="sc-carFqZ UksDl">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iJCRrE jCdxGr sc-dPaNzc gyljjx"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"created"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"b64_json"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"url"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"revised_prompt"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"background"</span>: <span class="token string">"transparent"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"output_format"</span>: <span class="token string">"png"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"size"</span>: <span class="token string">"1024x1024"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"quality"</span>: <span class="token string">"low"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"usage"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"input_tokens"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"total_tokens"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"output_tokens"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"output_tokens_details"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"image_tokens"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"text_tokens"</span>: <span class="token number">0</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"input_tokens_details"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"text_tokens"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"image_tokens"</span>: <span class="token number">0</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Images/operation/createImageVariation" data-section-id="tag/Images/operation/createImageVariation" class="sc-eCApnc liLqNm"><div data-section-id="operation/createImageVariation" id="operation/createImageVariation" class="sc-iCoGMd gLxhOh"><div class="sc-hKFxyN juinod"><h2 class="sc-pNWdM eftmgB"><a class="sc-crzoAE iUxAWq" href="#tag/Images/operation/createImageVariation" aria-label="tag/Images/operation/createImageVariation"></a>Creates a variation of a given image. This endpoint only supports `dall-e-2`.<!-- --> </h2><div class="sc-fcmMJX cvfxAX"><div class="sc-jUfyBS bhDyou"><h5 class="sc-iqAclL sc-fuISkM eONCmm hZIgic">Authorizations:</h5><svg class="sc-dIsUp iPqByX" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jQAxuV ccffaZ"><span class="sc-daBunf fcvuS"><span class="sc-dsXzNU dPrSxx"><i>ApiKeyAuth</i></span></span></div></div><h5 class="sc-iqAclL eONCmm">Request Body schema: <span class="sc-cBoqAE eKyrDP">multipart/form-data</span></h5><div class="sc-iJCRrE sc-ciSkZP jCdxGr QGruV"></div><table class="sc-hHEiqL VCQHZ"><tbody><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="image"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">image</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa"> <!-- --><<!-- -->binary<!-- -->><!-- --> </span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The image to use as the basis for the variation(s). Must be a valid PNG file, less than 4MB, and square.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT sc-gSYDnn iwcKgn cAqMTE hTttpy" kind="field" title="model"><span class="sc-iemWCZ bcnRwz"></span><button aria-label="expand properties"><span class="property-name">model</span><svg class="sc-dIsUp hGHhhO" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">(string or null) or (string or null)</span></div><div><span class="sc-laZMeE jWaWWE"> <!-- -->Default:<!-- --> </span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"dall-e-2"</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The model to use for image generation. Only <code>dall-e-2</code> is supported at this time.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="n"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">n</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">integer or null</span><span> <span class="sc-laZMeE sc-FRrlG jWaWWE gHBwqe"> <!-- -->[ 1 .. 10 ]<!-- --> </span></span></div><div><span class="sc-laZMeE jWaWWE"> <!-- -->Default:<!-- --> </span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">1</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The number of images to generate. Must be between 1 and 10.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="response_format"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">response_format</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string or null</span></div><div><span class="sc-laZMeE jWaWWE"> <!-- -->Default:<!-- --> </span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"url"</span></div><div><span class="sc-laZMeE jWaWWE"> <!-- -->Enum<!-- -->:</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"url"</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"b64_json"</span> </div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The format in which the generated images are returned. Must be one of <code>url</code> or <code>b64_json</code>. URLs are only valid for 60 minutes after the image has been generated.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="size"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">size</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string or null</span></div><div><span class="sc-laZMeE jWaWWE"> <!-- -->Default:<!-- --> </span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"1024x1024"</span></div><div><span class="sc-laZMeE jWaWWE"> <!-- -->Enum<!-- -->:</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"256x256"</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"512x512"</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"1024x1024"</span> </div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The size of the generated images. Must be one of <code>256x256</code>, <code>512x512</code>, or <code>1024x1024</code>.</p>
</div></div></div></td></tr><tr class="last "><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="user"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">user</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>A unique identifier representing your end-user, which can help OpenAI to monitor and detect abuse. <a href="/docs/guides/safety-best-practices#end-user-ids">Learn more</a>.</p>
</div></div></div></td></tr></tbody></table><div><h3 class="sc-fIxmyt DvFer">Responses</h3><div><button class="sc-htmcrh lbYftx"><svg class="sc-dIsUp dqYXmg" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-fWWYYk cMoEZ">200<!-- --> </strong><span class="sc-jcwpoC eDjFAZ"><p>OK</p>
</span></button></div></div></div><div class="sc-jSFjdj sc-gKAaRy gBjRyf gcushC"><div class="sc-EZqKI fWsqvQ"><button class="sc-eEVmNe ilvUMs"><span type="post" class="sc-fmdNqN ldMUmp http-verb post">post</span><span class="sc-jXcxbT fCEUju">/images/variations</span><svg class="sc-dIsUp bRmrKA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ljsmAU flIrdF"><div class="sc-jlZJtj fQkroN"><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div><div tabindex="0" role="button"><div class="sc-dTSzeu dfUAUz"><span>https://api.openai.com/v1</span>/images/variations</div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Response samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-242" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-243" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-243" aria-labelledby="react-tabs-242"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-bBjRSN kQSIAz">application/json</div></div><div class="sc-jgPyTC dSaTNC"><div class="sc-jNnpgg esZIbL"><div class="sc-giAqHp hMPeqJ"><button><div class="sc-carFqZ UksDl">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iJCRrE jCdxGr sc-dPaNzc gyljjx"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"created"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"b64_json"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"url"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"revised_prompt"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"background"</span>: <span class="token string">"transparent"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"output_format"</span>: <span class="token string">"png"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"size"</span>: <span class="token string">"1024x1024"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"quality"</span>: <span class="token string">"low"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"usage"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"input_tokens"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"total_tokens"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"output_tokens"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"output_tokens_details"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"image_tokens"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"text_tokens"</span>: <span class="token number">0</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"input_tokens_details"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"text_tokens"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"image_tokens"</span>: <span class="token number">0</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Models" data-section-id="tag/Models" class="sc-eCApnc jlMQbh"><div class="sc-iCoGMd gLxhOh"><div class="sc-hKFxyN juinod"><h1 class="sc-fujyAs bpZWeL"><a class="sc-crzoAE iUxAWq" href="#tag/Models" aria-label="tag/Models"></a>Models</h1></div></div><div class="sc-hKFxyN bJcDWV"><div class="sc-iJCRrE sc-ciSkZP jCdxGr QGruV redoc-markdown "><p>List and describe the various models available in the API.</p>
</div></div></div><div id="tag/Models/operation/listModels" data-section-id="tag/Models/operation/listModels" class="sc-eCApnc liLqNm"><div data-section-id="operation/listModels" id="operation/listModels" class="sc-iCoGMd gLxhOh"><div class="sc-hKFxyN juinod"><h2 class="sc-pNWdM eftmgB"><a class="sc-crzoAE iUxAWq" href="#tag/Models/operation/listModels" aria-label="tag/Models/operation/listModels"></a>Lists the currently available models, and provides basic information about each one such as the owner and availability.<!-- --> </h2><div class="sc-fcmMJX cvfxAX"><div class="sc-jUfyBS bhDyou"><h5 class="sc-iqAclL sc-fuISkM eONCmm hZIgic">Authorizations:</h5><svg class="sc-dIsUp iPqByX" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jQAxuV ccffaZ"><span class="sc-daBunf fcvuS"><span class="sc-dsXzNU dPrSxx"><i>ApiKeyAuth</i></span></span></div></div><div><h3 class="sc-fIxmyt DvFer">Responses</h3><div><button class="sc-htmcrh lbYftx"><svg class="sc-dIsUp dqYXmg" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-fWWYYk cMoEZ">200<!-- --> </strong><span class="sc-jcwpoC eDjFAZ"><p>OK</p>
</span></button></div></div></div><div class="sc-jSFjdj sc-gKAaRy gBjRyf gcushC"><div class="sc-EZqKI fWsqvQ"><button class="sc-eEVmNe ilvUMs"><span type="get" class="sc-fmdNqN ihNycv http-verb get">get</span><span class="sc-jXcxbT fCEUju">/models</span><svg class="sc-dIsUp bRmrKA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ljsmAU flIrdF"><div class="sc-jlZJtj fQkroN"><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div><div tabindex="0" role="button"><div class="sc-dTSzeu dfUAUz"><span>https://api.openai.com/v1</span>/models</div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Response samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-244" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-245" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-245" aria-labelledby="react-tabs-244"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-bBjRSN kQSIAz">application/json</div></div><div class="sc-jgPyTC dSaTNC"><div class="sc-jNnpgg esZIbL"><div class="sc-giAqHp hMPeqJ"><button><div class="sc-carFqZ UksDl">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iJCRrE jCdxGr sc-dPaNzc gyljjx"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"object"</span>: <span class="token string">"list"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"created"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"object"</span>: <span class="token string">"model"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"owned_by"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Models/operation/retrieveModel" data-section-id="tag/Models/operation/retrieveModel" class="sc-eCApnc liLqNm"><div data-section-id="operation/retrieveModel" id="operation/retrieveModel" class="sc-iCoGMd gLxhOh"><div class="sc-hKFxyN juinod"><h2 class="sc-pNWdM eftmgB"><a class="sc-crzoAE iUxAWq" href="#tag/Models/operation/retrieveModel" aria-label="tag/Models/operation/retrieveModel"></a>Retrieves a model instance, providing basic information about the model such as the owner and permissioning.<!-- --> </h2><div class="sc-fcmMJX cvfxAX"><div class="sc-jUfyBS bhDyou"><h5 class="sc-iqAclL sc-fuISkM eONCmm hZIgic">Authorizations:</h5><svg class="sc-dIsUp iPqByX" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jQAxuV ccffaZ"><span class="sc-daBunf fcvuS"><span class="sc-dsXzNU dPrSxx"><i>ApiKeyAuth</i></span></span></div></div><div><h5 class="sc-iqAclL eONCmm">path<!-- --> Parameters</h5><table class="sc-hHEiqL VCQHZ"><tbody><tr class="last "><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="model"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">model</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><span class="sc-laZMeE jWaWWE"> <!-- -->Example:<!-- --> </span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">gpt-4o-mini</span></div><div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The ID of the model to use for this request</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-fIxmyt DvFer">Responses</h3><div><button class="sc-htmcrh lbYftx"><svg class="sc-dIsUp dqYXmg" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-fWWYYk cMoEZ">200<!-- --> </strong><span class="sc-jcwpoC eDjFAZ"><p>OK</p>
</span></button></div></div></div><div class="sc-jSFjdj sc-gKAaRy gBjRyf gcushC"><div class="sc-EZqKI fWsqvQ"><button class="sc-eEVmNe ilvUMs"><span type="get" class="sc-fmdNqN ihNycv http-verb get">get</span><span class="sc-jXcxbT fCEUju">/models/{model}</span><svg class="sc-dIsUp bRmrKA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ljsmAU flIrdF"><div class="sc-jlZJtj fQkroN"><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div><div tabindex="0" role="button"><div class="sc-dTSzeu dfUAUz"><span>https://api.openai.com/v1</span>/models/{model}</div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Response samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-246" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-247" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-247" aria-labelledby="react-tabs-246"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-bBjRSN kQSIAz">application/json</div></div><div class="sc-jgPyTC dSaTNC"><div class="sc-jNnpgg esZIbL"><div class="sc-giAqHp hMPeqJ"><button><div class="sc-carFqZ UksDl">Copy</div></button></div><div class="sc-iJCRrE jCdxGr sc-dPaNzc gyljjx"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"created"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"object"</span>: <span class="token string">"model"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"owned_by"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Models/operation/deleteModel" data-section-id="tag/Models/operation/deleteModel" class="sc-eCApnc liLqNm"><div data-section-id="operation/deleteModel" id="operation/deleteModel" class="sc-iCoGMd gLxhOh"><div class="sc-hKFxyN juinod"><h2 class="sc-pNWdM eftmgB"><a class="sc-crzoAE iUxAWq" href="#tag/Models/operation/deleteModel" aria-label="tag/Models/operation/deleteModel"></a>Delete a fine-tuned model. You must have the Owner role in your organization to delete a model.<!-- --> </h2><div class="sc-fcmMJX cvfxAX"><div class="sc-jUfyBS bhDyou"><h5 class="sc-iqAclL sc-fuISkM eONCmm hZIgic">Authorizations:</h5><svg class="sc-dIsUp iPqByX" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jQAxuV ccffaZ"><span class="sc-daBunf fcvuS"><span class="sc-dsXzNU dPrSxx"><i>ApiKeyAuth</i></span></span></div></div><div><h5 class="sc-iqAclL eONCmm">path<!-- --> Parameters</h5><table class="sc-hHEiqL VCQHZ"><tbody><tr class="last "><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="model"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">model</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><span class="sc-laZMeE jWaWWE"> <!-- -->Example:<!-- --> </span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">ft:gpt-4o-mini:acemeco:suffix:abc123</span></div><div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The model to delete</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-fIxmyt DvFer">Responses</h3><div><button class="sc-htmcrh lbYftx"><svg class="sc-dIsUp dqYXmg" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-fWWYYk cMoEZ">200<!-- --> </strong><span class="sc-jcwpoC eDjFAZ"><p>OK</p>
</span></button></div></div></div><div class="sc-jSFjdj sc-gKAaRy gBjRyf gcushC"><div class="sc-EZqKI fWsqvQ"><button class="sc-eEVmNe ilvUMs"><span type="delete" class="sc-fmdNqN bJzUtf http-verb delete">delete</span><span class="sc-jXcxbT fCEUju">/models/{model}</span><svg class="sc-dIsUp bRmrKA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ljsmAU flIrdF"><div class="sc-jlZJtj fQkroN"><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div><div tabindex="0" role="button"><div class="sc-dTSzeu dfUAUz"><span>https://api.openai.com/v1</span>/models/{model}</div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Response samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-248" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-249" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-249" aria-labelledby="react-tabs-248"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-bBjRSN kQSIAz">application/json</div></div><div class="sc-jgPyTC dSaTNC"><div class="sc-jNnpgg esZIbL"><div class="sc-giAqHp hMPeqJ"><button><div class="sc-carFqZ UksDl">Copy</div></button></div><div class="sc-iJCRrE jCdxGr sc-dPaNzc gyljjx"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"deleted"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"object"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Moderations" data-section-id="tag/Moderations" class="sc-eCApnc jlMQbh"><div class="sc-iCoGMd gLxhOh"><div class="sc-hKFxyN juinod"><h1 class="sc-fujyAs bpZWeL"><a class="sc-crzoAE iUxAWq" href="#tag/Moderations" aria-label="tag/Moderations"></a>Moderations</h1></div></div><div class="sc-hKFxyN bJcDWV"><div class="sc-iJCRrE sc-ciSkZP jCdxGr QGruV redoc-markdown "><p>Given text and/or image inputs, classifies if those inputs are potentially harmful.</p>
</div></div></div><div id="tag/Moderations/operation/createModeration" data-section-id="tag/Moderations/operation/createModeration" class="sc-eCApnc liLqNm"><div data-section-id="operation/createModeration" id="operation/createModeration" class="sc-iCoGMd gLxhOh"><div class="sc-hKFxyN juinod"><h2 class="sc-pNWdM eftmgB"><a class="sc-crzoAE iUxAWq" href="#tag/Moderations/operation/createModeration" aria-label="tag/Moderations/operation/createModeration"></a>Classifies if text and/or image inputs are potentially harmful. Learn
more in the [moderation guide](/docs/guides/moderation).
<!-- --> </h2><div class="sc-fcmMJX cvfxAX"><div class="sc-jUfyBS bhDyou"><h5 class="sc-iqAclL sc-fuISkM eONCmm hZIgic">Authorizations:</h5><svg class="sc-dIsUp iPqByX" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jQAxuV ccffaZ"><span class="sc-daBunf fcvuS"><span class="sc-dsXzNU dPrSxx"><i>ApiKeyAuth</i></span></span></div></div><h5 class="sc-iqAclL eONCmm">Request Body schema: <span class="sc-cBoqAE eKyrDP">application/json</span></h5><div class="sc-iJCRrE sc-ciSkZP jCdxGr QGruV"></div><table class="sc-hHEiqL VCQHZ"><tbody><tr class=""><td class="sc-hBMUJo sc-fFSPTT sc-gSYDnn iwcKgn cAqMTE hTttpy" kind="field" title="input"><span class="sc-iemWCZ bcnRwz"></span><button aria-label="expand properties"><span class="property-name">input</span><svg class="sc-dIsUp hGHhhO" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string or Array of strings or (Array of objects or objects)</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>Input (or inputs) to classify. Can be a single string, an array of strings, or
an array of multi-modal input objects similar to other models.</p>
</div></div></div></td></tr><tr class="last "><td class="sc-hBMUJo sc-fFSPTT sc-gSYDnn iwcKgn cAqMTE hTttpy" kind="field" title="model"><span class="sc-iemWCZ bcnRwz"></span><button aria-label="expand properties"><span class="property-name">model</span><svg class="sc-dIsUp hGHhhO" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string or string</span></div><div><span class="sc-laZMeE jWaWWE"> <!-- -->Default:<!-- --> </span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"omni-moderation-latest"</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The content moderation model you would like to use. Learn more in
<a href="/docs/guides/moderation">the moderation guide</a>, and learn about
available models <a href="/docs/models#moderation">here</a>.</p>
</div></div></div></td></tr></tbody></table><div><h3 class="sc-fIxmyt DvFer">Responses</h3><div><button class="sc-htmcrh lbYftx"><svg class="sc-dIsUp dqYXmg" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-fWWYYk cMoEZ">200<!-- --> </strong><span class="sc-jcwpoC eDjFAZ"><p>OK</p>
</span></button></div></div></div><div class="sc-jSFjdj sc-gKAaRy gBjRyf gcushC"><div class="sc-EZqKI fWsqvQ"><button class="sc-eEVmNe ilvUMs"><span type="post" class="sc-fmdNqN ldMUmp http-verb post">post</span><span class="sc-jXcxbT fCEUju">/moderations</span><svg class="sc-dIsUp bRmrKA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ljsmAU flIrdF"><div class="sc-jlZJtj fQkroN"><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div><div tabindex="0" role="button"><div class="sc-dTSzeu dfUAUz"><span>https://api.openai.com/v1</span>/moderations</div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Request samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="react-tabs-250" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-251" tabindex="0" data-rttab="true">Payload</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-251" aria-labelledby="react-tabs-250"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-bBjRSN kQSIAz">application/json</div></div><div class="sc-jgPyTC dSaTNC"><div class="sc-jNnpgg esZIbL"><div class="sc-giAqHp hMPeqJ"><button><div class="sc-carFqZ UksDl">Copy</div></button></div><div class="sc-iJCRrE jCdxGr sc-dPaNzc gyljjx"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"input"</span>: <span class="token string">"I want to kill them."</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"model"</span>: <span class="token string">"omni-moderation-2024-09-26"</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Response samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-252" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-253" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-253" aria-labelledby="react-tabs-252"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-bBjRSN kQSIAz">application/json</div></div><div class="sc-jgPyTC dSaTNC"><div class="sc-jNnpgg esZIbL"><div class="sc-giAqHp hMPeqJ"><button><div class="sc-carFqZ UksDl">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iJCRrE jCdxGr sc-dPaNzc gyljjx"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"model"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"results"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"flagged"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"categories"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"hate"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"hate/threatening"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"harassment"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"harassment/threatening"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"illicit"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"illicit/violent"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"self-harm"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"self-harm/intent"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"self-harm/instructions"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"sexual"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"sexual/minors"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"violence"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"violence/graphic"</span>: <span class="token boolean">true</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"category_scores"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"hate"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"hate/threatening"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"harassment"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"harassment/threatening"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"illicit"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"illicit/violent"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"self-harm"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"self-harm/intent"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"self-harm/instructions"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"sexual"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"sexual/minors"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"violence"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"violence/graphic"</span>: <span class="token number">0</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"category_applied_input_types"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"hate"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><span class="token string">"text"</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"hate/threatening"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><span class="token string">"text"</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"harassment"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><span class="token string">"text"</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"harassment/threatening"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><span class="token string">"text"</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"illicit"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><span class="token string">"text"</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"illicit/violent"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><span class="token string">"text"</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"self-harm"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><span class="token string">"text"</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"self-harm/intent"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><span class="token string">"text"</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"self-harm/instructions"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><span class="token string">"text"</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"sexual"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><span class="token string">"text"</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"sexual/minors"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><span class="token string">"text"</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"violence"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><span class="token string">"text"</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"violence/graphic"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><span class="token string">"text"</span></div></li></ul><span class="token punctuation">]</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Audit-Logs" data-section-id="tag/Audit-Logs" class="sc-eCApnc jlMQbh"><div class="sc-iCoGMd gLxhOh"><div class="sc-hKFxyN juinod"><h1 class="sc-fujyAs bpZWeL"><a class="sc-crzoAE iUxAWq" href="#tag/Audit-Logs" aria-label="tag/Audit-Logs"></a>Audit Logs</h1></div></div><div class="sc-hKFxyN bJcDWV"><div class="sc-iJCRrE sc-ciSkZP jCdxGr QGruV redoc-markdown "><p>List user actions and configuration changes within this organization.</p>
</div></div></div><div id="tag/Audit-Logs/operation/list-audit-logs" data-section-id="tag/Audit-Logs/operation/list-audit-logs" class="sc-eCApnc liLqNm"><div data-section-id="operation/list-audit-logs" id="operation/list-audit-logs" class="sc-iCoGMd gLxhOh"><div class="sc-hKFxyN juinod"><h2 class="sc-pNWdM eftmgB"><a class="sc-crzoAE iUxAWq" href="#tag/Audit-Logs/operation/list-audit-logs" aria-label="tag/Audit-Logs/operation/list-audit-logs"></a>List user actions and configuration changes within this organization.<!-- --> </h2><div class="sc-fcmMJX cvfxAX"><div class="sc-jUfyBS bhDyou"><h5 class="sc-iqAclL sc-fuISkM eONCmm hZIgic">Authorizations:</h5><svg class="sc-dIsUp iPqByX" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jQAxuV ccffaZ"><span class="sc-daBunf fcvuS"><span class="sc-dsXzNU dPrSxx"><i>ApiKeyAuth</i></span></span></div></div><div><h5 class="sc-iqAclL eONCmm">query<!-- --> Parameters</h5><table class="sc-hHEiqL VCQHZ"><tbody><tr class=""><td class="sc-hBMUJo sc-fFSPTT sc-gSYDnn iwcKgn cAqMTE hTttpy" kind="field" title="effective_at"><span class="sc-iemWCZ bcnRwz"></span><button aria-label="expand properties"><span class="property-name">effective_at</span><svg class="sc-dIsUp hGHhhO" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">object</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>Return only events whose <code>effective_at</code> (Unix seconds) is in this range.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="project_ids[]"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">project_ids[]</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa">Array of </span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">strings</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>Return only events for these projects.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="event_types[]"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">event_types[]</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa">Array of </span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">strings</span><span class="sc-laZMeE sc-eJocfa jWaWWE bArHDh"> (<!-- -->AuditLogEventType<!-- -->) </span></div><div><span class="sc-laZMeE jWaWWE">Items<!-- --> <!-- -->Enum<!-- -->:</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"api_key.created"</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"api_key.updated"</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"api_key.deleted"</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"certificate.created"</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"certificate.updated"</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"certificate.deleted"</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"certificates.activated"</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"certificates.deactivated"</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"checkpoint.permission.created"</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"checkpoint.permission.deleted"</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"external_key.registered"</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"external_key.removed"</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"group.created"</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"group.updated"</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"group.deleted"</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"invite.sent"</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"invite.accepted"</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"invite.deleted"</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"ip_allowlist.created"</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"ip_allowlist.updated"</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"ip_allowlist.deleted"</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"ip_allowlist.config.activated"</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"ip_allowlist.config.deactivated"</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"login.succeeded"</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"login.failed"</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"logout.succeeded"</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"logout.failed"</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"organization.updated"</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"project.created"</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"project.updated"</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"project.archived"</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"project.deleted"</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"rate_limit.updated"</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"rate_limit.deleted"</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"resource.deleted"</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"tunnel.created"</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"tunnel.updated"</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"tunnel.deleted"</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"role.created"</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"role.updated"</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"role.deleted"</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"role.assignment.created"</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"role.assignment.deleted"</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"scim.enabled"</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"scim.disabled"</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"service_account.created"</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"service_account.updated"</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"service_account.deleted"</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"user.added"</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"user.updated"</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"user.deleted"</span> </div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>Return only events with a <code>type</code> in one of these values. For example, <code>project.created</code>. For all options, see the documentation for the <a href="/docs/api-reference/audit-logs/object">audit log object</a>.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="actor_ids[]"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">actor_ids[]</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa">Array of </span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">strings</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>Return only events performed by these actors. Can be a user ID, a service account ID, or an api key tracking ID.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="actor_emails[]"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">actor_emails[]</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa">Array of </span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">strings</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>Return only events performed by users with these emails.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="resource_ids[]"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">resource_ids[]</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa">Array of </span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">strings</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>Return only events performed on these targets. For example, a project ID updated.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="limit"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">limit</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">integer</span></div><div><span class="sc-laZMeE jWaWWE"> <!-- -->Default:<!-- --> </span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">20</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="after"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">after</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>A cursor for use in pagination. <code>after</code> is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list.</p>
</div></div></div></td></tr><tr class="last "><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="before"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">before</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>A cursor for use in pagination. <code>before</code> is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_foo, your subsequent call can include before=obj_foo in order to fetch the previous page of the list.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-fIxmyt DvFer">Responses</h3><div><button class="sc-htmcrh lbYftx"><svg class="sc-dIsUp dqYXmg" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-fWWYYk cMoEZ">200<!-- --> </strong><span class="sc-jcwpoC eDjFAZ"><p>Audit logs listed successfully.</p>
</span></button></div></div></div><div class="sc-jSFjdj sc-gKAaRy gBjRyf gcushC"><div class="sc-EZqKI fWsqvQ"><button class="sc-eEVmNe ilvUMs"><span type="get" class="sc-fmdNqN ihNycv http-verb get">get</span><span class="sc-jXcxbT fCEUju">/organization/audit_logs</span><svg class="sc-dIsUp bRmrKA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ljsmAU flIrdF"><div class="sc-jlZJtj fQkroN"><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div><div tabindex="0" role="button"><div class="sc-dTSzeu dfUAUz"><span>https://api.openai.com/v1</span>/organization/audit_logs</div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Response samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-254" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-255" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-255" aria-labelledby="react-tabs-254"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-bBjRSN kQSIAz">application/json</div></div><div class="sc-jgPyTC dSaTNC"><div class="sc-jNnpgg esZIbL"><div class="sc-giAqHp hMPeqJ"><button><div class="sc-carFqZ UksDl">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iJCRrE jCdxGr sc-dPaNzc gyljjx"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"object"</span>: <span class="token string">"list"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <span class="token string">"api_key.created"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"effective_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"project"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"name"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"actor"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <span class="token string">"session"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"session"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"user"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"email"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"ip_address"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"api_key"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <span class="token string">"user"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"user"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"email"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"service_account"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"id"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"api_key.created"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"data"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"scopes"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><span class="token string">"string"</span></div></li></ul><span class="token punctuation">]</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"api_key.updated"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"changes_requested"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"scopes"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><span class="token string">"string"</span></div></li></ul><span class="token punctuation">]</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"api_key.deleted"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"id"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"checkpoint.permission.created"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"data"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"project_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"fine_tuned_model_checkpoint"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"checkpoint.permission.deleted"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"id"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"external_key.registered"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"data"</span>: <span class="token punctuation">{ }</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"external_key.removed"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"id"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"group.created"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"data"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"group_name"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"group.updated"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"changes_requested"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"group_name"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"group.deleted"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"id"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"scim.enabled"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"id"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"scim.disabled"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"id"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"invite.sent"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"data"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"email"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"role"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"invite.accepted"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"id"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"invite.deleted"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"id"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"ip_allowlist.created"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"allowed_ips"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><span class="token string">"string"</span></div></li></ul><span class="token punctuation">]</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"ip_allowlist.updated"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"allowed_ips"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><span class="token string">"string"</span></div></li></ul><span class="token punctuation">]</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"ip_allowlist.deleted"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"allowed_ips"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><span class="token string">"string"</span></div></li></ul><span class="token punctuation">]</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"ip_allowlist.config.activated"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"configs"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"name"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"ip_allowlist.config.deactivated"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"configs"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"name"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"login.succeeded"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"login.failed"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"error_code"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"error_message"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"logout.succeeded"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"logout.failed"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"error_code"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"error_message"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"organization.updated"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"changes_requested"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"title"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"description"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"threads_ui_visibility"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"usage_dashboard_visibility"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"api_call_logging"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"api_call_logging_project_ids"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"project.created"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"data"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"title"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"project.updated"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"changes_requested"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"title"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"project.archived"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"id"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"project.deleted"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"id"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"rate_limit.updated"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"changes_requested"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"max_requests_per_1_minute"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"max_tokens_per_1_minute"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"max_images_per_1_minute"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"max_audio_megabytes_per_1_minute"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"max_requests_per_1_day"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"batch_1_day_max_input_tokens"</span>: <span class="token number">0</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"rate_limit.deleted"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"id"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"role.created"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"role_name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"permissions"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><span class="token string">"string"</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"resource_type"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"resource_id"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"role.updated"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"changes_requested"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"role_name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"resource_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"resource_type"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"permissions_added"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><span class="token string">"string"</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"permissions_removed"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><span class="token string">"string"</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"description"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"role.deleted"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"id"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"role.assignment.created"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"principal_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"principal_type"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"resource_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"resource_type"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"role.assignment.deleted"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"principal_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"principal_type"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"resource_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"resource_type"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"service_account.created"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"data"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"role"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"service_account.updated"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"changes_requested"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"role"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"service_account.deleted"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"id"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"user.added"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"data"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"role"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"user.updated"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"changes_requested"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"role"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"user.deleted"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"id"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"certificate.created"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"name"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"certificate.updated"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"name"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"certificate.deleted"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"certificate"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"certificates.activated"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"certificates"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"name"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"certificates.deactivated"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"certificates"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"name"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"first_id"</span>: <span class="token string">"audit_log-defb456h8dks"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"last_id"</span>: <span class="token string">"audit_log-hnbkd8s93s"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"has_more"</span>: <span class="token boolean">true</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="/paths/batch_cancelled/post" data-section-id="/paths/batch_cancelled/post" class="sc-eCApnc liLqNm"><div class="sc-iCoGMd gLxhOh"><div class="sc-hKFxyN juinod"><h2 class="sc-pNWdM eftmgB"><a class="sc-crzoAE iUxAWq" href="#/paths/batch_cancelled/post" aria-label="/paths/batch_cancelled/post"></a>Sent when a batch has been cancelled.
<!-- --> <span type="primary" class="sc-bqGGPW jeXFeD"> <!-- -->Webhook </span></h2><div class="sc-iGkqmO hCTIhr"><div class="sc-iJCRrE sc-ciSkZP jCdxGr QGruV"><p>Sent when a batch has been cancelled.</p>
</div></div><div class="sc-fcmMJX cvfxAX"><div class="sc-jUfyBS bhDyou"><h5 class="sc-iqAclL sc-fuISkM eONCmm hZIgic">Authorizations:</h5><svg class="sc-dIsUp iPqByX" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jQAxuV ccffaZ"><span class="sc-daBunf fcvuS"><span class="sc-dsXzNU dPrSxx"><i>ApiKeyAuth</i></span></span></div></div><h5 class="sc-iqAclL eONCmm">Request Body schema: <span class="sc-cBoqAE eKyrDP">application/json</span></h5><div class="sc-iJCRrE sc-ciSkZP jCdxGr QGruV"><p>The event payload sent by the API.</p>
</div><table class="sc-hHEiqL VCQHZ"><tbody><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="created_at"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">created_at</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">integer</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The Unix timestamp (in seconds) of when the batch API request was cancelled.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="id"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">id</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The unique ID of the event.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT sc-gSYDnn iwcKgn cAqMTE hTttpy" kind="field" title="data"><span class="sc-iemWCZ bcnRwz"></span><button aria-label="expand properties"><span class="property-name">data</span><svg class="sc-dIsUp hGHhhO" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">object</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>Event data payload.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="object"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">object</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div><div><span class="sc-laZMeE jWaWWE"> <!-- -->Value<!-- -->:</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"event"</span> </div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The object of the event. Always <code>event</code>.</p>
</div></div></div></td></tr><tr class="last "><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="type"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">type</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div><div><span class="sc-laZMeE jWaWWE"> <!-- -->Value<!-- -->:</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"batch.cancelled"</span> </div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The type of the event. Always <code>batch.cancelled</code>.</p>
</div></div></div></td></tr></tbody></table><div><h3 class="sc-fIxmyt DvFer">Responses</h3><div><button class="sc-htmcrh jUGDyD" disabled=""><strong class="sc-fWWYYk cMoEZ">200<!-- --> </strong><span class="sc-jcwpoC eDjFAZ"><p>Return a 200 status code to acknowledge receipt of the event. Non-200
status codes will be retried.</p>
</span></button></div></div></div><div class="sc-jSFjdj sc-gKAaRy gBjRyf gcushC"><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Request samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="react-tabs-256" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-257" tabindex="0" data-rttab="true">Payload</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-257" aria-labelledby="react-tabs-256"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-bBjRSN kQSIAz">application/json</div></div><div class="sc-jgPyTC dSaTNC"><div class="sc-jNnpgg esZIbL"><div class="sc-giAqHp hMPeqJ"><button><div class="sc-carFqZ UksDl">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iJCRrE jCdxGr sc-dPaNzc gyljjx"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"created_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"id"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"object"</span>: <span class="token string">"event"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"type"</span>: <span class="token string">"batch.cancelled"</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="/paths/batch_completed/post" data-section-id="/paths/batch_completed/post" class="sc-eCApnc liLqNm"><div class="sc-iCoGMd gLxhOh"><div class="sc-hKFxyN juinod"><h2 class="sc-pNWdM eftmgB"><a class="sc-crzoAE iUxAWq" href="#/paths/batch_completed/post" aria-label="/paths/batch_completed/post"></a>Sent when a batch has completed processing.
<!-- --> <span type="primary" class="sc-bqGGPW jeXFeD"> <!-- -->Webhook </span></h2><div class="sc-iGkqmO hCTIhr"><div class="sc-iJCRrE sc-ciSkZP jCdxGr QGruV"><p>Sent when a batch has completed processing.</p>
</div></div><div class="sc-fcmMJX cvfxAX"><div class="sc-jUfyBS bhDyou"><h5 class="sc-iqAclL sc-fuISkM eONCmm hZIgic">Authorizations:</h5><svg class="sc-dIsUp iPqByX" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jQAxuV ccffaZ"><span class="sc-daBunf fcvuS"><span class="sc-dsXzNU dPrSxx"><i>ApiKeyAuth</i></span></span></div></div><h5 class="sc-iqAclL eONCmm">Request Body schema: <span class="sc-cBoqAE eKyrDP">application/json</span></h5><div class="sc-iJCRrE sc-ciSkZP jCdxGr QGruV"><p>The event payload sent by the API.</p>
</div><table class="sc-hHEiqL VCQHZ"><tbody><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="created_at"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">created_at</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">integer</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The Unix timestamp (in seconds) of when the batch API request was completed.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="id"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">id</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The unique ID of the event.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT sc-gSYDnn iwcKgn cAqMTE hTttpy" kind="field" title="data"><span class="sc-iemWCZ bcnRwz"></span><button aria-label="expand properties"><span class="property-name">data</span><svg class="sc-dIsUp hGHhhO" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">object</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>Event data payload.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="object"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">object</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div><div><span class="sc-laZMeE jWaWWE"> <!-- -->Value<!-- -->:</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"event"</span> </div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The object of the event. Always <code>event</code>.</p>
</div></div></div></td></tr><tr class="last "><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="type"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">type</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div><div><span class="sc-laZMeE jWaWWE"> <!-- -->Value<!-- -->:</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"batch.completed"</span> </div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The type of the event. Always <code>batch.completed</code>.</p>
</div></div></div></td></tr></tbody></table><div><h3 class="sc-fIxmyt DvFer">Responses</h3><div><button class="sc-htmcrh jUGDyD" disabled=""><strong class="sc-fWWYYk cMoEZ">200<!-- --> </strong><span class="sc-jcwpoC eDjFAZ"><p>Return a 200 status code to acknowledge receipt of the event. Non-200
status codes will be retried.</p>
</span></button></div></div></div><div class="sc-jSFjdj sc-gKAaRy gBjRyf gcushC"><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Request samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="react-tabs-258" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-259" tabindex="0" data-rttab="true">Payload</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-259" aria-labelledby="react-tabs-258"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-bBjRSN kQSIAz">application/json</div></div><div class="sc-jgPyTC dSaTNC"><div class="sc-jNnpgg esZIbL"><div class="sc-giAqHp hMPeqJ"><button><div class="sc-carFqZ UksDl">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iJCRrE jCdxGr sc-dPaNzc gyljjx"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"created_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"id"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"object"</span>: <span class="token string">"event"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"type"</span>: <span class="token string">"batch.completed"</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="/paths/batch_expired/post" data-section-id="/paths/batch_expired/post" class="sc-eCApnc liLqNm"><div class="sc-iCoGMd gLxhOh"><div class="sc-hKFxyN juinod"><h2 class="sc-pNWdM eftmgB"><a class="sc-crzoAE iUxAWq" href="#/paths/batch_expired/post" aria-label="/paths/batch_expired/post"></a>Sent when a batch has expired before completion.
<!-- --> <span type="primary" class="sc-bqGGPW jeXFeD"> <!-- -->Webhook </span></h2><div class="sc-iGkqmO hCTIhr"><div class="sc-iJCRrE sc-ciSkZP jCdxGr QGruV"><p>Sent when a batch has expired before completion.</p>
</div></div><div class="sc-fcmMJX cvfxAX"><div class="sc-jUfyBS bhDyou"><h5 class="sc-iqAclL sc-fuISkM eONCmm hZIgic">Authorizations:</h5><svg class="sc-dIsUp iPqByX" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jQAxuV ccffaZ"><span class="sc-daBunf fcvuS"><span class="sc-dsXzNU dPrSxx"><i>ApiKeyAuth</i></span></span></div></div><h5 class="sc-iqAclL eONCmm">Request Body schema: <span class="sc-cBoqAE eKyrDP">application/json</span></h5><div class="sc-iJCRrE sc-ciSkZP jCdxGr QGruV"><p>The event payload sent by the API.</p>
</div><table class="sc-hHEiqL VCQHZ"><tbody><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="created_at"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">created_at</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">integer</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The Unix timestamp (in seconds) of when the batch API request expired.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="id"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">id</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The unique ID of the event.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT sc-gSYDnn iwcKgn cAqMTE hTttpy" kind="field" title="data"><span class="sc-iemWCZ bcnRwz"></span><button aria-label="expand properties"><span class="property-name">data</span><svg class="sc-dIsUp hGHhhO" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">object</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>Event data payload.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="object"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">object</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div><div><span class="sc-laZMeE jWaWWE"> <!-- -->Value<!-- -->:</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"event"</span> </div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The object of the event. Always <code>event</code>.</p>
</div></div></div></td></tr><tr class="last "><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="type"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">type</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div><div><span class="sc-laZMeE jWaWWE"> <!-- -->Value<!-- -->:</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"batch.expired"</span> </div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The type of the event. Always <code>batch.expired</code>.</p>
</div></div></div></td></tr></tbody></table><div><h3 class="sc-fIxmyt DvFer">Responses</h3><div><button class="sc-htmcrh jUGDyD" disabled=""><strong class="sc-fWWYYk cMoEZ">200<!-- --> </strong><span class="sc-jcwpoC eDjFAZ"><p>Return a 200 status code to acknowledge receipt of the event. Non-200
status codes will be retried.</p>
</span></button></div></div></div><div class="sc-jSFjdj sc-gKAaRy gBjRyf gcushC"><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Request samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="react-tabs-260" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-261" tabindex="0" data-rttab="true">Payload</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-261" aria-labelledby="react-tabs-260"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-bBjRSN kQSIAz">application/json</div></div><div class="sc-jgPyTC dSaTNC"><div class="sc-jNnpgg esZIbL"><div class="sc-giAqHp hMPeqJ"><button><div class="sc-carFqZ UksDl">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iJCRrE jCdxGr sc-dPaNzc gyljjx"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"created_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"id"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"object"</span>: <span class="token string">"event"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"type"</span>: <span class="token string">"batch.expired"</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="/paths/batch_failed/post" data-section-id="/paths/batch_failed/post" class="sc-eCApnc liLqNm"><div class="sc-iCoGMd gLxhOh"><div class="sc-hKFxyN juinod"><h2 class="sc-pNWdM eftmgB"><a class="sc-crzoAE iUxAWq" href="#/paths/batch_failed/post" aria-label="/paths/batch_failed/post"></a>Sent when a batch has failed.
<!-- --> <span type="primary" class="sc-bqGGPW jeXFeD"> <!-- -->Webhook </span></h2><div class="sc-iGkqmO hCTIhr"><div class="sc-iJCRrE sc-ciSkZP jCdxGr QGruV"><p>Sent when a batch has failed.</p>
</div></div><div class="sc-fcmMJX cvfxAX"><div class="sc-jUfyBS bhDyou"><h5 class="sc-iqAclL sc-fuISkM eONCmm hZIgic">Authorizations:</h5><svg class="sc-dIsUp iPqByX" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jQAxuV ccffaZ"><span class="sc-daBunf fcvuS"><span class="sc-dsXzNU dPrSxx"><i>ApiKeyAuth</i></span></span></div></div><h5 class="sc-iqAclL eONCmm">Request Body schema: <span class="sc-cBoqAE eKyrDP">application/json</span></h5><div class="sc-iJCRrE sc-ciSkZP jCdxGr QGruV"><p>The event payload sent by the API.</p>
</div><table class="sc-hHEiqL VCQHZ"><tbody><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="created_at"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">created_at</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">integer</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The Unix timestamp (in seconds) of when the batch API request failed.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="id"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">id</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The unique ID of the event.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT sc-gSYDnn iwcKgn cAqMTE hTttpy" kind="field" title="data"><span class="sc-iemWCZ bcnRwz"></span><button aria-label="expand properties"><span class="property-name">data</span><svg class="sc-dIsUp hGHhhO" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">object</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>Event data payload.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="object"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">object</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div><div><span class="sc-laZMeE jWaWWE"> <!-- -->Value<!-- -->:</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"event"</span> </div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The object of the event. Always <code>event</code>.</p>
</div></div></div></td></tr><tr class="last "><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="type"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">type</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div><div><span class="sc-laZMeE jWaWWE"> <!-- -->Value<!-- -->:</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"batch.failed"</span> </div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The type of the event. Always <code>batch.failed</code>.</p>
</div></div></div></td></tr></tbody></table><div><h3 class="sc-fIxmyt DvFer">Responses</h3><div><button class="sc-htmcrh jUGDyD" disabled=""><strong class="sc-fWWYYk cMoEZ">200<!-- --> </strong><span class="sc-jcwpoC eDjFAZ"><p>Return a 200 status code to acknowledge receipt of the event. Non-200
status codes will be retried.</p>
</span></button></div></div></div><div class="sc-jSFjdj sc-gKAaRy gBjRyf gcushC"><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Request samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="react-tabs-262" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-263" tabindex="0" data-rttab="true">Payload</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-263" aria-labelledby="react-tabs-262"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-bBjRSN kQSIAz">application/json</div></div><div class="sc-jgPyTC dSaTNC"><div class="sc-jNnpgg esZIbL"><div class="sc-giAqHp hMPeqJ"><button><div class="sc-carFqZ UksDl">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iJCRrE jCdxGr sc-dPaNzc gyljjx"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"created_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"id"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"object"</span>: <span class="token string">"event"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"type"</span>: <span class="token string">"batch.failed"</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="/paths/eval_run_canceled/post" data-section-id="/paths/eval_run_canceled/post" class="sc-eCApnc liLqNm"><div class="sc-iCoGMd gLxhOh"><div class="sc-hKFxyN juinod"><h2 class="sc-pNWdM eftmgB"><a class="sc-crzoAE iUxAWq" href="#/paths/eval_run_canceled/post" aria-label="/paths/eval_run_canceled/post"></a>Sent when an eval run has been canceled.
<!-- --> <span type="primary" class="sc-bqGGPW jeXFeD"> <!-- -->Webhook </span></h2><div class="sc-iGkqmO hCTIhr"><div class="sc-iJCRrE sc-ciSkZP jCdxGr QGruV"><p>Sent when an eval run has been canceled.</p>
</div></div><div class="sc-fcmMJX cvfxAX"><div class="sc-jUfyBS bhDyou"><h5 class="sc-iqAclL sc-fuISkM eONCmm hZIgic">Authorizations:</h5><svg class="sc-dIsUp iPqByX" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jQAxuV ccffaZ"><span class="sc-daBunf fcvuS"><span class="sc-dsXzNU dPrSxx"><i>ApiKeyAuth</i></span></span></div></div><h5 class="sc-iqAclL eONCmm">Request Body schema: <span class="sc-cBoqAE eKyrDP">application/json</span></h5><div class="sc-iJCRrE sc-ciSkZP jCdxGr QGruV"><p>The event payload sent by the API.</p>
</div><table class="sc-hHEiqL VCQHZ"><tbody><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="created_at"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">created_at</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">integer</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The Unix timestamp (in seconds) of when the eval run was canceled.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="id"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">id</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The unique ID of the event.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT sc-gSYDnn iwcKgn cAqMTE hTttpy" kind="field" title="data"><span class="sc-iemWCZ bcnRwz"></span><button aria-label="expand properties"><span class="property-name">data</span><svg class="sc-dIsUp hGHhhO" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">object</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>Event data payload.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="object"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">object</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div><div><span class="sc-laZMeE jWaWWE"> <!-- -->Value<!-- -->:</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"event"</span> </div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The object of the event. Always <code>event</code>.</p>
</div></div></div></td></tr><tr class="last "><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="type"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">type</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div><div><span class="sc-laZMeE jWaWWE"> <!-- -->Value<!-- -->:</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"eval.run.canceled"</span> </div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The type of the event. Always <code>eval.run.canceled</code>.</p>
</div></div></div></td></tr></tbody></table><div><h3 class="sc-fIxmyt DvFer">Responses</h3><div><button class="sc-htmcrh jUGDyD" disabled=""><strong class="sc-fWWYYk cMoEZ">200<!-- --> </strong><span class="sc-jcwpoC eDjFAZ"><p>Return a 200 status code to acknowledge receipt of the event. Non-200
status codes will be retried. </p>
</span></button></div></div></div><div class="sc-jSFjdj sc-gKAaRy gBjRyf gcushC"><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Request samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="react-tabs-264" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-265" tabindex="0" data-rttab="true">Payload</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-265" aria-labelledby="react-tabs-264"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-bBjRSN kQSIAz">application/json</div></div><div class="sc-jgPyTC dSaTNC"><div class="sc-jNnpgg esZIbL"><div class="sc-giAqHp hMPeqJ"><button><div class="sc-carFqZ UksDl">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iJCRrE jCdxGr sc-dPaNzc gyljjx"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"created_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"id"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"object"</span>: <span class="token string">"event"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"type"</span>: <span class="token string">"eval.run.canceled"</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="/paths/eval_run_failed/post" data-section-id="/paths/eval_run_failed/post" class="sc-eCApnc liLqNm"><div class="sc-iCoGMd gLxhOh"><div class="sc-hKFxyN juinod"><h2 class="sc-pNWdM eftmgB"><a class="sc-crzoAE iUxAWq" href="#/paths/eval_run_failed/post" aria-label="/paths/eval_run_failed/post"></a>Sent when an eval run has failed.
<!-- --> <span type="primary" class="sc-bqGGPW jeXFeD"> <!-- -->Webhook </span></h2><div class="sc-iGkqmO hCTIhr"><div class="sc-iJCRrE sc-ciSkZP jCdxGr QGruV"><p>Sent when an eval run has failed.</p>
</div></div><div class="sc-fcmMJX cvfxAX"><div class="sc-jUfyBS bhDyou"><h5 class="sc-iqAclL sc-fuISkM eONCmm hZIgic">Authorizations:</h5><svg class="sc-dIsUp iPqByX" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jQAxuV ccffaZ"><span class="sc-daBunf fcvuS"><span class="sc-dsXzNU dPrSxx"><i>ApiKeyAuth</i></span></span></div></div><h5 class="sc-iqAclL eONCmm">Request Body schema: <span class="sc-cBoqAE eKyrDP">application/json</span></h5><div class="sc-iJCRrE sc-ciSkZP jCdxGr QGruV"><p>The event payload sent by the API.</p>
</div><table class="sc-hHEiqL VCQHZ"><tbody><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="created_at"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">created_at</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">integer</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The Unix timestamp (in seconds) of when the eval run failed.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="id"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">id</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The unique ID of the event.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT sc-gSYDnn iwcKgn cAqMTE hTttpy" kind="field" title="data"><span class="sc-iemWCZ bcnRwz"></span><button aria-label="expand properties"><span class="property-name">data</span><svg class="sc-dIsUp hGHhhO" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">object</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>Event data payload.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="object"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">object</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div><div><span class="sc-laZMeE jWaWWE"> <!-- -->Value<!-- -->:</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"event"</span> </div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The object of the event. Always <code>event</code>.</p>
</div></div></div></td></tr><tr class="last "><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="type"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">type</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div><div><span class="sc-laZMeE jWaWWE"> <!-- -->Value<!-- -->:</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"eval.run.failed"</span> </div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The type of the event. Always <code>eval.run.failed</code>.</p>
</div></div></div></td></tr></tbody></table><div><h3 class="sc-fIxmyt DvFer">Responses</h3><div><button class="sc-htmcrh jUGDyD" disabled=""><strong class="sc-fWWYYk cMoEZ">200<!-- --> </strong><span class="sc-jcwpoC eDjFAZ"><p>Return a 200 status code to acknowledge receipt of the event. Non-200
status codes will be retried. </p>
</span></button></div></div></div><div class="sc-jSFjdj sc-gKAaRy gBjRyf gcushC"><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Request samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="react-tabs-266" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-267" tabindex="0" data-rttab="true">Payload</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-267" aria-labelledby="react-tabs-266"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-bBjRSN kQSIAz">application/json</div></div><div class="sc-jgPyTC dSaTNC"><div class="sc-jNnpgg esZIbL"><div class="sc-giAqHp hMPeqJ"><button><div class="sc-carFqZ UksDl">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iJCRrE jCdxGr sc-dPaNzc gyljjx"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"created_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"id"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"object"</span>: <span class="token string">"event"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"type"</span>: <span class="token string">"eval.run.failed"</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="/paths/eval_run_succeeded/post" data-section-id="/paths/eval_run_succeeded/post" class="sc-eCApnc liLqNm"><div class="sc-iCoGMd gLxhOh"><div class="sc-hKFxyN juinod"><h2 class="sc-pNWdM eftmgB"><a class="sc-crzoAE iUxAWq" href="#/paths/eval_run_succeeded/post" aria-label="/paths/eval_run_succeeded/post"></a>Sent when an eval run has succeeded.
<!-- --> <span type="primary" class="sc-bqGGPW jeXFeD"> <!-- -->Webhook </span></h2><div class="sc-iGkqmO hCTIhr"><div class="sc-iJCRrE sc-ciSkZP jCdxGr QGruV"><p>Sent when an eval run has succeeded.</p>
</div></div><div class="sc-fcmMJX cvfxAX"><div class="sc-jUfyBS bhDyou"><h5 class="sc-iqAclL sc-fuISkM eONCmm hZIgic">Authorizations:</h5><svg class="sc-dIsUp iPqByX" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jQAxuV ccffaZ"><span class="sc-daBunf fcvuS"><span class="sc-dsXzNU dPrSxx"><i>ApiKeyAuth</i></span></span></div></div><h5 class="sc-iqAclL eONCmm">Request Body schema: <span class="sc-cBoqAE eKyrDP">application/json</span></h5><div class="sc-iJCRrE sc-ciSkZP jCdxGr QGruV"><p>The event payload sent by the API.</p>
</div><table class="sc-hHEiqL VCQHZ"><tbody><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="created_at"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">created_at</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">integer</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The Unix timestamp (in seconds) of when the eval run succeeded.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="id"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">id</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The unique ID of the event.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT sc-gSYDnn iwcKgn cAqMTE hTttpy" kind="field" title="data"><span class="sc-iemWCZ bcnRwz"></span><button aria-label="expand properties"><span class="property-name">data</span><svg class="sc-dIsUp hGHhhO" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">object</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>Event data payload.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="object"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">object</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div><div><span class="sc-laZMeE jWaWWE"> <!-- -->Value<!-- -->:</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"event"</span> </div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The object of the event. Always <code>event</code>.</p>
</div></div></div></td></tr><tr class="last "><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="type"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">type</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div><div><span class="sc-laZMeE jWaWWE"> <!-- -->Value<!-- -->:</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"eval.run.succeeded"</span> </div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The type of the event. Always <code>eval.run.succeeded</code>.</p>
</div></div></div></td></tr></tbody></table><div><h3 class="sc-fIxmyt DvFer">Responses</h3><div><button class="sc-htmcrh jUGDyD" disabled=""><strong class="sc-fWWYYk cMoEZ">200<!-- --> </strong><span class="sc-jcwpoC eDjFAZ"><p>Return a 200 status code to acknowledge receipt of the event. Non-200
status codes will be retried. </p>
</span></button></div></div></div><div class="sc-jSFjdj sc-gKAaRy gBjRyf gcushC"><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Request samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="react-tabs-268" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-269" tabindex="0" data-rttab="true">Payload</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-269" aria-labelledby="react-tabs-268"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-bBjRSN kQSIAz">application/json</div></div><div class="sc-jgPyTC dSaTNC"><div class="sc-jNnpgg esZIbL"><div class="sc-giAqHp hMPeqJ"><button><div class="sc-carFqZ UksDl">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iJCRrE jCdxGr sc-dPaNzc gyljjx"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"created_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"id"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"object"</span>: <span class="token string">"event"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"type"</span>: <span class="token string">"eval.run.succeeded"</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="/paths/fine_tuning_job_cancelled/post" data-section-id="/paths/fine_tuning_job_cancelled/post" class="sc-eCApnc liLqNm"><div class="sc-iCoGMd gLxhOh"><div class="sc-hKFxyN juinod"><h2 class="sc-pNWdM eftmgB"><a class="sc-crzoAE iUxAWq" href="#/paths/fine_tuning_job_cancelled/post" aria-label="/paths/fine_tuning_job_cancelled/post"></a>Sent when a fine-tuning job has been cancelled.
<!-- --> <span type="primary" class="sc-bqGGPW jeXFeD"> <!-- -->Webhook </span></h2><div class="sc-iGkqmO hCTIhr"><div class="sc-iJCRrE sc-ciSkZP jCdxGr QGruV"><p>Sent when a fine-tuning job has been cancelled.</p>
</div></div><div class="sc-fcmMJX cvfxAX"><div class="sc-jUfyBS bhDyou"><h5 class="sc-iqAclL sc-fuISkM eONCmm hZIgic">Authorizations:</h5><svg class="sc-dIsUp iPqByX" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jQAxuV ccffaZ"><span class="sc-daBunf fcvuS"><span class="sc-dsXzNU dPrSxx"><i>ApiKeyAuth</i></span></span></div></div><h5 class="sc-iqAclL eONCmm">Request Body schema: <span class="sc-cBoqAE eKyrDP">application/json</span></h5><div class="sc-iJCRrE sc-ciSkZP jCdxGr QGruV"><p>The event payload sent by the API.</p>
</div><table class="sc-hHEiqL VCQHZ"><tbody><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="created_at"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">created_at</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">integer</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The Unix timestamp (in seconds) of when the fine-tuning job was cancelled.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="id"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">id</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The unique ID of the event.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT sc-gSYDnn iwcKgn cAqMTE hTttpy" kind="field" title="data"><span class="sc-iemWCZ bcnRwz"></span><button aria-label="expand properties"><span class="property-name">data</span><svg class="sc-dIsUp hGHhhO" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">object</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>Event data payload.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="object"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">object</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div><div><span class="sc-laZMeE jWaWWE"> <!-- -->Value<!-- -->:</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"event"</span> </div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The object of the event. Always <code>event</code>.</p>
</div></div></div></td></tr><tr class="last "><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="type"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">type</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div><div><span class="sc-laZMeE jWaWWE"> <!-- -->Value<!-- -->:</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"fine_tuning.job.cancelled"</span> </div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The type of the event. Always <code>fine_tuning.job.cancelled</code>.</p>
</div></div></div></td></tr></tbody></table><div><h3 class="sc-fIxmyt DvFer">Responses</h3><div><button class="sc-htmcrh jUGDyD" disabled=""><strong class="sc-fWWYYk cMoEZ">200<!-- --> </strong><span class="sc-jcwpoC eDjFAZ"><p>Return a 200 status code to acknowledge receipt of the event. Non-200
status codes will be retried. </p>
</span></button></div></div></div><div class="sc-jSFjdj sc-gKAaRy gBjRyf gcushC"><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Request samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="react-tabs-270" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-271" tabindex="0" data-rttab="true">Payload</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-271" aria-labelledby="react-tabs-270"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-bBjRSN kQSIAz">application/json</div></div><div class="sc-jgPyTC dSaTNC"><div class="sc-jNnpgg esZIbL"><div class="sc-giAqHp hMPeqJ"><button><div class="sc-carFqZ UksDl">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iJCRrE jCdxGr sc-dPaNzc gyljjx"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"created_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"id"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"object"</span>: <span class="token string">"event"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"type"</span>: <span class="token string">"fine_tuning.job.cancelled"</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="/paths/fine_tuning_job_failed/post" data-section-id="/paths/fine_tuning_job_failed/post" class="sc-eCApnc liLqNm"><div class="sc-iCoGMd gLxhOh"><div class="sc-hKFxyN juinod"><h2 class="sc-pNWdM eftmgB"><a class="sc-crzoAE iUxAWq" href="#/paths/fine_tuning_job_failed/post" aria-label="/paths/fine_tuning_job_failed/post"></a>Sent when a fine-tuning job has failed.
<!-- --> <span type="primary" class="sc-bqGGPW jeXFeD"> <!-- -->Webhook </span></h2><div class="sc-iGkqmO hCTIhr"><div class="sc-iJCRrE sc-ciSkZP jCdxGr QGruV"><p>Sent when a fine-tuning job has failed.</p>
</div></div><div class="sc-fcmMJX cvfxAX"><div class="sc-jUfyBS bhDyou"><h5 class="sc-iqAclL sc-fuISkM eONCmm hZIgic">Authorizations:</h5><svg class="sc-dIsUp iPqByX" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jQAxuV ccffaZ"><span class="sc-daBunf fcvuS"><span class="sc-dsXzNU dPrSxx"><i>ApiKeyAuth</i></span></span></div></div><h5 class="sc-iqAclL eONCmm">Request Body schema: <span class="sc-cBoqAE eKyrDP">application/json</span></h5><div class="sc-iJCRrE sc-ciSkZP jCdxGr QGruV"><p>The event payload sent by the API.</p>
</div><table class="sc-hHEiqL VCQHZ"><tbody><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="created_at"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">created_at</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">integer</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The Unix timestamp (in seconds) of when the fine-tuning job failed.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="id"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">id</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The unique ID of the event.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT sc-gSYDnn iwcKgn cAqMTE hTttpy" kind="field" title="data"><span class="sc-iemWCZ bcnRwz"></span><button aria-label="expand properties"><span class="property-name">data</span><svg class="sc-dIsUp hGHhhO" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">object</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>Event data payload.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="object"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">object</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div><div><span class="sc-laZMeE jWaWWE"> <!-- -->Value<!-- -->:</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"event"</span> </div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The object of the event. Always <code>event</code>.</p>
</div></div></div></td></tr><tr class="last "><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="type"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">type</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div><div><span class="sc-laZMeE jWaWWE"> <!-- -->Value<!-- -->:</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"fine_tuning.job.failed"</span> </div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The type of the event. Always <code>fine_tuning.job.failed</code>.</p>
</div></div></div></td></tr></tbody></table><div><h3 class="sc-fIxmyt DvFer">Responses</h3><div><button class="sc-htmcrh jUGDyD" disabled=""><strong class="sc-fWWYYk cMoEZ">200<!-- --> </strong><span class="sc-jcwpoC eDjFAZ"><p>Return a 200 status code to acknowledge receipt of the event. Non-200
status codes will be retried. </p>
</span></button></div></div></div><div class="sc-jSFjdj sc-gKAaRy gBjRyf gcushC"><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Request samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="react-tabs-272" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-273" tabindex="0" data-rttab="true">Payload</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-273" aria-labelledby="react-tabs-272"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-bBjRSN kQSIAz">application/json</div></div><div class="sc-jgPyTC dSaTNC"><div class="sc-jNnpgg esZIbL"><div class="sc-giAqHp hMPeqJ"><button><div class="sc-carFqZ UksDl">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iJCRrE jCdxGr sc-dPaNzc gyljjx"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"created_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"id"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"object"</span>: <span class="token string">"event"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"type"</span>: <span class="token string">"fine_tuning.job.failed"</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="/paths/fine_tuning_job_succeeded/post" data-section-id="/paths/fine_tuning_job_succeeded/post" class="sc-eCApnc liLqNm"><div class="sc-iCoGMd gLxhOh"><div class="sc-hKFxyN juinod"><h2 class="sc-pNWdM eftmgB"><a class="sc-crzoAE iUxAWq" href="#/paths/fine_tuning_job_succeeded/post" aria-label="/paths/fine_tuning_job_succeeded/post"></a>Sent when a fine-tuning job has succeeded.
<!-- --> <span type="primary" class="sc-bqGGPW jeXFeD"> <!-- -->Webhook </span></h2><div class="sc-iGkqmO hCTIhr"><div class="sc-iJCRrE sc-ciSkZP jCdxGr QGruV"><p>Sent when a fine-tuning job has succeeded.</p>
</div></div><div class="sc-fcmMJX cvfxAX"><div class="sc-jUfyBS bhDyou"><h5 class="sc-iqAclL sc-fuISkM eONCmm hZIgic">Authorizations:</h5><svg class="sc-dIsUp iPqByX" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jQAxuV ccffaZ"><span class="sc-daBunf fcvuS"><span class="sc-dsXzNU dPrSxx"><i>ApiKeyAuth</i></span></span></div></div><h5 class="sc-iqAclL eONCmm">Request Body schema: <span class="sc-cBoqAE eKyrDP">application/json</span></h5><div class="sc-iJCRrE sc-ciSkZP jCdxGr QGruV"><p>The event payload sent by the API.</p>
</div><table class="sc-hHEiqL VCQHZ"><tbody><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="created_at"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">created_at</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">integer</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The Unix timestamp (in seconds) of when the fine-tuning job succeeded.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="id"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">id</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The unique ID of the event.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT sc-gSYDnn iwcKgn cAqMTE hTttpy" kind="field" title="data"><span class="sc-iemWCZ bcnRwz"></span><button aria-label="expand properties"><span class="property-name">data</span><svg class="sc-dIsUp hGHhhO" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">object</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>Event data payload.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="object"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">object</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div><div><span class="sc-laZMeE jWaWWE"> <!-- -->Value<!-- -->:</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"event"</span> </div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The object of the event. Always <code>event</code>.</p>
</div></div></div></td></tr><tr class="last "><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="type"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">type</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div><div><span class="sc-laZMeE jWaWWE"> <!-- -->Value<!-- -->:</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"fine_tuning.job.succeeded"</span> </div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The type of the event. Always <code>fine_tuning.job.succeeded</code>.</p>
</div></div></div></td></tr></tbody></table><div><h3 class="sc-fIxmyt DvFer">Responses</h3><div><button class="sc-htmcrh jUGDyD" disabled=""><strong class="sc-fWWYYk cMoEZ">200<!-- --> </strong><span class="sc-jcwpoC eDjFAZ"><p>Return a 200 status code to acknowledge receipt of the event. Non-200
status codes will be retried. </p>
</span></button></div></div></div><div class="sc-jSFjdj sc-gKAaRy gBjRyf gcushC"><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Request samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="react-tabs-274" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-275" tabindex="0" data-rttab="true">Payload</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-275" aria-labelledby="react-tabs-274"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-bBjRSN kQSIAz">application/json</div></div><div class="sc-jgPyTC dSaTNC"><div class="sc-jNnpgg esZIbL"><div class="sc-giAqHp hMPeqJ"><button><div class="sc-carFqZ UksDl">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iJCRrE jCdxGr sc-dPaNzc gyljjx"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"created_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"id"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"object"</span>: <span class="token string">"event"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"type"</span>: <span class="token string">"fine_tuning.job.succeeded"</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="/paths/realtime_call_incoming/post" data-section-id="/paths/realtime_call_incoming/post" class="sc-eCApnc liLqNm"><div class="sc-iCoGMd gLxhOh"><div class="sc-hKFxyN juinod"><h2 class="sc-pNWdM eftmgB"><a class="sc-crzoAE iUxAWq" href="#/paths/realtime_call_incoming/post" aria-label="/paths/realtime_call_incoming/post"></a>Sent when Realtime API Receives a incoming SIP cal<!-- --> <span type="primary" class="sc-bqGGPW jeXFeD"> <!-- -->Webhook </span></h2><div class="sc-iGkqmO hCTIhr"><div class="sc-iJCRrE sc-ciSkZP jCdxGr QGruV"><p>Sent when Realtime API Receives a incoming SIP call.</p>
</div></div><div class="sc-fcmMJX cvfxAX"><div class="sc-jUfyBS bhDyou"><h5 class="sc-iqAclL sc-fuISkM eONCmm hZIgic">Authorizations:</h5><svg class="sc-dIsUp iPqByX" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jQAxuV ccffaZ"><span class="sc-daBunf fcvuS"><span class="sc-dsXzNU dPrSxx"><i>ApiKeyAuth</i></span></span></div></div><h5 class="sc-iqAclL eONCmm">Request Body schema: <span class="sc-cBoqAE eKyrDP">application/json</span></h5><div class="sc-iJCRrE sc-ciSkZP jCdxGr QGruV"><p>The event payload sent by the API.</p>
</div><table class="sc-hHEiqL VCQHZ"><tbody><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="created_at"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">created_at</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">integer</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The Unix timestamp (in seconds) of when the model response was completed.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="id"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">id</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The unique ID of the event.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT sc-gSYDnn iwcKgn cAqMTE hTttpy" kind="field" title="data"><span class="sc-iemWCZ bcnRwz"></span><button aria-label="expand properties"><span class="property-name">data</span><svg class="sc-dIsUp hGHhhO" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">object</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>Event data payload.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="object"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">object</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div><div><span class="sc-laZMeE jWaWWE"> <!-- -->Value<!-- -->:</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"event"</span> </div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The object of the event. Always <code>event</code>.</p>
</div></div></div></td></tr><tr class="last "><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="type"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">type</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div><div><span class="sc-laZMeE jWaWWE"> <!-- -->Value<!-- -->:</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"realtime.call.incoming"</span> </div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The type of the event. Always <code>realtime.call.incoming</code>.</p>
</div></div></div></td></tr></tbody></table><div><h3 class="sc-fIxmyt DvFer">Responses</h3><div><button class="sc-htmcrh jUGDyD" disabled=""><strong class="sc-fWWYYk cMoEZ">200<!-- --> </strong><span class="sc-jcwpoC eDjFAZ"><p>Return a 200 status code to acknowledge receipt of the event. Non-200
status codes will be retried.</p>
</span></button></div></div></div><div class="sc-jSFjdj sc-gKAaRy gBjRyf gcushC"><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Request samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="react-tabs-276" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-277" tabindex="0" data-rttab="true">Payload</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-277" aria-labelledby="react-tabs-276"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-bBjRSN kQSIAz">application/json</div></div><div class="sc-jgPyTC dSaTNC"><div class="sc-jNnpgg esZIbL"><div class="sc-giAqHp hMPeqJ"><button><div class="sc-carFqZ UksDl">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iJCRrE jCdxGr sc-dPaNzc gyljjx"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"created_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"call_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"sip_headers"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"value"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"object"</span>: <span class="token string">"event"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"type"</span>: <span class="token string">"realtime.call.incoming"</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="/paths/response_cancelled/post" data-section-id="/paths/response_cancelled/post" class="sc-eCApnc liLqNm"><div class="sc-iCoGMd gLxhOh"><div class="sc-hKFxyN juinod"><h2 class="sc-pNWdM eftmgB"><a class="sc-crzoAE iUxAWq" href="#/paths/response_cancelled/post" aria-label="/paths/response_cancelled/post"></a>Sent when a background response has been cancelled<!-- --> <span type="primary" class="sc-bqGGPW jeXFeD"> <!-- -->Webhook </span></h2><div class="sc-iGkqmO hCTIhr"><div class="sc-iJCRrE sc-ciSkZP jCdxGr QGruV"><p>Sent when a background response has been cancelled.</p>
</div></div><div class="sc-fcmMJX cvfxAX"><div class="sc-jUfyBS bhDyou"><h5 class="sc-iqAclL sc-fuISkM eONCmm hZIgic">Authorizations:</h5><svg class="sc-dIsUp iPqByX" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jQAxuV ccffaZ"><span class="sc-daBunf fcvuS"><span class="sc-dsXzNU dPrSxx"><i>ApiKeyAuth</i></span></span></div></div><h5 class="sc-iqAclL eONCmm">Request Body schema: <span class="sc-cBoqAE eKyrDP">application/json</span></h5><div class="sc-iJCRrE sc-ciSkZP jCdxGr QGruV"><p>The event payload sent by the API.</p>
</div><table class="sc-hHEiqL VCQHZ"><tbody><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="created_at"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">created_at</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">integer</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The Unix timestamp (in seconds) of when the model response was cancelled.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="id"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">id</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The unique ID of the event.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT sc-gSYDnn iwcKgn cAqMTE hTttpy" kind="field" title="data"><span class="sc-iemWCZ bcnRwz"></span><button aria-label="expand properties"><span class="property-name">data</span><svg class="sc-dIsUp hGHhhO" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">object</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>Event data payload.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="object"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">object</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div><div><span class="sc-laZMeE jWaWWE"> <!-- -->Value<!-- -->:</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"event"</span> </div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The object of the event. Always <code>event</code>.</p>
</div></div></div></td></tr><tr class="last "><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="type"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">type</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div><div><span class="sc-laZMeE jWaWWE"> <!-- -->Value<!-- -->:</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"response.cancelled"</span> </div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The type of the event. Always <code>response.cancelled</code>.</p>
</div></div></div></td></tr></tbody></table><div><h3 class="sc-fIxmyt DvFer">Responses</h3><div><button class="sc-htmcrh jUGDyD" disabled=""><strong class="sc-fWWYYk cMoEZ">200<!-- --> </strong><span class="sc-jcwpoC eDjFAZ"><p>Return a 200 status code to acknowledge receipt of the event. Non-200
status codes will be retried.</p>
</span></button></div></div></div><div class="sc-jSFjdj sc-gKAaRy gBjRyf gcushC"><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Request samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="react-tabs-278" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-279" tabindex="0" data-rttab="true">Payload</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-279" aria-labelledby="react-tabs-278"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-bBjRSN kQSIAz">application/json</div></div><div class="sc-jgPyTC dSaTNC"><div class="sc-jNnpgg esZIbL"><div class="sc-giAqHp hMPeqJ"><button><div class="sc-carFqZ UksDl">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iJCRrE jCdxGr sc-dPaNzc gyljjx"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"created_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"id"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"object"</span>: <span class="token string">"event"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"type"</span>: <span class="token string">"response.cancelled"</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="/paths/response_completed/post" data-section-id="/paths/response_completed/post" class="sc-eCApnc liLqNm"><div class="sc-iCoGMd gLxhOh"><div class="sc-hKFxyN juinod"><h2 class="sc-pNWdM eftmgB"><a class="sc-crzoAE iUxAWq" href="#/paths/response_completed/post" aria-label="/paths/response_completed/post"></a>Sent when a background response has completed succ<!-- --> <span type="primary" class="sc-bqGGPW jeXFeD"> <!-- -->Webhook </span></h2><div class="sc-iGkqmO hCTIhr"><div class="sc-iJCRrE sc-ciSkZP jCdxGr QGruV"><p>Sent when a background response has completed successfully.</p>
</div></div><div class="sc-fcmMJX cvfxAX"><div class="sc-jUfyBS bhDyou"><h5 class="sc-iqAclL sc-fuISkM eONCmm hZIgic">Authorizations:</h5><svg class="sc-dIsUp iPqByX" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jQAxuV ccffaZ"><span class="sc-daBunf fcvuS"><span class="sc-dsXzNU dPrSxx"><i>ApiKeyAuth</i></span></span></div></div><h5 class="sc-iqAclL eONCmm">Request Body schema: <span class="sc-cBoqAE eKyrDP">application/json</span></h5><div class="sc-iJCRrE sc-ciSkZP jCdxGr QGruV"><p>The event payload sent by the API.</p>
</div><table class="sc-hHEiqL VCQHZ"><tbody><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="created_at"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">created_at</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">integer</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The Unix timestamp (in seconds) of when the model response was completed.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="id"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">id</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The unique ID of the event.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT sc-gSYDnn iwcKgn cAqMTE hTttpy" kind="field" title="data"><span class="sc-iemWCZ bcnRwz"></span><button aria-label="expand properties"><span class="property-name">data</span><svg class="sc-dIsUp hGHhhO" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">object</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>Event data payload.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="object"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">object</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div><div><span class="sc-laZMeE jWaWWE"> <!-- -->Value<!-- -->:</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"event"</span> </div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The object of the event. Always <code>event</code>.</p>
</div></div></div></td></tr><tr class="last "><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="type"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">type</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div><div><span class="sc-laZMeE jWaWWE"> <!-- -->Value<!-- -->:</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"response.completed"</span> </div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The type of the event. Always <code>response.completed</code>.</p>
</div></div></div></td></tr></tbody></table><div><h3 class="sc-fIxmyt DvFer">Responses</h3><div><button class="sc-htmcrh jUGDyD" disabled=""><strong class="sc-fWWYYk cMoEZ">200<!-- --> </strong><span class="sc-jcwpoC eDjFAZ"><p>Return a 200 status code to acknowledge receipt of the event. Non-200
status codes will be retried. </p>
</span></button></div></div></div><div class="sc-jSFjdj sc-gKAaRy gBjRyf gcushC"><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Request samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="react-tabs-280" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-281" tabindex="0" data-rttab="true">Payload</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-281" aria-labelledby="react-tabs-280"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-bBjRSN kQSIAz">application/json</div></div><div class="sc-jgPyTC dSaTNC"><div class="sc-jNnpgg esZIbL"><div class="sc-giAqHp hMPeqJ"><button><div class="sc-carFqZ UksDl">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iJCRrE jCdxGr sc-dPaNzc gyljjx"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"created_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"id"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"object"</span>: <span class="token string">"event"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"type"</span>: <span class="token string">"response.completed"</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="/paths/response_failed/post" data-section-id="/paths/response_failed/post" class="sc-eCApnc liLqNm"><div class="sc-iCoGMd gLxhOh"><div class="sc-hKFxyN juinod"><h2 class="sc-pNWdM eftmgB"><a class="sc-crzoAE iUxAWq" href="#/paths/response_failed/post" aria-label="/paths/response_failed/post"></a>Sent when a background response has failed.
<!-- --> <span type="primary" class="sc-bqGGPW jeXFeD"> <!-- -->Webhook </span></h2><div class="sc-iGkqmO hCTIhr"><div class="sc-iJCRrE sc-ciSkZP jCdxGr QGruV"><p>Sent when a background response has failed.</p>
</div></div><div class="sc-fcmMJX cvfxAX"><div class="sc-jUfyBS bhDyou"><h5 class="sc-iqAclL sc-fuISkM eONCmm hZIgic">Authorizations:</h5><svg class="sc-dIsUp iPqByX" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jQAxuV ccffaZ"><span class="sc-daBunf fcvuS"><span class="sc-dsXzNU dPrSxx"><i>ApiKeyAuth</i></span></span></div></div><h5 class="sc-iqAclL eONCmm">Request Body schema: <span class="sc-cBoqAE eKyrDP">application/json</span></h5><div class="sc-iJCRrE sc-ciSkZP jCdxGr QGruV"><p>The event payload sent by the API.</p>
</div><table class="sc-hHEiqL VCQHZ"><tbody><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="created_at"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">created_at</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">integer</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The Unix timestamp (in seconds) of when the model response failed.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="id"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">id</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The unique ID of the event.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT sc-gSYDnn iwcKgn cAqMTE hTttpy" kind="field" title="data"><span class="sc-iemWCZ bcnRwz"></span><button aria-label="expand properties"><span class="property-name">data</span><svg class="sc-dIsUp hGHhhO" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">object</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>Event data payload.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="object"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">object</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div><div><span class="sc-laZMeE jWaWWE"> <!-- -->Value<!-- -->:</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"event"</span> </div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The object of the event. Always <code>event</code>.</p>
</div></div></div></td></tr><tr class="last "><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="type"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">type</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div><div><span class="sc-laZMeE jWaWWE"> <!-- -->Value<!-- -->:</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"response.failed"</span> </div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The type of the event. Always <code>response.failed</code>.</p>
</div></div></div></td></tr></tbody></table><div><h3 class="sc-fIxmyt DvFer">Responses</h3><div><button class="sc-htmcrh jUGDyD" disabled=""><strong class="sc-fWWYYk cMoEZ">200<!-- --> </strong><span class="sc-jcwpoC eDjFAZ"><p>Return a 200 status code to acknowledge receipt of the event. Non-200
status codes will be retried.</p>
</span></button></div></div></div><div class="sc-jSFjdj sc-gKAaRy gBjRyf gcushC"><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Request samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="react-tabs-282" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-283" tabindex="0" data-rttab="true">Payload</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-283" aria-labelledby="react-tabs-282"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-bBjRSN kQSIAz">application/json</div></div><div class="sc-jgPyTC dSaTNC"><div class="sc-jNnpgg esZIbL"><div class="sc-giAqHp hMPeqJ"><button><div class="sc-carFqZ UksDl">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iJCRrE jCdxGr sc-dPaNzc gyljjx"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"created_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"id"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"object"</span>: <span class="token string">"event"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"type"</span>: <span class="token string">"response.failed"</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="/paths/response_incomplete/post" data-section-id="/paths/response_incomplete/post" class="sc-eCApnc liLqNm"><div class="sc-iCoGMd gLxhOh"><div class="sc-hKFxyN juinod"><h2 class="sc-pNWdM eftmgB"><a class="sc-crzoAE iUxAWq" href="#/paths/response_incomplete/post" aria-label="/paths/response_incomplete/post"></a>Sent when a background response is incomplete.
<!-- --> <span type="primary" class="sc-bqGGPW jeXFeD"> <!-- -->Webhook </span></h2><div class="sc-iGkqmO hCTIhr"><div class="sc-iJCRrE sc-ciSkZP jCdxGr QGruV"><p>Sent when a background response is incomplete.</p>
</div></div><div class="sc-fcmMJX cvfxAX"><div class="sc-jUfyBS bhDyou"><h5 class="sc-iqAclL sc-fuISkM eONCmm hZIgic">Authorizations:</h5><svg class="sc-dIsUp iPqByX" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jQAxuV ccffaZ"><span class="sc-daBunf fcvuS"><span class="sc-dsXzNU dPrSxx"><i>ApiKeyAuth</i></span></span></div></div><h5 class="sc-iqAclL eONCmm">Request Body schema: <span class="sc-cBoqAE eKyrDP">application/json</span></h5><div class="sc-iJCRrE sc-ciSkZP jCdxGr QGruV"><p>The event payload sent by the API.</p>
</div><table class="sc-hHEiqL VCQHZ"><tbody><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="created_at"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">created_at</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">integer</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The Unix timestamp (in seconds) of when the model response was interrupted.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="id"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">id</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The unique ID of the event.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT sc-gSYDnn iwcKgn cAqMTE hTttpy" kind="field" title="data"><span class="sc-iemWCZ bcnRwz"></span><button aria-label="expand properties"><span class="property-name">data</span><svg class="sc-dIsUp hGHhhO" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">object</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>Event data payload.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="object"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">object</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div><div><span class="sc-laZMeE jWaWWE"> <!-- -->Value<!-- -->:</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"event"</span> </div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The object of the event. Always <code>event</code>.</p>
</div></div></div></td></tr><tr class="last "><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="type"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">type</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div><div><span class="sc-laZMeE jWaWWE"> <!-- -->Value<!-- -->:</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"response.incomplete"</span> </div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The type of the event. Always <code>response.incomplete</code>.</p>
</div></div></div></td></tr></tbody></table><div><h3 class="sc-fIxmyt DvFer">Responses</h3><div><button class="sc-htmcrh jUGDyD" disabled=""><strong class="sc-fWWYYk cMoEZ">200<!-- --> </strong><span class="sc-jcwpoC eDjFAZ"><p>Return a 200 status code to acknowledge receipt of the event. Non-200
status codes will be retried.</p>
</span></button></div></div></div><div class="sc-jSFjdj sc-gKAaRy gBjRyf gcushC"><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Request samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="react-tabs-284" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-285" tabindex="0" data-rttab="true">Payload</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-285" aria-labelledby="react-tabs-284"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-bBjRSN kQSIAz">application/json</div></div><div class="sc-jgPyTC dSaTNC"><div class="sc-jNnpgg esZIbL"><div class="sc-giAqHp hMPeqJ"><button><div class="sc-carFqZ UksDl">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iJCRrE jCdxGr sc-dPaNzc gyljjx"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"created_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"id"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"object"</span>: <span class="token string">"event"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"type"</span>: <span class="token string">"response.incomplete"</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="operation/ListContainers" data-section-id="operation/ListContainers" class="sc-eCApnc liLqNm"><div data-section-id="operation/ListContainers" id="operation/ListContainers" class="sc-iCoGMd gLxhOh"><div class="sc-hKFxyN juinod"><h2 class="sc-pNWdM eftmgB"><a class="sc-crzoAE iUxAWq" href="#operation/ListContainers" aria-label="operation/ListContainers"></a>List Containers<!-- --> </h2><div class="sc-iGkqmO hCTIhr"><div class="sc-iJCRrE sc-ciSkZP jCdxGr QGruV"><p>Lists containers.</p>
</div></div><div class="sc-fcmMJX cvfxAX"><div class="sc-jUfyBS bhDyou"><h5 class="sc-iqAclL sc-fuISkM eONCmm hZIgic">Authorizations:</h5><svg class="sc-dIsUp iPqByX" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jQAxuV ccffaZ"><span class="sc-daBunf fcvuS"><span class="sc-dsXzNU dPrSxx"><i>ApiKeyAuth</i></span></span></div></div><div><h5 class="sc-iqAclL eONCmm">query<!-- --> Parameters</h5><table class="sc-hHEiqL VCQHZ"><tbody><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="limit"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">limit</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">integer</span></div><div><span class="sc-laZMeE jWaWWE"> <!-- -->Default:<!-- --> </span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">20</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="order"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">order</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div><div><span class="sc-laZMeE jWaWWE"> <!-- -->Default:<!-- --> </span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"desc"</span></div><div><span class="sc-laZMeE jWaWWE"> <!-- -->Enum<!-- -->:</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"asc"</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"desc"</span> </div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>Sort order by the <code>created_at</code> timestamp of the objects. <code>asc</code> for ascending order and <code>desc</code> for descending order.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="after"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">after</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>A cursor for use in pagination. <code>after</code> is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list.</p>
</div></div></div></td></tr><tr class="last "><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="name"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">name</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>Filter results by container name.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-fIxmyt DvFer">Responses</h3><div><button class="sc-htmcrh lbYftx"><svg class="sc-dIsUp dqYXmg" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-fWWYYk cMoEZ">200<!-- --> </strong><span class="sc-jcwpoC eDjFAZ"><p>Success</p>
</span></button></div></div></div><div class="sc-jSFjdj sc-gKAaRy gBjRyf gcushC"><div class="sc-EZqKI fWsqvQ"><button class="sc-eEVmNe ilvUMs"><span type="get" class="sc-fmdNqN ihNycv http-verb get">get</span><span class="sc-jXcxbT fCEUju">/containers</span><svg class="sc-dIsUp bRmrKA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ljsmAU flIrdF"><div class="sc-jlZJtj fQkroN"><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div><div tabindex="0" role="button"><div class="sc-dTSzeu dfUAUz"><span>https://api.openai.com/v1</span>/containers</div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Response samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-286" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-287" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-287" aria-labelledby="react-tabs-286"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-bBjRSN kQSIAz">application/json</div></div><div class="sc-jgPyTC dSaTNC"><div class="sc-jNnpgg esZIbL"><div class="sc-giAqHp hMPeqJ"><button><div class="sc-carFqZ UksDl">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iJCRrE jCdxGr sc-dPaNzc gyljjx"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"object"</span>: <span class="token string">"list"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"object"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"created_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"status"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"last_active_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"expires_after"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"anchor"</span>: <span class="token string">"last_active_at"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"minutes"</span>: <span class="token number">0</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"memory_limit"</span>: <span class="token string">"1g"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"network_policy"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <span class="token string">"allowlist"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"allowed_domains"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><span class="token string">"string"</span></div></li></ul><span class="token punctuation">]</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"first_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"last_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"has_more"</span>: <span class="token boolean">true</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="operation/CreateContainer" data-section-id="operation/CreateContainer" class="sc-eCApnc liLqNm"><div data-section-id="operation/CreateContainer" id="operation/CreateContainer" class="sc-iCoGMd gLxhOh"><div class="sc-hKFxyN juinod"><h2 class="sc-pNWdM eftmgB"><a class="sc-crzoAE iUxAWq" href="#operation/CreateContainer" aria-label="operation/CreateContainer"></a>Create Container<!-- --> </h2><div class="sc-iGkqmO hCTIhr"><div class="sc-iJCRrE sc-ciSkZP jCdxGr QGruV"><p>Creates a container.</p>
</div></div><div class="sc-fcmMJX cvfxAX"><div class="sc-jUfyBS bhDyou"><h5 class="sc-iqAclL sc-fuISkM eONCmm hZIgic">Authorizations:</h5><svg class="sc-dIsUp iPqByX" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jQAxuV ccffaZ"><span class="sc-daBunf fcvuS"><span class="sc-dsXzNU dPrSxx"><i>ApiKeyAuth</i></span></span></div></div><h5 class="sc-iqAclL eONCmm">Request Body schema: <span class="sc-cBoqAE eKyrDP">application/json</span></h5><div class="sc-iJCRrE sc-ciSkZP jCdxGr QGruV"></div><table class="sc-hHEiqL VCQHZ"><tbody><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="name"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">name</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>Name of the container to create.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="file_ids"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">file_ids</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa">Array of </span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">strings</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>IDs of files to copy to the container.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT sc-gSYDnn iwcKgn cAqMTE hTttpy" kind="field" title="expires_after"><span class="sc-iemWCZ bcnRwz"></span><button aria-label="expand properties"><span class="property-name">expires_after</span><svg class="sc-dIsUp hGHhhO" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">object</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>Container expiration time in seconds relative to the 'anchor' time.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT sc-gSYDnn iwcKgn cAqMTE hTttpy" kind="field" title="skills"><span class="sc-iemWCZ bcnRwz"></span><button aria-label="expand properties"><span class="property-name">skills</span><svg class="sc-dIsUp hGHhhO" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa">Array of </span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">any</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>An optional list of skills referenced by id or inline data.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="memory_limit"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">memory_limit</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div><div><span class="sc-laZMeE jWaWWE"> <!-- -->Enum<!-- -->:</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"1g"</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"4g"</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"16g"</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"64g"</span> </div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>Optional memory limit for the container. Defaults to "1g".</p>
</div></div></div></td></tr><tr class="last "><td class="sc-hBMUJo sc-fFSPTT sc-gSYDnn iwcKgn cAqMTE hTttpy" kind="field" title="network_policy"><span class="sc-iemWCZ bcnRwz"></span><button aria-label="expand properties"><span class="property-name">network_policy</span><svg class="sc-dIsUp hGHhhO" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">any</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>Network access policy for the container.</p>
</div></div></div></td></tr></tbody></table><div><h3 class="sc-fIxmyt DvFer">Responses</h3><div><button class="sc-htmcrh lbYftx"><svg class="sc-dIsUp dqYXmg" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-fWWYYk cMoEZ">200<!-- --> </strong><span class="sc-jcwpoC eDjFAZ"><p>Success</p>
</span></button></div></div></div><div class="sc-jSFjdj sc-gKAaRy gBjRyf gcushC"><div class="sc-EZqKI fWsqvQ"><button class="sc-eEVmNe ilvUMs"><span type="post" class="sc-fmdNqN ldMUmp http-verb post">post</span><span class="sc-jXcxbT fCEUju">/containers</span><svg class="sc-dIsUp bRmrKA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ljsmAU flIrdF"><div class="sc-jlZJtj fQkroN"><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div><div tabindex="0" role="button"><div class="sc-dTSzeu dfUAUz"><span>https://api.openai.com/v1</span>/containers</div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Request samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="react-tabs-288" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-289" tabindex="0" data-rttab="true">Payload</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-289" aria-labelledby="react-tabs-288"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-bBjRSN kQSIAz">application/json</div></div><div class="sc-jgPyTC dSaTNC"><div class="sc-jNnpgg esZIbL"><div class="sc-giAqHp hMPeqJ"><button><div class="sc-carFqZ UksDl">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iJCRrE jCdxGr sc-dPaNzc gyljjx"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"file_ids"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><span class="token string">"string"</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"expires_after"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"anchor"</span>: <span class="token string">"last_active_at"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"minutes"</span>: <span class="token number">0</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"skills"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <span class="token string">"skill_reference"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"skill_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"version"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"memory_limit"</span>: <span class="token string">"1g"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"network_policy"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <span class="token string">"disabled"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Response samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-290" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-291" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-291" aria-labelledby="react-tabs-290"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-bBjRSN kQSIAz">application/json</div></div><div class="sc-jgPyTC dSaTNC"><div class="sc-jNnpgg esZIbL"><div class="sc-giAqHp hMPeqJ"><button><div class="sc-carFqZ UksDl">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iJCRrE jCdxGr sc-dPaNzc gyljjx"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"object"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"created_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"last_active_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"expires_after"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"anchor"</span>: <span class="token string">"last_active_at"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"minutes"</span>: <span class="token number">0</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"memory_limit"</span>: <span class="token string">"1g"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"network_policy"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <span class="token string">"allowlist"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"allowed_domains"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><span class="token string">"string"</span></div></li></ul><span class="token punctuation">]</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="operation/RetrieveContainer" data-section-id="operation/RetrieveContainer" class="sc-eCApnc liLqNm"><div data-section-id="operation/RetrieveContainer" id="operation/RetrieveContainer" class="sc-iCoGMd gLxhOh"><div class="sc-hKFxyN juinod"><h2 class="sc-pNWdM eftmgB"><a class="sc-crzoAE iUxAWq" href="#operation/RetrieveContainer" aria-label="operation/RetrieveContainer"></a>Retrieve Container<!-- --> </h2><div class="sc-iGkqmO hCTIhr"><div class="sc-iJCRrE sc-ciSkZP jCdxGr QGruV"><p>Retrieves a container.</p>
</div></div><div class="sc-fcmMJX cvfxAX"><div class="sc-jUfyBS bhDyou"><h5 class="sc-iqAclL sc-fuISkM eONCmm hZIgic">Authorizations:</h5><svg class="sc-dIsUp iPqByX" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jQAxuV ccffaZ"><span class="sc-daBunf fcvuS"><span class="sc-dsXzNU dPrSxx"><i>ApiKeyAuth</i></span></span></div></div><div><h5 class="sc-iqAclL eONCmm">path<!-- --> Parameters</h5><table class="sc-hHEiqL VCQHZ"><tbody><tr class="last "><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="container_id"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">container_id</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div></div></div></td></tr></tbody></table></div><div><h3 class="sc-fIxmyt DvFer">Responses</h3><div><button class="sc-htmcrh lbYftx"><svg class="sc-dIsUp dqYXmg" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-fWWYYk cMoEZ">200<!-- --> </strong><span class="sc-jcwpoC eDjFAZ"><p>Success</p>
</span></button></div></div></div><div class="sc-jSFjdj sc-gKAaRy gBjRyf gcushC"><div class="sc-EZqKI fWsqvQ"><button class="sc-eEVmNe ilvUMs"><span type="get" class="sc-fmdNqN ihNycv http-verb get">get</span><span class="sc-jXcxbT fCEUju">/containers/{container_id}</span><svg class="sc-dIsUp bRmrKA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ljsmAU flIrdF"><div class="sc-jlZJtj fQkroN"><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div><div tabindex="0" role="button"><div class="sc-dTSzeu dfUAUz"><span>https://api.openai.com/v1</span>/containers/{container_id}</div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Response samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-292" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-293" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-293" aria-labelledby="react-tabs-292"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-bBjRSN kQSIAz">application/json</div></div><div class="sc-jgPyTC dSaTNC"><div class="sc-jNnpgg esZIbL"><div class="sc-giAqHp hMPeqJ"><button><div class="sc-carFqZ UksDl">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iJCRrE jCdxGr sc-dPaNzc gyljjx"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"object"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"created_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"last_active_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"expires_after"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"anchor"</span>: <span class="token string">"last_active_at"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"minutes"</span>: <span class="token number">0</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"memory_limit"</span>: <span class="token string">"1g"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"network_policy"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <span class="token string">"allowlist"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"allowed_domains"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><span class="token string">"string"</span></div></li></ul><span class="token punctuation">]</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="operation/DeleteContainer" data-section-id="operation/DeleteContainer" class="sc-eCApnc liLqNm"><div data-section-id="operation/DeleteContainer" id="operation/DeleteContainer" class="sc-iCoGMd gLxhOh"><div class="sc-hKFxyN juinod"><h2 class="sc-pNWdM eftmgB"><a class="sc-crzoAE iUxAWq" href="#operation/DeleteContainer" aria-label="operation/DeleteContainer"></a>Delete Container<!-- --> </h2><div class="sc-iGkqmO hCTIhr"><div class="sc-iJCRrE sc-ciSkZP jCdxGr QGruV"><p>Delete a container.</p>
</div></div><div class="sc-fcmMJX cvfxAX"><div class="sc-jUfyBS bhDyou"><h5 class="sc-iqAclL sc-fuISkM eONCmm hZIgic">Authorizations:</h5><svg class="sc-dIsUp iPqByX" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jQAxuV ccffaZ"><span class="sc-daBunf fcvuS"><span class="sc-dsXzNU dPrSxx"><i>ApiKeyAuth</i></span></span></div></div><div><h5 class="sc-iqAclL eONCmm">path<!-- --> Parameters</h5><table class="sc-hHEiqL VCQHZ"><tbody><tr class="last "><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="container_id"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">container_id</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The ID of the container to delete.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-fIxmyt DvFer">Responses</h3><div><button class="sc-htmcrh jUGDyD" disabled=""><strong class="sc-fWWYYk cMoEZ">200<!-- --> </strong><span class="sc-jcwpoC eDjFAZ"><p>OK</p>
</span></button></div></div></div><div class="sc-jSFjdj sc-gKAaRy gBjRyf gcushC"><div class="sc-EZqKI fWsqvQ"><button class="sc-eEVmNe ilvUMs"><span type="delete" class="sc-fmdNqN bJzUtf http-verb delete">delete</span><span class="sc-jXcxbT fCEUju">/containers/{container_id}</span><svg class="sc-dIsUp bRmrKA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ljsmAU flIrdF"><div class="sc-jlZJtj fQkroN"><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div><div tabindex="0" role="button"><div class="sc-dTSzeu dfUAUz"><span>https://api.openai.com/v1</span>/containers/{container_id}</div></div></div></div></div></div></div></div><div id="operation/CreateContainerFile" data-section-id="operation/CreateContainerFile" class="sc-eCApnc liLqNm"><div data-section-id="operation/CreateContainerFile" id="operation/CreateContainerFile" class="sc-iCoGMd gLxhOh"><div class="sc-hKFxyN juinod"><h2 class="sc-pNWdM eftmgB"><a class="sc-crzoAE iUxAWq" href="#operation/CreateContainerFile" aria-label="operation/CreateContainerFile"></a>Create a Container File
You can send either a multipart/form-data request with the raw file content, or a JSON request with a file ID.
<!-- --> </h2><div class="sc-iGkqmO hCTIhr"><div class="sc-iJCRrE sc-ciSkZP jCdxGr QGruV"><p>Creates a container file.</p>
</div></div><div class="sc-fcmMJX cvfxAX"><div class="sc-jUfyBS bhDyou"><h5 class="sc-iqAclL sc-fuISkM eONCmm hZIgic">Authorizations:</h5><svg class="sc-dIsUp iPqByX" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jQAxuV ccffaZ"><span class="sc-daBunf fcvuS"><span class="sc-dsXzNU dPrSxx"><i>ApiKeyAuth</i></span></span></div></div><div><h5 class="sc-iqAclL eONCmm">path<!-- --> Parameters</h5><table class="sc-hHEiqL VCQHZ"><tbody><tr class="last "><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="container_id"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">container_id</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div></div></div></td></tr></tbody></table></div><h5 class="sc-iqAclL eONCmm">Request Body schema: <div class="sc-hiKfDv sc-gXfVKN bycQNU dhIYNk"><svg class="sc-jJMGnK hzcSs" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option selected="" value="application/json">application/json</option><option value="multipart/form-data">multipart/form-data</option></select><label>application/json</label></div></h5><div class="sc-iJCRrE sc-ciSkZP jCdxGr QGruV"></div><table class="sc-hHEiqL VCQHZ"><tbody><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="file_id"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">file_id</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>Name of the file to create.</p>
</div></div></div></td></tr><tr class="last "><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="file"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">file</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa"> <!-- --><<!-- -->binary<!-- -->><!-- --> </span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The File object (not file name) to be uploaded.</p>
</div></div></div></td></tr></tbody></table><div><h3 class="sc-fIxmyt DvFer">Responses</h3><div><button class="sc-htmcrh lbYftx"><svg class="sc-dIsUp dqYXmg" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-fWWYYk cMoEZ">200<!-- --> </strong><span class="sc-jcwpoC eDjFAZ"><p>Success</p>
</span></button></div></div></div><div class="sc-jSFjdj sc-gKAaRy gBjRyf gcushC"><div class="sc-EZqKI fWsqvQ"><button class="sc-eEVmNe ilvUMs"><span type="post" class="sc-fmdNqN ldMUmp http-verb post">post</span><span class="sc-jXcxbT fCEUju">/containers/{container_id}/files</span><svg class="sc-dIsUp bRmrKA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ljsmAU flIrdF"><div class="sc-jlZJtj fQkroN"><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div><div tabindex="0" role="button"><div class="sc-dTSzeu dfUAUz"><span>https://api.openai.com/v1</span>/containers/{container_id}/files</div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Request samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="react-tabs-294" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-295" tabindex="0" data-rttab="true">Payload</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-295" aria-labelledby="react-tabs-294"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-hiKfDv sc-khIgEk bycQNU hLNtis"><svg class="sc-jJMGnK gVpQmv" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option selected="" value="application/json">application/json</option><option value="multipart/form-data">multipart/form-data</option></select><label>application/json</label></div></div><div class="sc-jgPyTC dSaTNC"><div class="sc-jNnpgg esZIbL"><div class="sc-giAqHp hMPeqJ"><button><div class="sc-carFqZ UksDl">Copy</div></button></div><div class="sc-iJCRrE jCdxGr sc-dPaNzc gyljjx"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"file_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"file"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Response samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-296" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-297" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-297" aria-labelledby="react-tabs-296"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-bBjRSN kQSIAz">application/json</div></div><div class="sc-jgPyTC dSaTNC"><div class="sc-jNnpgg esZIbL"><div class="sc-giAqHp hMPeqJ"><button><div class="sc-carFqZ UksDl">Copy</div></button></div><div class="sc-iJCRrE jCdxGr sc-dPaNzc gyljjx"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"object"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"container_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"created_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"bytes"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"path"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"source"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="operation/ListContainerFiles" data-section-id="operation/ListContainerFiles" class="sc-eCApnc liLqNm"><div data-section-id="operation/ListContainerFiles" id="operation/ListContainerFiles" class="sc-iCoGMd gLxhOh"><div class="sc-hKFxyN juinod"><h2 class="sc-pNWdM eftmgB"><a class="sc-crzoAE iUxAWq" href="#operation/ListContainerFiles" aria-label="operation/ListContainerFiles"></a>List Container files<!-- --> </h2><div class="sc-iGkqmO hCTIhr"><div class="sc-iJCRrE sc-ciSkZP jCdxGr QGruV"><p>Lists container files.</p>
</div></div><div class="sc-fcmMJX cvfxAX"><div class="sc-jUfyBS bhDyou"><h5 class="sc-iqAclL sc-fuISkM eONCmm hZIgic">Authorizations:</h5><svg class="sc-dIsUp iPqByX" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jQAxuV ccffaZ"><span class="sc-daBunf fcvuS"><span class="sc-dsXzNU dPrSxx"><i>ApiKeyAuth</i></span></span></div></div><div><h5 class="sc-iqAclL eONCmm">path<!-- --> Parameters</h5><table class="sc-hHEiqL VCQHZ"><tbody><tr class="last "><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="container_id"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">container_id</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div></div></div></td></tr></tbody></table></div><div><h5 class="sc-iqAclL eONCmm">query<!-- --> Parameters</h5><table class="sc-hHEiqL VCQHZ"><tbody><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="limit"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">limit</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">integer</span></div><div><span class="sc-laZMeE jWaWWE"> <!-- -->Default:<!-- --> </span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">20</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="order"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">order</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div><div><span class="sc-laZMeE jWaWWE"> <!-- -->Default:<!-- --> </span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"desc"</span></div><div><span class="sc-laZMeE jWaWWE"> <!-- -->Enum<!-- -->:</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"asc"</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"desc"</span> </div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>Sort order by the <code>created_at</code> timestamp of the objects. <code>asc</code> for ascending order and <code>desc</code> for descending order.</p>
</div></div></div></td></tr><tr class="last "><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="after"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">after</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>A cursor for use in pagination. <code>after</code> is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-fIxmyt DvFer">Responses</h3><div><button class="sc-htmcrh lbYftx"><svg class="sc-dIsUp dqYXmg" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-fWWYYk cMoEZ">200<!-- --> </strong><span class="sc-jcwpoC eDjFAZ"><p>Success</p>
</span></button></div></div></div><div class="sc-jSFjdj sc-gKAaRy gBjRyf gcushC"><div class="sc-EZqKI fWsqvQ"><button class="sc-eEVmNe ilvUMs"><span type="get" class="sc-fmdNqN ihNycv http-verb get">get</span><span class="sc-jXcxbT fCEUju">/containers/{container_id}/files</span><svg class="sc-dIsUp bRmrKA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ljsmAU flIrdF"><div class="sc-jlZJtj fQkroN"><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div><div tabindex="0" role="button"><div class="sc-dTSzeu dfUAUz"><span>https://api.openai.com/v1</span>/containers/{container_id}/files</div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Response samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-298" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-299" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-299" aria-labelledby="react-tabs-298"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-bBjRSN kQSIAz">application/json</div></div><div class="sc-jgPyTC dSaTNC"><div class="sc-jNnpgg esZIbL"><div class="sc-giAqHp hMPeqJ"><button><div class="sc-carFqZ UksDl">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iJCRrE jCdxGr sc-dPaNzc gyljjx"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"object"</span>: <span class="token string">"list"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"object"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"container_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"created_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"bytes"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"path"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"source"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"first_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"last_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"has_more"</span>: <span class="token boolean">true</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="operation/RetrieveContainerFile" data-section-id="operation/RetrieveContainerFile" class="sc-eCApnc liLqNm"><div data-section-id="operation/RetrieveContainerFile" id="operation/RetrieveContainerFile" class="sc-iCoGMd gLxhOh"><div class="sc-hKFxyN juinod"><h2 class="sc-pNWdM eftmgB"><a class="sc-crzoAE iUxAWq" href="#operation/RetrieveContainerFile" aria-label="operation/RetrieveContainerFile"></a>Retrieve Container File<!-- --> </h2><div class="sc-iGkqmO hCTIhr"><div class="sc-iJCRrE sc-ciSkZP jCdxGr QGruV"><p>Retrieves a container file.</p>
</div></div><div class="sc-fcmMJX cvfxAX"><div class="sc-jUfyBS bhDyou"><h5 class="sc-iqAclL sc-fuISkM eONCmm hZIgic">Authorizations:</h5><svg class="sc-dIsUp iPqByX" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jQAxuV ccffaZ"><span class="sc-daBunf fcvuS"><span class="sc-dsXzNU dPrSxx"><i>ApiKeyAuth</i></span></span></div></div><div><h5 class="sc-iqAclL eONCmm">path<!-- --> Parameters</h5><table class="sc-hHEiqL VCQHZ"><tbody><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="container_id"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">container_id</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div></div></div></td></tr><tr class="last "><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="file_id"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">file_id</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div></div></div></td></tr></tbody></table></div><div><h3 class="sc-fIxmyt DvFer">Responses</h3><div><button class="sc-htmcrh lbYftx"><svg class="sc-dIsUp dqYXmg" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-fWWYYk cMoEZ">200<!-- --> </strong><span class="sc-jcwpoC eDjFAZ"><p>Success</p>
</span></button></div></div></div><div class="sc-jSFjdj sc-gKAaRy gBjRyf gcushC"><div class="sc-EZqKI fWsqvQ"><button class="sc-eEVmNe ilvUMs"><span type="get" class="sc-fmdNqN ihNycv http-verb get">get</span><span class="sc-jXcxbT fCEUju">/containers/{container_id}/files/{file_id}</span><svg class="sc-dIsUp bRmrKA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ljsmAU flIrdF"><div class="sc-jlZJtj fQkroN"><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div><div tabindex="0" role="button"><div class="sc-dTSzeu dfUAUz"><span>https://api.openai.com/v1</span>/containers/{container_id}/files/{file_id}</div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Response samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-300" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-301" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-301" aria-labelledby="react-tabs-300"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-bBjRSN kQSIAz">application/json</div></div><div class="sc-jgPyTC dSaTNC"><div class="sc-jNnpgg esZIbL"><div class="sc-giAqHp hMPeqJ"><button><div class="sc-carFqZ UksDl">Copy</div></button></div><div class="sc-iJCRrE jCdxGr sc-dPaNzc gyljjx"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"object"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"container_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"created_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"bytes"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"path"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"source"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="operation/DeleteContainerFile" data-section-id="operation/DeleteContainerFile" class="sc-eCApnc liLqNm"><div data-section-id="operation/DeleteContainerFile" id="operation/DeleteContainerFile" class="sc-iCoGMd gLxhOh"><div class="sc-hKFxyN juinod"><h2 class="sc-pNWdM eftmgB"><a class="sc-crzoAE iUxAWq" href="#operation/DeleteContainerFile" aria-label="operation/DeleteContainerFile"></a>Delete Container File<!-- --> </h2><div class="sc-iGkqmO hCTIhr"><div class="sc-iJCRrE sc-ciSkZP jCdxGr QGruV"><p>Delete a container file.</p>
</div></div><div class="sc-fcmMJX cvfxAX"><div class="sc-jUfyBS bhDyou"><h5 class="sc-iqAclL sc-fuISkM eONCmm hZIgic">Authorizations:</h5><svg class="sc-dIsUp iPqByX" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jQAxuV ccffaZ"><span class="sc-daBunf fcvuS"><span class="sc-dsXzNU dPrSxx"><i>ApiKeyAuth</i></span></span></div></div><div><h5 class="sc-iqAclL eONCmm">path<!-- --> Parameters</h5><table class="sc-hHEiqL VCQHZ"><tbody><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="container_id"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">container_id</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div></div></div></td></tr><tr class="last "><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="file_id"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">file_id</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div></div></div></td></tr></tbody></table></div><div><h3 class="sc-fIxmyt DvFer">Responses</h3><div><button class="sc-htmcrh jUGDyD" disabled=""><strong class="sc-fWWYYk cMoEZ">200<!-- --> </strong><span class="sc-jcwpoC eDjFAZ"><p>OK</p>
</span></button></div></div></div><div class="sc-jSFjdj sc-gKAaRy gBjRyf gcushC"><div class="sc-EZqKI fWsqvQ"><button class="sc-eEVmNe ilvUMs"><span type="delete" class="sc-fmdNqN bJzUtf http-verb delete">delete</span><span class="sc-jXcxbT fCEUju">/containers/{container_id}/files/{file_id}</span><svg class="sc-dIsUp bRmrKA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ljsmAU flIrdF"><div class="sc-jlZJtj fQkroN"><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div><div tabindex="0" role="button"><div class="sc-dTSzeu dfUAUz"><span>https://api.openai.com/v1</span>/containers/{container_id}/files/{file_id}</div></div></div></div></div></div></div></div><div id="operation/RetrieveContainerFileContent" data-section-id="operation/RetrieveContainerFileContent" class="sc-eCApnc liLqNm"><div data-section-id="operation/RetrieveContainerFileContent" id="operation/RetrieveContainerFileContent" class="sc-iCoGMd gLxhOh"><div class="sc-hKFxyN juinod"><h2 class="sc-pNWdM eftmgB"><a class="sc-crzoAE iUxAWq" href="#operation/RetrieveContainerFileContent" aria-label="operation/RetrieveContainerFileContent"></a>Retrieve Container File Content<!-- --> </h2><div class="sc-iGkqmO hCTIhr"><div class="sc-iJCRrE sc-ciSkZP jCdxGr QGruV"><p>Retrieves a container file content.</p>
</div></div><div class="sc-fcmMJX cvfxAX"><div class="sc-jUfyBS bhDyou"><h5 class="sc-iqAclL sc-fuISkM eONCmm hZIgic">Authorizations:</h5><svg class="sc-dIsUp iPqByX" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jQAxuV ccffaZ"><span class="sc-daBunf fcvuS"><span class="sc-dsXzNU dPrSxx"><i>ApiKeyAuth</i></span></span></div></div><div><h5 class="sc-iqAclL eONCmm">path<!-- --> Parameters</h5><table class="sc-hHEiqL VCQHZ"><tbody><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="container_id"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">container_id</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div></div></div></td></tr><tr class="last "><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="file_id"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">file_id</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div></div></div></td></tr></tbody></table></div><div><h3 class="sc-fIxmyt DvFer">Responses</h3><div><button class="sc-htmcrh jUGDyD" disabled=""><strong class="sc-fWWYYk cMoEZ">200<!-- --> </strong><span class="sc-jcwpoC eDjFAZ"><p>Success</p>
</span></button></div></div></div><div class="sc-jSFjdj sc-gKAaRy gBjRyf gcushC"><div class="sc-EZqKI fWsqvQ"><button class="sc-eEVmNe ilvUMs"><span type="get" class="sc-fmdNqN ihNycv http-verb get">get</span><span class="sc-jXcxbT fCEUju">/containers/{container_id}/files/{file_id}/content</span><svg class="sc-dIsUp bRmrKA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ljsmAU flIrdF"><div class="sc-jlZJtj fQkroN"><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div><div tabindex="0" role="button"><div class="sc-dTSzeu dfUAUz"><span>https://api.openai.com/v1</span>/containers/{container_id}/files/{file_id}/content</div></div></div></div></div></div></div></div><div id="operation/admin-api-keys-list" data-section-id="operation/admin-api-keys-list" class="sc-eCApnc liLqNm"><div data-section-id="operation/admin-api-keys-list" id="operation/admin-api-keys-list" class="sc-iCoGMd gLxhOh"><div class="sc-hKFxyN juinod"><h2 class="sc-pNWdM eftmgB"><a class="sc-crzoAE iUxAWq" href="#operation/admin-api-keys-list" aria-label="operation/admin-api-keys-list"></a>List organization API keys<!-- --> </h2><div class="sc-iGkqmO hCTIhr"><div class="sc-iJCRrE sc-ciSkZP jCdxGr QGruV"><p>Retrieve a paginated list of organization admin API keys.</p>
</div></div><div class="sc-fcmMJX cvfxAX"><div class="sc-jUfyBS bhDyou"><h5 class="sc-iqAclL sc-fuISkM eONCmm hZIgic">Authorizations:</h5><svg class="sc-dIsUp iPqByX" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jQAxuV ccffaZ"><span class="sc-daBunf fcvuS"><span class="sc-dsXzNU dPrSxx"><i>ApiKeyAuth</i></span></span></div></div><div><h5 class="sc-iqAclL eONCmm">query<!-- --> Parameters</h5><table class="sc-hHEiqL VCQHZ"><tbody><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="after"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">after</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string or null</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>Return keys with IDs that come after this ID in the pagination order.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="order"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">order</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div><div><span class="sc-laZMeE jWaWWE"> <!-- -->Default:<!-- --> </span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"asc"</span></div><div><span class="sc-laZMeE jWaWWE"> <!-- -->Enum<!-- -->:</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"asc"</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"desc"</span> </div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>Order results by creation time, ascending or descending.</p>
</div></div></div></td></tr><tr class="last "><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="limit"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">limit</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">integer</span></div><div><span class="sc-laZMeE jWaWWE"> <!-- -->Default:<!-- --> </span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">20</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>Maximum number of keys to return.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-fIxmyt DvFer">Responses</h3><div><button class="sc-htmcrh lbYftx"><svg class="sc-dIsUp dqYXmg" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-fWWYYk cMoEZ">200<!-- --> </strong><span class="sc-jcwpoC eDjFAZ"><p>A list of organization API keys.</p>
</span></button></div></div></div><div class="sc-jSFjdj sc-gKAaRy gBjRyf gcushC"><div class="sc-EZqKI fWsqvQ"><button class="sc-eEVmNe ilvUMs"><span type="get" class="sc-fmdNqN ihNycv http-verb get">get</span><span class="sc-jXcxbT fCEUju">/organization/admin_api_keys</span><svg class="sc-dIsUp bRmrKA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ljsmAU flIrdF"><div class="sc-jlZJtj fQkroN"><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div><div tabindex="0" role="button"><div class="sc-dTSzeu dfUAUz"><span>https://api.openai.com/v1</span>/organization/admin_api_keys</div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Response samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-302" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-303" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-303" aria-labelledby="react-tabs-302"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-bBjRSN kQSIAz">application/json</div></div><div class="sc-jgPyTC dSaTNC"><div class="sc-jNnpgg esZIbL"><div class="sc-giAqHp hMPeqJ"><button><div class="sc-carFqZ UksDl">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iJCRrE jCdxGr sc-dPaNzc gyljjx"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"object"</span>: <span class="token string">"list"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"object"</span>: <span class="token string">"organization.admin_api_key"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"id"</span>: <span class="token string">"key_abc"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"name"</span>: <span class="token string">"Administration Key"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"redacted_value"</span>: <span class="token string">"sk-admin...def"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"value"</span>: <span class="token string">"sk-admin-1234abcd"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"created_at"</span>: <span class="token number">1711471533</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"last_used_at"</span>: <span class="token number">1711471534</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"owner"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <span class="token string">"user"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"object"</span>: <span class="token string">"organization.user"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"id"</span>: <span class="token string">"sa_456"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"name"</span>: <span class="token string">"My Service Account"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"created_at"</span>: <span class="token number">1711471533</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"role"</span>: <span class="token string">"owner"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"has_more"</span>: <span class="token boolean">false</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"first_id"</span>: <span class="token string">"key_abc"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"last_id"</span>: <span class="token string">"key_xyz"</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="operation/admin-api-keys-create" data-section-id="operation/admin-api-keys-create" class="sc-eCApnc liLqNm"><div data-section-id="operation/admin-api-keys-create" id="operation/admin-api-keys-create" class="sc-iCoGMd gLxhOh"><div class="sc-hKFxyN juinod"><h2 class="sc-pNWdM eftmgB"><a class="sc-crzoAE iUxAWq" href="#operation/admin-api-keys-create" aria-label="operation/admin-api-keys-create"></a>Create an organization admin API key<!-- --> </h2><div class="sc-iGkqmO hCTIhr"><div class="sc-iJCRrE sc-ciSkZP jCdxGr QGruV"><p>Create a new admin-level API key for the organization.</p>
</div></div><div class="sc-fcmMJX cvfxAX"><div class="sc-jUfyBS bhDyou"><h5 class="sc-iqAclL sc-fuISkM eONCmm hZIgic">Authorizations:</h5><svg class="sc-dIsUp iPqByX" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jQAxuV ccffaZ"><span class="sc-daBunf fcvuS"><span class="sc-dsXzNU dPrSxx"><i>ApiKeyAuth</i></span></span></div></div><h5 class="sc-iqAclL eONCmm">Request Body schema: <span class="sc-cBoqAE eKyrDP">application/json</span></h5><div class="sc-iJCRrE sc-ciSkZP jCdxGr QGruV"></div><table class="sc-hHEiqL VCQHZ"><tbody><tr class="last "><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="name"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">name</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div></div></div></td></tr></tbody></table><div><h3 class="sc-fIxmyt DvFer">Responses</h3><div><button class="sc-htmcrh lbYftx"><svg class="sc-dIsUp dqYXmg" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-fWWYYk cMoEZ">200<!-- --> </strong><span class="sc-jcwpoC eDjFAZ"><p>The newly created admin API key.</p>
</span></button></div></div></div><div class="sc-jSFjdj sc-gKAaRy gBjRyf gcushC"><div class="sc-EZqKI fWsqvQ"><button class="sc-eEVmNe ilvUMs"><span type="post" class="sc-fmdNqN ldMUmp http-verb post">post</span><span class="sc-jXcxbT fCEUju">/organization/admin_api_keys</span><svg class="sc-dIsUp bRmrKA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ljsmAU flIrdF"><div class="sc-jlZJtj fQkroN"><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div><div tabindex="0" role="button"><div class="sc-dTSzeu dfUAUz"><span>https://api.openai.com/v1</span>/organization/admin_api_keys</div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Request samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="react-tabs-304" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-305" tabindex="0" data-rttab="true">Payload</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-305" aria-labelledby="react-tabs-304"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-bBjRSN kQSIAz">application/json</div></div><div class="sc-jgPyTC dSaTNC"><div class="sc-jNnpgg esZIbL"><div class="sc-giAqHp hMPeqJ"><button><div class="sc-carFqZ UksDl">Copy</div></button></div><div class="sc-iJCRrE jCdxGr sc-dPaNzc gyljjx"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">"New Admin Key"</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Response samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-306" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-307" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-307" aria-labelledby="react-tabs-306"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-bBjRSN kQSIAz">application/json</div></div><div class="sc-jgPyTC dSaTNC"><div class="sc-jNnpgg esZIbL"><div class="sc-giAqHp hMPeqJ"><button><div class="sc-carFqZ UksDl">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iJCRrE jCdxGr sc-dPaNzc gyljjx"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"object"</span>: <span class="token string">"organization.admin_api_key"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">"key_abc"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">"Administration Key"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"redacted_value"</span>: <span class="token string">"sk-admin...def"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"value"</span>: <span class="token string">"sk-admin-1234abcd"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"created_at"</span>: <span class="token number">1711471533</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"last_used_at"</span>: <span class="token number">1711471534</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"owner"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <span class="token string">"user"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"object"</span>: <span class="token string">"organization.user"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"id"</span>: <span class="token string">"sa_456"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"name"</span>: <span class="token string">"My Service Account"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"created_at"</span>: <span class="token number">1711471533</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"role"</span>: <span class="token string">"owner"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="operation/admin-api-keys-get" data-section-id="operation/admin-api-keys-get" class="sc-eCApnc liLqNm"><div data-section-id="operation/admin-api-keys-get" id="operation/admin-api-keys-get" class="sc-iCoGMd gLxhOh"><div class="sc-hKFxyN juinod"><h2 class="sc-pNWdM eftmgB"><a class="sc-crzoAE iUxAWq" href="#operation/admin-api-keys-get" aria-label="operation/admin-api-keys-get"></a>Retrieve a single organization API key<!-- --> </h2><div class="sc-iGkqmO hCTIhr"><div class="sc-iJCRrE sc-ciSkZP jCdxGr QGruV"><p>Get details for a specific organization API key by its ID.</p>
</div></div><div class="sc-fcmMJX cvfxAX"><div class="sc-jUfyBS bhDyou"><h5 class="sc-iqAclL sc-fuISkM eONCmm hZIgic">Authorizations:</h5><svg class="sc-dIsUp iPqByX" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jQAxuV ccffaZ"><span class="sc-daBunf fcvuS"><span class="sc-dsXzNU dPrSxx"><i>ApiKeyAuth</i></span></span></div></div><div><h5 class="sc-iqAclL eONCmm">path<!-- --> Parameters</h5><table class="sc-hHEiqL VCQHZ"><tbody><tr class="last "><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="key_id"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">key_id</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The ID of the API key.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-fIxmyt DvFer">Responses</h3><div><button class="sc-htmcrh lbYftx"><svg class="sc-dIsUp dqYXmg" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-fWWYYk cMoEZ">200<!-- --> </strong><span class="sc-jcwpoC eDjFAZ"><p>Details of the requested API key.</p>
</span></button></div></div></div><div class="sc-jSFjdj sc-gKAaRy gBjRyf gcushC"><div class="sc-EZqKI fWsqvQ"><button class="sc-eEVmNe ilvUMs"><span type="get" class="sc-fmdNqN ihNycv http-verb get">get</span><span class="sc-jXcxbT fCEUju">/organization/admin_api_keys/{key_id}</span><svg class="sc-dIsUp bRmrKA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ljsmAU flIrdF"><div class="sc-jlZJtj fQkroN"><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div><div tabindex="0" role="button"><div class="sc-dTSzeu dfUAUz"><span>https://api.openai.com/v1</span>/organization/admin_api_keys/{key_id}</div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Response samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-308" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-309" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-309" aria-labelledby="react-tabs-308"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-bBjRSN kQSIAz">application/json</div></div><div class="sc-jgPyTC dSaTNC"><div class="sc-jNnpgg esZIbL"><div class="sc-giAqHp hMPeqJ"><button><div class="sc-carFqZ UksDl">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iJCRrE jCdxGr sc-dPaNzc gyljjx"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"object"</span>: <span class="token string">"organization.admin_api_key"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">"key_abc"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">"Administration Key"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"redacted_value"</span>: <span class="token string">"sk-admin...def"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"value"</span>: <span class="token string">"sk-admin-1234abcd"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"created_at"</span>: <span class="token number">1711471533</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"last_used_at"</span>: <span class="token number">1711471534</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"owner"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <span class="token string">"user"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"object"</span>: <span class="token string">"organization.user"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"id"</span>: <span class="token string">"sa_456"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"name"</span>: <span class="token string">"My Service Account"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"created_at"</span>: <span class="token number">1711471533</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"role"</span>: <span class="token string">"owner"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="operation/admin-api-keys-delete" data-section-id="operation/admin-api-keys-delete" class="sc-eCApnc liLqNm"><div data-section-id="operation/admin-api-keys-delete" id="operation/admin-api-keys-delete" class="sc-iCoGMd gLxhOh"><div class="sc-hKFxyN juinod"><h2 class="sc-pNWdM eftmgB"><a class="sc-crzoAE iUxAWq" href="#operation/admin-api-keys-delete" aria-label="operation/admin-api-keys-delete"></a>Delete an organization admin API key<!-- --> </h2><div class="sc-iGkqmO hCTIhr"><div class="sc-iJCRrE sc-ciSkZP jCdxGr QGruV"><p>Delete the specified admin API key.</p>
</div></div><div class="sc-fcmMJX cvfxAX"><div class="sc-jUfyBS bhDyou"><h5 class="sc-iqAclL sc-fuISkM eONCmm hZIgic">Authorizations:</h5><svg class="sc-dIsUp iPqByX" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jQAxuV ccffaZ"><span class="sc-daBunf fcvuS"><span class="sc-dsXzNU dPrSxx"><i>ApiKeyAuth</i></span></span></div></div><div><h5 class="sc-iqAclL eONCmm">path<!-- --> Parameters</h5><table class="sc-hHEiqL VCQHZ"><tbody><tr class="last "><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="key_id"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">key_id</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The ID of the API key to be deleted.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-fIxmyt DvFer">Responses</h3><div><button class="sc-htmcrh lbYftx"><svg class="sc-dIsUp dqYXmg" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-fWWYYk cMoEZ">200<!-- --> </strong><span class="sc-jcwpoC eDjFAZ"><p>Confirmation that the API key was deleted.</p>
</span></button></div></div></div><div class="sc-jSFjdj sc-gKAaRy gBjRyf gcushC"><div class="sc-EZqKI fWsqvQ"><button class="sc-eEVmNe ilvUMs"><span type="delete" class="sc-fmdNqN bJzUtf http-verb delete">delete</span><span class="sc-jXcxbT fCEUju">/organization/admin_api_keys/{key_id}</span><svg class="sc-dIsUp bRmrKA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ljsmAU flIrdF"><div class="sc-jlZJtj fQkroN"><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div><div tabindex="0" role="button"><div class="sc-dTSzeu dfUAUz"><span>https://api.openai.com/v1</span>/organization/admin_api_keys/{key_id}</div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Response samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-310" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-311" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-311" aria-labelledby="react-tabs-310"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-bBjRSN kQSIAz">application/json</div></div><div class="sc-jgPyTC dSaTNC"><div class="sc-jNnpgg esZIbL"><div class="sc-giAqHp hMPeqJ"><button><div class="sc-carFqZ UksDl">Copy</div></button></div><div class="sc-iJCRrE jCdxGr sc-dPaNzc gyljjx"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">"key_abc"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"object"</span>: <span class="token string">"organization.admin_api_key.deleted"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"deleted"</span>: <span class="token boolean">true</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="operation/Getinputtokencounts" data-section-id="operation/Getinputtokencounts" class="sc-eCApnc liLqNm"><div data-section-id="operation/Getinputtokencounts" id="operation/Getinputtokencounts" class="sc-iCoGMd gLxhOh"><div class="sc-hKFxyN juinod"><h2 class="sc-pNWdM eftmgB"><a class="sc-crzoAE iUxAWq" href="#operation/Getinputtokencounts" aria-label="operation/Getinputtokencounts"></a>Returns input token counts of the request.
Returns an object with `object` set to `response.input_tokens` and an `input_tokens` count.<!-- --> </h2><div class="sc-fcmMJX cvfxAX"><div class="sc-jUfyBS bhDyou"><h5 class="sc-iqAclL sc-fuISkM eONCmm hZIgic">Authorizations:</h5><svg class="sc-dIsUp iPqByX" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jQAxuV ccffaZ"><span class="sc-daBunf fcvuS"><span class="sc-dsXzNU dPrSxx"><i>ApiKeyAuth</i></span></span></div></div><h5 class="sc-iqAclL eONCmm">Request Body schema: <div class="sc-hiKfDv sc-gXfVKN bycQNU dhIYNk"><svg class="sc-jJMGnK hzcSs" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option selected="" value="application/json">application/json</option><option value="application/x-www-form-urlencoded">application/x-www-form-urlencoded</option></select><label>application/json</label></div></h5><div class="sc-iJCRrE sc-ciSkZP jCdxGr QGruV"></div><table class="sc-hHEiqL VCQHZ"><tbody><tr class=""><td class="sc-hBMUJo sc-fFSPTT sc-gSYDnn iwcKgn cAqMTE hTttpy" kind="field" title="model"><span class="sc-iemWCZ bcnRwz"></span><button aria-label="expand properties"><span class="property-name">model</span><svg class="sc-dIsUp hGHhhO" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string or null</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT sc-gSYDnn iwcKgn cAqMTE hTttpy" kind="field" title="input"><span class="sc-iemWCZ bcnRwz"></span><button aria-label="expand properties"><span class="property-name">input</span><svg class="sc-dIsUp hGHhhO" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">(string or Array of InputItem (any)) or null</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT sc-gSYDnn iwcKgn cAqMTE hTttpy" kind="field" title="previous_response_id"><span class="sc-iemWCZ bcnRwz"></span><button aria-label="expand properties"><span class="property-name">previous_response_id</span><svg class="sc-dIsUp hGHhhO" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string or null</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT sc-gSYDnn iwcKgn cAqMTE hTttpy" kind="field" title="tools"><span class="sc-iemWCZ bcnRwz"></span><button aria-label="expand properties"><span class="property-name">tools</span><svg class="sc-dIsUp hGHhhO" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">Array of Tool (any) or null</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT sc-gSYDnn iwcKgn cAqMTE hTttpy" kind="field" title="text"><span class="sc-iemWCZ bcnRwz"></span><button aria-label="expand properties"><span class="property-name">text</span><svg class="sc-dIsUp hGHhhO" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">ResponseTextParam (object) or null</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT sc-gSYDnn iwcKgn cAqMTE hTttpy" kind="field" title="reasoning"><span class="sc-iemWCZ bcnRwz"></span><button aria-label="expand properties"><span class="property-name">reasoning</span><svg class="sc-dIsUp hGHhhO" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">Reasoning (object) or null</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="truncation"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">truncation</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span><span class="sc-laZMeE sc-eJocfa jWaWWE bArHDh"> (<!-- -->TruncationEnum<!-- -->) </span></div><div><span class="sc-laZMeE jWaWWE"> <!-- -->Enum<!-- -->:</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"auto"</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"disabled"</span> </div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The truncation strategy to use for the model response. - <code>auto</code>: If the input to this Response exceeds the model's context window size, the model will truncate the response to fit the context window by dropping items from the beginning of the conversation. - <code>disabled</code> (default): If the input size will exceed the context window size for a model, the request will fail with a 400 error.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT sc-gSYDnn iwcKgn cAqMTE hTttpy" kind="field" title="instructions"><span class="sc-iemWCZ bcnRwz"></span><button aria-label="expand properties"><span class="property-name">instructions</span><svg class="sc-dIsUp hGHhhO" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string or null</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT sc-gSYDnn iwcKgn cAqMTE hTttpy" kind="field" title="conversation"><span class="sc-iemWCZ bcnRwz"></span><button aria-label="expand properties"><span class="property-name">conversation</span><svg class="sc-dIsUp hGHhhO" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">(ConversationParam (Conversation ID (string) or Conversation object (object))) or null</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT sc-gSYDnn iwcKgn cAqMTE hTttpy" kind="field" title="tool_choice"><span class="sc-iemWCZ bcnRwz"></span><button aria-label="expand properties"><span class="property-name">tool_choice</span><svg class="sc-dIsUp hGHhhO" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">(ToolChoiceParam (Tool choice mode (string) or Allowed tools (object) or Hosted tool (object) or Function tool (object) or MCP tool (object) or Custom tool (object) or Specific apply patch tool choice (object) or Specific shell tool choice (object))) or null</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div></div></div></td></tr><tr class="last "><td class="sc-hBMUJo sc-fFSPTT sc-gSYDnn iwcKgn cAqMTE hTttpy" kind="field" title="parallel_tool_calls"><span class="sc-iemWCZ bcnRwz"></span><button aria-label="expand properties"><span class="property-name">parallel_tool_calls</span><svg class="sc-dIsUp hGHhhO" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">boolean or null</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div></div></div></td></tr></tbody></table><div><h3 class="sc-fIxmyt DvFer">Responses</h3><div><button class="sc-htmcrh lbYftx"><svg class="sc-dIsUp dqYXmg" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-fWWYYk cMoEZ">200<!-- --> </strong><span class="sc-jcwpoC eDjFAZ"><p>Success</p>
</span></button></div></div></div><div class="sc-jSFjdj sc-gKAaRy gBjRyf gcushC"><div class="sc-EZqKI fWsqvQ"><button class="sc-eEVmNe ilvUMs"><span type="post" class="sc-fmdNqN ldMUmp http-verb post">post</span><span class="sc-jXcxbT fCEUju">/responses/input_tokens</span><svg class="sc-dIsUp bRmrKA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ljsmAU flIrdF"><div class="sc-jlZJtj fQkroN"><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div><div tabindex="0" role="button"><div class="sc-dTSzeu dfUAUz"><span>https://api.openai.com/v1</span>/responses/input_tokens</div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Request samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="react-tabs-312" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-313" tabindex="0" data-rttab="true">Payload</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-313" aria-labelledby="react-tabs-312"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-hiKfDv sc-khIgEk bycQNU hLNtis"><svg class="sc-jJMGnK gVpQmv" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option selected="" value="application/json">application/json</option><option value="application/x-www-form-urlencoded">application/x-www-form-urlencoded</option></select><label>application/json</label></div></div><div class="sc-jgPyTC dSaTNC"><div class="sc-jNnpgg esZIbL"><div class="sc-giAqHp hMPeqJ"><button><div class="sc-carFqZ UksDl">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iJCRrE jCdxGr sc-dPaNzc gyljjx"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"model"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"input"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"previous_response_id"</span>: <span class="token string">"resp_123"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"tools"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <span class="token string">"function"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"description"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"parameters"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"property1"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"property2"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"strict"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"defer_loading"</span>: <span class="token boolean">true</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"text"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"format"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <span class="token string">"text"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"verbosity"</span>: <span class="token string">"low"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"reasoning"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"effort"</span>: <span class="token string">"none"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"summary"</span>: <span class="token string">"auto"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"generate_summary"</span>: <span class="token string">"auto"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"truncation"</span>: <span class="token string">"auto"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"instructions"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"conversation"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"tool_choice"</span>: <span class="token string">"none"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"parallel_tool_calls"</span>: <span class="token boolean">true</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Response samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-314" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-315" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-315" aria-labelledby="react-tabs-314"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-bBjRSN kQSIAz">application/json</div></div><div class="sc-jgPyTC dSaTNC"><div class="sc-jNnpgg esZIbL"><div class="sc-giAqHp hMPeqJ"><button><div class="sc-carFqZ UksDl">Copy</div></button></div><div class="sc-iJCRrE jCdxGr sc-dPaNzc gyljjx"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"object"</span>: <span class="token string">"response.input_tokens"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"input_tokens"</span>: <span class="token number">123</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="operation/Compactconversation" data-section-id="operation/Compactconversation" class="sc-eCApnc liLqNm"><div data-section-id="operation/Compactconversation" id="operation/Compactconversation" class="sc-iCoGMd gLxhOh"><div class="sc-hKFxyN juinod"><h2 class="sc-pNWdM eftmgB"><a class="sc-crzoAE iUxAWq" href="#operation/Compactconversation" aria-label="operation/Compactconversation"></a>Compact a conversation. Returns a compacted response object.
Learn when and how to compact long-running conversations in the [conversation state guide](/docs/guides/conversation-state#managing-the-context-window). For ZDR-compatible compaction details, see [Compaction (advanced)](/docs/guides/conversation-state#compaction-advanced).<!-- --> </h2><div class="sc-fcmMJX cvfxAX"><div class="sc-jUfyBS bhDyou"><h5 class="sc-iqAclL sc-fuISkM eONCmm hZIgic">Authorizations:</h5><svg class="sc-dIsUp iPqByX" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jQAxuV ccffaZ"><span class="sc-daBunf fcvuS"><span class="sc-dsXzNU dPrSxx"><i>ApiKeyAuth</i></span></span></div></div><h5 class="sc-iqAclL eONCmm">Request Body schema: <div class="sc-hiKfDv sc-gXfVKN bycQNU dhIYNk"><svg class="sc-jJMGnK hzcSs" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option selected="" value="application/json">application/json</option><option value="application/x-www-form-urlencoded">application/x-www-form-urlencoded</option></select><label>application/json</label></div></h5><div class="sc-iJCRrE sc-ciSkZP jCdxGr QGruV"></div><table class="sc-hHEiqL VCQHZ"><tbody><tr class=""><td class="sc-hBMUJo sc-fFSPTT sc-gSYDnn iwcKgn cAqMTE hTttpy" kind="field" title="model"><span class="sc-iemWCZ bcnRwz"></span><button aria-label="expand properties"><span class="property-name">model</span><svg class="sc-dIsUp hGHhhO" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">(ModelIdsResponses ((ModelIdsShared (ModelIdsShared (string) or ModelIdsShared (string))) or ResponsesOnlyModel (string))) or ModelIdsCompaction (string) or ModelIdsCompaction (null)</span><span class="sc-laZMeE sc-eJocfa jWaWWE bArHDh"> (<!-- -->ModelIdsCompaction<!-- -->) </span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>Model ID used to generate the response, like <code>gpt-5</code> or <code>o3</code>. OpenAI offers a wide range of models with different capabilities, performance characteristics, and price points. Refer to the <a href="/docs/models">model guide</a> to browse and compare available models.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT sc-gSYDnn iwcKgn cAqMTE hTttpy" kind="field" title="input"><span class="sc-iemWCZ bcnRwz"></span><button aria-label="expand properties"><span class="property-name">input</span><svg class="sc-dIsUp hGHhhO" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">(string or Array of InputItem (any)) or null</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT sc-gSYDnn iwcKgn cAqMTE hTttpy" kind="field" title="previous_response_id"><span class="sc-iemWCZ bcnRwz"></span><button aria-label="expand properties"><span class="property-name">previous_response_id</span><svg class="sc-dIsUp hGHhhO" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string or null</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT sc-gSYDnn iwcKgn cAqMTE hTttpy" kind="field" title="instructions"><span class="sc-iemWCZ bcnRwz"></span><button aria-label="expand properties"><span class="property-name">instructions</span><svg class="sc-dIsUp hGHhhO" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string or null</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT sc-gSYDnn iwcKgn cAqMTE hTttpy" kind="field" title="prompt_cache_key"><span class="sc-iemWCZ bcnRwz"></span><button aria-label="expand properties"><span class="property-name">prompt_cache_key</span><svg class="sc-dIsUp hGHhhO" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string or null</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div></div></div></td></tr><tr class="last "><td class="sc-hBMUJo sc-fFSPTT sc-gSYDnn iwcKgn cAqMTE hTttpy" kind="field" title="prompt_cache_retention"><span class="sc-iemWCZ bcnRwz"></span><button aria-label="expand properties"><span class="property-name">prompt_cache_retention</span><svg class="sc-dIsUp hGHhhO" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">PromptCacheRetentionEnum (string) or null</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div></div></div></td></tr></tbody></table><div><h3 class="sc-fIxmyt DvFer">Responses</h3><div><button class="sc-htmcrh lbYftx"><svg class="sc-dIsUp dqYXmg" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-fWWYYk cMoEZ">200<!-- --> </strong><span class="sc-jcwpoC eDjFAZ"><p>Success</p>
</span></button></div></div></div><div class="sc-jSFjdj sc-gKAaRy gBjRyf gcushC"><div class="sc-EZqKI fWsqvQ"><button class="sc-eEVmNe ilvUMs"><span type="post" class="sc-fmdNqN ldMUmp http-verb post">post</span><span class="sc-jXcxbT fCEUju">/responses/compact</span><svg class="sc-dIsUp bRmrKA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ljsmAU flIrdF"><div class="sc-jlZJtj fQkroN"><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div><div tabindex="0" role="button"><div class="sc-dTSzeu dfUAUz"><span>https://api.openai.com/v1</span>/responses/compact</div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Request samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="react-tabs-316" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-317" tabindex="0" data-rttab="true">Payload</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-317" aria-labelledby="react-tabs-316"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-hiKfDv sc-khIgEk bycQNU hLNtis"><svg class="sc-jJMGnK gVpQmv" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option selected="" value="application/json">application/json</option><option value="application/x-www-form-urlencoded">application/x-www-form-urlencoded</option></select><label>application/json</label></div></div><div class="sc-jgPyTC dSaTNC"><div class="sc-jNnpgg esZIbL"><div class="sc-giAqHp hMPeqJ"><button><div class="sc-carFqZ UksDl">Copy</div></button></div><div class="sc-iJCRrE jCdxGr sc-dPaNzc gyljjx"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"model"</span>: <span class="token string">"gpt-5.1"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"input"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"previous_response_id"</span>: <span class="token string">"resp_123"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"instructions"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"prompt_cache_key"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"prompt_cache_retention"</span>: <span class="token string">"in_memory"</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Response samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-318" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-319" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-319" aria-labelledby="react-tabs-318"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-bBjRSN kQSIAz">application/json</div></div><div class="sc-jgPyTC dSaTNC"><div class="sc-jNnpgg esZIbL"><div class="sc-giAqHp hMPeqJ"><button><div class="sc-carFqZ UksDl">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iJCRrE jCdxGr sc-dPaNzc gyljjx"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">"resp_001"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"object"</span>: <span class="token string">"response.compaction"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"output"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <span class="token string">"message"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"role"</span>: <span class="token string">"user"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"content"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <span class="token string">"input_text"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"text"</span>: <span class="token string">"Summarize our launch checklist from last week."</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span></div></li></ul><span class="token punctuation">}</span>,</div></li><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <span class="token string">"message"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"role"</span>: <span class="token string">"user"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"content"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <span class="token string">"input_text"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"text"</span>: <span class="token string">"You are performing a CONTEXT CHECKPOINT COMPACTION..."</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span></div></li></ul><span class="token punctuation">}</span>,</div></li><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <span class="token string">"compaction"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"id"</span>: <span class="token string">"cmp_001"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"encrypted_content"</span>: <span class="token string">"encrypted-summary"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"created_at"</span>: <span class="token number">1731459200</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"usage"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"input_tokens"</span>: <span class="token number">42897</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"output_tokens"</span>: <span class="token number">12000</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"total_tokens"</span>: <span class="token number">54912</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="operation/CancelChatSessionMethod" data-section-id="operation/CancelChatSessionMethod" class="sc-eCApnc liLqNm"><div data-section-id="operation/CancelChatSessionMethod" id="operation/CancelChatSessionMethod" class="sc-iCoGMd gLxhOh"><div class="sc-hKFxyN juinod"><h2 class="sc-pNWdM eftmgB"><a class="sc-crzoAE iUxAWq" href="#operation/CancelChatSessionMethod" aria-label="operation/CancelChatSessionMethod"></a>Cancel an active ChatKit session and return its most recent metadata.
Cancelling prevents new requests from using the issued client secret.<!-- --> </h2><div class="sc-fcmMJX cvfxAX"><div class="sc-jUfyBS bhDyou"><h5 class="sc-iqAclL sc-fuISkM eONCmm hZIgic">Authorizations:</h5><svg class="sc-dIsUp iPqByX" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jQAxuV ccffaZ"><span class="sc-daBunf fcvuS"><span class="sc-dsXzNU dPrSxx"><i>ApiKeyAuth</i></span></span></div></div><div><h5 class="sc-iqAclL eONCmm">path<!-- --> Parameters</h5><table class="sc-hHEiqL VCQHZ"><tbody><tr class="last "><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="session_id"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">session_id</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><span class="sc-laZMeE jWaWWE"> <!-- -->Example:<!-- --> </span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">cksess_123</span></div><div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>Unique identifier for the ChatKit session to cancel.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-fIxmyt DvFer">Responses</h3><div><button class="sc-htmcrh lbYftx"><svg class="sc-dIsUp dqYXmg" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-fWWYYk cMoEZ">200<!-- --> </strong><span class="sc-jcwpoC eDjFAZ"><p>Success</p>
</span></button></div></div></div><div class="sc-jSFjdj sc-gKAaRy gBjRyf gcushC"><div class="sc-EZqKI fWsqvQ"><button class="sc-eEVmNe ilvUMs"><span type="post" class="sc-fmdNqN ldMUmp http-verb post">post</span><span class="sc-jXcxbT fCEUju">/chatkit/sessions/{session_id}/cancel</span><svg class="sc-dIsUp bRmrKA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ljsmAU flIrdF"><div class="sc-jlZJtj fQkroN"><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div><div tabindex="0" role="button"><div class="sc-dTSzeu dfUAUz"><span>https://api.openai.com/v1</span>/chatkit/sessions/{session_id}/cancel</div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Response samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-320" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-321" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-321" aria-labelledby="react-tabs-320"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-bBjRSN kQSIAz">application/json</div></div><div class="sc-jgPyTC dSaTNC"><div class="sc-jNnpgg esZIbL"><div class="sc-giAqHp hMPeqJ"><button><div class="sc-carFqZ UksDl">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iJCRrE jCdxGr sc-dPaNzc gyljjx"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">"cksess_123"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"object"</span>: <span class="token string">"chatkit.session"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"client_secret"</span>: <span class="token string">"ek_token_123"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"expires_at"</span>: <span class="token number">1712349876</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"workflow"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"id"</span>: <span class="token string">"workflow_alpha"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"version"</span>: <span class="token string">"2024-10-01T00:00:00.000Z"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"user"</span>: <span class="token string">"user_789"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"rate_limits"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"max_requests_per_1_minute"</span>: <span class="token number">60</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"max_requests_per_1_minute"</span>: <span class="token number">60</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token string">"cancelled"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"chatkit_configuration"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"automatic_thread_titling"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"enabled"</span>: <span class="token boolean">true</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"file_upload"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"enabled"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"max_file_size"</span>: <span class="token number">16</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"max_files"</span>: <span class="token number">20</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"history"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"enabled"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"recent_threads"</span>: <span class="token number">10</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="operation/CreateChatSessionMethod" data-section-id="operation/CreateChatSessionMethod" class="sc-eCApnc liLqNm"><div data-section-id="operation/CreateChatSessionMethod" id="operation/CreateChatSessionMethod" class="sc-iCoGMd gLxhOh"><div class="sc-hKFxyN juinod"><h2 class="sc-pNWdM eftmgB"><a class="sc-crzoAE iUxAWq" href="#operation/CreateChatSessionMethod" aria-label="operation/CreateChatSessionMethod"></a>Create a ChatKit session.<!-- --> </h2><div class="sc-fcmMJX cvfxAX"><div class="sc-jUfyBS bhDyou"><h5 class="sc-iqAclL sc-fuISkM eONCmm hZIgic">Authorizations:</h5><svg class="sc-dIsUp iPqByX" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jQAxuV ccffaZ"><span class="sc-daBunf fcvuS"><span class="sc-dsXzNU dPrSxx"><i>ApiKeyAuth</i></span></span></div></div><h5 class="sc-iqAclL eONCmm">Request Body schema: <span class="sc-cBoqAE eKyrDP">application/json</span></h5><div class="sc-iJCRrE sc-ciSkZP jCdxGr QGruV"></div><table class="sc-hHEiqL VCQHZ"><tbody><tr class=""><td class="sc-hBMUJo sc-fFSPTT sc-gSYDnn iwcKgn cAqMTE hTttpy" kind="field" title="workflow"><span class="sc-iemWCZ bcnRwz"></span><button aria-label="expand properties"><span class="property-name">workflow</span><svg class="sc-dIsUp hGHhhO" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">object</span><span class="sc-laZMeE sc-eJocfa jWaWWE bArHDh"> (<!-- -->WorkflowParam<!-- -->) </span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>Workflow that powers the session.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="user"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">user</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span><span> <span class="sc-laZMeE sc-FRrlG jWaWWE gHBwqe"> <!-- -->non-empty<!-- --> </span></span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>A free-form string that identifies your end user; ensures this Session can access other objects that have the same <code>user</code> scope.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT sc-gSYDnn iwcKgn cAqMTE hTttpy" kind="field" title="expires_after"><span class="sc-iemWCZ bcnRwz"></span><button aria-label="expand properties"><span class="property-name">expires_after</span><svg class="sc-dIsUp hGHhhO" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">object</span><span class="sc-laZMeE sc-eJocfa jWaWWE bArHDh"> (<!-- -->ExpiresAfterParam<!-- -->) </span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>Optional override for session expiration timing in seconds from creation. Defaults to 10 minutes.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT sc-gSYDnn iwcKgn cAqMTE hTttpy" kind="field" title="rate_limits"><span class="sc-iemWCZ bcnRwz"></span><button aria-label="expand properties"><span class="property-name">rate_limits</span><svg class="sc-dIsUp hGHhhO" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">object</span><span class="sc-laZMeE sc-eJocfa jWaWWE bArHDh"> (<!-- -->RateLimitsParam<!-- -->) </span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>Optional override for per-minute request limits. When omitted, defaults to 10.</p>
</div></div></div></td></tr><tr class="last "><td class="sc-hBMUJo sc-fFSPTT sc-gSYDnn iwcKgn cAqMTE hTttpy" kind="field" title="chatkit_configuration"><span class="sc-iemWCZ bcnRwz"></span><button aria-label="expand properties"><span class="property-name">chatkit_configuration</span><svg class="sc-dIsUp hGHhhO" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">object</span><span class="sc-laZMeE sc-eJocfa jWaWWE bArHDh"> (<!-- -->ChatkitConfigurationParam<!-- -->) </span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>Optional overrides for ChatKit runtime configuration features</p>
</div></div></div></td></tr></tbody></table><div><h3 class="sc-fIxmyt DvFer">Responses</h3><div><button class="sc-htmcrh lbYftx"><svg class="sc-dIsUp dqYXmg" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-fWWYYk cMoEZ">200<!-- --> </strong><span class="sc-jcwpoC eDjFAZ"><p>Success</p>
</span></button></div></div></div><div class="sc-jSFjdj sc-gKAaRy gBjRyf gcushC"><div class="sc-EZqKI fWsqvQ"><button class="sc-eEVmNe ilvUMs"><span type="post" class="sc-fmdNqN ldMUmp http-verb post">post</span><span class="sc-jXcxbT fCEUju">/chatkit/sessions</span><svg class="sc-dIsUp bRmrKA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ljsmAU flIrdF"><div class="sc-jlZJtj fQkroN"><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div><div tabindex="0" role="button"><div class="sc-dTSzeu dfUAUz"><span>https://api.openai.com/v1</span>/chatkit/sessions</div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Request samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="react-tabs-322" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-323" tabindex="0" data-rttab="true">Payload</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-323" aria-labelledby="react-tabs-322"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-bBjRSN kQSIAz">application/json</div></div><div class="sc-jgPyTC dSaTNC"><div class="sc-jNnpgg esZIbL"><div class="sc-giAqHp hMPeqJ"><button><div class="sc-carFqZ UksDl">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iJCRrE jCdxGr sc-dPaNzc gyljjx"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"workflow"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"version"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"state_variables"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"property1"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"property2"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"tracing"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"enabled"</span>: <span class="token boolean">true</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"user"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"expires_after"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"anchor"</span>: <span class="token string">"created_at"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"seconds"</span>: <span class="token number">1</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"rate_limits"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"max_requests_per_1_minute"</span>: <span class="token number">1</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"chatkit_configuration"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"automatic_thread_titling"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"enabled"</span>: <span class="token boolean">true</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"file_upload"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"enabled"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"max_file_size"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"max_files"</span>: <span class="token number">1</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"history"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"enabled"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"recent_threads"</span>: <span class="token number">1</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Response samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-324" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-325" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-325" aria-labelledby="react-tabs-324"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-bBjRSN kQSIAz">application/json</div></div><div class="sc-jgPyTC dSaTNC"><div class="sc-jNnpgg esZIbL"><div class="sc-giAqHp hMPeqJ"><button><div class="sc-carFqZ UksDl">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iJCRrE jCdxGr sc-dPaNzc gyljjx"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">"cksess_123"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"object"</span>: <span class="token string">"chatkit.session"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"client_secret"</span>: <span class="token string">"ek_token_123"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"expires_at"</span>: <span class="token number">1712349876</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"workflow"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"id"</span>: <span class="token string">"workflow_alpha"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"version"</span>: <span class="token string">"2024-10-01T00:00:00.000Z"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"user"</span>: <span class="token string">"user_789"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"rate_limits"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"max_requests_per_1_minute"</span>: <span class="token number">60</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"max_requests_per_1_minute"</span>: <span class="token number">60</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token string">"cancelled"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"chatkit_configuration"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"automatic_thread_titling"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"enabled"</span>: <span class="token boolean">true</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"file_upload"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"enabled"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"max_file_size"</span>: <span class="token number">16</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"max_files"</span>: <span class="token number">20</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"history"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"enabled"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"recent_threads"</span>: <span class="token number">10</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="operation/ListThreadItemsMethod" data-section-id="operation/ListThreadItemsMethod" class="sc-eCApnc liLqNm"><div data-section-id="operation/ListThreadItemsMethod" id="operation/ListThreadItemsMethod" class="sc-iCoGMd gLxhOh"><div class="sc-hKFxyN juinod"><h2 class="sc-pNWdM eftmgB"><a class="sc-crzoAE iUxAWq" href="#operation/ListThreadItemsMethod" aria-label="operation/ListThreadItemsMethod"></a>List items that belong to a ChatKit thread.<!-- --> </h2><div class="sc-fcmMJX cvfxAX"><div class="sc-jUfyBS bhDyou"><h5 class="sc-iqAclL sc-fuISkM eONCmm hZIgic">Authorizations:</h5><svg class="sc-dIsUp iPqByX" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jQAxuV ccffaZ"><span class="sc-daBunf fcvuS"><span class="sc-dsXzNU dPrSxx"><i>ApiKeyAuth</i></span></span></div></div><div><h5 class="sc-iqAclL eONCmm">path<!-- --> Parameters</h5><table class="sc-hHEiqL VCQHZ"><tbody><tr class="last "><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="thread_id"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">thread_id</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><span class="sc-laZMeE jWaWWE"> <!-- -->Example:<!-- --> </span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">cthr_123</span></div><div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>Identifier of the ChatKit thread whose items are requested.</p>
</div></div></div></td></tr></tbody></table></div><div><h5 class="sc-iqAclL eONCmm">query<!-- --> Parameters</h5><table class="sc-hHEiqL VCQHZ"><tbody><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="limit"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">limit</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">integer</span><span> <span class="sc-laZMeE sc-FRrlG jWaWWE gHBwqe"> <!-- -->[ 0 .. 100 ]<!-- --> </span></span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>Maximum number of thread items to return. Defaults to 20.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="order"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">order</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span><span class="sc-laZMeE sc-eJocfa jWaWWE bArHDh"> (<!-- -->OrderEnum<!-- -->) </span></div><div><span class="sc-laZMeE jWaWWE"> <!-- -->Enum<!-- -->:</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"asc"</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"desc"</span> </div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>Sort order for results by creation time. Defaults to <code>desc</code>.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="after"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">after</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>List items created after this thread item ID. Defaults to null for the first page.</p>
</div></div></div></td></tr><tr class="last "><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="before"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">before</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>List items created before this thread item ID. Defaults to null for the newest results.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-fIxmyt DvFer">Responses</h3><div><button class="sc-htmcrh lbYftx"><svg class="sc-dIsUp dqYXmg" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-fWWYYk cMoEZ">200<!-- --> </strong><span class="sc-jcwpoC eDjFAZ"><p>Success</p>
</span></button></div></div></div><div class="sc-jSFjdj sc-gKAaRy gBjRyf gcushC"><div class="sc-EZqKI fWsqvQ"><button class="sc-eEVmNe ilvUMs"><span type="get" class="sc-fmdNqN ihNycv http-verb get">get</span><span class="sc-jXcxbT fCEUju">/chatkit/threads/{thread_id}/items</span><svg class="sc-dIsUp bRmrKA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ljsmAU flIrdF"><div class="sc-jlZJtj fQkroN"><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div><div tabindex="0" role="button"><div class="sc-dTSzeu dfUAUz"><span>https://api.openai.com/v1</span>/chatkit/threads/{thread_id}/items</div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Response samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-326" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-327" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-327" aria-labelledby="react-tabs-326"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-bBjRSN kQSIAz">application/json</div></div><div class="sc-jgPyTC dSaTNC"><div class="sc-jNnpgg esZIbL"><div class="sc-giAqHp hMPeqJ"><button><div class="sc-carFqZ UksDl">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iJCRrE jCdxGr sc-dPaNzc gyljjx"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"object"</span>: <span class="token string">"list"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"object"</span>: <span class="token string">"chatkit.thread_item"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"created_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"thread_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <span class="token string">"chatkit.user_message"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"content"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <span class="token string">"input_text"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"text"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"attachments"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <span class="token string">"image"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"mime_type"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"preview_url"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"inference_options"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"tool_choice"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"id"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"model"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"first_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"last_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"has_more"</span>: <span class="token boolean">true</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="operation/GetThreadMethod" data-section-id="operation/GetThreadMethod" class="sc-eCApnc liLqNm"><div data-section-id="operation/GetThreadMethod" id="operation/GetThreadMethod" class="sc-iCoGMd gLxhOh"><div class="sc-hKFxyN juinod"><h2 class="sc-pNWdM eftmgB"><a class="sc-crzoAE iUxAWq" href="#operation/GetThreadMethod" aria-label="operation/GetThreadMethod"></a>Retrieve a ChatKit thread by its identifier.<!-- --> </h2><div class="sc-fcmMJX cvfxAX"><div class="sc-jUfyBS bhDyou"><h5 class="sc-iqAclL sc-fuISkM eONCmm hZIgic">Authorizations:</h5><svg class="sc-dIsUp iPqByX" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jQAxuV ccffaZ"><span class="sc-daBunf fcvuS"><span class="sc-dsXzNU dPrSxx"><i>ApiKeyAuth</i></span></span></div></div><div><h5 class="sc-iqAclL eONCmm">path<!-- --> Parameters</h5><table class="sc-hHEiqL VCQHZ"><tbody><tr class="last "><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="thread_id"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">thread_id</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><span class="sc-laZMeE jWaWWE"> <!-- -->Example:<!-- --> </span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">cthr_123</span></div><div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>Identifier of the ChatKit thread to retrieve.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-fIxmyt DvFer">Responses</h3><div><button class="sc-htmcrh lbYftx"><svg class="sc-dIsUp dqYXmg" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-fWWYYk cMoEZ">200<!-- --> </strong><span class="sc-jcwpoC eDjFAZ"><p>Success</p>
</span></button></div></div></div><div class="sc-jSFjdj sc-gKAaRy gBjRyf gcushC"><div class="sc-EZqKI fWsqvQ"><button class="sc-eEVmNe ilvUMs"><span type="get" class="sc-fmdNqN ihNycv http-verb get">get</span><span class="sc-jXcxbT fCEUju">/chatkit/threads/{thread_id}</span><svg class="sc-dIsUp bRmrKA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ljsmAU flIrdF"><div class="sc-jlZJtj fQkroN"><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div><div tabindex="0" role="button"><div class="sc-dTSzeu dfUAUz"><span>https://api.openai.com/v1</span>/chatkit/threads/{thread_id}</div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Response samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-328" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-329" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-329" aria-labelledby="react-tabs-328"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-bBjRSN kQSIAz">application/json</div></div><div class="sc-jgPyTC dSaTNC"><div class="sc-jNnpgg esZIbL"><div class="sc-giAqHp hMPeqJ"><button><div class="sc-carFqZ UksDl">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iJCRrE jCdxGr sc-dPaNzc gyljjx"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">"cthr_def456"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"object"</span>: <span class="token string">"chatkit.thread"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"created_at"</span>: <span class="token number">1712345600</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"title"</span>: <span class="token string">"Demo feedback"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <span class="token string">"active"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"user"</span>: <span class="token string">"user_456"</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="operation/DeleteThreadMethod" data-section-id="operation/DeleteThreadMethod" class="sc-eCApnc liLqNm"><div data-section-id="operation/DeleteThreadMethod" id="operation/DeleteThreadMethod" class="sc-iCoGMd gLxhOh"><div class="sc-hKFxyN juinod"><h2 class="sc-pNWdM eftmgB"><a class="sc-crzoAE iUxAWq" href="#operation/DeleteThreadMethod" aria-label="operation/DeleteThreadMethod"></a>Delete a ChatKit thread along with its items and stored attachments.<!-- --> </h2><div class="sc-fcmMJX cvfxAX"><div class="sc-jUfyBS bhDyou"><h5 class="sc-iqAclL sc-fuISkM eONCmm hZIgic">Authorizations:</h5><svg class="sc-dIsUp iPqByX" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jQAxuV ccffaZ"><span class="sc-daBunf fcvuS"><span class="sc-dsXzNU dPrSxx"><i>ApiKeyAuth</i></span></span></div></div><div><h5 class="sc-iqAclL eONCmm">path<!-- --> Parameters</h5><table class="sc-hHEiqL VCQHZ"><tbody><tr class="last "><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="thread_id"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">thread_id</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><span class="sc-laZMeE jWaWWE"> <!-- -->Example:<!-- --> </span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">cthr_123</span></div><div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>Identifier of the ChatKit thread to delete.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-fIxmyt DvFer">Responses</h3><div><button class="sc-htmcrh lbYftx"><svg class="sc-dIsUp dqYXmg" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-fWWYYk cMoEZ">200<!-- --> </strong><span class="sc-jcwpoC eDjFAZ"><p>Success</p>
</span></button></div></div></div><div class="sc-jSFjdj sc-gKAaRy gBjRyf gcushC"><div class="sc-EZqKI fWsqvQ"><button class="sc-eEVmNe ilvUMs"><span type="delete" class="sc-fmdNqN bJzUtf http-verb delete">delete</span><span class="sc-jXcxbT fCEUju">/chatkit/threads/{thread_id}</span><svg class="sc-dIsUp bRmrKA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ljsmAU flIrdF"><div class="sc-jlZJtj fQkroN"><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div><div tabindex="0" role="button"><div class="sc-dTSzeu dfUAUz"><span>https://api.openai.com/v1</span>/chatkit/threads/{thread_id}</div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Response samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-330" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-331" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-331" aria-labelledby="react-tabs-330"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-bBjRSN kQSIAz">application/json</div></div><div class="sc-jgPyTC dSaTNC"><div class="sc-jNnpgg esZIbL"><div class="sc-giAqHp hMPeqJ"><button><div class="sc-carFqZ UksDl">Copy</div></button></div><div class="sc-iJCRrE jCdxGr sc-dPaNzc gyljjx"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"object"</span>: <span class="token string">"chatkit.thread.deleted"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"deleted"</span>: <span class="token boolean">true</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="operation/ListThreadsMethod" data-section-id="operation/ListThreadsMethod" class="sc-eCApnc liLqNm"><div data-section-id="operation/ListThreadsMethod" id="operation/ListThreadsMethod" class="sc-iCoGMd gLxhOh"><div class="sc-hKFxyN juinod"><h2 class="sc-pNWdM eftmgB"><a class="sc-crzoAE iUxAWq" href="#operation/ListThreadsMethod" aria-label="operation/ListThreadsMethod"></a>List ChatKit threads with optional pagination and user filters.<!-- --> </h2><div class="sc-fcmMJX cvfxAX"><div class="sc-jUfyBS bhDyou"><h5 class="sc-iqAclL sc-fuISkM eONCmm hZIgic">Authorizations:</h5><svg class="sc-dIsUp iPqByX" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jQAxuV ccffaZ"><span class="sc-daBunf fcvuS"><span class="sc-dsXzNU dPrSxx"><i>ApiKeyAuth</i></span></span></div></div><div><h5 class="sc-iqAclL eONCmm">query<!-- --> Parameters</h5><table class="sc-hHEiqL VCQHZ"><tbody><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="limit"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">limit</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">integer</span><span> <span class="sc-laZMeE sc-FRrlG jWaWWE gHBwqe"> <!-- -->[ 0 .. 100 ]<!-- --> </span></span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>Maximum number of thread items to return. Defaults to 20.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="order"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">order</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span><span class="sc-laZMeE sc-eJocfa jWaWWE bArHDh"> (<!-- -->OrderEnum<!-- -->) </span></div><div><span class="sc-laZMeE jWaWWE"> <!-- -->Enum<!-- -->:</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"asc"</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"desc"</span> </div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>Sort order for results by creation time. Defaults to <code>desc</code>.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="after"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">after</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>List items created after this thread item ID. Defaults to null for the first page.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="before"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">before</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>List items created before this thread item ID. Defaults to null for the newest results.</p>
</div></div></div></td></tr><tr class="last "><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="user"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">user</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span><span> <span class="sc-laZMeE sc-FRrlG jWaWWE gHBwqe"> <!-- -->[ 1 .. 512 ] characters<!-- --> </span></span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>Filter threads that belong to this user identifier. Defaults to null to return all users.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-fIxmyt DvFer">Responses</h3><div><button class="sc-htmcrh lbYftx"><svg class="sc-dIsUp dqYXmg" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-fWWYYk cMoEZ">200<!-- --> </strong><span class="sc-jcwpoC eDjFAZ"><p>Success</p>
</span></button></div></div></div><div class="sc-jSFjdj sc-gKAaRy gBjRyf gcushC"><div class="sc-EZqKI fWsqvQ"><button class="sc-eEVmNe ilvUMs"><span type="get" class="sc-fmdNqN ihNycv http-verb get">get</span><span class="sc-jXcxbT fCEUju">/chatkit/threads</span><svg class="sc-dIsUp bRmrKA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ljsmAU flIrdF"><div class="sc-jlZJtj fQkroN"><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div><div tabindex="0" role="button"><div class="sc-dTSzeu dfUAUz"><span>https://api.openai.com/v1</span>/chatkit/threads</div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Response samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-332" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-333" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-333" aria-labelledby="react-tabs-332"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-bBjRSN kQSIAz">application/json</div></div><div class="sc-jgPyTC dSaTNC"><div class="sc-jNnpgg esZIbL"><div class="sc-giAqHp hMPeqJ"><button><div class="sc-carFqZ UksDl">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iJCRrE jCdxGr sc-dPaNzc gyljjx"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"object"</span>: <span class="token string">"list"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"id"</span>: <span class="token string">"cthr_def456"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"object"</span>: <span class="token string">"chatkit.thread"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"created_at"</span>: <span class="token number">1712345600</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"title"</span>: <span class="token string">"Demo feedback"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"status"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <span class="token string">"active"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"user"</span>: <span class="token string">"user_456"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"first_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"last_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"has_more"</span>: <span class="token boolean">true</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Certificates" data-section-id="tag/Certificates" class="sc-eCApnc jlMQbh"><div class="sc-iCoGMd gLxhOh"><div class="sc-hKFxyN juinod"><h1 class="sc-fujyAs bpZWeL"><a class="sc-crzoAE iUxAWq" href="#tag/Certificates" aria-label="tag/Certificates"></a>Certificates</h1></div></div></div><div id="tag/Certificates/operation/listOrganizationCertificates" data-section-id="tag/Certificates/operation/listOrganizationCertificates" class="sc-eCApnc liLqNm"><div data-section-id="operation/listOrganizationCertificates" id="operation/listOrganizationCertificates" class="sc-iCoGMd gLxhOh"><div class="sc-hKFxyN juinod"><h2 class="sc-pNWdM eftmgB"><a class="sc-crzoAE iUxAWq" href="#tag/Certificates/operation/listOrganizationCertificates" aria-label="tag/Certificates/operation/listOrganizationCertificates"></a>List uploaded certificates for this organization.<!-- --> </h2><div class="sc-fcmMJX cvfxAX"><div class="sc-jUfyBS bhDyou"><h5 class="sc-iqAclL sc-fuISkM eONCmm hZIgic">Authorizations:</h5><svg class="sc-dIsUp iPqByX" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jQAxuV ccffaZ"><span class="sc-daBunf fcvuS"><span class="sc-dsXzNU dPrSxx"><i>ApiKeyAuth</i></span></span></div></div><div><h5 class="sc-iqAclL eONCmm">query<!-- --> Parameters</h5><table class="sc-hHEiqL VCQHZ"><tbody><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="limit"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">limit</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">integer</span></div><div><span class="sc-laZMeE jWaWWE"> <!-- -->Default:<!-- --> </span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">20</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="after"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">after</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>A cursor for use in pagination. <code>after</code> is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list.</p>
</div></div></div></td></tr><tr class="last "><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="order"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">order</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div><div><span class="sc-laZMeE jWaWWE"> <!-- -->Default:<!-- --> </span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"desc"</span></div><div><span class="sc-laZMeE jWaWWE"> <!-- -->Enum<!-- -->:</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"asc"</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"desc"</span> </div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>Sort order by the <code>created_at</code> timestamp of the objects. <code>asc</code> for ascending order and <code>desc</code> for descending order.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-fIxmyt DvFer">Responses</h3><div><button class="sc-htmcrh lbYftx"><svg class="sc-dIsUp dqYXmg" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-fWWYYk cMoEZ">200<!-- --> </strong><span class="sc-jcwpoC eDjFAZ"><p>Certificates listed successfully.</p>
</span></button></div></div></div><div class="sc-jSFjdj sc-gKAaRy gBjRyf gcushC"><div class="sc-EZqKI fWsqvQ"><button class="sc-eEVmNe ilvUMs"><span type="get" class="sc-fmdNqN ihNycv http-verb get">get</span><span class="sc-jXcxbT fCEUju">/organization/certificates</span><svg class="sc-dIsUp bRmrKA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ljsmAU flIrdF"><div class="sc-jlZJtj fQkroN"><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div><div tabindex="0" role="button"><div class="sc-dTSzeu dfUAUz"><span>https://api.openai.com/v1</span>/organization/certificates</div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Response samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-334" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-335" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-335" aria-labelledby="react-tabs-334"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-bBjRSN kQSIAz">application/json</div></div><div class="sc-jgPyTC dSaTNC"><div class="sc-jNnpgg esZIbL"><div class="sc-giAqHp hMPeqJ"><button><div class="sc-carFqZ UksDl">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iJCRrE jCdxGr sc-dPaNzc gyljjx"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"object"</span>: <span class="token string">"certificate"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"created_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"certificate_details"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"valid_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"expires_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"content"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"active"</span>: <span class="token boolean">true</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"first_id"</span>: <span class="token string">"cert_abc"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"last_id"</span>: <span class="token string">"cert_abc"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"has_more"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"object"</span>: <span class="token string">"list"</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Certificates/operation/uploadCertificate" data-section-id="tag/Certificates/operation/uploadCertificate" class="sc-eCApnc liLqNm"><div data-section-id="operation/uploadCertificate" id="operation/uploadCertificate" class="sc-iCoGMd gLxhOh"><div class="sc-hKFxyN juinod"><h2 class="sc-pNWdM eftmgB"><a class="sc-crzoAE iUxAWq" href="#tag/Certificates/operation/uploadCertificate" aria-label="tag/Certificates/operation/uploadCertificate"></a>Upload a certificate to the organization. This does **not** automatically activate the certificate.
Organizations can upload up to 50 certificates.
<!-- --> </h2><div class="sc-fcmMJX cvfxAX"><div class="sc-jUfyBS bhDyou"><h5 class="sc-iqAclL sc-fuISkM eONCmm hZIgic">Authorizations:</h5><svg class="sc-dIsUp iPqByX" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jQAxuV ccffaZ"><span class="sc-daBunf fcvuS"><span class="sc-dsXzNU dPrSxx"><i>ApiKeyAuth</i></span></span></div></div><h5 class="sc-iqAclL eONCmm">Request Body schema: <span class="sc-cBoqAE eKyrDP">application/json</span></h5><div class="sc-iJCRrE sc-ciSkZP jCdxGr QGruV"><p>The certificate upload payload.</p>
</div><table class="sc-hHEiqL VCQHZ"><tbody><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="name"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">name</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>An optional name for the certificate</p>
</div></div></div></td></tr><tr class="last "><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="content"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">content</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The certificate content in PEM format</p>
</div></div></div></td></tr></tbody></table><div><h3 class="sc-fIxmyt DvFer">Responses</h3><div><button class="sc-htmcrh lbYftx"><svg class="sc-dIsUp dqYXmg" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-fWWYYk cMoEZ">200<!-- --> </strong><span class="sc-jcwpoC eDjFAZ"><p>Certificate uploaded successfully.</p>
</span></button></div></div></div><div class="sc-jSFjdj sc-gKAaRy gBjRyf gcushC"><div class="sc-EZqKI fWsqvQ"><button class="sc-eEVmNe ilvUMs"><span type="post" class="sc-fmdNqN ldMUmp http-verb post">post</span><span class="sc-jXcxbT fCEUju">/organization/certificates</span><svg class="sc-dIsUp bRmrKA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ljsmAU flIrdF"><div class="sc-jlZJtj fQkroN"><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div><div tabindex="0" role="button"><div class="sc-dTSzeu dfUAUz"><span>https://api.openai.com/v1</span>/organization/certificates</div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Request samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="react-tabs-336" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-337" tabindex="0" data-rttab="true">Payload</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-337" aria-labelledby="react-tabs-336"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-bBjRSN kQSIAz">application/json</div></div><div class="sc-jgPyTC dSaTNC"><div class="sc-jNnpgg esZIbL"><div class="sc-giAqHp hMPeqJ"><button><div class="sc-carFqZ UksDl">Copy</div></button></div><div class="sc-iJCRrE jCdxGr sc-dPaNzc gyljjx"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"content"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Response samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-338" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-339" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-339" aria-labelledby="react-tabs-338"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-bBjRSN kQSIAz">application/json</div></div><div class="sc-jgPyTC dSaTNC"><div class="sc-jNnpgg esZIbL"><div class="sc-giAqHp hMPeqJ"><button><div class="sc-carFqZ UksDl">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iJCRrE jCdxGr sc-dPaNzc gyljjx"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"object"</span>: <span class="token string">"certificate"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"created_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"certificate_details"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"valid_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"expires_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"content"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"active"</span>: <span class="token boolean">true</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Certificates/operation/activateOrganizationCertificates" data-section-id="tag/Certificates/operation/activateOrganizationCertificates" class="sc-eCApnc liLqNm"><div data-section-id="operation/activateOrganizationCertificates" id="operation/activateOrganizationCertificates" class="sc-iCoGMd gLxhOh"><div class="sc-hKFxyN juinod"><h2 class="sc-pNWdM eftmgB"><a class="sc-crzoAE iUxAWq" href="#tag/Certificates/operation/activateOrganizationCertificates" aria-label="tag/Certificates/operation/activateOrganizationCertificates"></a>Activate certificates at the organization level.
You can atomically and idempotently activate up to 10 certificates at a time.
<!-- --> </h2><div class="sc-fcmMJX cvfxAX"><div class="sc-jUfyBS bhDyou"><h5 class="sc-iqAclL sc-fuISkM eONCmm hZIgic">Authorizations:</h5><svg class="sc-dIsUp iPqByX" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jQAxuV ccffaZ"><span class="sc-daBunf fcvuS"><span class="sc-dsXzNU dPrSxx"><i>ApiKeyAuth</i></span></span></div></div><h5 class="sc-iqAclL eONCmm">Request Body schema: <span class="sc-cBoqAE eKyrDP">application/json</span></h5><div class="sc-iJCRrE sc-ciSkZP jCdxGr QGruV"><p>The certificate activation payload.</p>
</div><table class="sc-hHEiqL VCQHZ"><tbody><tr class="last "><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="certificate_ids"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">certificate_ids</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa">Array of </span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">strings</span><span> <span class="sc-laZMeE sc-FRrlG jWaWWE gHBwqe"> <!-- -->[ 1 .. 10 ] items<!-- --> </span></span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div></div></div></td></tr></tbody></table><div><h3 class="sc-fIxmyt DvFer">Responses</h3><div><button class="sc-htmcrh lbYftx"><svg class="sc-dIsUp dqYXmg" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-fWWYYk cMoEZ">200<!-- --> </strong><span class="sc-jcwpoC eDjFAZ"><p>Certificates activated successfully.</p>
</span></button></div></div></div><div class="sc-jSFjdj sc-gKAaRy gBjRyf gcushC"><div class="sc-EZqKI fWsqvQ"><button class="sc-eEVmNe ilvUMs"><span type="post" class="sc-fmdNqN ldMUmp http-verb post">post</span><span class="sc-jXcxbT fCEUju">/organization/certificates/activate</span><svg class="sc-dIsUp bRmrKA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ljsmAU flIrdF"><div class="sc-jlZJtj fQkroN"><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div><div tabindex="0" role="button"><div class="sc-dTSzeu dfUAUz"><span>https://api.openai.com/v1</span>/organization/certificates/activate</div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Request samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="react-tabs-340" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-341" tabindex="0" data-rttab="true">Payload</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-341" aria-labelledby="react-tabs-340"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-bBjRSN kQSIAz">application/json</div></div><div class="sc-jgPyTC dSaTNC"><div class="sc-jNnpgg esZIbL"><div class="sc-giAqHp hMPeqJ"><button><div class="sc-carFqZ UksDl">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iJCRrE jCdxGr sc-dPaNzc gyljjx"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"certificate_ids"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><span class="token string">"cert_abc"</span></div></li></ul><span class="token punctuation">]</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Response samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-342" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-343" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-343" aria-labelledby="react-tabs-342"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-bBjRSN kQSIAz">application/json</div></div><div class="sc-jgPyTC dSaTNC"><div class="sc-jNnpgg esZIbL"><div class="sc-giAqHp hMPeqJ"><button><div class="sc-carFqZ UksDl">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iJCRrE jCdxGr sc-dPaNzc gyljjx"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"object"</span>: <span class="token string">"certificate"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"created_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"certificate_details"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"valid_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"expires_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"content"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"active"</span>: <span class="token boolean">true</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"first_id"</span>: <span class="token string">"cert_abc"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"last_id"</span>: <span class="token string">"cert_abc"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"has_more"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"object"</span>: <span class="token string">"list"</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Certificates/operation/deactivateOrganizationCertificates" data-section-id="tag/Certificates/operation/deactivateOrganizationCertificates" class="sc-eCApnc liLqNm"><div data-section-id="operation/deactivateOrganizationCertificates" id="operation/deactivateOrganizationCertificates" class="sc-iCoGMd gLxhOh"><div class="sc-hKFxyN juinod"><h2 class="sc-pNWdM eftmgB"><a class="sc-crzoAE iUxAWq" href="#tag/Certificates/operation/deactivateOrganizationCertificates" aria-label="tag/Certificates/operation/deactivateOrganizationCertificates"></a>Deactivate certificates at the organization level.
You can atomically and idempotently deactivate up to 10 certificates at a time.
<!-- --> </h2><div class="sc-fcmMJX cvfxAX"><div class="sc-jUfyBS bhDyou"><h5 class="sc-iqAclL sc-fuISkM eONCmm hZIgic">Authorizations:</h5><svg class="sc-dIsUp iPqByX" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jQAxuV ccffaZ"><span class="sc-daBunf fcvuS"><span class="sc-dsXzNU dPrSxx"><i>ApiKeyAuth</i></span></span></div></div><h5 class="sc-iqAclL eONCmm">Request Body schema: <span class="sc-cBoqAE eKyrDP">application/json</span></h5><div class="sc-iJCRrE sc-ciSkZP jCdxGr QGruV"><p>The certificate deactivation payload.</p>
</div><table class="sc-hHEiqL VCQHZ"><tbody><tr class="last "><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="certificate_ids"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">certificate_ids</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa">Array of </span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">strings</span><span> <span class="sc-laZMeE sc-FRrlG jWaWWE gHBwqe"> <!-- -->[ 1 .. 10 ] items<!-- --> </span></span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div></div></div></td></tr></tbody></table><div><h3 class="sc-fIxmyt DvFer">Responses</h3><div><button class="sc-htmcrh lbYftx"><svg class="sc-dIsUp dqYXmg" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-fWWYYk cMoEZ">200<!-- --> </strong><span class="sc-jcwpoC eDjFAZ"><p>Certificates deactivated successfully.</p>
</span></button></div></div></div><div class="sc-jSFjdj sc-gKAaRy gBjRyf gcushC"><div class="sc-EZqKI fWsqvQ"><button class="sc-eEVmNe ilvUMs"><span type="post" class="sc-fmdNqN ldMUmp http-verb post">post</span><span class="sc-jXcxbT fCEUju">/organization/certificates/deactivate</span><svg class="sc-dIsUp bRmrKA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ljsmAU flIrdF"><div class="sc-jlZJtj fQkroN"><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div><div tabindex="0" role="button"><div class="sc-dTSzeu dfUAUz"><span>https://api.openai.com/v1</span>/organization/certificates/deactivate</div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Request samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="react-tabs-344" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-345" tabindex="0" data-rttab="true">Payload</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-345" aria-labelledby="react-tabs-344"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-bBjRSN kQSIAz">application/json</div></div><div class="sc-jgPyTC dSaTNC"><div class="sc-jNnpgg esZIbL"><div class="sc-giAqHp hMPeqJ"><button><div class="sc-carFqZ UksDl">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iJCRrE jCdxGr sc-dPaNzc gyljjx"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"certificate_ids"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><span class="token string">"cert_abc"</span></div></li></ul><span class="token punctuation">]</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Response samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-346" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-347" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-347" aria-labelledby="react-tabs-346"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-bBjRSN kQSIAz">application/json</div></div><div class="sc-jgPyTC dSaTNC"><div class="sc-jNnpgg esZIbL"><div class="sc-giAqHp hMPeqJ"><button><div class="sc-carFqZ UksDl">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iJCRrE jCdxGr sc-dPaNzc gyljjx"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"object"</span>: <span class="token string">"certificate"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"created_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"certificate_details"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"valid_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"expires_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"content"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"active"</span>: <span class="token boolean">true</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"first_id"</span>: <span class="token string">"cert_abc"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"last_id"</span>: <span class="token string">"cert_abc"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"has_more"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"object"</span>: <span class="token string">"list"</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Certificates/operation/getCertificate" data-section-id="tag/Certificates/operation/getCertificate" class="sc-eCApnc liLqNm"><div data-section-id="operation/getCertificate" id="operation/getCertificate" class="sc-iCoGMd gLxhOh"><div class="sc-hKFxyN juinod"><h2 class="sc-pNWdM eftmgB"><a class="sc-crzoAE iUxAWq" href="#tag/Certificates/operation/getCertificate" aria-label="tag/Certificates/operation/getCertificate"></a>Get a certificate that has been uploaded to the organization.
You can get a certificate regardless of whether it is active or not.
<!-- --> </h2><div class="sc-fcmMJX cvfxAX"><div class="sc-jUfyBS bhDyou"><h5 class="sc-iqAclL sc-fuISkM eONCmm hZIgic">Authorizations:</h5><svg class="sc-dIsUp iPqByX" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jQAxuV ccffaZ"><span class="sc-daBunf fcvuS"><span class="sc-dsXzNU dPrSxx"><i>ApiKeyAuth</i></span></span></div></div><div><h5 class="sc-iqAclL eONCmm">path<!-- --> Parameters</h5><table class="sc-hHEiqL VCQHZ"><tbody><tr class="last "><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="certificate_id"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">certificate_id</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>Unique ID of the certificate to retrieve.</p>
</div></div></div></td></tr></tbody></table></div><div><h5 class="sc-iqAclL eONCmm">query<!-- --> Parameters</h5><table class="sc-hHEiqL VCQHZ"><tbody><tr class="last "><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="include"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">include</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa">Array of </span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">strings</span></div><div><span class="sc-laZMeE jWaWWE">Items<!-- --> <!-- -->Value<!-- -->:</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"content"</span> </div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>A list of additional fields to include in the response. Currently the only supported value is <code>content</code> to fetch the PEM content of the certificate.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-fIxmyt DvFer">Responses</h3><div><button class="sc-htmcrh lbYftx"><svg class="sc-dIsUp dqYXmg" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-fWWYYk cMoEZ">200<!-- --> </strong><span class="sc-jcwpoC eDjFAZ"><p>Certificate retrieved successfully.</p>
</span></button></div></div></div><div class="sc-jSFjdj sc-gKAaRy gBjRyf gcushC"><div class="sc-EZqKI fWsqvQ"><button class="sc-eEVmNe ilvUMs"><span type="get" class="sc-fmdNqN ihNycv http-verb get">get</span><span class="sc-jXcxbT fCEUju">/organization/certificates/{certificate_id}</span><svg class="sc-dIsUp bRmrKA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ljsmAU flIrdF"><div class="sc-jlZJtj fQkroN"><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div><div tabindex="0" role="button"><div class="sc-dTSzeu dfUAUz"><span>https://api.openai.com/v1</span>/organization/certificates/{certificate_id}</div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Response samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-348" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-349" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-349" aria-labelledby="react-tabs-348"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-bBjRSN kQSIAz">application/json</div></div><div class="sc-jgPyTC dSaTNC"><div class="sc-jNnpgg esZIbL"><div class="sc-giAqHp hMPeqJ"><button><div class="sc-carFqZ UksDl">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iJCRrE jCdxGr sc-dPaNzc gyljjx"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"object"</span>: <span class="token string">"certificate"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"created_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"certificate_details"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"valid_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"expires_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"content"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"active"</span>: <span class="token boolean">true</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Certificates/operation/modifyCertificate" data-section-id="tag/Certificates/operation/modifyCertificate" class="sc-eCApnc liLqNm"><div data-section-id="operation/modifyCertificate" id="operation/modifyCertificate" class="sc-iCoGMd gLxhOh"><div class="sc-hKFxyN juinod"><h2 class="sc-pNWdM eftmgB"><a class="sc-crzoAE iUxAWq" href="#tag/Certificates/operation/modifyCertificate" aria-label="tag/Certificates/operation/modifyCertificate"></a>Modify a certificate. Note that only the name can be modified.
<!-- --> </h2><div class="sc-fcmMJX cvfxAX"><div class="sc-jUfyBS bhDyou"><h5 class="sc-iqAclL sc-fuISkM eONCmm hZIgic">Authorizations:</h5><svg class="sc-dIsUp iPqByX" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jQAxuV ccffaZ"><span class="sc-daBunf fcvuS"><span class="sc-dsXzNU dPrSxx"><i>ApiKeyAuth</i></span></span></div></div><div><h5 class="sc-iqAclL eONCmm">path<!-- --> Parameters</h5><table class="sc-hHEiqL VCQHZ"><tbody><tr class="last "><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="certificate_id"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">certificate_id</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>Unique ID of the certificate to modify.</p>
</div></div></div></td></tr></tbody></table></div><h5 class="sc-iqAclL eONCmm">Request Body schema: <span class="sc-cBoqAE eKyrDP">application/json</span></h5><div class="sc-iJCRrE sc-ciSkZP jCdxGr QGruV"><p>The certificate modification payload.</p>
</div><table class="sc-hHEiqL VCQHZ"><tbody><tr class="last "><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="name"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">name</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The updated name for the certificate</p>
</div></div></div></td></tr></tbody></table><div><h3 class="sc-fIxmyt DvFer">Responses</h3><div><button class="sc-htmcrh lbYftx"><svg class="sc-dIsUp dqYXmg" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-fWWYYk cMoEZ">200<!-- --> </strong><span class="sc-jcwpoC eDjFAZ"><p>Certificate modified successfully.</p>
</span></button></div></div></div><div class="sc-jSFjdj sc-gKAaRy gBjRyf gcushC"><div class="sc-EZqKI fWsqvQ"><button class="sc-eEVmNe ilvUMs"><span type="post" class="sc-fmdNqN ldMUmp http-verb post">post</span><span class="sc-jXcxbT fCEUju">/organization/certificates/{certificate_id}</span><svg class="sc-dIsUp bRmrKA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ljsmAU flIrdF"><div class="sc-jlZJtj fQkroN"><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div><div tabindex="0" role="button"><div class="sc-dTSzeu dfUAUz"><span>https://api.openai.com/v1</span>/organization/certificates/{certificate_id}</div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Request samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="react-tabs-350" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-351" tabindex="0" data-rttab="true">Payload</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-351" aria-labelledby="react-tabs-350"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-bBjRSN kQSIAz">application/json</div></div><div class="sc-jgPyTC dSaTNC"><div class="sc-jNnpgg esZIbL"><div class="sc-giAqHp hMPeqJ"><button><div class="sc-carFqZ UksDl">Copy</div></button></div><div class="sc-iJCRrE jCdxGr sc-dPaNzc gyljjx"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Response samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-352" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-353" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-353" aria-labelledby="react-tabs-352"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-bBjRSN kQSIAz">application/json</div></div><div class="sc-jgPyTC dSaTNC"><div class="sc-jNnpgg esZIbL"><div class="sc-giAqHp hMPeqJ"><button><div class="sc-carFqZ UksDl">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iJCRrE jCdxGr sc-dPaNzc gyljjx"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"object"</span>: <span class="token string">"certificate"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"created_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"certificate_details"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"valid_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"expires_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"content"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"active"</span>: <span class="token boolean">true</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Certificates/operation/deleteCertificate" data-section-id="tag/Certificates/operation/deleteCertificate" class="sc-eCApnc liLqNm"><div data-section-id="operation/deleteCertificate" id="operation/deleteCertificate" class="sc-iCoGMd gLxhOh"><div class="sc-hKFxyN juinod"><h2 class="sc-pNWdM eftmgB"><a class="sc-crzoAE iUxAWq" href="#tag/Certificates/operation/deleteCertificate" aria-label="tag/Certificates/operation/deleteCertificate"></a>Delete a certificate from the organization.
The certificate must be inactive for the organization and all projects.
<!-- --> </h2><div class="sc-fcmMJX cvfxAX"><div class="sc-jUfyBS bhDyou"><h5 class="sc-iqAclL sc-fuISkM eONCmm hZIgic">Authorizations:</h5><svg class="sc-dIsUp iPqByX" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jQAxuV ccffaZ"><span class="sc-daBunf fcvuS"><span class="sc-dsXzNU dPrSxx"><i>ApiKeyAuth</i></span></span></div></div><div><h5 class="sc-iqAclL eONCmm">path<!-- --> Parameters</h5><table class="sc-hHEiqL VCQHZ"><tbody><tr class="last "><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="certificate_id"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">certificate_id</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>Unique ID of the certificate to delete.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-fIxmyt DvFer">Responses</h3><div><button class="sc-htmcrh lbYftx"><svg class="sc-dIsUp dqYXmg" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-fWWYYk cMoEZ">200<!-- --> </strong><span class="sc-jcwpoC eDjFAZ"><p>Certificate deleted successfully.</p>
</span></button></div></div></div><div class="sc-jSFjdj sc-gKAaRy gBjRyf gcushC"><div class="sc-EZqKI fWsqvQ"><button class="sc-eEVmNe ilvUMs"><span type="delete" class="sc-fmdNqN bJzUtf http-verb delete">delete</span><span class="sc-jXcxbT fCEUju">/organization/certificates/{certificate_id}</span><svg class="sc-dIsUp bRmrKA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ljsmAU flIrdF"><div class="sc-jlZJtj fQkroN"><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div><div tabindex="0" role="button"><div class="sc-dTSzeu dfUAUz"><span>https://api.openai.com/v1</span>/organization/certificates/{certificate_id}</div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Response samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-354" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-355" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-355" aria-labelledby="react-tabs-354"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-bBjRSN kQSIAz">application/json</div></div><div class="sc-jgPyTC dSaTNC"><div class="sc-jNnpgg esZIbL"><div class="sc-giAqHp hMPeqJ"><button><div class="sc-carFqZ UksDl">Copy</div></button></div><div class="sc-iJCRrE jCdxGr sc-dPaNzc gyljjx"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"object"</span>: <span class="token string">"certificate.deleted"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Certificates/operation/listProjectCertificates" data-section-id="tag/Certificates/operation/listProjectCertificates" class="sc-eCApnc liLqNm"><div data-section-id="operation/listProjectCertificates" id="operation/listProjectCertificates" class="sc-iCoGMd gLxhOh"><div class="sc-hKFxyN juinod"><h2 class="sc-pNWdM eftmgB"><a class="sc-crzoAE iUxAWq" href="#tag/Certificates/operation/listProjectCertificates" aria-label="tag/Certificates/operation/listProjectCertificates"></a>List certificates for this project.<!-- --> </h2><div class="sc-fcmMJX cvfxAX"><div class="sc-jUfyBS bhDyou"><h5 class="sc-iqAclL sc-fuISkM eONCmm hZIgic">Authorizations:</h5><svg class="sc-dIsUp iPqByX" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jQAxuV ccffaZ"><span class="sc-daBunf fcvuS"><span class="sc-dsXzNU dPrSxx"><i>ApiKeyAuth</i></span></span></div></div><div><h5 class="sc-iqAclL eONCmm">path<!-- --> Parameters</h5><table class="sc-hHEiqL VCQHZ"><tbody><tr class="last "><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="project_id"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">project_id</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The ID of the project.</p>
</div></div></div></td></tr></tbody></table></div><div><h5 class="sc-iqAclL eONCmm">query<!-- --> Parameters</h5><table class="sc-hHEiqL VCQHZ"><tbody><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="limit"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">limit</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">integer</span></div><div><span class="sc-laZMeE jWaWWE"> <!-- -->Default:<!-- --> </span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">20</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="after"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">after</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>A cursor for use in pagination. <code>after</code> is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list.</p>
</div></div></div></td></tr><tr class="last "><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="order"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">order</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div><div><span class="sc-laZMeE jWaWWE"> <!-- -->Default:<!-- --> </span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"desc"</span></div><div><span class="sc-laZMeE jWaWWE"> <!-- -->Enum<!-- -->:</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"asc"</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"desc"</span> </div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>Sort order by the <code>created_at</code> timestamp of the objects. <code>asc</code> for ascending order and <code>desc</code> for descending order.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-fIxmyt DvFer">Responses</h3><div><button class="sc-htmcrh lbYftx"><svg class="sc-dIsUp dqYXmg" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-fWWYYk cMoEZ">200<!-- --> </strong><span class="sc-jcwpoC eDjFAZ"><p>Certificates listed successfully.</p>
</span></button></div></div></div><div class="sc-jSFjdj sc-gKAaRy gBjRyf gcushC"><div class="sc-EZqKI fWsqvQ"><button class="sc-eEVmNe ilvUMs"><span type="get" class="sc-fmdNqN ihNycv http-verb get">get</span><span class="sc-jXcxbT fCEUju">/organization/projects/{project_id}/certificates</span><svg class="sc-dIsUp bRmrKA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ljsmAU flIrdF"><div class="sc-jlZJtj fQkroN"><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div><div tabindex="0" role="button"><div class="sc-dTSzeu dfUAUz"><span>https://api.openai.com/v1</span>/organization/projects/{project_id}/certificates</div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Response samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-356" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-357" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-357" aria-labelledby="react-tabs-356"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-bBjRSN kQSIAz">application/json</div></div><div class="sc-jgPyTC dSaTNC"><div class="sc-jNnpgg esZIbL"><div class="sc-giAqHp hMPeqJ"><button><div class="sc-carFqZ UksDl">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iJCRrE jCdxGr sc-dPaNzc gyljjx"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"object"</span>: <span class="token string">"certificate"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"created_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"certificate_details"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"valid_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"expires_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"content"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"active"</span>: <span class="token boolean">true</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"first_id"</span>: <span class="token string">"cert_abc"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"last_id"</span>: <span class="token string">"cert_abc"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"has_more"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"object"</span>: <span class="token string">"list"</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Certificates/operation/activateProjectCertificates" data-section-id="tag/Certificates/operation/activateProjectCertificates" class="sc-eCApnc liLqNm"><div data-section-id="operation/activateProjectCertificates" id="operation/activateProjectCertificates" class="sc-iCoGMd gLxhOh"><div class="sc-hKFxyN juinod"><h2 class="sc-pNWdM eftmgB"><a class="sc-crzoAE iUxAWq" href="#tag/Certificates/operation/activateProjectCertificates" aria-label="tag/Certificates/operation/activateProjectCertificates"></a>Activate certificates at the project level.
You can atomically and idempotently activate up to 10 certificates at a time.
<!-- --> </h2><div class="sc-fcmMJX cvfxAX"><div class="sc-jUfyBS bhDyou"><h5 class="sc-iqAclL sc-fuISkM eONCmm hZIgic">Authorizations:</h5><svg class="sc-dIsUp iPqByX" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jQAxuV ccffaZ"><span class="sc-daBunf fcvuS"><span class="sc-dsXzNU dPrSxx"><i>ApiKeyAuth</i></span></span></div></div><div><h5 class="sc-iqAclL eONCmm">path<!-- --> Parameters</h5><table class="sc-hHEiqL VCQHZ"><tbody><tr class="last "><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="project_id"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">project_id</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The ID of the project.</p>
</div></div></div></td></tr></tbody></table></div><h5 class="sc-iqAclL eONCmm">Request Body schema: <span class="sc-cBoqAE eKyrDP">application/json</span></h5><div class="sc-iJCRrE sc-ciSkZP jCdxGr QGruV"><p>The certificate activation payload.</p>
</div><table class="sc-hHEiqL VCQHZ"><tbody><tr class="last "><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="certificate_ids"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">certificate_ids</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa">Array of </span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">strings</span><span> <span class="sc-laZMeE sc-FRrlG jWaWWE gHBwqe"> <!-- -->[ 1 .. 10 ] items<!-- --> </span></span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div></div></div></td></tr></tbody></table><div><h3 class="sc-fIxmyt DvFer">Responses</h3><div><button class="sc-htmcrh lbYftx"><svg class="sc-dIsUp dqYXmg" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-fWWYYk cMoEZ">200<!-- --> </strong><span class="sc-jcwpoC eDjFAZ"><p>Certificates activated successfully.</p>
</span></button></div></div></div><div class="sc-jSFjdj sc-gKAaRy gBjRyf gcushC"><div class="sc-EZqKI fWsqvQ"><button class="sc-eEVmNe ilvUMs"><span type="post" class="sc-fmdNqN ldMUmp http-verb post">post</span><span class="sc-jXcxbT fCEUju">/organization/projects/{project_id}/certificates/activate</span><svg class="sc-dIsUp bRmrKA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ljsmAU flIrdF"><div class="sc-jlZJtj fQkroN"><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div><div tabindex="0" role="button"><div class="sc-dTSzeu dfUAUz"><span>https://api.openai.com/v1</span>/organization/projects/{project_id}/certificates/activate</div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Request samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="react-tabs-358" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-359" tabindex="0" data-rttab="true">Payload</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-359" aria-labelledby="react-tabs-358"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-bBjRSN kQSIAz">application/json</div></div><div class="sc-jgPyTC dSaTNC"><div class="sc-jNnpgg esZIbL"><div class="sc-giAqHp hMPeqJ"><button><div class="sc-carFqZ UksDl">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iJCRrE jCdxGr sc-dPaNzc gyljjx"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"certificate_ids"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><span class="token string">"cert_abc"</span></div></li></ul><span class="token punctuation">]</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Response samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-360" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-361" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-361" aria-labelledby="react-tabs-360"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-bBjRSN kQSIAz">application/json</div></div><div class="sc-jgPyTC dSaTNC"><div class="sc-jNnpgg esZIbL"><div class="sc-giAqHp hMPeqJ"><button><div class="sc-carFqZ UksDl">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iJCRrE jCdxGr sc-dPaNzc gyljjx"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"object"</span>: <span class="token string">"certificate"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"created_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"certificate_details"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"valid_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"expires_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"content"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"active"</span>: <span class="token boolean">true</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"first_id"</span>: <span class="token string">"cert_abc"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"last_id"</span>: <span class="token string">"cert_abc"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"has_more"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"object"</span>: <span class="token string">"list"</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Certificates/operation/deactivateProjectCertificates" data-section-id="tag/Certificates/operation/deactivateProjectCertificates" class="sc-eCApnc liLqNm"><div data-section-id="operation/deactivateProjectCertificates" id="operation/deactivateProjectCertificates" class="sc-iCoGMd gLxhOh"><div class="sc-hKFxyN juinod"><h2 class="sc-pNWdM eftmgB"><a class="sc-crzoAE iUxAWq" href="#tag/Certificates/operation/deactivateProjectCertificates" aria-label="tag/Certificates/operation/deactivateProjectCertificates"></a>Deactivate certificates at the project level. You can atomically and
idempotently deactivate up to 10 certificates at a time.
<!-- --> </h2><div class="sc-fcmMJX cvfxAX"><div class="sc-jUfyBS bhDyou"><h5 class="sc-iqAclL sc-fuISkM eONCmm hZIgic">Authorizations:</h5><svg class="sc-dIsUp iPqByX" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jQAxuV ccffaZ"><span class="sc-daBunf fcvuS"><span class="sc-dsXzNU dPrSxx"><i>ApiKeyAuth</i></span></span></div></div><div><h5 class="sc-iqAclL eONCmm">path<!-- --> Parameters</h5><table class="sc-hHEiqL VCQHZ"><tbody><tr class="last "><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="project_id"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">project_id</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The ID of the project.</p>
</div></div></div></td></tr></tbody></table></div><h5 class="sc-iqAclL eONCmm">Request Body schema: <span class="sc-cBoqAE eKyrDP">application/json</span></h5><div class="sc-iJCRrE sc-ciSkZP jCdxGr QGruV"><p>The certificate deactivation payload.</p>
</div><table class="sc-hHEiqL VCQHZ"><tbody><tr class="last "><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="certificate_ids"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">certificate_ids</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa">Array of </span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">strings</span><span> <span class="sc-laZMeE sc-FRrlG jWaWWE gHBwqe"> <!-- -->[ 1 .. 10 ] items<!-- --> </span></span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div></div></div></td></tr></tbody></table><div><h3 class="sc-fIxmyt DvFer">Responses</h3><div><button class="sc-htmcrh lbYftx"><svg class="sc-dIsUp dqYXmg" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-fWWYYk cMoEZ">200<!-- --> </strong><span class="sc-jcwpoC eDjFAZ"><p>Certificates deactivated successfully.</p>
</span></button></div></div></div><div class="sc-jSFjdj sc-gKAaRy gBjRyf gcushC"><div class="sc-EZqKI fWsqvQ"><button class="sc-eEVmNe ilvUMs"><span type="post" class="sc-fmdNqN ldMUmp http-verb post">post</span><span class="sc-jXcxbT fCEUju">/organization/projects/{project_id}/certificates/deactivate</span><svg class="sc-dIsUp bRmrKA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ljsmAU flIrdF"><div class="sc-jlZJtj fQkroN"><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div><div tabindex="0" role="button"><div class="sc-dTSzeu dfUAUz"><span>https://api.openai.com/v1</span>/organization/projects/{project_id}/certificates/deactivate</div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Request samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="react-tabs-362" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-363" tabindex="0" data-rttab="true">Payload</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-363" aria-labelledby="react-tabs-362"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-bBjRSN kQSIAz">application/json</div></div><div class="sc-jgPyTC dSaTNC"><div class="sc-jNnpgg esZIbL"><div class="sc-giAqHp hMPeqJ"><button><div class="sc-carFqZ UksDl">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iJCRrE jCdxGr sc-dPaNzc gyljjx"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"certificate_ids"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><span class="token string">"cert_abc"</span></div></li></ul><span class="token punctuation">]</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Response samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-364" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-365" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-365" aria-labelledby="react-tabs-364"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-bBjRSN kQSIAz">application/json</div></div><div class="sc-jgPyTC dSaTNC"><div class="sc-jNnpgg esZIbL"><div class="sc-giAqHp hMPeqJ"><button><div class="sc-carFqZ UksDl">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iJCRrE jCdxGr sc-dPaNzc gyljjx"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"object"</span>: <span class="token string">"certificate"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"created_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"certificate_details"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"valid_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"expires_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"content"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"active"</span>: <span class="token boolean">true</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"first_id"</span>: <span class="token string">"cert_abc"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"last_id"</span>: <span class="token string">"cert_abc"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"has_more"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"object"</span>: <span class="token string">"list"</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Usage" data-section-id="tag/Usage" class="sc-eCApnc jlMQbh"><div class="sc-iCoGMd gLxhOh"><div class="sc-hKFxyN juinod"><h1 class="sc-fujyAs bpZWeL"><a class="sc-crzoAE iUxAWq" href="#tag/Usage" aria-label="tag/Usage"></a>Usage</h1></div></div></div><div id="tag/Usage/operation/usage-costs" data-section-id="tag/Usage/operation/usage-costs" class="sc-eCApnc liLqNm"><div data-section-id="operation/usage-costs" id="operation/usage-costs" class="sc-iCoGMd gLxhOh"><div class="sc-hKFxyN juinod"><h2 class="sc-pNWdM eftmgB"><a class="sc-crzoAE iUxAWq" href="#tag/Usage/operation/usage-costs" aria-label="tag/Usage/operation/usage-costs"></a>Get costs details for the organization.<!-- --> </h2><div class="sc-fcmMJX cvfxAX"><div class="sc-jUfyBS bhDyou"><h5 class="sc-iqAclL sc-fuISkM eONCmm hZIgic">Authorizations:</h5><svg class="sc-dIsUp iPqByX" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jQAxuV ccffaZ"><span class="sc-daBunf fcvuS"><span class="sc-dsXzNU dPrSxx"><i>ApiKeyAuth</i></span></span></div></div><div><h5 class="sc-iqAclL eONCmm">query<!-- --> Parameters</h5><table class="sc-hHEiqL VCQHZ"><tbody><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="start_time"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">start_time</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">integer</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>Start time (Unix seconds) of the query time range, inclusive.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="end_time"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">end_time</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">integer</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>End time (Unix seconds) of the query time range, exclusive.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="bucket_width"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">bucket_width</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div><div><span class="sc-laZMeE jWaWWE"> <!-- -->Default:<!-- --> </span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"1d"</span></div><div><span class="sc-laZMeE jWaWWE"> <!-- -->Value<!-- -->:</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"1d"</span> </div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>Width of each time bucket in response. Currently only <code>1d</code> is supported, default to <code>1d</code>.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="project_ids"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">project_ids</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa">Array of </span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">strings</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>Return only costs for these projects.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="group_by"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">group_by</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa">Array of </span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">strings</span></div><div><span class="sc-laZMeE jWaWWE">Items<!-- --> <!-- -->Enum<!-- -->:</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"project_id"</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"line_item"</span> </div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>Group the costs by the specified fields. Support fields include <code>project_id</code>, <code>line_item</code> and any combination of them.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="limit"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">limit</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">integer</span></div><div><span class="sc-laZMeE jWaWWE"> <!-- -->Default:<!-- --> </span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">7</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>A limit on the number of buckets to be returned. Limit can range between 1 and 180, and the default is 7.</p>
</div></div></div></td></tr><tr class="last "><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="page"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">page</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>A cursor for use in pagination. Corresponding to the <code>next_page</code> field from the previous response.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-fIxmyt DvFer">Responses</h3><div><button class="sc-htmcrh lbYftx"><svg class="sc-dIsUp dqYXmg" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-fWWYYk cMoEZ">200<!-- --> </strong><span class="sc-jcwpoC eDjFAZ"><p>Costs data retrieved successfully.</p>
</span></button></div></div></div><div class="sc-jSFjdj sc-gKAaRy gBjRyf gcushC"><div class="sc-EZqKI fWsqvQ"><button class="sc-eEVmNe ilvUMs"><span type="get" class="sc-fmdNqN ihNycv http-verb get">get</span><span class="sc-jXcxbT fCEUju">/organization/costs</span><svg class="sc-dIsUp bRmrKA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ljsmAU flIrdF"><div class="sc-jlZJtj fQkroN"><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div><div tabindex="0" role="button"><div class="sc-dTSzeu dfUAUz"><span>https://api.openai.com/v1</span>/organization/costs</div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Response samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-366" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-367" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-367" aria-labelledby="react-tabs-366"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-bBjRSN kQSIAz">application/json</div></div><div class="sc-jgPyTC dSaTNC"><div class="sc-jNnpgg esZIbL"><div class="sc-giAqHp hMPeqJ"><button><div class="sc-carFqZ UksDl">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iJCRrE jCdxGr sc-dPaNzc gyljjx"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"object"</span>: <span class="token string">"page"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"object"</span>: <span class="token string">"bucket"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"start_time"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"end_time"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"result"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"object"</span>: <span class="token string">"organization.usage.completions.result"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"input_tokens"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"input_cached_tokens"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"output_tokens"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"input_audio_tokens"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"output_audio_tokens"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"num_model_requests"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"project_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"user_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"api_key_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"model"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"batch"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"service_tier"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"has_more"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"next_page"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Usage/operation/usage-audio-speeches" data-section-id="tag/Usage/operation/usage-audio-speeches" class="sc-eCApnc liLqNm"><div data-section-id="operation/usage-audio-speeches" id="operation/usage-audio-speeches" class="sc-iCoGMd gLxhOh"><div class="sc-hKFxyN juinod"><h2 class="sc-pNWdM eftmgB"><a class="sc-crzoAE iUxAWq" href="#tag/Usage/operation/usage-audio-speeches" aria-label="tag/Usage/operation/usage-audio-speeches"></a>Get audio speeches usage details for the organization.<!-- --> </h2><div class="sc-fcmMJX cvfxAX"><div class="sc-jUfyBS bhDyou"><h5 class="sc-iqAclL sc-fuISkM eONCmm hZIgic">Authorizations:</h5><svg class="sc-dIsUp iPqByX" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jQAxuV ccffaZ"><span class="sc-daBunf fcvuS"><span class="sc-dsXzNU dPrSxx"><i>ApiKeyAuth</i></span></span></div></div><div><h5 class="sc-iqAclL eONCmm">query<!-- --> Parameters</h5><table class="sc-hHEiqL VCQHZ"><tbody><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="start_time"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">start_time</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">integer</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>Start time (Unix seconds) of the query time range, inclusive.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="end_time"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">end_time</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">integer</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>End time (Unix seconds) of the query time range, exclusive.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="bucket_width"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">bucket_width</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div><div><span class="sc-laZMeE jWaWWE"> <!-- -->Default:<!-- --> </span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"1d"</span></div><div><span class="sc-laZMeE jWaWWE"> <!-- -->Enum<!-- -->:</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"1m"</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"1h"</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"1d"</span> </div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>Width of each time bucket in response. Currently <code>1m</code>, <code>1h</code> and <code>1d</code> are supported, default to <code>1d</code>.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="project_ids"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">project_ids</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa">Array of </span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">strings</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>Return only usage for these projects.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="user_ids"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">user_ids</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa">Array of </span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">strings</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>Return only usage for these users.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="api_key_ids"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">api_key_ids</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa">Array of </span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">strings</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>Return only usage for these API keys.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="models"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">models</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa">Array of </span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">strings</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>Return only usage for these models.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="group_by"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">group_by</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa">Array of </span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">strings</span></div><div><span class="sc-laZMeE jWaWWE">Items<!-- --> <!-- -->Enum<!-- -->:</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"project_id"</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"user_id"</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"api_key_id"</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"model"</span> </div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>Group the usage data by the specified fields. Support fields include <code>project_id</code>, <code>user_id</code>, <code>api_key_id</code>, <code>model</code> or any combination of them.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="limit"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">limit</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">integer</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>Specifies the number of buckets to return.</p>
<ul>
<li><code>bucket_width=1d</code>: default: 7, max: 31</li>
<li><code>bucket_width=1h</code>: default: 24, max: 168</li>
<li><code>bucket_width=1m</code>: default: 60, max: 1440</li>
</ul>
</div></div></div></td></tr><tr class="last "><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="page"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">page</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>A cursor for use in pagination. Corresponding to the <code>next_page</code> field from the previous response.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-fIxmyt DvFer">Responses</h3><div><button class="sc-htmcrh lbYftx"><svg class="sc-dIsUp dqYXmg" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-fWWYYk cMoEZ">200<!-- --> </strong><span class="sc-jcwpoC eDjFAZ"><p>Usage data retrieved successfully.</p>
</span></button></div></div></div><div class="sc-jSFjdj sc-gKAaRy gBjRyf gcushC"><div class="sc-EZqKI fWsqvQ"><button class="sc-eEVmNe ilvUMs"><span type="get" class="sc-fmdNqN ihNycv http-verb get">get</span><span class="sc-jXcxbT fCEUju">/organization/usage/audio_speeches</span><svg class="sc-dIsUp bRmrKA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ljsmAU flIrdF"><div class="sc-jlZJtj fQkroN"><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div><div tabindex="0" role="button"><div class="sc-dTSzeu dfUAUz"><span>https://api.openai.com/v1</span>/organization/usage/audio_speeches</div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Response samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-368" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-369" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-369" aria-labelledby="react-tabs-368"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-bBjRSN kQSIAz">application/json</div></div><div class="sc-jgPyTC dSaTNC"><div class="sc-jNnpgg esZIbL"><div class="sc-giAqHp hMPeqJ"><button><div class="sc-carFqZ UksDl">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iJCRrE jCdxGr sc-dPaNzc gyljjx"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"object"</span>: <span class="token string">"page"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"object"</span>: <span class="token string">"bucket"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"start_time"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"end_time"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"result"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"object"</span>: <span class="token string">"organization.usage.completions.result"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"input_tokens"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"input_cached_tokens"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"output_tokens"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"input_audio_tokens"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"output_audio_tokens"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"num_model_requests"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"project_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"user_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"api_key_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"model"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"batch"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"service_tier"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"has_more"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"next_page"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Usage/operation/usage-audio-transcriptions" data-section-id="tag/Usage/operation/usage-audio-transcriptions" class="sc-eCApnc liLqNm"><div data-section-id="operation/usage-audio-transcriptions" id="operation/usage-audio-transcriptions" class="sc-iCoGMd gLxhOh"><div class="sc-hKFxyN juinod"><h2 class="sc-pNWdM eftmgB"><a class="sc-crzoAE iUxAWq" href="#tag/Usage/operation/usage-audio-transcriptions" aria-label="tag/Usage/operation/usage-audio-transcriptions"></a>Get audio transcriptions usage details for the organization.<!-- --> </h2><div class="sc-fcmMJX cvfxAX"><div class="sc-jUfyBS bhDyou"><h5 class="sc-iqAclL sc-fuISkM eONCmm hZIgic">Authorizations:</h5><svg class="sc-dIsUp iPqByX" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jQAxuV ccffaZ"><span class="sc-daBunf fcvuS"><span class="sc-dsXzNU dPrSxx"><i>ApiKeyAuth</i></span></span></div></div><div><h5 class="sc-iqAclL eONCmm">query<!-- --> Parameters</h5><table class="sc-hHEiqL VCQHZ"><tbody><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="start_time"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">start_time</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">integer</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>Start time (Unix seconds) of the query time range, inclusive.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="end_time"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">end_time</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">integer</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>End time (Unix seconds) of the query time range, exclusive.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="bucket_width"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">bucket_width</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div><div><span class="sc-laZMeE jWaWWE"> <!-- -->Default:<!-- --> </span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"1d"</span></div><div><span class="sc-laZMeE jWaWWE"> <!-- -->Enum<!-- -->:</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"1m"</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"1h"</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"1d"</span> </div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>Width of each time bucket in response. Currently <code>1m</code>, <code>1h</code> and <code>1d</code> are supported, default to <code>1d</code>.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="project_ids"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">project_ids</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa">Array of </span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">strings</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>Return only usage for these projects.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="user_ids"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">user_ids</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa">Array of </span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">strings</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>Return only usage for these users.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="api_key_ids"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">api_key_ids</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa">Array of </span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">strings</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>Return only usage for these API keys.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="models"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">models</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa">Array of </span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">strings</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>Return only usage for these models.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="group_by"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">group_by</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa">Array of </span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">strings</span></div><div><span class="sc-laZMeE jWaWWE">Items<!-- --> <!-- -->Enum<!-- -->:</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"project_id"</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"user_id"</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"api_key_id"</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"model"</span> </div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>Group the usage data by the specified fields. Support fields include <code>project_id</code>, <code>user_id</code>, <code>api_key_id</code>, <code>model</code> or any combination of them.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="limit"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">limit</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">integer</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>Specifies the number of buckets to return.</p>
<ul>
<li><code>bucket_width=1d</code>: default: 7, max: 31</li>
<li><code>bucket_width=1h</code>: default: 24, max: 168</li>
<li><code>bucket_width=1m</code>: default: 60, max: 1440</li>
</ul>
</div></div></div></td></tr><tr class="last "><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="page"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">page</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>A cursor for use in pagination. Corresponding to the <code>next_page</code> field from the previous response.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-fIxmyt DvFer">Responses</h3><div><button class="sc-htmcrh lbYftx"><svg class="sc-dIsUp dqYXmg" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-fWWYYk cMoEZ">200<!-- --> </strong><span class="sc-jcwpoC eDjFAZ"><p>Usage data retrieved successfully.</p>
</span></button></div></div></div><div class="sc-jSFjdj sc-gKAaRy gBjRyf gcushC"><div class="sc-EZqKI fWsqvQ"><button class="sc-eEVmNe ilvUMs"><span type="get" class="sc-fmdNqN ihNycv http-verb get">get</span><span class="sc-jXcxbT fCEUju">/organization/usage/audio_transcriptions</span><svg class="sc-dIsUp bRmrKA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ljsmAU flIrdF"><div class="sc-jlZJtj fQkroN"><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div><div tabindex="0" role="button"><div class="sc-dTSzeu dfUAUz"><span>https://api.openai.com/v1</span>/organization/usage/audio_transcriptions</div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Response samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-370" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-371" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-371" aria-labelledby="react-tabs-370"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-bBjRSN kQSIAz">application/json</div></div><div class="sc-jgPyTC dSaTNC"><div class="sc-jNnpgg esZIbL"><div class="sc-giAqHp hMPeqJ"><button><div class="sc-carFqZ UksDl">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iJCRrE jCdxGr sc-dPaNzc gyljjx"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"object"</span>: <span class="token string">"page"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"object"</span>: <span class="token string">"bucket"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"start_time"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"end_time"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"result"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"object"</span>: <span class="token string">"organization.usage.completions.result"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"input_tokens"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"input_cached_tokens"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"output_tokens"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"input_audio_tokens"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"output_audio_tokens"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"num_model_requests"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"project_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"user_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"api_key_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"model"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"batch"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"service_tier"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"has_more"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"next_page"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Usage/operation/usage-code-interpreter-sessions" data-section-id="tag/Usage/operation/usage-code-interpreter-sessions" class="sc-eCApnc liLqNm"><div data-section-id="operation/usage-code-interpreter-sessions" id="operation/usage-code-interpreter-sessions" class="sc-iCoGMd gLxhOh"><div class="sc-hKFxyN juinod"><h2 class="sc-pNWdM eftmgB"><a class="sc-crzoAE iUxAWq" href="#tag/Usage/operation/usage-code-interpreter-sessions" aria-label="tag/Usage/operation/usage-code-interpreter-sessions"></a>Get code interpreter sessions usage details for the organization.<!-- --> </h2><div class="sc-fcmMJX cvfxAX"><div class="sc-jUfyBS bhDyou"><h5 class="sc-iqAclL sc-fuISkM eONCmm hZIgic">Authorizations:</h5><svg class="sc-dIsUp iPqByX" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jQAxuV ccffaZ"><span class="sc-daBunf fcvuS"><span class="sc-dsXzNU dPrSxx"><i>ApiKeyAuth</i></span></span></div></div><div><h5 class="sc-iqAclL eONCmm">query<!-- --> Parameters</h5><table class="sc-hHEiqL VCQHZ"><tbody><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="start_time"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">start_time</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">integer</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>Start time (Unix seconds) of the query time range, inclusive.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="end_time"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">end_time</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">integer</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>End time (Unix seconds) of the query time range, exclusive.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="bucket_width"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">bucket_width</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div><div><span class="sc-laZMeE jWaWWE"> <!-- -->Default:<!-- --> </span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"1d"</span></div><div><span class="sc-laZMeE jWaWWE"> <!-- -->Enum<!-- -->:</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"1m"</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"1h"</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"1d"</span> </div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>Width of each time bucket in response. Currently <code>1m</code>, <code>1h</code> and <code>1d</code> are supported, default to <code>1d</code>.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="project_ids"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">project_ids</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa">Array of </span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">strings</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>Return only usage for these projects.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="group_by"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">group_by</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa">Array of </span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">strings</span></div><div><span class="sc-laZMeE jWaWWE">Items<!-- --> <!-- -->Value<!-- -->:</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"project_id"</span> </div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>Group the usage data by the specified fields. Support fields include <code>project_id</code>.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="limit"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">limit</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">integer</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>Specifies the number of buckets to return.</p>
<ul>
<li><code>bucket_width=1d</code>: default: 7, max: 31</li>
<li><code>bucket_width=1h</code>: default: 24, max: 168</li>
<li><code>bucket_width=1m</code>: default: 60, max: 1440</li>
</ul>
</div></div></div></td></tr><tr class="last "><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="page"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">page</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>A cursor for use in pagination. Corresponding to the <code>next_page</code> field from the previous response.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-fIxmyt DvFer">Responses</h3><div><button class="sc-htmcrh lbYftx"><svg class="sc-dIsUp dqYXmg" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-fWWYYk cMoEZ">200<!-- --> </strong><span class="sc-jcwpoC eDjFAZ"><p>Usage data retrieved successfully.</p>
</span></button></div></div></div><div class="sc-jSFjdj sc-gKAaRy gBjRyf gcushC"><div class="sc-EZqKI fWsqvQ"><button class="sc-eEVmNe ilvUMs"><span type="get" class="sc-fmdNqN ihNycv http-verb get">get</span><span class="sc-jXcxbT fCEUju">/organization/usage/code_interpreter_sessions</span><svg class="sc-dIsUp bRmrKA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ljsmAU flIrdF"><div class="sc-jlZJtj fQkroN"><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div><div tabindex="0" role="button"><div class="sc-dTSzeu dfUAUz"><span>https://api.openai.com/v1</span>/organization/usage/code_interpreter_sessions</div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Response samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-372" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-373" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-373" aria-labelledby="react-tabs-372"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-bBjRSN kQSIAz">application/json</div></div><div class="sc-jgPyTC dSaTNC"><div class="sc-jNnpgg esZIbL"><div class="sc-giAqHp hMPeqJ"><button><div class="sc-carFqZ UksDl">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iJCRrE jCdxGr sc-dPaNzc gyljjx"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"object"</span>: <span class="token string">"page"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"object"</span>: <span class="token string">"bucket"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"start_time"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"end_time"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"result"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"object"</span>: <span class="token string">"organization.usage.completions.result"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"input_tokens"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"input_cached_tokens"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"output_tokens"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"input_audio_tokens"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"output_audio_tokens"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"num_model_requests"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"project_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"user_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"api_key_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"model"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"batch"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"service_tier"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"has_more"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"next_page"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Usage/operation/usage-completions" data-section-id="tag/Usage/operation/usage-completions" class="sc-eCApnc liLqNm"><div data-section-id="operation/usage-completions" id="operation/usage-completions" class="sc-iCoGMd gLxhOh"><div class="sc-hKFxyN juinod"><h2 class="sc-pNWdM eftmgB"><a class="sc-crzoAE iUxAWq" href="#tag/Usage/operation/usage-completions" aria-label="tag/Usage/operation/usage-completions"></a>Get completions usage details for the organization.<!-- --> </h2><div class="sc-fcmMJX cvfxAX"><div class="sc-jUfyBS bhDyou"><h5 class="sc-iqAclL sc-fuISkM eONCmm hZIgic">Authorizations:</h5><svg class="sc-dIsUp iPqByX" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jQAxuV ccffaZ"><span class="sc-daBunf fcvuS"><span class="sc-dsXzNU dPrSxx"><i>ApiKeyAuth</i></span></span></div></div><div><h5 class="sc-iqAclL eONCmm">query<!-- --> Parameters</h5><table class="sc-hHEiqL VCQHZ"><tbody><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="start_time"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">start_time</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">integer</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>Start time (Unix seconds) of the query time range, inclusive.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="end_time"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">end_time</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">integer</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>End time (Unix seconds) of the query time range, exclusive.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="bucket_width"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">bucket_width</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div><div><span class="sc-laZMeE jWaWWE"> <!-- -->Default:<!-- --> </span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"1d"</span></div><div><span class="sc-laZMeE jWaWWE"> <!-- -->Enum<!-- -->:</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"1m"</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"1h"</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"1d"</span> </div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>Width of each time bucket in response. Currently <code>1m</code>, <code>1h</code> and <code>1d</code> are supported, default to <code>1d</code>.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="project_ids"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">project_ids</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa">Array of </span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">strings</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>Return only usage for these projects.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="user_ids"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">user_ids</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa">Array of </span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">strings</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>Return only usage for these users.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="api_key_ids"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">api_key_ids</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa">Array of </span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">strings</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>Return only usage for these API keys.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="models"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">models</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa">Array of </span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">strings</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>Return only usage for these models.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="batch"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">batch</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">boolean</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>If <code>true</code>, return batch jobs only. If <code>false</code>, return non-batch jobs only. By default, return both.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="group_by"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">group_by</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa">Array of </span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">strings</span></div><div><span class="sc-laZMeE jWaWWE">Items<!-- --> <!-- -->Enum<!-- -->:</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"project_id"</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"user_id"</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"api_key_id"</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"model"</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"batch"</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"service_tier"</span> </div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>Group the usage data by the specified fields. Support fields include <code>project_id</code>, <code>user_id</code>, <code>api_key_id</code>, <code>model</code>, <code>batch</code>, <code>service_tier</code> or any combination of them.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="limit"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">limit</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">integer</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>Specifies the number of buckets to return.</p>
<ul>
<li><code>bucket_width=1d</code>: default: 7, max: 31</li>
<li><code>bucket_width=1h</code>: default: 24, max: 168</li>
<li><code>bucket_width=1m</code>: default: 60, max: 1440</li>
</ul>
</div></div></div></td></tr><tr class="last "><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="page"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">page</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>A cursor for use in pagination. Corresponding to the <code>next_page</code> field from the previous response.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-fIxmyt DvFer">Responses</h3><div><button class="sc-htmcrh lbYftx"><svg class="sc-dIsUp dqYXmg" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-fWWYYk cMoEZ">200<!-- --> </strong><span class="sc-jcwpoC eDjFAZ"><p>Usage data retrieved successfully.</p>
</span></button></div></div></div><div class="sc-jSFjdj sc-gKAaRy gBjRyf gcushC"><div class="sc-EZqKI fWsqvQ"><button class="sc-eEVmNe ilvUMs"><span type="get" class="sc-fmdNqN ihNycv http-verb get">get</span><span class="sc-jXcxbT fCEUju">/organization/usage/completions</span><svg class="sc-dIsUp bRmrKA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ljsmAU flIrdF"><div class="sc-jlZJtj fQkroN"><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div><div tabindex="0" role="button"><div class="sc-dTSzeu dfUAUz"><span>https://api.openai.com/v1</span>/organization/usage/completions</div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Response samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-374" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-375" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-375" aria-labelledby="react-tabs-374"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-bBjRSN kQSIAz">application/json</div></div><div class="sc-jgPyTC dSaTNC"><div class="sc-jNnpgg esZIbL"><div class="sc-giAqHp hMPeqJ"><button><div class="sc-carFqZ UksDl">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iJCRrE jCdxGr sc-dPaNzc gyljjx"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"object"</span>: <span class="token string">"page"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"object"</span>: <span class="token string">"bucket"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"start_time"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"end_time"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"result"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"object"</span>: <span class="token string">"organization.usage.completions.result"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"input_tokens"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"input_cached_tokens"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"output_tokens"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"input_audio_tokens"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"output_audio_tokens"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"num_model_requests"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"project_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"user_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"api_key_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"model"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"batch"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"service_tier"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"has_more"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"next_page"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Usage/operation/usage-embeddings" data-section-id="tag/Usage/operation/usage-embeddings" class="sc-eCApnc liLqNm"><div data-section-id="operation/usage-embeddings" id="operation/usage-embeddings" class="sc-iCoGMd gLxhOh"><div class="sc-hKFxyN juinod"><h2 class="sc-pNWdM eftmgB"><a class="sc-crzoAE iUxAWq" href="#tag/Usage/operation/usage-embeddings" aria-label="tag/Usage/operation/usage-embeddings"></a>Get embeddings usage details for the organization.<!-- --> </h2><div class="sc-fcmMJX cvfxAX"><div class="sc-jUfyBS bhDyou"><h5 class="sc-iqAclL sc-fuISkM eONCmm hZIgic">Authorizations:</h5><svg class="sc-dIsUp iPqByX" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jQAxuV ccffaZ"><span class="sc-daBunf fcvuS"><span class="sc-dsXzNU dPrSxx"><i>ApiKeyAuth</i></span></span></div></div><div><h5 class="sc-iqAclL eONCmm">query<!-- --> Parameters</h5><table class="sc-hHEiqL VCQHZ"><tbody><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="start_time"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">start_time</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">integer</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>Start time (Unix seconds) of the query time range, inclusive.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="end_time"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">end_time</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">integer</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>End time (Unix seconds) of the query time range, exclusive.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="bucket_width"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">bucket_width</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div><div><span class="sc-laZMeE jWaWWE"> <!-- -->Default:<!-- --> </span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"1d"</span></div><div><span class="sc-laZMeE jWaWWE"> <!-- -->Enum<!-- -->:</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"1m"</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"1h"</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"1d"</span> </div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>Width of each time bucket in response. Currently <code>1m</code>, <code>1h</code> and <code>1d</code> are supported, default to <code>1d</code>.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="project_ids"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">project_ids</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa">Array of </span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">strings</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>Return only usage for these projects.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="user_ids"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">user_ids</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa">Array of </span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">strings</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>Return only usage for these users.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="api_key_ids"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">api_key_ids</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa">Array of </span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">strings</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>Return only usage for these API keys.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="models"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">models</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa">Array of </span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">strings</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>Return only usage for these models.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="group_by"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">group_by</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa">Array of </span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">strings</span></div><div><span class="sc-laZMeE jWaWWE">Items<!-- --> <!-- -->Enum<!-- -->:</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"project_id"</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"user_id"</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"api_key_id"</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"model"</span> </div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>Group the usage data by the specified fields. Support fields include <code>project_id</code>, <code>user_id</code>, <code>api_key_id</code>, <code>model</code> or any combination of them.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="limit"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">limit</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">integer</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>Specifies the number of buckets to return.</p>
<ul>
<li><code>bucket_width=1d</code>: default: 7, max: 31</li>
<li><code>bucket_width=1h</code>: default: 24, max: 168</li>
<li><code>bucket_width=1m</code>: default: 60, max: 1440</li>
</ul>
</div></div></div></td></tr><tr class="last "><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="page"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">page</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>A cursor for use in pagination. Corresponding to the <code>next_page</code> field from the previous response.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-fIxmyt DvFer">Responses</h3><div><button class="sc-htmcrh lbYftx"><svg class="sc-dIsUp dqYXmg" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-fWWYYk cMoEZ">200<!-- --> </strong><span class="sc-jcwpoC eDjFAZ"><p>Usage data retrieved successfully.</p>
</span></button></div></div></div><div class="sc-jSFjdj sc-gKAaRy gBjRyf gcushC"><div class="sc-EZqKI fWsqvQ"><button class="sc-eEVmNe ilvUMs"><span type="get" class="sc-fmdNqN ihNycv http-verb get">get</span><span class="sc-jXcxbT fCEUju">/organization/usage/embeddings</span><svg class="sc-dIsUp bRmrKA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ljsmAU flIrdF"><div class="sc-jlZJtj fQkroN"><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div><div tabindex="0" role="button"><div class="sc-dTSzeu dfUAUz"><span>https://api.openai.com/v1</span>/organization/usage/embeddings</div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Response samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-376" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-377" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-377" aria-labelledby="react-tabs-376"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-bBjRSN kQSIAz">application/json</div></div><div class="sc-jgPyTC dSaTNC"><div class="sc-jNnpgg esZIbL"><div class="sc-giAqHp hMPeqJ"><button><div class="sc-carFqZ UksDl">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iJCRrE jCdxGr sc-dPaNzc gyljjx"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"object"</span>: <span class="token string">"page"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"object"</span>: <span class="token string">"bucket"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"start_time"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"end_time"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"result"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"object"</span>: <span class="token string">"organization.usage.completions.result"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"input_tokens"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"input_cached_tokens"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"output_tokens"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"input_audio_tokens"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"output_audio_tokens"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"num_model_requests"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"project_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"user_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"api_key_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"model"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"batch"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"service_tier"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"has_more"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"next_page"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Usage/operation/usage-images" data-section-id="tag/Usage/operation/usage-images" class="sc-eCApnc liLqNm"><div data-section-id="operation/usage-images" id="operation/usage-images" class="sc-iCoGMd gLxhOh"><div class="sc-hKFxyN juinod"><h2 class="sc-pNWdM eftmgB"><a class="sc-crzoAE iUxAWq" href="#tag/Usage/operation/usage-images" aria-label="tag/Usage/operation/usage-images"></a>Get images usage details for the organization.<!-- --> </h2><div class="sc-fcmMJX cvfxAX"><div class="sc-jUfyBS bhDyou"><h5 class="sc-iqAclL sc-fuISkM eONCmm hZIgic">Authorizations:</h5><svg class="sc-dIsUp iPqByX" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jQAxuV ccffaZ"><span class="sc-daBunf fcvuS"><span class="sc-dsXzNU dPrSxx"><i>ApiKeyAuth</i></span></span></div></div><div><h5 class="sc-iqAclL eONCmm">query<!-- --> Parameters</h5><table class="sc-hHEiqL VCQHZ"><tbody><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="start_time"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">start_time</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">integer</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>Start time (Unix seconds) of the query time range, inclusive.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="end_time"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">end_time</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">integer</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>End time (Unix seconds) of the query time range, exclusive.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="bucket_width"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">bucket_width</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div><div><span class="sc-laZMeE jWaWWE"> <!-- -->Default:<!-- --> </span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"1d"</span></div><div><span class="sc-laZMeE jWaWWE"> <!-- -->Enum<!-- -->:</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"1m"</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"1h"</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"1d"</span> </div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>Width of each time bucket in response. Currently <code>1m</code>, <code>1h</code> and <code>1d</code> are supported, default to <code>1d</code>.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="sources"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">sources</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa">Array of </span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">strings</span></div><div><span class="sc-laZMeE jWaWWE">Items<!-- --> <!-- -->Enum<!-- -->:</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"image.generation"</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"image.edit"</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"image.variation"</span> </div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>Return only usages for these sources. Possible values are <code>image.generation</code>, <code>image.edit</code>, <code>image.variation</code> or any combination of them.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="sizes"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">sizes</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa">Array of </span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">strings</span></div><div><span class="sc-laZMeE jWaWWE">Items<!-- --> <!-- -->Enum<!-- -->:</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"256x256"</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"512x512"</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"1024x1024"</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"1792x1792"</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"1024x1792"</span> </div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>Return only usages for these image sizes. Possible values are <code>256x256</code>, <code>512x512</code>, <code>1024x1024</code>, <code>1792x1792</code>, <code>1024x1792</code> or any combination of them.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="project_ids"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">project_ids</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa">Array of </span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">strings</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>Return only usage for these projects.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="user_ids"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">user_ids</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa">Array of </span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">strings</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>Return only usage for these users.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="api_key_ids"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">api_key_ids</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa">Array of </span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">strings</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>Return only usage for these API keys.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="models"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">models</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa">Array of </span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">strings</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>Return only usage for these models.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="group_by"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">group_by</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa">Array of </span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">strings</span></div><div><span class="sc-laZMeE jWaWWE">Items<!-- --> <!-- -->Enum<!-- -->:</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"project_id"</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"user_id"</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"api_key_id"</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"model"</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"size"</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"source"</span> </div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>Group the usage data by the specified fields. Support fields include <code>project_id</code>, <code>user_id</code>, <code>api_key_id</code>, <code>model</code>, <code>size</code>, <code>source</code> or any combination of them.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="limit"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">limit</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">integer</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>Specifies the number of buckets to return.</p>
<ul>
<li><code>bucket_width=1d</code>: default: 7, max: 31</li>
<li><code>bucket_width=1h</code>: default: 24, max: 168</li>
<li><code>bucket_width=1m</code>: default: 60, max: 1440</li>
</ul>
</div></div></div></td></tr><tr class="last "><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="page"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">page</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>A cursor for use in pagination. Corresponding to the <code>next_page</code> field from the previous response.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-fIxmyt DvFer">Responses</h3><div><button class="sc-htmcrh lbYftx"><svg class="sc-dIsUp dqYXmg" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-fWWYYk cMoEZ">200<!-- --> </strong><span class="sc-jcwpoC eDjFAZ"><p>Usage data retrieved successfully.</p>
</span></button></div></div></div><div class="sc-jSFjdj sc-gKAaRy gBjRyf gcushC"><div class="sc-EZqKI fWsqvQ"><button class="sc-eEVmNe ilvUMs"><span type="get" class="sc-fmdNqN ihNycv http-verb get">get</span><span class="sc-jXcxbT fCEUju">/organization/usage/images</span><svg class="sc-dIsUp bRmrKA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ljsmAU flIrdF"><div class="sc-jlZJtj fQkroN"><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div><div tabindex="0" role="button"><div class="sc-dTSzeu dfUAUz"><span>https://api.openai.com/v1</span>/organization/usage/images</div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Response samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-378" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-379" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-379" aria-labelledby="react-tabs-378"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-bBjRSN kQSIAz">application/json</div></div><div class="sc-jgPyTC dSaTNC"><div class="sc-jNnpgg esZIbL"><div class="sc-giAqHp hMPeqJ"><button><div class="sc-carFqZ UksDl">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iJCRrE jCdxGr sc-dPaNzc gyljjx"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"object"</span>: <span class="token string">"page"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"object"</span>: <span class="token string">"bucket"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"start_time"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"end_time"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"result"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"object"</span>: <span class="token string">"organization.usage.completions.result"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"input_tokens"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"input_cached_tokens"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"output_tokens"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"input_audio_tokens"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"output_audio_tokens"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"num_model_requests"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"project_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"user_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"api_key_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"model"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"batch"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"service_tier"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"has_more"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"next_page"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Usage/operation/usage-moderations" data-section-id="tag/Usage/operation/usage-moderations" class="sc-eCApnc liLqNm"><div data-section-id="operation/usage-moderations" id="operation/usage-moderations" class="sc-iCoGMd gLxhOh"><div class="sc-hKFxyN juinod"><h2 class="sc-pNWdM eftmgB"><a class="sc-crzoAE iUxAWq" href="#tag/Usage/operation/usage-moderations" aria-label="tag/Usage/operation/usage-moderations"></a>Get moderations usage details for the organization.<!-- --> </h2><div class="sc-fcmMJX cvfxAX"><div class="sc-jUfyBS bhDyou"><h5 class="sc-iqAclL sc-fuISkM eONCmm hZIgic">Authorizations:</h5><svg class="sc-dIsUp iPqByX" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jQAxuV ccffaZ"><span class="sc-daBunf fcvuS"><span class="sc-dsXzNU dPrSxx"><i>ApiKeyAuth</i></span></span></div></div><div><h5 class="sc-iqAclL eONCmm">query<!-- --> Parameters</h5><table class="sc-hHEiqL VCQHZ"><tbody><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="start_time"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">start_time</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">integer</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>Start time (Unix seconds) of the query time range, inclusive.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="end_time"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">end_time</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">integer</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>End time (Unix seconds) of the query time range, exclusive.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="bucket_width"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">bucket_width</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div><div><span class="sc-laZMeE jWaWWE"> <!-- -->Default:<!-- --> </span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"1d"</span></div><div><span class="sc-laZMeE jWaWWE"> <!-- -->Enum<!-- -->:</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"1m"</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"1h"</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"1d"</span> </div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>Width of each time bucket in response. Currently <code>1m</code>, <code>1h</code> and <code>1d</code> are supported, default to <code>1d</code>.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="project_ids"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">project_ids</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa">Array of </span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">strings</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>Return only usage for these projects.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="user_ids"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">user_ids</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa">Array of </span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">strings</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>Return only usage for these users.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="api_key_ids"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">api_key_ids</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa">Array of </span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">strings</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>Return only usage for these API keys.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="models"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">models</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa">Array of </span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">strings</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>Return only usage for these models.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="group_by"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">group_by</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa">Array of </span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">strings</span></div><div><span class="sc-laZMeE jWaWWE">Items<!-- --> <!-- -->Enum<!-- -->:</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"project_id"</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"user_id"</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"api_key_id"</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"model"</span> </div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>Group the usage data by the specified fields. Support fields include <code>project_id</code>, <code>user_id</code>, <code>api_key_id</code>, <code>model</code> or any combination of them.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="limit"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">limit</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">integer</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>Specifies the number of buckets to return.</p>
<ul>
<li><code>bucket_width=1d</code>: default: 7, max: 31</li>
<li><code>bucket_width=1h</code>: default: 24, max: 168</li>
<li><code>bucket_width=1m</code>: default: 60, max: 1440</li>
</ul>
</div></div></div></td></tr><tr class="last "><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="page"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">page</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>A cursor for use in pagination. Corresponding to the <code>next_page</code> field from the previous response.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-fIxmyt DvFer">Responses</h3><div><button class="sc-htmcrh lbYftx"><svg class="sc-dIsUp dqYXmg" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-fWWYYk cMoEZ">200<!-- --> </strong><span class="sc-jcwpoC eDjFAZ"><p>Usage data retrieved successfully.</p>
</span></button></div></div></div><div class="sc-jSFjdj sc-gKAaRy gBjRyf gcushC"><div class="sc-EZqKI fWsqvQ"><button class="sc-eEVmNe ilvUMs"><span type="get" class="sc-fmdNqN ihNycv http-verb get">get</span><span class="sc-jXcxbT fCEUju">/organization/usage/moderations</span><svg class="sc-dIsUp bRmrKA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ljsmAU flIrdF"><div class="sc-jlZJtj fQkroN"><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div><div tabindex="0" role="button"><div class="sc-dTSzeu dfUAUz"><span>https://api.openai.com/v1</span>/organization/usage/moderations</div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Response samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-380" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-381" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-381" aria-labelledby="react-tabs-380"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-bBjRSN kQSIAz">application/json</div></div><div class="sc-jgPyTC dSaTNC"><div class="sc-jNnpgg esZIbL"><div class="sc-giAqHp hMPeqJ"><button><div class="sc-carFqZ UksDl">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iJCRrE jCdxGr sc-dPaNzc gyljjx"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"object"</span>: <span class="token string">"page"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"object"</span>: <span class="token string">"bucket"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"start_time"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"end_time"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"result"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"object"</span>: <span class="token string">"organization.usage.completions.result"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"input_tokens"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"input_cached_tokens"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"output_tokens"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"input_audio_tokens"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"output_audio_tokens"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"num_model_requests"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"project_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"user_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"api_key_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"model"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"batch"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"service_tier"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"has_more"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"next_page"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Usage/operation/usage-vector-stores" data-section-id="tag/Usage/operation/usage-vector-stores" class="sc-eCApnc liLqNm"><div data-section-id="operation/usage-vector-stores" id="operation/usage-vector-stores" class="sc-iCoGMd gLxhOh"><div class="sc-hKFxyN juinod"><h2 class="sc-pNWdM eftmgB"><a class="sc-crzoAE iUxAWq" href="#tag/Usage/operation/usage-vector-stores" aria-label="tag/Usage/operation/usage-vector-stores"></a>Get vector stores usage details for the organization.<!-- --> </h2><div class="sc-fcmMJX cvfxAX"><div class="sc-jUfyBS bhDyou"><h5 class="sc-iqAclL sc-fuISkM eONCmm hZIgic">Authorizations:</h5><svg class="sc-dIsUp iPqByX" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jQAxuV ccffaZ"><span class="sc-daBunf fcvuS"><span class="sc-dsXzNU dPrSxx"><i>ApiKeyAuth</i></span></span></div></div><div><h5 class="sc-iqAclL eONCmm">query<!-- --> Parameters</h5><table class="sc-hHEiqL VCQHZ"><tbody><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="start_time"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">start_time</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">integer</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>Start time (Unix seconds) of the query time range, inclusive.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="end_time"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">end_time</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">integer</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>End time (Unix seconds) of the query time range, exclusive.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="bucket_width"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">bucket_width</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div><div><span class="sc-laZMeE jWaWWE"> <!-- -->Default:<!-- --> </span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"1d"</span></div><div><span class="sc-laZMeE jWaWWE"> <!-- -->Enum<!-- -->:</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"1m"</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"1h"</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"1d"</span> </div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>Width of each time bucket in response. Currently <code>1m</code>, <code>1h</code> and <code>1d</code> are supported, default to <code>1d</code>.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="project_ids"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">project_ids</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa">Array of </span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">strings</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>Return only usage for these projects.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="group_by"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">group_by</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa">Array of </span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">strings</span></div><div><span class="sc-laZMeE jWaWWE">Items<!-- --> <!-- -->Value<!-- -->:</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"project_id"</span> </div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>Group the usage data by the specified fields. Support fields include <code>project_id</code>.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="limit"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">limit</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">integer</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>Specifies the number of buckets to return.</p>
<ul>
<li><code>bucket_width=1d</code>: default: 7, max: 31</li>
<li><code>bucket_width=1h</code>: default: 24, max: 168</li>
<li><code>bucket_width=1m</code>: default: 60, max: 1440</li>
</ul>
</div></div></div></td></tr><tr class="last "><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="page"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">page</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>A cursor for use in pagination. Corresponding to the <code>next_page</code> field from the previous response.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-fIxmyt DvFer">Responses</h3><div><button class="sc-htmcrh lbYftx"><svg class="sc-dIsUp dqYXmg" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-fWWYYk cMoEZ">200<!-- --> </strong><span class="sc-jcwpoC eDjFAZ"><p>Usage data retrieved successfully.</p>
</span></button></div></div></div><div class="sc-jSFjdj sc-gKAaRy gBjRyf gcushC"><div class="sc-EZqKI fWsqvQ"><button class="sc-eEVmNe ilvUMs"><span type="get" class="sc-fmdNqN ihNycv http-verb get">get</span><span class="sc-jXcxbT fCEUju">/organization/usage/vector_stores</span><svg class="sc-dIsUp bRmrKA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ljsmAU flIrdF"><div class="sc-jlZJtj fQkroN"><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div><div tabindex="0" role="button"><div class="sc-dTSzeu dfUAUz"><span>https://api.openai.com/v1</span>/organization/usage/vector_stores</div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Response samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-382" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-383" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-383" aria-labelledby="react-tabs-382"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-bBjRSN kQSIAz">application/json</div></div><div class="sc-jgPyTC dSaTNC"><div class="sc-jNnpgg esZIbL"><div class="sc-giAqHp hMPeqJ"><button><div class="sc-carFqZ UksDl">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iJCRrE jCdxGr sc-dPaNzc gyljjx"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"object"</span>: <span class="token string">"page"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"object"</span>: <span class="token string">"bucket"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"start_time"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"end_time"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"result"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"object"</span>: <span class="token string">"organization.usage.completions.result"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"input_tokens"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"input_cached_tokens"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"output_tokens"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"input_audio_tokens"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"output_audio_tokens"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"num_model_requests"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"project_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"user_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"api_key_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"model"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"batch"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"service_tier"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"has_more"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"next_page"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Groups" data-section-id="tag/Groups" class="sc-eCApnc jlMQbh"><div class="sc-iCoGMd gLxhOh"><div class="sc-hKFxyN juinod"><h1 class="sc-fujyAs bpZWeL"><a class="sc-crzoAE iUxAWq" href="#tag/Groups" aria-label="tag/Groups"></a>Groups</h1></div></div></div><div id="tag/Groups/operation/list-groups" data-section-id="tag/Groups/operation/list-groups" class="sc-eCApnc liLqNm"><div data-section-id="operation/list-groups" id="operation/list-groups" class="sc-iCoGMd gLxhOh"><div class="sc-hKFxyN juinod"><h2 class="sc-pNWdM eftmgB"><a class="sc-crzoAE iUxAWq" href="#tag/Groups/operation/list-groups" aria-label="tag/Groups/operation/list-groups"></a>Lists all groups in the organization.<!-- --> </h2><div class="sc-fcmMJX cvfxAX"><div class="sc-jUfyBS bhDyou"><h5 class="sc-iqAclL sc-fuISkM eONCmm hZIgic">Authorizations:</h5><svg class="sc-dIsUp iPqByX" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jQAxuV ccffaZ"><span class="sc-daBunf fcvuS"><span class="sc-dsXzNU dPrSxx"><i>ApiKeyAuth</i></span></span></div></div><div><h5 class="sc-iqAclL eONCmm">query<!-- --> Parameters</h5><table class="sc-hHEiqL VCQHZ"><tbody><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="limit"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">limit</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">integer</span><span> <span class="sc-laZMeE sc-FRrlG jWaWWE gHBwqe"> <!-- -->[ 0 .. 1000 ]<!-- --> </span></span></div><div><span class="sc-laZMeE jWaWWE"> <!-- -->Default:<!-- --> </span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">100</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>A limit on the number of groups to be returned. Limit can range between 0 and 1000, and the default is 100.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="after"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">after</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>A cursor for use in pagination. <code>after</code> is a group ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with group_abc, your subsequent call can include <code>after=group_abc</code> in order to fetch the next page of the list.</p>
</div></div></div></td></tr><tr class="last "><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="order"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">order</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div><div><span class="sc-laZMeE jWaWWE"> <!-- -->Default:<!-- --> </span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"asc"</span></div><div><span class="sc-laZMeE jWaWWE"> <!-- -->Enum<!-- -->:</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"asc"</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"desc"</span> </div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>Specifies the sort order of the returned groups.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-fIxmyt DvFer">Responses</h3><div><button class="sc-htmcrh lbYftx"><svg class="sc-dIsUp dqYXmg" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-fWWYYk cMoEZ">200<!-- --> </strong><span class="sc-jcwpoC eDjFAZ"><p>Groups listed successfully.</p>
</span></button></div></div></div><div class="sc-jSFjdj sc-gKAaRy gBjRyf gcushC"><div class="sc-EZqKI fWsqvQ"><button class="sc-eEVmNe ilvUMs"><span type="get" class="sc-fmdNqN ihNycv http-verb get">get</span><span class="sc-jXcxbT fCEUju">/organization/groups</span><svg class="sc-dIsUp bRmrKA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ljsmAU flIrdF"><div class="sc-jlZJtj fQkroN"><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div><div tabindex="0" role="button"><div class="sc-dTSzeu dfUAUz"><span>https://api.openai.com/v1</span>/organization/groups</div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Response samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-384" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-385" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-385" aria-labelledby="react-tabs-384"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-bBjRSN kQSIAz">application/json</div></div><div class="sc-jgPyTC dSaTNC"><div class="sc-jNnpgg esZIbL"><div class="sc-giAqHp hMPeqJ"><button><div class="sc-carFqZ UksDl">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iJCRrE jCdxGr sc-dPaNzc gyljjx"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"object"</span>: <span class="token string">"list"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"created_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"is_scim_managed"</span>: <span class="token boolean">true</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"has_more"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"next"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Groups/operation/create-group" data-section-id="tag/Groups/operation/create-group" class="sc-eCApnc liLqNm"><div data-section-id="operation/create-group" id="operation/create-group" class="sc-iCoGMd gLxhOh"><div class="sc-hKFxyN juinod"><h2 class="sc-pNWdM eftmgB"><a class="sc-crzoAE iUxAWq" href="#tag/Groups/operation/create-group" aria-label="tag/Groups/operation/create-group"></a>Creates a new group in the organization.<!-- --> </h2><div class="sc-fcmMJX cvfxAX"><div class="sc-jUfyBS bhDyou"><h5 class="sc-iqAclL sc-fuISkM eONCmm hZIgic">Authorizations:</h5><svg class="sc-dIsUp iPqByX" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jQAxuV ccffaZ"><span class="sc-daBunf fcvuS"><span class="sc-dsXzNU dPrSxx"><i>ApiKeyAuth</i></span></span></div></div><h5 class="sc-iqAclL eONCmm">Request Body schema: <span class="sc-cBoqAE eKyrDP">application/json</span></h5><div class="sc-iJCRrE sc-ciSkZP jCdxGr QGruV"><p>Parameters for the group you want to create.</p>
</div><table class="sc-hHEiqL VCQHZ"><tbody><tr class="last "><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="name"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">name</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span><span> <span class="sc-laZMeE sc-FRrlG jWaWWE gHBwqe"> <!-- -->[ 1 .. 255 ] characters<!-- --> </span></span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>Human readable name for the group.</p>
</div></div></div></td></tr></tbody></table><div><h3 class="sc-fIxmyt DvFer">Responses</h3><div><button class="sc-htmcrh lbYftx"><svg class="sc-dIsUp dqYXmg" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-fWWYYk cMoEZ">200<!-- --> </strong><span class="sc-jcwpoC eDjFAZ"><p>Group created successfully.</p>
</span></button></div></div></div><div class="sc-jSFjdj sc-gKAaRy gBjRyf gcushC"><div class="sc-EZqKI fWsqvQ"><button class="sc-eEVmNe ilvUMs"><span type="post" class="sc-fmdNqN ldMUmp http-verb post">post</span><span class="sc-jXcxbT fCEUju">/organization/groups</span><svg class="sc-dIsUp bRmrKA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ljsmAU flIrdF"><div class="sc-jlZJtj fQkroN"><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div><div tabindex="0" role="button"><div class="sc-dTSzeu dfUAUz"><span>https://api.openai.com/v1</span>/organization/groups</div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Request samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="react-tabs-386" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-387" tabindex="0" data-rttab="true">Payload</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-387" aria-labelledby="react-tabs-386"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-bBjRSN kQSIAz">application/json</div></div><div class="sc-jgPyTC dSaTNC"><div class="sc-jNnpgg esZIbL"><div class="sc-giAqHp hMPeqJ"><button><div class="sc-carFqZ UksDl">Copy</div></button></div><div class="sc-iJCRrE jCdxGr sc-dPaNzc gyljjx"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Response samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-388" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-389" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-389" aria-labelledby="react-tabs-388"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-bBjRSN kQSIAz">application/json</div></div><div class="sc-jgPyTC dSaTNC"><div class="sc-jNnpgg esZIbL"><div class="sc-giAqHp hMPeqJ"><button><div class="sc-carFqZ UksDl">Copy</div></button></div><div class="sc-iJCRrE jCdxGr sc-dPaNzc gyljjx"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"created_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"is_scim_managed"</span>: <span class="token boolean">true</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Groups/operation/update-group" data-section-id="tag/Groups/operation/update-group" class="sc-eCApnc liLqNm"><div data-section-id="operation/update-group" id="operation/update-group" class="sc-iCoGMd gLxhOh"><div class="sc-hKFxyN juinod"><h2 class="sc-pNWdM eftmgB"><a class="sc-crzoAE iUxAWq" href="#tag/Groups/operation/update-group" aria-label="tag/Groups/operation/update-group"></a>Updates a group's information.<!-- --> </h2><div class="sc-fcmMJX cvfxAX"><div class="sc-jUfyBS bhDyou"><h5 class="sc-iqAclL sc-fuISkM eONCmm hZIgic">Authorizations:</h5><svg class="sc-dIsUp iPqByX" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jQAxuV ccffaZ"><span class="sc-daBunf fcvuS"><span class="sc-dsXzNU dPrSxx"><i>ApiKeyAuth</i></span></span></div></div><div><h5 class="sc-iqAclL eONCmm">path<!-- --> Parameters</h5><table class="sc-hHEiqL VCQHZ"><tbody><tr class="last "><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="group_id"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">group_id</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The ID of the group to update.</p>
</div></div></div></td></tr></tbody></table></div><h5 class="sc-iqAclL eONCmm">Request Body schema: <span class="sc-cBoqAE eKyrDP">application/json</span></h5><div class="sc-iJCRrE sc-ciSkZP jCdxGr QGruV"><p>New attributes to set on the group.</p>
</div><table class="sc-hHEiqL VCQHZ"><tbody><tr class="last "><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="name"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">name</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span><span> <span class="sc-laZMeE sc-FRrlG jWaWWE gHBwqe"> <!-- -->[ 1 .. 255 ] characters<!-- --> </span></span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>New display name for the group.</p>
</div></div></div></td></tr></tbody></table><div><h3 class="sc-fIxmyt DvFer">Responses</h3><div><button class="sc-htmcrh lbYftx"><svg class="sc-dIsUp dqYXmg" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-fWWYYk cMoEZ">200<!-- --> </strong><span class="sc-jcwpoC eDjFAZ"><p>Group updated successfully.</p>
</span></button></div></div></div><div class="sc-jSFjdj sc-gKAaRy gBjRyf gcushC"><div class="sc-EZqKI fWsqvQ"><button class="sc-eEVmNe ilvUMs"><span type="post" class="sc-fmdNqN ldMUmp http-verb post">post</span><span class="sc-jXcxbT fCEUju">/organization/groups/{group_id}</span><svg class="sc-dIsUp bRmrKA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ljsmAU flIrdF"><div class="sc-jlZJtj fQkroN"><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div><div tabindex="0" role="button"><div class="sc-dTSzeu dfUAUz"><span>https://api.openai.com/v1</span>/organization/groups/{group_id}</div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Request samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="react-tabs-390" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-391" tabindex="0" data-rttab="true">Payload</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-391" aria-labelledby="react-tabs-390"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-bBjRSN kQSIAz">application/json</div></div><div class="sc-jgPyTC dSaTNC"><div class="sc-jNnpgg esZIbL"><div class="sc-giAqHp hMPeqJ"><button><div class="sc-carFqZ UksDl">Copy</div></button></div><div class="sc-iJCRrE jCdxGr sc-dPaNzc gyljjx"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Response samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-392" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-393" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-393" aria-labelledby="react-tabs-392"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-bBjRSN kQSIAz">application/json</div></div><div class="sc-jgPyTC dSaTNC"><div class="sc-jNnpgg esZIbL"><div class="sc-giAqHp hMPeqJ"><button><div class="sc-carFqZ UksDl">Copy</div></button></div><div class="sc-iJCRrE jCdxGr sc-dPaNzc gyljjx"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"created_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"is_scim_managed"</span>: <span class="token boolean">true</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Groups/operation/delete-group" data-section-id="tag/Groups/operation/delete-group" class="sc-eCApnc liLqNm"><div data-section-id="operation/delete-group" id="operation/delete-group" class="sc-iCoGMd gLxhOh"><div class="sc-hKFxyN juinod"><h2 class="sc-pNWdM eftmgB"><a class="sc-crzoAE iUxAWq" href="#tag/Groups/operation/delete-group" aria-label="tag/Groups/operation/delete-group"></a>Deletes a group from the organization.<!-- --> </h2><div class="sc-fcmMJX cvfxAX"><div class="sc-jUfyBS bhDyou"><h5 class="sc-iqAclL sc-fuISkM eONCmm hZIgic">Authorizations:</h5><svg class="sc-dIsUp iPqByX" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jQAxuV ccffaZ"><span class="sc-daBunf fcvuS"><span class="sc-dsXzNU dPrSxx"><i>ApiKeyAuth</i></span></span></div></div><div><h5 class="sc-iqAclL eONCmm">path<!-- --> Parameters</h5><table class="sc-hHEiqL VCQHZ"><tbody><tr class="last "><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="group_id"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">group_id</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The ID of the group to delete.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-fIxmyt DvFer">Responses</h3><div><button class="sc-htmcrh lbYftx"><svg class="sc-dIsUp dqYXmg" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-fWWYYk cMoEZ">200<!-- --> </strong><span class="sc-jcwpoC eDjFAZ"><p>Group deleted successfully.</p>
</span></button></div></div></div><div class="sc-jSFjdj sc-gKAaRy gBjRyf gcushC"><div class="sc-EZqKI fWsqvQ"><button class="sc-eEVmNe ilvUMs"><span type="delete" class="sc-fmdNqN bJzUtf http-verb delete">delete</span><span class="sc-jXcxbT fCEUju">/organization/groups/{group_id}</span><svg class="sc-dIsUp bRmrKA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ljsmAU flIrdF"><div class="sc-jlZJtj fQkroN"><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div><div tabindex="0" role="button"><div class="sc-dTSzeu dfUAUz"><span>https://api.openai.com/v1</span>/organization/groups/{group_id}</div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Response samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-394" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-395" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-395" aria-labelledby="react-tabs-394"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-bBjRSN kQSIAz">application/json</div></div><div class="sc-jgPyTC dSaTNC"><div class="sc-jNnpgg esZIbL"><div class="sc-giAqHp hMPeqJ"><button><div class="sc-carFqZ UksDl">Copy</div></button></div><div class="sc-iJCRrE jCdxGr sc-dPaNzc gyljjx"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"object"</span>: <span class="token string">"group.deleted"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"deleted"</span>: <span class="token boolean">true</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Group-organization-role-assignments" data-section-id="tag/Group-organization-role-assignments" class="sc-eCApnc jlMQbh"><div class="sc-iCoGMd gLxhOh"><div class="sc-hKFxyN juinod"><h1 class="sc-fujyAs bpZWeL"><a class="sc-crzoAE iUxAWq" href="#tag/Group-organization-role-assignments" aria-label="tag/Group-organization-role-assignments"></a>Group organization role assignments</h1></div></div></div><div id="tag/Group-organization-role-assignments/operation/list-group-role-assignments" data-section-id="tag/Group-organization-role-assignments/operation/list-group-role-assignments" class="sc-eCApnc liLqNm"><div data-section-id="operation/list-group-role-assignments" id="operation/list-group-role-assignments" class="sc-iCoGMd gLxhOh"><div class="sc-hKFxyN juinod"><h2 class="sc-pNWdM eftmgB"><a class="sc-crzoAE iUxAWq" href="#tag/Group-organization-role-assignments/operation/list-group-role-assignments" aria-label="tag/Group-organization-role-assignments/operation/list-group-role-assignments"></a>Lists the organization roles assigned to a group within the organization.<!-- --> </h2><div class="sc-fcmMJX cvfxAX"><div class="sc-jUfyBS bhDyou"><h5 class="sc-iqAclL sc-fuISkM eONCmm hZIgic">Authorizations:</h5><svg class="sc-dIsUp iPqByX" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jQAxuV ccffaZ"><span class="sc-daBunf fcvuS"><span class="sc-dsXzNU dPrSxx"><i>ApiKeyAuth</i></span></span></div></div><div><h5 class="sc-iqAclL eONCmm">path<!-- --> Parameters</h5><table class="sc-hHEiqL VCQHZ"><tbody><tr class="last "><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="group_id"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">group_id</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The ID of the group whose organization role assignments you want to list.</p>
</div></div></div></td></tr></tbody></table></div><div><h5 class="sc-iqAclL eONCmm">query<!-- --> Parameters</h5><table class="sc-hHEiqL VCQHZ"><tbody><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="limit"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">limit</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">integer</span><span> <span class="sc-laZMeE sc-FRrlG jWaWWE gHBwqe"> <!-- -->[ 0 .. 1000 ]<!-- --> </span></span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>A limit on the number of organization role assignments to return.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="after"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">after</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>Cursor for pagination. Provide the value from the previous response's <code>next</code> field to continue listing organization roles.</p>
</div></div></div></td></tr><tr class="last "><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="order"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">order</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div><div><span class="sc-laZMeE jWaWWE"> <!-- -->Enum<!-- -->:</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"asc"</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"desc"</span> </div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>Sort order for the returned organization roles.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-fIxmyt DvFer">Responses</h3><div><button class="sc-htmcrh lbYftx"><svg class="sc-dIsUp dqYXmg" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-fWWYYk cMoEZ">200<!-- --> </strong><span class="sc-jcwpoC eDjFAZ"><p>Group organization role assignments listed successfully.</p>
</span></button></div></div></div><div class="sc-jSFjdj sc-gKAaRy gBjRyf gcushC"><div class="sc-EZqKI fWsqvQ"><button class="sc-eEVmNe ilvUMs"><span type="get" class="sc-fmdNqN ihNycv http-verb get">get</span><span class="sc-jXcxbT fCEUju">/organization/groups/{group_id}/roles</span><svg class="sc-dIsUp bRmrKA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ljsmAU flIrdF"><div class="sc-jlZJtj fQkroN"><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div><div tabindex="0" role="button"><div class="sc-dTSzeu dfUAUz"><span>https://api.openai.com/v1</span>/organization/groups/{group_id}/roles</div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Response samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-396" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-397" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-397" aria-labelledby="react-tabs-396"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-bBjRSN kQSIAz">application/json</div></div><div class="sc-jgPyTC dSaTNC"><div class="sc-jNnpgg esZIbL"><div class="sc-giAqHp hMPeqJ"><button><div class="sc-carFqZ UksDl">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iJCRrE jCdxGr sc-dPaNzc gyljjx"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"object"</span>: <span class="token string">"list"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"permissions"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><span class="token string">"string"</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"resource_type"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"predefined_role"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"description"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"created_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"updated_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"created_by"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"created_by_user_obj"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"has_more"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"next"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Group-organization-role-assignments/operation/assign-group-role" data-section-id="tag/Group-organization-role-assignments/operation/assign-group-role" class="sc-eCApnc liLqNm"><div data-section-id="operation/assign-group-role" id="operation/assign-group-role" class="sc-iCoGMd gLxhOh"><div class="sc-hKFxyN juinod"><h2 class="sc-pNWdM eftmgB"><a class="sc-crzoAE iUxAWq" href="#tag/Group-organization-role-assignments/operation/assign-group-role" aria-label="tag/Group-organization-role-assignments/operation/assign-group-role"></a>Assigns an organization role to a group within the organization.<!-- --> </h2><div class="sc-fcmMJX cvfxAX"><div class="sc-jUfyBS bhDyou"><h5 class="sc-iqAclL sc-fuISkM eONCmm hZIgic">Authorizations:</h5><svg class="sc-dIsUp iPqByX" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jQAxuV ccffaZ"><span class="sc-daBunf fcvuS"><span class="sc-dsXzNU dPrSxx"><i>ApiKeyAuth</i></span></span></div></div><div><h5 class="sc-iqAclL eONCmm">path<!-- --> Parameters</h5><table class="sc-hHEiqL VCQHZ"><tbody><tr class="last "><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="group_id"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">group_id</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The ID of the group that should receive the organization role.</p>
</div></div></div></td></tr></tbody></table></div><h5 class="sc-iqAclL eONCmm">Request Body schema: <span class="sc-cBoqAE eKyrDP">application/json</span></h5><div class="sc-iJCRrE sc-ciSkZP jCdxGr QGruV"><p>Identifies the organization role to assign to the group.</p>
</div><table class="sc-hHEiqL VCQHZ"><tbody><tr class="last "><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="role_id"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">role_id</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>Identifier of the role to assign.</p>
</div></div></div></td></tr></tbody></table><div><h3 class="sc-fIxmyt DvFer">Responses</h3><div><button class="sc-htmcrh lbYftx"><svg class="sc-dIsUp dqYXmg" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-fWWYYk cMoEZ">200<!-- --> </strong><span class="sc-jcwpoC eDjFAZ"><p>Organization role assigned to the group successfully.</p>
</span></button></div></div></div><div class="sc-jSFjdj sc-gKAaRy gBjRyf gcushC"><div class="sc-EZqKI fWsqvQ"><button class="sc-eEVmNe ilvUMs"><span type="post" class="sc-fmdNqN ldMUmp http-verb post">post</span><span class="sc-jXcxbT fCEUju">/organization/groups/{group_id}/roles</span><svg class="sc-dIsUp bRmrKA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ljsmAU flIrdF"><div class="sc-jlZJtj fQkroN"><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div><div tabindex="0" role="button"><div class="sc-dTSzeu dfUAUz"><span>https://api.openai.com/v1</span>/organization/groups/{group_id}/roles</div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Request samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="react-tabs-398" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-399" tabindex="0" data-rttab="true">Payload</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-399" aria-labelledby="react-tabs-398"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-bBjRSN kQSIAz">application/json</div></div><div class="sc-jgPyTC dSaTNC"><div class="sc-jNnpgg esZIbL"><div class="sc-giAqHp hMPeqJ"><button><div class="sc-carFqZ UksDl">Copy</div></button></div><div class="sc-iJCRrE jCdxGr sc-dPaNzc gyljjx"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"role_id"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Response samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-400" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-401" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-401" aria-labelledby="react-tabs-400"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-bBjRSN kQSIAz">application/json</div></div><div class="sc-jgPyTC dSaTNC"><div class="sc-jNnpgg esZIbL"><div class="sc-giAqHp hMPeqJ"><button><div class="sc-carFqZ UksDl">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iJCRrE jCdxGr sc-dPaNzc gyljjx"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"object"</span>: <span class="token string">"group.role"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"group"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"object"</span>: <span class="token string">"group"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"created_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"scim_managed"</span>: <span class="token boolean">true</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"role"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"object"</span>: <span class="token string">"role"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"description"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"permissions"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><span class="token string">"string"</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"resource_type"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"predefined_role"</span>: <span class="token boolean">true</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Group-organization-role-assignments/operation/unassign-group-role" data-section-id="tag/Group-organization-role-assignments/operation/unassign-group-role" class="sc-eCApnc liLqNm"><div data-section-id="operation/unassign-group-role" id="operation/unassign-group-role" class="sc-iCoGMd gLxhOh"><div class="sc-hKFxyN juinod"><h2 class="sc-pNWdM eftmgB"><a class="sc-crzoAE iUxAWq" href="#tag/Group-organization-role-assignments/operation/unassign-group-role" aria-label="tag/Group-organization-role-assignments/operation/unassign-group-role"></a>Unassigns an organization role from a group within the organization.<!-- --> </h2><div class="sc-fcmMJX cvfxAX"><div class="sc-jUfyBS bhDyou"><h5 class="sc-iqAclL sc-fuISkM eONCmm hZIgic">Authorizations:</h5><svg class="sc-dIsUp iPqByX" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jQAxuV ccffaZ"><span class="sc-daBunf fcvuS"><span class="sc-dsXzNU dPrSxx"><i>ApiKeyAuth</i></span></span></div></div><div><h5 class="sc-iqAclL eONCmm">path<!-- --> Parameters</h5><table class="sc-hHEiqL VCQHZ"><tbody><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="group_id"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">group_id</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The ID of the group to modify.</p>
</div></div></div></td></tr><tr class="last "><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="role_id"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">role_id</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The ID of the organization role to remove from the group.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-fIxmyt DvFer">Responses</h3><div><button class="sc-htmcrh lbYftx"><svg class="sc-dIsUp dqYXmg" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-fWWYYk cMoEZ">200<!-- --> </strong><span class="sc-jcwpoC eDjFAZ"><p>Organization role unassigned from the group successfully.</p>
</span></button></div></div></div><div class="sc-jSFjdj sc-gKAaRy gBjRyf gcushC"><div class="sc-EZqKI fWsqvQ"><button class="sc-eEVmNe ilvUMs"><span type="delete" class="sc-fmdNqN bJzUtf http-verb delete">delete</span><span class="sc-jXcxbT fCEUju">/organization/groups/{group_id}/roles/{role_id}</span><svg class="sc-dIsUp bRmrKA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ljsmAU flIrdF"><div class="sc-jlZJtj fQkroN"><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div><div tabindex="0" role="button"><div class="sc-dTSzeu dfUAUz"><span>https://api.openai.com/v1</span>/organization/groups/{group_id}/roles/{role_id}</div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Response samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-402" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-403" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-403" aria-labelledby="react-tabs-402"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-bBjRSN kQSIAz">application/json</div></div><div class="sc-jgPyTC dSaTNC"><div class="sc-jNnpgg esZIbL"><div class="sc-giAqHp hMPeqJ"><button><div class="sc-carFqZ UksDl">Copy</div></button></div><div class="sc-iJCRrE jCdxGr sc-dPaNzc gyljjx"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"object"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"deleted"</span>: <span class="token boolean">true</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Group-users" data-section-id="tag/Group-users" class="sc-eCApnc jlMQbh"><div class="sc-iCoGMd gLxhOh"><div class="sc-hKFxyN juinod"><h1 class="sc-fujyAs bpZWeL"><a class="sc-crzoAE iUxAWq" href="#tag/Group-users" aria-label="tag/Group-users"></a>Group users</h1></div></div></div><div id="tag/Group-users/operation/list-group-users" data-section-id="tag/Group-users/operation/list-group-users" class="sc-eCApnc liLqNm"><div data-section-id="operation/list-group-users" id="operation/list-group-users" class="sc-iCoGMd gLxhOh"><div class="sc-hKFxyN juinod"><h2 class="sc-pNWdM eftmgB"><a class="sc-crzoAE iUxAWq" href="#tag/Group-users/operation/list-group-users" aria-label="tag/Group-users/operation/list-group-users"></a>Lists the users assigned to a group.<!-- --> </h2><div class="sc-fcmMJX cvfxAX"><div class="sc-jUfyBS bhDyou"><h5 class="sc-iqAclL sc-fuISkM eONCmm hZIgic">Authorizations:</h5><svg class="sc-dIsUp iPqByX" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jQAxuV ccffaZ"><span class="sc-daBunf fcvuS"><span class="sc-dsXzNU dPrSxx"><i>ApiKeyAuth</i></span></span></div></div><div><h5 class="sc-iqAclL eONCmm">path<!-- --> Parameters</h5><table class="sc-hHEiqL VCQHZ"><tbody><tr class="last "><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="group_id"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">group_id</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The ID of the group to inspect.</p>
</div></div></div></td></tr></tbody></table></div><div><h5 class="sc-iqAclL eONCmm">query<!-- --> Parameters</h5><table class="sc-hHEiqL VCQHZ"><tbody><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="limit"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">limit</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">integer</span><span> <span class="sc-laZMeE sc-FRrlG jWaWWE gHBwqe"> <!-- -->[ 0 .. 1000 ]<!-- --> </span></span></div><div><span class="sc-laZMeE jWaWWE"> <!-- -->Default:<!-- --> </span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">100</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>A limit on the number of users to be returned. Limit can range between 0 and 1000, and the default is 100.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="after"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">after</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>A cursor for use in pagination. Provide the ID of the last user from the previous list response to retrieve the next page.</p>
</div></div></div></td></tr><tr class="last "><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="order"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">order</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div><div><span class="sc-laZMeE jWaWWE"> <!-- -->Default:<!-- --> </span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"desc"</span></div><div><span class="sc-laZMeE jWaWWE"> <!-- -->Enum<!-- -->:</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"asc"</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"desc"</span> </div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>Specifies the sort order of users in the list.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-fIxmyt DvFer">Responses</h3><div><button class="sc-htmcrh lbYftx"><svg class="sc-dIsUp dqYXmg" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-fWWYYk cMoEZ">200<!-- --> </strong><span class="sc-jcwpoC eDjFAZ"><p>Group users listed successfully.</p>
</span></button></div></div></div><div class="sc-jSFjdj sc-gKAaRy gBjRyf gcushC"><div class="sc-EZqKI fWsqvQ"><button class="sc-eEVmNe ilvUMs"><span type="get" class="sc-fmdNqN ihNycv http-verb get">get</span><span class="sc-jXcxbT fCEUju">/organization/groups/{group_id}/users</span><svg class="sc-dIsUp bRmrKA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ljsmAU flIrdF"><div class="sc-jlZJtj fQkroN"><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div><div tabindex="0" role="button"><div class="sc-dTSzeu dfUAUz"><span>https://api.openai.com/v1</span>/organization/groups/{group_id}/users</div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Response samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-404" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-405" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-405" aria-labelledby="react-tabs-404"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-bBjRSN kQSIAz">application/json</div></div><div class="sc-jgPyTC dSaTNC"><div class="sc-jNnpgg esZIbL"><div class="sc-giAqHp hMPeqJ"><button><div class="sc-carFqZ UksDl">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iJCRrE jCdxGr sc-dPaNzc gyljjx"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"object"</span>: <span class="token string">"list"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"object"</span>: <span class="token string">"organization.user"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"email"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"role"</span>: <span class="token string">"owner"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"added_at"</span>: <span class="token number">0</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"has_more"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"next"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Group-users/operation/add-group-user" data-section-id="tag/Group-users/operation/add-group-user" class="sc-eCApnc liLqNm"><div data-section-id="operation/add-group-user" id="operation/add-group-user" class="sc-iCoGMd gLxhOh"><div class="sc-hKFxyN juinod"><h2 class="sc-pNWdM eftmgB"><a class="sc-crzoAE iUxAWq" href="#tag/Group-users/operation/add-group-user" aria-label="tag/Group-users/operation/add-group-user"></a>Adds a user to a group.<!-- --> </h2><div class="sc-fcmMJX cvfxAX"><div class="sc-jUfyBS bhDyou"><h5 class="sc-iqAclL sc-fuISkM eONCmm hZIgic">Authorizations:</h5><svg class="sc-dIsUp iPqByX" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jQAxuV ccffaZ"><span class="sc-daBunf fcvuS"><span class="sc-dsXzNU dPrSxx"><i>ApiKeyAuth</i></span></span></div></div><div><h5 class="sc-iqAclL eONCmm">path<!-- --> Parameters</h5><table class="sc-hHEiqL VCQHZ"><tbody><tr class="last "><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="group_id"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">group_id</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The ID of the group to update.</p>
</div></div></div></td></tr></tbody></table></div><h5 class="sc-iqAclL eONCmm">Request Body schema: <span class="sc-cBoqAE eKyrDP">application/json</span></h5><div class="sc-iJCRrE sc-ciSkZP jCdxGr QGruV"><p>Identifies the user that should be added to the group.</p>
</div><table class="sc-hHEiqL VCQHZ"><tbody><tr class="last "><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="user_id"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">user_id</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>Identifier of the user to add to the group.</p>
</div></div></div></td></tr></tbody></table><div><h3 class="sc-fIxmyt DvFer">Responses</h3><div><button class="sc-htmcrh lbYftx"><svg class="sc-dIsUp dqYXmg" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-fWWYYk cMoEZ">200<!-- --> </strong><span class="sc-jcwpoC eDjFAZ"><p>User added to the group successfully.</p>
</span></button></div></div></div><div class="sc-jSFjdj sc-gKAaRy gBjRyf gcushC"><div class="sc-EZqKI fWsqvQ"><button class="sc-eEVmNe ilvUMs"><span type="post" class="sc-fmdNqN ldMUmp http-verb post">post</span><span class="sc-jXcxbT fCEUju">/organization/groups/{group_id}/users</span><svg class="sc-dIsUp bRmrKA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ljsmAU flIrdF"><div class="sc-jlZJtj fQkroN"><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div><div tabindex="0" role="button"><div class="sc-dTSzeu dfUAUz"><span>https://api.openai.com/v1</span>/organization/groups/{group_id}/users</div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Request samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="react-tabs-406" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-407" tabindex="0" data-rttab="true">Payload</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-407" aria-labelledby="react-tabs-406"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-bBjRSN kQSIAz">application/json</div></div><div class="sc-jgPyTC dSaTNC"><div class="sc-jNnpgg esZIbL"><div class="sc-giAqHp hMPeqJ"><button><div class="sc-carFqZ UksDl">Copy</div></button></div><div class="sc-iJCRrE jCdxGr sc-dPaNzc gyljjx"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"user_id"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Response samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-408" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-409" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-409" aria-labelledby="react-tabs-408"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-bBjRSN kQSIAz">application/json</div></div><div class="sc-jgPyTC dSaTNC"><div class="sc-jNnpgg esZIbL"><div class="sc-giAqHp hMPeqJ"><button><div class="sc-carFqZ UksDl">Copy</div></button></div><div class="sc-iJCRrE jCdxGr sc-dPaNzc gyljjx"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"object"</span>: <span class="token string">"group.user"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"user_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"group_id"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Group-users/operation/remove-group-user" data-section-id="tag/Group-users/operation/remove-group-user" class="sc-eCApnc liLqNm"><div data-section-id="operation/remove-group-user" id="operation/remove-group-user" class="sc-iCoGMd gLxhOh"><div class="sc-hKFxyN juinod"><h2 class="sc-pNWdM eftmgB"><a class="sc-crzoAE iUxAWq" href="#tag/Group-users/operation/remove-group-user" aria-label="tag/Group-users/operation/remove-group-user"></a>Removes a user from a group.<!-- --> </h2><div class="sc-fcmMJX cvfxAX"><div class="sc-jUfyBS bhDyou"><h5 class="sc-iqAclL sc-fuISkM eONCmm hZIgic">Authorizations:</h5><svg class="sc-dIsUp iPqByX" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jQAxuV ccffaZ"><span class="sc-daBunf fcvuS"><span class="sc-dsXzNU dPrSxx"><i>ApiKeyAuth</i></span></span></div></div><div><h5 class="sc-iqAclL eONCmm">path<!-- --> Parameters</h5><table class="sc-hHEiqL VCQHZ"><tbody><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="group_id"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">group_id</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The ID of the group to update.</p>
</div></div></div></td></tr><tr class="last "><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="user_id"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">user_id</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The ID of the user to remove from the group.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-fIxmyt DvFer">Responses</h3><div><button class="sc-htmcrh lbYftx"><svg class="sc-dIsUp dqYXmg" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-fWWYYk cMoEZ">200<!-- --> </strong><span class="sc-jcwpoC eDjFAZ"><p>User removed from the group successfully.</p>
</span></button></div></div></div><div class="sc-jSFjdj sc-gKAaRy gBjRyf gcushC"><div class="sc-EZqKI fWsqvQ"><button class="sc-eEVmNe ilvUMs"><span type="delete" class="sc-fmdNqN bJzUtf http-verb delete">delete</span><span class="sc-jXcxbT fCEUju">/organization/groups/{group_id}/users/{user_id}</span><svg class="sc-dIsUp bRmrKA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ljsmAU flIrdF"><div class="sc-jlZJtj fQkroN"><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div><div tabindex="0" role="button"><div class="sc-dTSzeu dfUAUz"><span>https://api.openai.com/v1</span>/organization/groups/{group_id}/users/{user_id}</div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Response samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-410" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-411" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-411" aria-labelledby="react-tabs-410"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-bBjRSN kQSIAz">application/json</div></div><div class="sc-jgPyTC dSaTNC"><div class="sc-jNnpgg esZIbL"><div class="sc-giAqHp hMPeqJ"><button><div class="sc-carFqZ UksDl">Copy</div></button></div><div class="sc-iJCRrE jCdxGr sc-dPaNzc gyljjx"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"object"</span>: <span class="token string">"group.user.deleted"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"deleted"</span>: <span class="token boolean">true</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Invites" data-section-id="tag/Invites" class="sc-eCApnc jlMQbh"><div class="sc-iCoGMd gLxhOh"><div class="sc-hKFxyN juinod"><h1 class="sc-fujyAs bpZWeL"><a class="sc-crzoAE iUxAWq" href="#tag/Invites" aria-label="tag/Invites"></a>Invites</h1></div></div></div><div id="tag/Invites/operation/list-invites" data-section-id="tag/Invites/operation/list-invites" class="sc-eCApnc liLqNm"><div data-section-id="operation/list-invites" id="operation/list-invites" class="sc-iCoGMd gLxhOh"><div class="sc-hKFxyN juinod"><h2 class="sc-pNWdM eftmgB"><a class="sc-crzoAE iUxAWq" href="#tag/Invites/operation/list-invites" aria-label="tag/Invites/operation/list-invites"></a>Returns a list of invites in the organization.<!-- --> </h2><div class="sc-fcmMJX cvfxAX"><div class="sc-jUfyBS bhDyou"><h5 class="sc-iqAclL sc-fuISkM eONCmm hZIgic">Authorizations:</h5><svg class="sc-dIsUp iPqByX" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jQAxuV ccffaZ"><span class="sc-daBunf fcvuS"><span class="sc-dsXzNU dPrSxx"><i>ApiKeyAuth</i></span></span></div></div><div><h5 class="sc-iqAclL eONCmm">query<!-- --> Parameters</h5><table class="sc-hHEiqL VCQHZ"><tbody><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="limit"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">limit</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">integer</span></div><div><span class="sc-laZMeE jWaWWE"> <!-- -->Default:<!-- --> </span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">20</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.</p>
</div></div></div></td></tr><tr class="last "><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="after"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">after</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>A cursor for use in pagination. <code>after</code> is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-fIxmyt DvFer">Responses</h3><div><button class="sc-htmcrh lbYftx"><svg class="sc-dIsUp dqYXmg" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-fWWYYk cMoEZ">200<!-- --> </strong><span class="sc-jcwpoC eDjFAZ"><p>Invites listed successfully.</p>
</span></button></div></div></div><div class="sc-jSFjdj sc-gKAaRy gBjRyf gcushC"><div class="sc-EZqKI fWsqvQ"><button class="sc-eEVmNe ilvUMs"><span type="get" class="sc-fmdNqN ihNycv http-verb get">get</span><span class="sc-jXcxbT fCEUju">/organization/invites</span><svg class="sc-dIsUp bRmrKA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ljsmAU flIrdF"><div class="sc-jlZJtj fQkroN"><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div><div tabindex="0" role="button"><div class="sc-dTSzeu dfUAUz"><span>https://api.openai.com/v1</span>/organization/invites</div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Response samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-412" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-413" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-413" aria-labelledby="react-tabs-412"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-bBjRSN kQSIAz">application/json</div></div><div class="sc-jgPyTC dSaTNC"><div class="sc-jNnpgg esZIbL"><div class="sc-giAqHp hMPeqJ"><button><div class="sc-carFqZ UksDl">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iJCRrE jCdxGr sc-dPaNzc gyljjx"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"object"</span>: <span class="token string">"list"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"object"</span>: <span class="token string">"organization.invite"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"email"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"role"</span>: <span class="token string">"owner"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"status"</span>: <span class="token string">"accepted"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"invited_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"expires_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"accepted_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"projects"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"role"</span>: <span class="token string">"member"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"first_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"last_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"has_more"</span>: <span class="token boolean">true</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Invites/operation/inviteUser" data-section-id="tag/Invites/operation/inviteUser" class="sc-eCApnc liLqNm"><div data-section-id="operation/inviteUser" id="operation/inviteUser" class="sc-iCoGMd gLxhOh"><div class="sc-hKFxyN juinod"><h2 class="sc-pNWdM eftmgB"><a class="sc-crzoAE iUxAWq" href="#tag/Invites/operation/inviteUser" aria-label="tag/Invites/operation/inviteUser"></a>Create an invite for a user to the organization. The invite must be accepted by the user before they have access to the organization.<!-- --> </h2><div class="sc-fcmMJX cvfxAX"><div class="sc-jUfyBS bhDyou"><h5 class="sc-iqAclL sc-fuISkM eONCmm hZIgic">Authorizations:</h5><svg class="sc-dIsUp iPqByX" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jQAxuV ccffaZ"><span class="sc-daBunf fcvuS"><span class="sc-dsXzNU dPrSxx"><i>ApiKeyAuth</i></span></span></div></div><h5 class="sc-iqAclL eONCmm">Request Body schema: <span class="sc-cBoqAE eKyrDP">application/json</span></h5><div class="sc-iJCRrE sc-ciSkZP jCdxGr QGruV"><p>The invite request payload.</p>
</div><table class="sc-hHEiqL VCQHZ"><tbody><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="email"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">email</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>Send an email to this address</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="role"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">role</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div><div><span class="sc-laZMeE jWaWWE"> <!-- -->Enum<!-- -->:</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"reader"</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"owner"</span> </div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p><code>owner</code> or <code>reader</code></p>
</div></div></div></td></tr><tr class="last "><td class="sc-hBMUJo sc-fFSPTT sc-gSYDnn iwcKgn cAqMTE hTttpy" kind="field" title="projects"><span class="sc-iemWCZ bcnRwz"></span><button aria-label="expand properties"><span class="property-name">projects</span><svg class="sc-dIsUp hGHhhO" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa">Array of </span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">objects</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>An array of projects to which membership is granted at the same time the org invite is accepted. If omitted, the user will be invited to the default project for compatibility with legacy behavior.</p>
</div></div></div></td></tr></tbody></table><div><h3 class="sc-fIxmyt DvFer">Responses</h3><div><button class="sc-htmcrh lbYftx"><svg class="sc-dIsUp dqYXmg" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-fWWYYk cMoEZ">200<!-- --> </strong><span class="sc-jcwpoC eDjFAZ"><p>User invited successfully.</p>
</span></button></div></div></div><div class="sc-jSFjdj sc-gKAaRy gBjRyf gcushC"><div class="sc-EZqKI fWsqvQ"><button class="sc-eEVmNe ilvUMs"><span type="post" class="sc-fmdNqN ldMUmp http-verb post">post</span><span class="sc-jXcxbT fCEUju">/organization/invites</span><svg class="sc-dIsUp bRmrKA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ljsmAU flIrdF"><div class="sc-jlZJtj fQkroN"><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div><div tabindex="0" role="button"><div class="sc-dTSzeu dfUAUz"><span>https://api.openai.com/v1</span>/organization/invites</div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Request samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="react-tabs-414" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-415" tabindex="0" data-rttab="true">Payload</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-415" aria-labelledby="react-tabs-414"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-bBjRSN kQSIAz">application/json</div></div><div class="sc-jgPyTC dSaTNC"><div class="sc-jNnpgg esZIbL"><div class="sc-giAqHp hMPeqJ"><button><div class="sc-carFqZ UksDl">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iJCRrE jCdxGr sc-dPaNzc gyljjx"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"email"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"role"</span>: <span class="token string">"reader"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"projects"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"role"</span>: <span class="token string">"member"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Response samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-416" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-417" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-417" aria-labelledby="react-tabs-416"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-bBjRSN kQSIAz">application/json</div></div><div class="sc-jgPyTC dSaTNC"><div class="sc-jNnpgg esZIbL"><div class="sc-giAqHp hMPeqJ"><button><div class="sc-carFqZ UksDl">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iJCRrE jCdxGr sc-dPaNzc gyljjx"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"object"</span>: <span class="token string">"organization.invite"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"email"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"role"</span>: <span class="token string">"owner"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token string">"accepted"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"invited_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"expires_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"accepted_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"projects"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"role"</span>: <span class="token string">"member"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Invites/operation/retrieve-invite" data-section-id="tag/Invites/operation/retrieve-invite" class="sc-eCApnc liLqNm"><div data-section-id="operation/retrieve-invite" id="operation/retrieve-invite" class="sc-iCoGMd gLxhOh"><div class="sc-hKFxyN juinod"><h2 class="sc-pNWdM eftmgB"><a class="sc-crzoAE iUxAWq" href="#tag/Invites/operation/retrieve-invite" aria-label="tag/Invites/operation/retrieve-invite"></a>Retrieves an invite.<!-- --> </h2><div class="sc-fcmMJX cvfxAX"><div class="sc-jUfyBS bhDyou"><h5 class="sc-iqAclL sc-fuISkM eONCmm hZIgic">Authorizations:</h5><svg class="sc-dIsUp iPqByX" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jQAxuV ccffaZ"><span class="sc-daBunf fcvuS"><span class="sc-dsXzNU dPrSxx"><i>ApiKeyAuth</i></span></span></div></div><div><h5 class="sc-iqAclL eONCmm">path<!-- --> Parameters</h5><table class="sc-hHEiqL VCQHZ"><tbody><tr class="last "><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="invite_id"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">invite_id</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The ID of the invite to retrieve.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-fIxmyt DvFer">Responses</h3><div><button class="sc-htmcrh lbYftx"><svg class="sc-dIsUp dqYXmg" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-fWWYYk cMoEZ">200<!-- --> </strong><span class="sc-jcwpoC eDjFAZ"><p>Invite retrieved successfully.</p>
</span></button></div></div></div><div class="sc-jSFjdj sc-gKAaRy gBjRyf gcushC"><div class="sc-EZqKI fWsqvQ"><button class="sc-eEVmNe ilvUMs"><span type="get" class="sc-fmdNqN ihNycv http-verb get">get</span><span class="sc-jXcxbT fCEUju">/organization/invites/{invite_id}</span><svg class="sc-dIsUp bRmrKA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ljsmAU flIrdF"><div class="sc-jlZJtj fQkroN"><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div><div tabindex="0" role="button"><div class="sc-dTSzeu dfUAUz"><span>https://api.openai.com/v1</span>/organization/invites/{invite_id}</div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Response samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-418" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-419" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-419" aria-labelledby="react-tabs-418"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-bBjRSN kQSIAz">application/json</div></div><div class="sc-jgPyTC dSaTNC"><div class="sc-jNnpgg esZIbL"><div class="sc-giAqHp hMPeqJ"><button><div class="sc-carFqZ UksDl">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iJCRrE jCdxGr sc-dPaNzc gyljjx"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"object"</span>: <span class="token string">"organization.invite"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"email"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"role"</span>: <span class="token string">"owner"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token string">"accepted"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"invited_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"expires_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"accepted_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"projects"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"role"</span>: <span class="token string">"member"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Invites/operation/delete-invite" data-section-id="tag/Invites/operation/delete-invite" class="sc-eCApnc liLqNm"><div data-section-id="operation/delete-invite" id="operation/delete-invite" class="sc-iCoGMd gLxhOh"><div class="sc-hKFxyN juinod"><h2 class="sc-pNWdM eftmgB"><a class="sc-crzoAE iUxAWq" href="#tag/Invites/operation/delete-invite" aria-label="tag/Invites/operation/delete-invite"></a>Delete an invite. If the invite has already been accepted, it cannot be deleted.<!-- --> </h2><div class="sc-fcmMJX cvfxAX"><div class="sc-jUfyBS bhDyou"><h5 class="sc-iqAclL sc-fuISkM eONCmm hZIgic">Authorizations:</h5><svg class="sc-dIsUp iPqByX" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jQAxuV ccffaZ"><span class="sc-daBunf fcvuS"><span class="sc-dsXzNU dPrSxx"><i>ApiKeyAuth</i></span></span></div></div><div><h5 class="sc-iqAclL eONCmm">path<!-- --> Parameters</h5><table class="sc-hHEiqL VCQHZ"><tbody><tr class="last "><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="invite_id"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">invite_id</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The ID of the invite to delete.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-fIxmyt DvFer">Responses</h3><div><button class="sc-htmcrh lbYftx"><svg class="sc-dIsUp dqYXmg" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-fWWYYk cMoEZ">200<!-- --> </strong><span class="sc-jcwpoC eDjFAZ"><p>Invite deleted successfully.</p>
</span></button></div></div></div><div class="sc-jSFjdj sc-gKAaRy gBjRyf gcushC"><div class="sc-EZqKI fWsqvQ"><button class="sc-eEVmNe ilvUMs"><span type="delete" class="sc-fmdNqN bJzUtf http-verb delete">delete</span><span class="sc-jXcxbT fCEUju">/organization/invites/{invite_id}</span><svg class="sc-dIsUp bRmrKA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ljsmAU flIrdF"><div class="sc-jlZJtj fQkroN"><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div><div tabindex="0" role="button"><div class="sc-dTSzeu dfUAUz"><span>https://api.openai.com/v1</span>/organization/invites/{invite_id}</div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Response samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-420" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-421" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-421" aria-labelledby="react-tabs-420"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-bBjRSN kQSIAz">application/json</div></div><div class="sc-jgPyTC dSaTNC"><div class="sc-jNnpgg esZIbL"><div class="sc-giAqHp hMPeqJ"><button><div class="sc-carFqZ UksDl">Copy</div></button></div><div class="sc-iJCRrE jCdxGr sc-dPaNzc gyljjx"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"object"</span>: <span class="token string">"organization.invite.deleted"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"deleted"</span>: <span class="token boolean">true</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Projects" data-section-id="tag/Projects" class="sc-eCApnc jlMQbh"><div class="sc-iCoGMd gLxhOh"><div class="sc-hKFxyN juinod"><h1 class="sc-fujyAs bpZWeL"><a class="sc-crzoAE iUxAWq" href="#tag/Projects" aria-label="tag/Projects"></a>Projects</h1></div></div></div><div id="tag/Projects/operation/list-projects" data-section-id="tag/Projects/operation/list-projects" class="sc-eCApnc liLqNm"><div data-section-id="operation/list-projects" id="operation/list-projects" class="sc-iCoGMd gLxhOh"><div class="sc-hKFxyN juinod"><h2 class="sc-pNWdM eftmgB"><a class="sc-crzoAE iUxAWq" href="#tag/Projects/operation/list-projects" aria-label="tag/Projects/operation/list-projects"></a>Returns a list of projects.<!-- --> </h2><div class="sc-fcmMJX cvfxAX"><div class="sc-jUfyBS bhDyou"><h5 class="sc-iqAclL sc-fuISkM eONCmm hZIgic">Authorizations:</h5><svg class="sc-dIsUp iPqByX" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jQAxuV ccffaZ"><span class="sc-daBunf fcvuS"><span class="sc-dsXzNU dPrSxx"><i>ApiKeyAuth</i></span></span></div></div><div><h5 class="sc-iqAclL eONCmm">query<!-- --> Parameters</h5><table class="sc-hHEiqL VCQHZ"><tbody><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="limit"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">limit</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">integer</span></div><div><span class="sc-laZMeE jWaWWE"> <!-- -->Default:<!-- --> </span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">20</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="after"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">after</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>A cursor for use in pagination. <code>after</code> is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list.</p>
</div></div></div></td></tr><tr class="last "><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="include_archived"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">include_archived</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">boolean</span></div><div><span class="sc-laZMeE jWaWWE"> <!-- -->Default:<!-- --> </span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">false</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>If <code>true</code> returns all projects including those that have been <code>archived</code>. Archived projects are not included by default.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-fIxmyt DvFer">Responses</h3><div><button class="sc-htmcrh lbYftx"><svg class="sc-dIsUp dqYXmg" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-fWWYYk cMoEZ">200<!-- --> </strong><span class="sc-jcwpoC eDjFAZ"><p>Projects listed successfully.</p>
</span></button></div></div></div><div class="sc-jSFjdj sc-gKAaRy gBjRyf gcushC"><div class="sc-EZqKI fWsqvQ"><button class="sc-eEVmNe ilvUMs"><span type="get" class="sc-fmdNqN ihNycv http-verb get">get</span><span class="sc-jXcxbT fCEUju">/organization/projects</span><svg class="sc-dIsUp bRmrKA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ljsmAU flIrdF"><div class="sc-jlZJtj fQkroN"><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div><div tabindex="0" role="button"><div class="sc-dTSzeu dfUAUz"><span>https://api.openai.com/v1</span>/organization/projects</div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Response samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-422" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-423" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-423" aria-labelledby="react-tabs-422"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-bBjRSN kQSIAz">application/json</div></div><div class="sc-jgPyTC dSaTNC"><div class="sc-jNnpgg esZIbL"><div class="sc-giAqHp hMPeqJ"><button><div class="sc-carFqZ UksDl">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iJCRrE jCdxGr sc-dPaNzc gyljjx"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"object"</span>: <span class="token string">"list"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"object"</span>: <span class="token string">"organization.project"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"created_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"archived_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"status"</span>: <span class="token string">"active"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"first_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"last_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"has_more"</span>: <span class="token boolean">true</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Projects/operation/create-project" data-section-id="tag/Projects/operation/create-project" class="sc-eCApnc liLqNm"><div data-section-id="operation/create-project" id="operation/create-project" class="sc-iCoGMd gLxhOh"><div class="sc-hKFxyN juinod"><h2 class="sc-pNWdM eftmgB"><a class="sc-crzoAE iUxAWq" href="#tag/Projects/operation/create-project" aria-label="tag/Projects/operation/create-project"></a>Create a new project in the organization. Projects can be created and archived, but cannot be deleted.<!-- --> </h2><div class="sc-fcmMJX cvfxAX"><div class="sc-jUfyBS bhDyou"><h5 class="sc-iqAclL sc-fuISkM eONCmm hZIgic">Authorizations:</h5><svg class="sc-dIsUp iPqByX" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jQAxuV ccffaZ"><span class="sc-daBunf fcvuS"><span class="sc-dsXzNU dPrSxx"><i>ApiKeyAuth</i></span></span></div></div><h5 class="sc-iqAclL eONCmm">Request Body schema: <span class="sc-cBoqAE eKyrDP">application/json</span></h5><div class="sc-iJCRrE sc-ciSkZP jCdxGr QGruV"><p>The project create request payload.</p>
</div><table class="sc-hHEiqL VCQHZ"><tbody><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="name"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">name</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The friendly name of the project, this name appears in reports.</p>
</div></div></div></td></tr><tr class="last "><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="geography"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">geography</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div><div><span class="sc-laZMeE jWaWWE"> <!-- -->Enum<!-- -->:</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"US"</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"EU"</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"JP"</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"IN"</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"KR"</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"CA"</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"AU"</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"SG"</span> </div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>Create the project with the specified data residency region. Your organization must have access to Data residency functionality in order to use. See <a href="/docs/guides/your-data#data-residency-controls">data residency controls</a> to review the functionality and limitations of setting this field.</p>
</div></div></div></td></tr></tbody></table><div><h3 class="sc-fIxmyt DvFer">Responses</h3><div><button class="sc-htmcrh lbYftx"><svg class="sc-dIsUp dqYXmg" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-fWWYYk cMoEZ">200<!-- --> </strong><span class="sc-jcwpoC eDjFAZ"><p>Project created successfully.</p>
</span></button></div></div></div><div class="sc-jSFjdj sc-gKAaRy gBjRyf gcushC"><div class="sc-EZqKI fWsqvQ"><button class="sc-eEVmNe ilvUMs"><span type="post" class="sc-fmdNqN ldMUmp http-verb post">post</span><span class="sc-jXcxbT fCEUju">/organization/projects</span><svg class="sc-dIsUp bRmrKA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ljsmAU flIrdF"><div class="sc-jlZJtj fQkroN"><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div><div tabindex="0" role="button"><div class="sc-dTSzeu dfUAUz"><span>https://api.openai.com/v1</span>/organization/projects</div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Request samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="react-tabs-424" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-425" tabindex="0" data-rttab="true">Payload</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-425" aria-labelledby="react-tabs-424"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-bBjRSN kQSIAz">application/json</div></div><div class="sc-jgPyTC dSaTNC"><div class="sc-jNnpgg esZIbL"><div class="sc-giAqHp hMPeqJ"><button><div class="sc-carFqZ UksDl">Copy</div></button></div><div class="sc-iJCRrE jCdxGr sc-dPaNzc gyljjx"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"geography"</span>: <span class="token string">"US"</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Response samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-426" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-427" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-427" aria-labelledby="react-tabs-426"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-bBjRSN kQSIAz">application/json</div></div><div class="sc-jgPyTC dSaTNC"><div class="sc-jNnpgg esZIbL"><div class="sc-giAqHp hMPeqJ"><button><div class="sc-carFqZ UksDl">Copy</div></button></div><div class="sc-iJCRrE jCdxGr sc-dPaNzc gyljjx"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"object"</span>: <span class="token string">"organization.project"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"created_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"archived_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token string">"active"</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Projects/operation/retrieve-project" data-section-id="tag/Projects/operation/retrieve-project" class="sc-eCApnc liLqNm"><div data-section-id="operation/retrieve-project" id="operation/retrieve-project" class="sc-iCoGMd gLxhOh"><div class="sc-hKFxyN juinod"><h2 class="sc-pNWdM eftmgB"><a class="sc-crzoAE iUxAWq" href="#tag/Projects/operation/retrieve-project" aria-label="tag/Projects/operation/retrieve-project"></a>Retrieves a project.<!-- --> </h2><div class="sc-fcmMJX cvfxAX"><div class="sc-jUfyBS bhDyou"><h5 class="sc-iqAclL sc-fuISkM eONCmm hZIgic">Authorizations:</h5><svg class="sc-dIsUp iPqByX" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jQAxuV ccffaZ"><span class="sc-daBunf fcvuS"><span class="sc-dsXzNU dPrSxx"><i>ApiKeyAuth</i></span></span></div></div><div><h5 class="sc-iqAclL eONCmm">path<!-- --> Parameters</h5><table class="sc-hHEiqL VCQHZ"><tbody><tr class="last "><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="project_id"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">project_id</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The ID of the project.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-fIxmyt DvFer">Responses</h3><div><button class="sc-htmcrh lbYftx"><svg class="sc-dIsUp dqYXmg" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-fWWYYk cMoEZ">200<!-- --> </strong><span class="sc-jcwpoC eDjFAZ"><p>Project retrieved successfully.</p>
</span></button></div></div></div><div class="sc-jSFjdj sc-gKAaRy gBjRyf gcushC"><div class="sc-EZqKI fWsqvQ"><button class="sc-eEVmNe ilvUMs"><span type="get" class="sc-fmdNqN ihNycv http-verb get">get</span><span class="sc-jXcxbT fCEUju">/organization/projects/{project_id}</span><svg class="sc-dIsUp bRmrKA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ljsmAU flIrdF"><div class="sc-jlZJtj fQkroN"><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div><div tabindex="0" role="button"><div class="sc-dTSzeu dfUAUz"><span>https://api.openai.com/v1</span>/organization/projects/{project_id}</div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Response samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-428" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-429" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-429" aria-labelledby="react-tabs-428"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-bBjRSN kQSIAz">application/json</div></div><div class="sc-jgPyTC dSaTNC"><div class="sc-jNnpgg esZIbL"><div class="sc-giAqHp hMPeqJ"><button><div class="sc-carFqZ UksDl">Copy</div></button></div><div class="sc-iJCRrE jCdxGr sc-dPaNzc gyljjx"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"object"</span>: <span class="token string">"organization.project"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"created_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"archived_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token string">"active"</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Projects/operation/modify-project" data-section-id="tag/Projects/operation/modify-project" class="sc-eCApnc liLqNm"><div data-section-id="operation/modify-project" id="operation/modify-project" class="sc-iCoGMd gLxhOh"><div class="sc-hKFxyN juinod"><h2 class="sc-pNWdM eftmgB"><a class="sc-crzoAE iUxAWq" href="#tag/Projects/operation/modify-project" aria-label="tag/Projects/operation/modify-project"></a>Modifies a project in the organization.<!-- --> </h2><div class="sc-fcmMJX cvfxAX"><div class="sc-jUfyBS bhDyou"><h5 class="sc-iqAclL sc-fuISkM eONCmm hZIgic">Authorizations:</h5><svg class="sc-dIsUp iPqByX" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jQAxuV ccffaZ"><span class="sc-daBunf fcvuS"><span class="sc-dsXzNU dPrSxx"><i>ApiKeyAuth</i></span></span></div></div><div><h5 class="sc-iqAclL eONCmm">path<!-- --> Parameters</h5><table class="sc-hHEiqL VCQHZ"><tbody><tr class="last "><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="project_id"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">project_id</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The ID of the project.</p>
</div></div></div></td></tr></tbody></table></div><h5 class="sc-iqAclL eONCmm">Request Body schema: <span class="sc-cBoqAE eKyrDP">application/json</span></h5><div class="sc-iJCRrE sc-ciSkZP jCdxGr QGruV"><p>The project update request payload.</p>
</div><table class="sc-hHEiqL VCQHZ"><tbody><tr class="last "><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="name"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">name</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The updated name of the project, this name appears in reports.</p>
</div></div></div></td></tr></tbody></table><div><h3 class="sc-fIxmyt DvFer">Responses</h3><div><button class="sc-htmcrh lbYftx"><svg class="sc-dIsUp dqYXmg" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-fWWYYk cMoEZ">200<!-- --> </strong><span class="sc-jcwpoC eDjFAZ"><p>Project updated successfully.</p>
</span></button></div><div><button class="sc-htmcrh NAUPn"><svg class="sc-dIsUp dVWHLw" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-fWWYYk cMoEZ">400<!-- --> </strong><span class="sc-jcwpoC eDjFAZ"><p>Error response when updating the default project.</p>
</span></button></div></div></div><div class="sc-jSFjdj sc-gKAaRy gBjRyf gcushC"><div class="sc-EZqKI fWsqvQ"><button class="sc-eEVmNe ilvUMs"><span type="post" class="sc-fmdNqN ldMUmp http-verb post">post</span><span class="sc-jXcxbT fCEUju">/organization/projects/{project_id}</span><svg class="sc-dIsUp bRmrKA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ljsmAU flIrdF"><div class="sc-jlZJtj fQkroN"><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div><div tabindex="0" role="button"><div class="sc-dTSzeu dfUAUz"><span>https://api.openai.com/v1</span>/organization/projects/{project_id}</div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Request samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="react-tabs-430" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-431" tabindex="0" data-rttab="true">Payload</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-431" aria-labelledby="react-tabs-430"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-bBjRSN kQSIAz">application/json</div></div><div class="sc-jgPyTC dSaTNC"><div class="sc-jNnpgg esZIbL"><div class="sc-giAqHp hMPeqJ"><button><div class="sc-carFqZ UksDl">Copy</div></button></div><div class="sc-iJCRrE jCdxGr sc-dPaNzc gyljjx"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Response samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-432" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-433" tabindex="0" data-rttab="true">200</li><li class="tab-error" role="tab" id="react-tabs-434" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-435" data-rttab="true">400</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-433" aria-labelledby="react-tabs-432"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-bBjRSN kQSIAz">application/json</div></div><div class="sc-jgPyTC dSaTNC"><div class="sc-jNnpgg esZIbL"><div class="sc-giAqHp hMPeqJ"><button><div class="sc-carFqZ UksDl">Copy</div></button></div><div class="sc-iJCRrE jCdxGr sc-dPaNzc gyljjx"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"object"</span>: <span class="token string">"organization.project"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"created_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"archived_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token string">"active"</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-435" aria-labelledby="react-tabs-434"></div></div></div></div></div></div><div id="tag/Projects/operation/list-project-api-keys" data-section-id="tag/Projects/operation/list-project-api-keys" class="sc-eCApnc liLqNm"><div data-section-id="operation/list-project-api-keys" id="operation/list-project-api-keys" class="sc-iCoGMd gLxhOh"><div class="sc-hKFxyN juinod"><h2 class="sc-pNWdM eftmgB"><a class="sc-crzoAE iUxAWq" href="#tag/Projects/operation/list-project-api-keys" aria-label="tag/Projects/operation/list-project-api-keys"></a>Returns a list of API keys in the project.<!-- --> </h2><div class="sc-fcmMJX cvfxAX"><div class="sc-jUfyBS bhDyou"><h5 class="sc-iqAclL sc-fuISkM eONCmm hZIgic">Authorizations:</h5><svg class="sc-dIsUp iPqByX" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jQAxuV ccffaZ"><span class="sc-daBunf fcvuS"><span class="sc-dsXzNU dPrSxx"><i>ApiKeyAuth</i></span></span></div></div><div><h5 class="sc-iqAclL eONCmm">path<!-- --> Parameters</h5><table class="sc-hHEiqL VCQHZ"><tbody><tr class="last "><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="project_id"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">project_id</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The ID of the project.</p>
</div></div></div></td></tr></tbody></table></div><div><h5 class="sc-iqAclL eONCmm">query<!-- --> Parameters</h5><table class="sc-hHEiqL VCQHZ"><tbody><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="limit"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">limit</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">integer</span></div><div><span class="sc-laZMeE jWaWWE"> <!-- -->Default:<!-- --> </span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">20</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.</p>
</div></div></div></td></tr><tr class="last "><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="after"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">after</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>A cursor for use in pagination. <code>after</code> is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-fIxmyt DvFer">Responses</h3><div><button class="sc-htmcrh lbYftx"><svg class="sc-dIsUp dqYXmg" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-fWWYYk cMoEZ">200<!-- --> </strong><span class="sc-jcwpoC eDjFAZ"><p>Project API keys listed successfully.</p>
</span></button></div></div></div><div class="sc-jSFjdj sc-gKAaRy gBjRyf gcushC"><div class="sc-EZqKI fWsqvQ"><button class="sc-eEVmNe ilvUMs"><span type="get" class="sc-fmdNqN ihNycv http-verb get">get</span><span class="sc-jXcxbT fCEUju">/organization/projects/{project_id}/api_keys</span><svg class="sc-dIsUp bRmrKA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ljsmAU flIrdF"><div class="sc-jlZJtj fQkroN"><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div><div tabindex="0" role="button"><div class="sc-dTSzeu dfUAUz"><span>https://api.openai.com/v1</span>/organization/projects/{project_id}/api_keys</div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Response samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-436" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-437" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-437" aria-labelledby="react-tabs-436"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-bBjRSN kQSIAz">application/json</div></div><div class="sc-jgPyTC dSaTNC"><div class="sc-jNnpgg esZIbL"><div class="sc-giAqHp hMPeqJ"><button><div class="sc-carFqZ UksDl">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iJCRrE jCdxGr sc-dPaNzc gyljjx"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"object"</span>: <span class="token string">"list"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"object"</span>: <span class="token string">"organization.project.api_key"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"redacted_value"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"created_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"last_used_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"owner"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <span class="token string">"user"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"user"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"object"</span>: <span class="token string">"organization.project.user"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"email"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"role"</span>: <span class="token string">"owner"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"added_at"</span>: <span class="token number">0</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"service_account"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"object"</span>: <span class="token string">"organization.project.service_account"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"role"</span>: <span class="token string">"owner"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"created_at"</span>: <span class="token number">0</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"first_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"last_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"has_more"</span>: <span class="token boolean">true</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Projects/operation/retrieve-project-api-key" data-section-id="tag/Projects/operation/retrieve-project-api-key" class="sc-eCApnc liLqNm"><div data-section-id="operation/retrieve-project-api-key" id="operation/retrieve-project-api-key" class="sc-iCoGMd gLxhOh"><div class="sc-hKFxyN juinod"><h2 class="sc-pNWdM eftmgB"><a class="sc-crzoAE iUxAWq" href="#tag/Projects/operation/retrieve-project-api-key" aria-label="tag/Projects/operation/retrieve-project-api-key"></a>Retrieves an API key in the project.<!-- --> </h2><div class="sc-fcmMJX cvfxAX"><div class="sc-jUfyBS bhDyou"><h5 class="sc-iqAclL sc-fuISkM eONCmm hZIgic">Authorizations:</h5><svg class="sc-dIsUp iPqByX" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jQAxuV ccffaZ"><span class="sc-daBunf fcvuS"><span class="sc-dsXzNU dPrSxx"><i>ApiKeyAuth</i></span></span></div></div><div><h5 class="sc-iqAclL eONCmm">path<!-- --> Parameters</h5><table class="sc-hHEiqL VCQHZ"><tbody><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="project_id"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">project_id</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The ID of the project.</p>
</div></div></div></td></tr><tr class="last "><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="key_id"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">key_id</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The ID of the API key.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-fIxmyt DvFer">Responses</h3><div><button class="sc-htmcrh lbYftx"><svg class="sc-dIsUp dqYXmg" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-fWWYYk cMoEZ">200<!-- --> </strong><span class="sc-jcwpoC eDjFAZ"><p>Project API key retrieved successfully.</p>
</span></button></div></div></div><div class="sc-jSFjdj sc-gKAaRy gBjRyf gcushC"><div class="sc-EZqKI fWsqvQ"><button class="sc-eEVmNe ilvUMs"><span type="get" class="sc-fmdNqN ihNycv http-verb get">get</span><span class="sc-jXcxbT fCEUju">/organization/projects/{project_id}/api_keys/{key_id}</span><svg class="sc-dIsUp bRmrKA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ljsmAU flIrdF"><div class="sc-jlZJtj fQkroN"><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div><div tabindex="0" role="button"><div class="sc-dTSzeu dfUAUz"><span>https://api.openai.com/v1</span>/organization/projects/{project_id}/api_keys/{key_id}</div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Response samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-438" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-439" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-439" aria-labelledby="react-tabs-438"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-bBjRSN kQSIAz">application/json</div></div><div class="sc-jgPyTC dSaTNC"><div class="sc-jNnpgg esZIbL"><div class="sc-giAqHp hMPeqJ"><button><div class="sc-carFqZ UksDl">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iJCRrE jCdxGr sc-dPaNzc gyljjx"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"object"</span>: <span class="token string">"organization.project.api_key"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"redacted_value"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"created_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"last_used_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"owner"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <span class="token string">"user"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"user"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"object"</span>: <span class="token string">"organization.project.user"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"email"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"role"</span>: <span class="token string">"owner"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"added_at"</span>: <span class="token number">0</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"service_account"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"object"</span>: <span class="token string">"organization.project.service_account"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"role"</span>: <span class="token string">"owner"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"created_at"</span>: <span class="token number">0</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Projects/operation/delete-project-api-key" data-section-id="tag/Projects/operation/delete-project-api-key" class="sc-eCApnc liLqNm"><div data-section-id="operation/delete-project-api-key" id="operation/delete-project-api-key" class="sc-iCoGMd gLxhOh"><div class="sc-hKFxyN juinod"><h2 class="sc-pNWdM eftmgB"><a class="sc-crzoAE iUxAWq" href="#tag/Projects/operation/delete-project-api-key" aria-label="tag/Projects/operation/delete-project-api-key"></a>Deletes an API key from the project.
Returns confirmation of the key deletion, or an error if the key belonged to
a service account.
<!-- --> </h2><div class="sc-fcmMJX cvfxAX"><div class="sc-jUfyBS bhDyou"><h5 class="sc-iqAclL sc-fuISkM eONCmm hZIgic">Authorizations:</h5><svg class="sc-dIsUp iPqByX" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jQAxuV ccffaZ"><span class="sc-daBunf fcvuS"><span class="sc-dsXzNU dPrSxx"><i>ApiKeyAuth</i></span></span></div></div><div><h5 class="sc-iqAclL eONCmm">path<!-- --> Parameters</h5><table class="sc-hHEiqL VCQHZ"><tbody><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="project_id"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">project_id</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The ID of the project.</p>
</div></div></div></td></tr><tr class="last "><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="key_id"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">key_id</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The ID of the API key.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-fIxmyt DvFer">Responses</h3><div><button class="sc-htmcrh lbYftx"><svg class="sc-dIsUp dqYXmg" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-fWWYYk cMoEZ">200<!-- --> </strong><span class="sc-jcwpoC eDjFAZ"><p>Project API key deleted successfully.</p>
</span></button></div><div><button class="sc-htmcrh NAUPn"><svg class="sc-dIsUp dVWHLw" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-fWWYYk cMoEZ">400<!-- --> </strong><span class="sc-jcwpoC eDjFAZ"><p>Error response for various conditions.</p>
</span></button></div></div></div><div class="sc-jSFjdj sc-gKAaRy gBjRyf gcushC"><div class="sc-EZqKI fWsqvQ"><button class="sc-eEVmNe ilvUMs"><span type="delete" class="sc-fmdNqN bJzUtf http-verb delete">delete</span><span class="sc-jXcxbT fCEUju">/organization/projects/{project_id}/api_keys/{key_id}</span><svg class="sc-dIsUp bRmrKA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ljsmAU flIrdF"><div class="sc-jlZJtj fQkroN"><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div><div tabindex="0" role="button"><div class="sc-dTSzeu dfUAUz"><span>https://api.openai.com/v1</span>/organization/projects/{project_id}/api_keys/{key_id}</div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Response samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-440" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-441" tabindex="0" data-rttab="true">200</li><li class="tab-error" role="tab" id="react-tabs-442" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-443" data-rttab="true">400</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-441" aria-labelledby="react-tabs-440"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-bBjRSN kQSIAz">application/json</div></div><div class="sc-jgPyTC dSaTNC"><div class="sc-jNnpgg esZIbL"><div class="sc-giAqHp hMPeqJ"><button><div class="sc-carFqZ UksDl">Copy</div></button></div><div class="sc-iJCRrE jCdxGr sc-dPaNzc gyljjx"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"object"</span>: <span class="token string">"organization.project.api_key.deleted"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"deleted"</span>: <span class="token boolean">true</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-443" aria-labelledby="react-tabs-442"></div></div></div></div></div></div><div id="tag/Projects/operation/archive-project" data-section-id="tag/Projects/operation/archive-project" class="sc-eCApnc liLqNm"><div data-section-id="operation/archive-project" id="operation/archive-project" class="sc-iCoGMd gLxhOh"><div class="sc-hKFxyN juinod"><h2 class="sc-pNWdM eftmgB"><a class="sc-crzoAE iUxAWq" href="#tag/Projects/operation/archive-project" aria-label="tag/Projects/operation/archive-project"></a>Archives a project in the organization. Archived projects cannot be used or updated.<!-- --> </h2><div class="sc-fcmMJX cvfxAX"><div class="sc-jUfyBS bhDyou"><h5 class="sc-iqAclL sc-fuISkM eONCmm hZIgic">Authorizations:</h5><svg class="sc-dIsUp iPqByX" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jQAxuV ccffaZ"><span class="sc-daBunf fcvuS"><span class="sc-dsXzNU dPrSxx"><i>ApiKeyAuth</i></span></span></div></div><div><h5 class="sc-iqAclL eONCmm">path<!-- --> Parameters</h5><table class="sc-hHEiqL VCQHZ"><tbody><tr class="last "><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="project_id"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">project_id</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The ID of the project.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-fIxmyt DvFer">Responses</h3><div><button class="sc-htmcrh lbYftx"><svg class="sc-dIsUp dqYXmg" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-fWWYYk cMoEZ">200<!-- --> </strong><span class="sc-jcwpoC eDjFAZ"><p>Project archived successfully.</p>
</span></button></div></div></div><div class="sc-jSFjdj sc-gKAaRy gBjRyf gcushC"><div class="sc-EZqKI fWsqvQ"><button class="sc-eEVmNe ilvUMs"><span type="post" class="sc-fmdNqN ldMUmp http-verb post">post</span><span class="sc-jXcxbT fCEUju">/organization/projects/{project_id}/archive</span><svg class="sc-dIsUp bRmrKA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ljsmAU flIrdF"><div class="sc-jlZJtj fQkroN"><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div><div tabindex="0" role="button"><div class="sc-dTSzeu dfUAUz"><span>https://api.openai.com/v1</span>/organization/projects/{project_id}/archive</div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Response samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-444" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-445" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-445" aria-labelledby="react-tabs-444"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-bBjRSN kQSIAz">application/json</div></div><div class="sc-jgPyTC dSaTNC"><div class="sc-jNnpgg esZIbL"><div class="sc-giAqHp hMPeqJ"><button><div class="sc-carFqZ UksDl">Copy</div></button></div><div class="sc-iJCRrE jCdxGr sc-dPaNzc gyljjx"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"object"</span>: <span class="token string">"organization.project"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"created_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"archived_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token string">"active"</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Projects/operation/list-project-rate-limits" data-section-id="tag/Projects/operation/list-project-rate-limits" class="sc-eCApnc liLqNm"><div data-section-id="operation/list-project-rate-limits" id="operation/list-project-rate-limits" class="sc-iCoGMd gLxhOh"><div class="sc-hKFxyN juinod"><h2 class="sc-pNWdM eftmgB"><a class="sc-crzoAE iUxAWq" href="#tag/Projects/operation/list-project-rate-limits" aria-label="tag/Projects/operation/list-project-rate-limits"></a>Returns the rate limits per model for a project.<!-- --> </h2><div class="sc-fcmMJX cvfxAX"><div class="sc-jUfyBS bhDyou"><h5 class="sc-iqAclL sc-fuISkM eONCmm hZIgic">Authorizations:</h5><svg class="sc-dIsUp iPqByX" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jQAxuV ccffaZ"><span class="sc-daBunf fcvuS"><span class="sc-dsXzNU dPrSxx"><i>ApiKeyAuth</i></span></span></div></div><div><h5 class="sc-iqAclL eONCmm">path<!-- --> Parameters</h5><table class="sc-hHEiqL VCQHZ"><tbody><tr class="last "><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="project_id"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">project_id</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The ID of the project.</p>
</div></div></div></td></tr></tbody></table></div><div><h5 class="sc-iqAclL eONCmm">query<!-- --> Parameters</h5><table class="sc-hHEiqL VCQHZ"><tbody><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="limit"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">limit</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">integer</span></div><div><span class="sc-laZMeE jWaWWE"> <!-- -->Default:<!-- --> </span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">100</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>A limit on the number of objects to be returned. The default is 100.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="after"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">after</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>A cursor for use in pagination. <code>after</code> is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list.</p>
</div></div></div></td></tr><tr class="last "><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="before"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">before</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>A cursor for use in pagination. <code>before</code> is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, beginning with obj_foo, your subsequent call can include before=obj_foo in order to fetch the previous page of the list.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-fIxmyt DvFer">Responses</h3><div><button class="sc-htmcrh lbYftx"><svg class="sc-dIsUp dqYXmg" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-fWWYYk cMoEZ">200<!-- --> </strong><span class="sc-jcwpoC eDjFAZ"><p>Project rate limits listed successfully.</p>
</span></button></div></div></div><div class="sc-jSFjdj sc-gKAaRy gBjRyf gcushC"><div class="sc-EZqKI fWsqvQ"><button class="sc-eEVmNe ilvUMs"><span type="get" class="sc-fmdNqN ihNycv http-verb get">get</span><span class="sc-jXcxbT fCEUju">/organization/projects/{project_id}/rate_limits</span><svg class="sc-dIsUp bRmrKA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ljsmAU flIrdF"><div class="sc-jlZJtj fQkroN"><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div><div tabindex="0" role="button"><div class="sc-dTSzeu dfUAUz"><span>https://api.openai.com/v1</span>/organization/projects/{project_id}/rate_limits</div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Response samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-446" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-447" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-447" aria-labelledby="react-tabs-446"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-bBjRSN kQSIAz">application/json</div></div><div class="sc-jgPyTC dSaTNC"><div class="sc-jNnpgg esZIbL"><div class="sc-giAqHp hMPeqJ"><button><div class="sc-carFqZ UksDl">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iJCRrE jCdxGr sc-dPaNzc gyljjx"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"object"</span>: <span class="token string">"list"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"object"</span>: <span class="token string">"project.rate_limit"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"model"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"max_requests_per_1_minute"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"max_tokens_per_1_minute"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"max_images_per_1_minute"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"max_audio_megabytes_per_1_minute"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"max_requests_per_1_day"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"batch_1_day_max_input_tokens"</span>: <span class="token number">0</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"first_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"last_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"has_more"</span>: <span class="token boolean">true</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Projects/operation/update-project-rate-limits" data-section-id="tag/Projects/operation/update-project-rate-limits" class="sc-eCApnc liLqNm"><div data-section-id="operation/update-project-rate-limits" id="operation/update-project-rate-limits" class="sc-iCoGMd gLxhOh"><div class="sc-hKFxyN juinod"><h2 class="sc-pNWdM eftmgB"><a class="sc-crzoAE iUxAWq" href="#tag/Projects/operation/update-project-rate-limits" aria-label="tag/Projects/operation/update-project-rate-limits"></a>Updates a project rate limit.<!-- --> </h2><div class="sc-fcmMJX cvfxAX"><div class="sc-jUfyBS bhDyou"><h5 class="sc-iqAclL sc-fuISkM eONCmm hZIgic">Authorizations:</h5><svg class="sc-dIsUp iPqByX" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jQAxuV ccffaZ"><span class="sc-daBunf fcvuS"><span class="sc-dsXzNU dPrSxx"><i>ApiKeyAuth</i></span></span></div></div><div><h5 class="sc-iqAclL eONCmm">path<!-- --> Parameters</h5><table class="sc-hHEiqL VCQHZ"><tbody><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="project_id"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">project_id</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The ID of the project.</p>
</div></div></div></td></tr><tr class="last "><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="rate_limit_id"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">rate_limit_id</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The ID of the rate limit.</p>
</div></div></div></td></tr></tbody></table></div><h5 class="sc-iqAclL eONCmm">Request Body schema: <span class="sc-cBoqAE eKyrDP">application/json</span></h5><div class="sc-iJCRrE sc-ciSkZP jCdxGr QGruV"><p>The project rate limit update request payload.</p>
</div><table class="sc-hHEiqL VCQHZ"><tbody><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="max_requests_per_1_minute"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">max_requests_per_1_minute</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">integer</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The maximum requests per minute.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="max_tokens_per_1_minute"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">max_tokens_per_1_minute</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">integer</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The maximum tokens per minute.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="max_images_per_1_minute"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">max_images_per_1_minute</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">integer</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The maximum images per minute. Only relevant for certain models.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="max_audio_megabytes_per_1_minute"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">max_audio_megabytes_per_1_minute</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">integer</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The maximum audio megabytes per minute. Only relevant for certain models.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="max_requests_per_1_day"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">max_requests_per_1_day</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">integer</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The maximum requests per day. Only relevant for certain models.</p>
</div></div></div></td></tr><tr class="last "><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="batch_1_day_max_input_tokens"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">batch_1_day_max_input_tokens</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">integer</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The maximum batch input tokens per day. Only relevant for certain models.</p>
</div></div></div></td></tr></tbody></table><div><h3 class="sc-fIxmyt DvFer">Responses</h3><div><button class="sc-htmcrh lbYftx"><svg class="sc-dIsUp dqYXmg" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-fWWYYk cMoEZ">200<!-- --> </strong><span class="sc-jcwpoC eDjFAZ"><p>Project rate limit updated successfully.</p>
</span></button></div><div><button class="sc-htmcrh NAUPn"><svg class="sc-dIsUp dVWHLw" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-fWWYYk cMoEZ">400<!-- --> </strong><span class="sc-jcwpoC eDjFAZ"><p>Error response for various conditions.</p>
</span></button></div></div></div><div class="sc-jSFjdj sc-gKAaRy gBjRyf gcushC"><div class="sc-EZqKI fWsqvQ"><button class="sc-eEVmNe ilvUMs"><span type="post" class="sc-fmdNqN ldMUmp http-verb post">post</span><span class="sc-jXcxbT fCEUju">/organization/projects/{project_id}/rate_limits/{rate_limit_id}</span><svg class="sc-dIsUp bRmrKA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ljsmAU flIrdF"><div class="sc-jlZJtj fQkroN"><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div><div tabindex="0" role="button"><div class="sc-dTSzeu dfUAUz"><span>https://api.openai.com/v1</span>/organization/projects/{project_id}/rate_limits/{rate_limit_id}</div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Request samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="react-tabs-448" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-449" tabindex="0" data-rttab="true">Payload</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-449" aria-labelledby="react-tabs-448"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-bBjRSN kQSIAz">application/json</div></div><div class="sc-jgPyTC dSaTNC"><div class="sc-jNnpgg esZIbL"><div class="sc-giAqHp hMPeqJ"><button><div class="sc-carFqZ UksDl">Copy</div></button></div><div class="sc-iJCRrE jCdxGr sc-dPaNzc gyljjx"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"max_requests_per_1_minute"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"max_tokens_per_1_minute"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"max_images_per_1_minute"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"max_audio_megabytes_per_1_minute"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"max_requests_per_1_day"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"batch_1_day_max_input_tokens"</span>: <span class="token number">0</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Response samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-450" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-451" tabindex="0" data-rttab="true">200</li><li class="tab-error" role="tab" id="react-tabs-452" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-453" data-rttab="true">400</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-451" aria-labelledby="react-tabs-450"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-bBjRSN kQSIAz">application/json</div></div><div class="sc-jgPyTC dSaTNC"><div class="sc-jNnpgg esZIbL"><div class="sc-giAqHp hMPeqJ"><button><div class="sc-carFqZ UksDl">Copy</div></button></div><div class="sc-iJCRrE jCdxGr sc-dPaNzc gyljjx"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"object"</span>: <span class="token string">"project.rate_limit"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"model"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"max_requests_per_1_minute"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"max_tokens_per_1_minute"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"max_images_per_1_minute"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"max_audio_megabytes_per_1_minute"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"max_requests_per_1_day"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"batch_1_day_max_input_tokens"</span>: <span class="token number">0</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-453" aria-labelledby="react-tabs-452"></div></div></div></div></div></div><div id="tag/Projects/operation/list-project-service-accounts" data-section-id="tag/Projects/operation/list-project-service-accounts" class="sc-eCApnc liLqNm"><div data-section-id="operation/list-project-service-accounts" id="operation/list-project-service-accounts" class="sc-iCoGMd gLxhOh"><div class="sc-hKFxyN juinod"><h2 class="sc-pNWdM eftmgB"><a class="sc-crzoAE iUxAWq" href="#tag/Projects/operation/list-project-service-accounts" aria-label="tag/Projects/operation/list-project-service-accounts"></a>Returns a list of service accounts in the project.<!-- --> </h2><div class="sc-fcmMJX cvfxAX"><div class="sc-jUfyBS bhDyou"><h5 class="sc-iqAclL sc-fuISkM eONCmm hZIgic">Authorizations:</h5><svg class="sc-dIsUp iPqByX" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jQAxuV ccffaZ"><span class="sc-daBunf fcvuS"><span class="sc-dsXzNU dPrSxx"><i>ApiKeyAuth</i></span></span></div></div><div><h5 class="sc-iqAclL eONCmm">path<!-- --> Parameters</h5><table class="sc-hHEiqL VCQHZ"><tbody><tr class="last "><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="project_id"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">project_id</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The ID of the project.</p>
</div></div></div></td></tr></tbody></table></div><div><h5 class="sc-iqAclL eONCmm">query<!-- --> Parameters</h5><table class="sc-hHEiqL VCQHZ"><tbody><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="limit"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">limit</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">integer</span></div><div><span class="sc-laZMeE jWaWWE"> <!-- -->Default:<!-- --> </span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">20</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.</p>
</div></div></div></td></tr><tr class="last "><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="after"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">after</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>A cursor for use in pagination. <code>after</code> is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-fIxmyt DvFer">Responses</h3><div><button class="sc-htmcrh lbYftx"><svg class="sc-dIsUp dqYXmg" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-fWWYYk cMoEZ">200<!-- --> </strong><span class="sc-jcwpoC eDjFAZ"><p>Project service accounts listed successfully.</p>
</span></button></div><div><button class="sc-htmcrh NAUPn"><svg class="sc-dIsUp dVWHLw" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-fWWYYk cMoEZ">400<!-- --> </strong><span class="sc-jcwpoC eDjFAZ"><p>Error response when project is archived.</p>
</span></button></div></div></div><div class="sc-jSFjdj sc-gKAaRy gBjRyf gcushC"><div class="sc-EZqKI fWsqvQ"><button class="sc-eEVmNe ilvUMs"><span type="get" class="sc-fmdNqN ihNycv http-verb get">get</span><span class="sc-jXcxbT fCEUju">/organization/projects/{project_id}/service_accounts</span><svg class="sc-dIsUp bRmrKA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ljsmAU flIrdF"><div class="sc-jlZJtj fQkroN"><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div><div tabindex="0" role="button"><div class="sc-dTSzeu dfUAUz"><span>https://api.openai.com/v1</span>/organization/projects/{project_id}/service_accounts</div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Response samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-454" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-455" tabindex="0" data-rttab="true">200</li><li class="tab-error" role="tab" id="react-tabs-456" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-457" data-rttab="true">400</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-455" aria-labelledby="react-tabs-454"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-bBjRSN kQSIAz">application/json</div></div><div class="sc-jgPyTC dSaTNC"><div class="sc-jNnpgg esZIbL"><div class="sc-giAqHp hMPeqJ"><button><div class="sc-carFqZ UksDl">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iJCRrE jCdxGr sc-dPaNzc gyljjx"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"object"</span>: <span class="token string">"list"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"object"</span>: <span class="token string">"organization.project.service_account"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"role"</span>: <span class="token string">"owner"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"created_at"</span>: <span class="token number">0</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"first_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"last_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"has_more"</span>: <span class="token boolean">true</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-457" aria-labelledby="react-tabs-456"></div></div></div></div></div></div><div id="tag/Projects/operation/create-project-service-account" data-section-id="tag/Projects/operation/create-project-service-account" class="sc-eCApnc liLqNm"><div data-section-id="operation/create-project-service-account" id="operation/create-project-service-account" class="sc-iCoGMd gLxhOh"><div class="sc-hKFxyN juinod"><h2 class="sc-pNWdM eftmgB"><a class="sc-crzoAE iUxAWq" href="#tag/Projects/operation/create-project-service-account" aria-label="tag/Projects/operation/create-project-service-account"></a>Creates a new service account in the project. This also returns an unredacted API key for the service account.<!-- --> </h2><div class="sc-fcmMJX cvfxAX"><div class="sc-jUfyBS bhDyou"><h5 class="sc-iqAclL sc-fuISkM eONCmm hZIgic">Authorizations:</h5><svg class="sc-dIsUp iPqByX" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jQAxuV ccffaZ"><span class="sc-daBunf fcvuS"><span class="sc-dsXzNU dPrSxx"><i>ApiKeyAuth</i></span></span></div></div><div><h5 class="sc-iqAclL eONCmm">path<!-- --> Parameters</h5><table class="sc-hHEiqL VCQHZ"><tbody><tr class="last "><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="project_id"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">project_id</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The ID of the project.</p>
</div></div></div></td></tr></tbody></table></div><h5 class="sc-iqAclL eONCmm">Request Body schema: <span class="sc-cBoqAE eKyrDP">application/json</span></h5><div class="sc-iJCRrE sc-ciSkZP jCdxGr QGruV"><p>The project service account create request payload.</p>
</div><table class="sc-hHEiqL VCQHZ"><tbody><tr class="last "><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="name"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">name</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The name of the service account being created.</p>
</div></div></div></td></tr></tbody></table><div><h3 class="sc-fIxmyt DvFer">Responses</h3><div><button class="sc-htmcrh lbYftx"><svg class="sc-dIsUp dqYXmg" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-fWWYYk cMoEZ">200<!-- --> </strong><span class="sc-jcwpoC eDjFAZ"><p>Project service account created successfully.</p>
</span></button></div><div><button class="sc-htmcrh NAUPn"><svg class="sc-dIsUp dVWHLw" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-fWWYYk cMoEZ">400<!-- --> </strong><span class="sc-jcwpoC eDjFAZ"><p>Error response when project is archived.</p>
</span></button></div></div></div><div class="sc-jSFjdj sc-gKAaRy gBjRyf gcushC"><div class="sc-EZqKI fWsqvQ"><button class="sc-eEVmNe ilvUMs"><span type="post" class="sc-fmdNqN ldMUmp http-verb post">post</span><span class="sc-jXcxbT fCEUju">/organization/projects/{project_id}/service_accounts</span><svg class="sc-dIsUp bRmrKA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ljsmAU flIrdF"><div class="sc-jlZJtj fQkroN"><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div><div tabindex="0" role="button"><div class="sc-dTSzeu dfUAUz"><span>https://api.openai.com/v1</span>/organization/projects/{project_id}/service_accounts</div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Request samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="react-tabs-458" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-459" tabindex="0" data-rttab="true">Payload</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-459" aria-labelledby="react-tabs-458"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-bBjRSN kQSIAz">application/json</div></div><div class="sc-jgPyTC dSaTNC"><div class="sc-jNnpgg esZIbL"><div class="sc-giAqHp hMPeqJ"><button><div class="sc-carFqZ UksDl">Copy</div></button></div><div class="sc-iJCRrE jCdxGr sc-dPaNzc gyljjx"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Response samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-460" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-461" tabindex="0" data-rttab="true">200</li><li class="tab-error" role="tab" id="react-tabs-462" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-463" data-rttab="true">400</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-461" aria-labelledby="react-tabs-460"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-bBjRSN kQSIAz">application/json</div></div><div class="sc-jgPyTC dSaTNC"><div class="sc-jNnpgg esZIbL"><div class="sc-giAqHp hMPeqJ"><button><div class="sc-carFqZ UksDl">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iJCRrE jCdxGr sc-dPaNzc gyljjx"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"object"</span>: <span class="token string">"organization.project.service_account"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"role"</span>: <span class="token string">"member"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"created_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"api_key"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"object"</span>: <span class="token string">"organization.project.service_account.api_key"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"value"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"created_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"id"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-463" aria-labelledby="react-tabs-462"></div></div></div></div></div></div><div id="tag/Projects/operation/retrieve-project-service-account" data-section-id="tag/Projects/operation/retrieve-project-service-account" class="sc-eCApnc liLqNm"><div data-section-id="operation/retrieve-project-service-account" id="operation/retrieve-project-service-account" class="sc-iCoGMd gLxhOh"><div class="sc-hKFxyN juinod"><h2 class="sc-pNWdM eftmgB"><a class="sc-crzoAE iUxAWq" href="#tag/Projects/operation/retrieve-project-service-account" aria-label="tag/Projects/operation/retrieve-project-service-account"></a>Retrieves a service account in the project.<!-- --> </h2><div class="sc-fcmMJX cvfxAX"><div class="sc-jUfyBS bhDyou"><h5 class="sc-iqAclL sc-fuISkM eONCmm hZIgic">Authorizations:</h5><svg class="sc-dIsUp iPqByX" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jQAxuV ccffaZ"><span class="sc-daBunf fcvuS"><span class="sc-dsXzNU dPrSxx"><i>ApiKeyAuth</i></span></span></div></div><div><h5 class="sc-iqAclL eONCmm">path<!-- --> Parameters</h5><table class="sc-hHEiqL VCQHZ"><tbody><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="project_id"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">project_id</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The ID of the project.</p>
</div></div></div></td></tr><tr class="last "><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="service_account_id"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">service_account_id</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The ID of the service account.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-fIxmyt DvFer">Responses</h3><div><button class="sc-htmcrh lbYftx"><svg class="sc-dIsUp dqYXmg" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-fWWYYk cMoEZ">200<!-- --> </strong><span class="sc-jcwpoC eDjFAZ"><p>Project service account retrieved successfully.</p>
</span></button></div></div></div><div class="sc-jSFjdj sc-gKAaRy gBjRyf gcushC"><div class="sc-EZqKI fWsqvQ"><button class="sc-eEVmNe ilvUMs"><span type="get" class="sc-fmdNqN ihNycv http-verb get">get</span><span class="sc-jXcxbT fCEUju">/organization/projects/{project_id}/service_accounts/{service_account_id}</span><svg class="sc-dIsUp bRmrKA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ljsmAU flIrdF"><div class="sc-jlZJtj fQkroN"><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div><div tabindex="0" role="button"><div class="sc-dTSzeu dfUAUz"><span>https://api.openai.com/v1</span>/organization/projects/{project_id}/service_accounts/{service_account_id}</div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Response samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-464" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-465" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-465" aria-labelledby="react-tabs-464"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-bBjRSN kQSIAz">application/json</div></div><div class="sc-jgPyTC dSaTNC"><div class="sc-jNnpgg esZIbL"><div class="sc-giAqHp hMPeqJ"><button><div class="sc-carFqZ UksDl">Copy</div></button></div><div class="sc-iJCRrE jCdxGr sc-dPaNzc gyljjx"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"object"</span>: <span class="token string">"organization.project.service_account"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"role"</span>: <span class="token string">"owner"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"created_at"</span>: <span class="token number">0</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Projects/operation/delete-project-service-account" data-section-id="tag/Projects/operation/delete-project-service-account" class="sc-eCApnc liLqNm"><div data-section-id="operation/delete-project-service-account" id="operation/delete-project-service-account" class="sc-iCoGMd gLxhOh"><div class="sc-hKFxyN juinod"><h2 class="sc-pNWdM eftmgB"><a class="sc-crzoAE iUxAWq" href="#tag/Projects/operation/delete-project-service-account" aria-label="tag/Projects/operation/delete-project-service-account"></a>Deletes a service account from the project.
Returns confirmation of service account deletion, or an error if the project
is archived (archived projects have no service accounts).
<!-- --> </h2><div class="sc-fcmMJX cvfxAX"><div class="sc-jUfyBS bhDyou"><h5 class="sc-iqAclL sc-fuISkM eONCmm hZIgic">Authorizations:</h5><svg class="sc-dIsUp iPqByX" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jQAxuV ccffaZ"><span class="sc-daBunf fcvuS"><span class="sc-dsXzNU dPrSxx"><i>ApiKeyAuth</i></span></span></div></div><div><h5 class="sc-iqAclL eONCmm">path<!-- --> Parameters</h5><table class="sc-hHEiqL VCQHZ"><tbody><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="project_id"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">project_id</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The ID of the project.</p>
</div></div></div></td></tr><tr class="last "><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="service_account_id"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">service_account_id</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The ID of the service account.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-fIxmyt DvFer">Responses</h3><div><button class="sc-htmcrh lbYftx"><svg class="sc-dIsUp dqYXmg" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-fWWYYk cMoEZ">200<!-- --> </strong><span class="sc-jcwpoC eDjFAZ"><p>Project service account deleted successfully.</p>
</span></button></div></div></div><div class="sc-jSFjdj sc-gKAaRy gBjRyf gcushC"><div class="sc-EZqKI fWsqvQ"><button class="sc-eEVmNe ilvUMs"><span type="delete" class="sc-fmdNqN bJzUtf http-verb delete">delete</span><span class="sc-jXcxbT fCEUju">/organization/projects/{project_id}/service_accounts/{service_account_id}</span><svg class="sc-dIsUp bRmrKA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ljsmAU flIrdF"><div class="sc-jlZJtj fQkroN"><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div><div tabindex="0" role="button"><div class="sc-dTSzeu dfUAUz"><span>https://api.openai.com/v1</span>/organization/projects/{project_id}/service_accounts/{service_account_id}</div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Response samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-466" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-467" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-467" aria-labelledby="react-tabs-466"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-bBjRSN kQSIAz">application/json</div></div><div class="sc-jgPyTC dSaTNC"><div class="sc-jNnpgg esZIbL"><div class="sc-giAqHp hMPeqJ"><button><div class="sc-carFqZ UksDl">Copy</div></button></div><div class="sc-iJCRrE jCdxGr sc-dPaNzc gyljjx"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"object"</span>: <span class="token string">"organization.project.service_account.deleted"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"deleted"</span>: <span class="token boolean">true</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Projects/operation/list-project-users" data-section-id="tag/Projects/operation/list-project-users" class="sc-eCApnc liLqNm"><div data-section-id="operation/list-project-users" id="operation/list-project-users" class="sc-iCoGMd gLxhOh"><div class="sc-hKFxyN juinod"><h2 class="sc-pNWdM eftmgB"><a class="sc-crzoAE iUxAWq" href="#tag/Projects/operation/list-project-users" aria-label="tag/Projects/operation/list-project-users"></a>Returns a list of users in the project.<!-- --> </h2><div class="sc-fcmMJX cvfxAX"><div class="sc-jUfyBS bhDyou"><h5 class="sc-iqAclL sc-fuISkM eONCmm hZIgic">Authorizations:</h5><svg class="sc-dIsUp iPqByX" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jQAxuV ccffaZ"><span class="sc-daBunf fcvuS"><span class="sc-dsXzNU dPrSxx"><i>ApiKeyAuth</i></span></span></div></div><div><h5 class="sc-iqAclL eONCmm">path<!-- --> Parameters</h5><table class="sc-hHEiqL VCQHZ"><tbody><tr class="last "><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="project_id"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">project_id</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The ID of the project.</p>
</div></div></div></td></tr></tbody></table></div><div><h5 class="sc-iqAclL eONCmm">query<!-- --> Parameters</h5><table class="sc-hHEiqL VCQHZ"><tbody><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="limit"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">limit</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">integer</span></div><div><span class="sc-laZMeE jWaWWE"> <!-- -->Default:<!-- --> </span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">20</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.</p>
</div></div></div></td></tr><tr class="last "><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="after"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">after</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>A cursor for use in pagination. <code>after</code> is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-fIxmyt DvFer">Responses</h3><div><button class="sc-htmcrh lbYftx"><svg class="sc-dIsUp dqYXmg" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-fWWYYk cMoEZ">200<!-- --> </strong><span class="sc-jcwpoC eDjFAZ"><p>Project users listed successfully.</p>
</span></button></div><div><button class="sc-htmcrh NAUPn"><svg class="sc-dIsUp dVWHLw" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-fWWYYk cMoEZ">400<!-- --> </strong><span class="sc-jcwpoC eDjFAZ"><p>Error response when project is archived.</p>
</span></button></div></div></div><div class="sc-jSFjdj sc-gKAaRy gBjRyf gcushC"><div class="sc-EZqKI fWsqvQ"><button class="sc-eEVmNe ilvUMs"><span type="get" class="sc-fmdNqN ihNycv http-verb get">get</span><span class="sc-jXcxbT fCEUju">/organization/projects/{project_id}/users</span><svg class="sc-dIsUp bRmrKA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ljsmAU flIrdF"><div class="sc-jlZJtj fQkroN"><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div><div tabindex="0" role="button"><div class="sc-dTSzeu dfUAUz"><span>https://api.openai.com/v1</span>/organization/projects/{project_id}/users</div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Response samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-468" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-469" tabindex="0" data-rttab="true">200</li><li class="tab-error" role="tab" id="react-tabs-470" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-471" data-rttab="true">400</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-469" aria-labelledby="react-tabs-468"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-bBjRSN kQSIAz">application/json</div></div><div class="sc-jgPyTC dSaTNC"><div class="sc-jNnpgg esZIbL"><div class="sc-giAqHp hMPeqJ"><button><div class="sc-carFqZ UksDl">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iJCRrE jCdxGr sc-dPaNzc gyljjx"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"object"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"object"</span>: <span class="token string">"organization.project.user"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"email"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"role"</span>: <span class="token string">"owner"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"added_at"</span>: <span class="token number">0</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"first_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"last_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"has_more"</span>: <span class="token boolean">true</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-471" aria-labelledby="react-tabs-470"></div></div></div></div></div></div><div id="tag/Projects/operation/create-project-user" data-section-id="tag/Projects/operation/create-project-user" class="sc-eCApnc liLqNm"><div data-section-id="operation/create-project-user" id="operation/create-project-user" class="sc-iCoGMd gLxhOh"><div class="sc-hKFxyN juinod"><h2 class="sc-pNWdM eftmgB"><a class="sc-crzoAE iUxAWq" href="#tag/Projects/operation/create-project-user" aria-label="tag/Projects/operation/create-project-user"></a>Adds a user to the project. Users must already be members of the organization to be added to a project.<!-- --> </h2><div class="sc-fcmMJX cvfxAX"><div class="sc-jUfyBS bhDyou"><h5 class="sc-iqAclL sc-fuISkM eONCmm hZIgic">Authorizations:</h5><svg class="sc-dIsUp iPqByX" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jQAxuV ccffaZ"><span class="sc-daBunf fcvuS"><span class="sc-dsXzNU dPrSxx"><i>ApiKeyAuth</i></span></span></div></div><div><h5 class="sc-iqAclL eONCmm">path<!-- --> Parameters</h5><table class="sc-hHEiqL VCQHZ"><tbody><tr class="last "><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="project_id"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">project_id</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The ID of the project.</p>
</div></div></div></td></tr></tbody></table></div><h5 class="sc-iqAclL eONCmm">Request Body schema: <span class="sc-cBoqAE eKyrDP">application/json</span></h5><div class="sc-iJCRrE sc-ciSkZP jCdxGr QGruV"><p>The project user create request payload.</p>
</div><table class="sc-hHEiqL VCQHZ"><tbody><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="user_id"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">user_id</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The ID of the user.</p>
</div></div></div></td></tr><tr class="last "><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="role"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">role</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div><div><span class="sc-laZMeE jWaWWE"> <!-- -->Enum<!-- -->:</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"owner"</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"member"</span> </div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p><code>owner</code> or <code>member</code></p>
</div></div></div></td></tr></tbody></table><div><h3 class="sc-fIxmyt DvFer">Responses</h3><div><button class="sc-htmcrh lbYftx"><svg class="sc-dIsUp dqYXmg" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-fWWYYk cMoEZ">200<!-- --> </strong><span class="sc-jcwpoC eDjFAZ"><p>User added to project successfully.</p>
</span></button></div><div><button class="sc-htmcrh NAUPn"><svg class="sc-dIsUp dVWHLw" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-fWWYYk cMoEZ">400<!-- --> </strong><span class="sc-jcwpoC eDjFAZ"><p>Error response for various conditions.</p>
</span></button></div></div></div><div class="sc-jSFjdj sc-gKAaRy gBjRyf gcushC"><div class="sc-EZqKI fWsqvQ"><button class="sc-eEVmNe ilvUMs"><span type="post" class="sc-fmdNqN ldMUmp http-verb post">post</span><span class="sc-jXcxbT fCEUju">/organization/projects/{project_id}/users</span><svg class="sc-dIsUp bRmrKA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ljsmAU flIrdF"><div class="sc-jlZJtj fQkroN"><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div><div tabindex="0" role="button"><div class="sc-dTSzeu dfUAUz"><span>https://api.openai.com/v1</span>/organization/projects/{project_id}/users</div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Request samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="react-tabs-472" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-473" tabindex="0" data-rttab="true">Payload</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-473" aria-labelledby="react-tabs-472"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-bBjRSN kQSIAz">application/json</div></div><div class="sc-jgPyTC dSaTNC"><div class="sc-jNnpgg esZIbL"><div class="sc-giAqHp hMPeqJ"><button><div class="sc-carFqZ UksDl">Copy</div></button></div><div class="sc-iJCRrE jCdxGr sc-dPaNzc gyljjx"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"user_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"role"</span>: <span class="token string">"owner"</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Response samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-474" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-475" tabindex="0" data-rttab="true">200</li><li class="tab-error" role="tab" id="react-tabs-476" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-477" data-rttab="true">400</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-475" aria-labelledby="react-tabs-474"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-bBjRSN kQSIAz">application/json</div></div><div class="sc-jgPyTC dSaTNC"><div class="sc-jNnpgg esZIbL"><div class="sc-giAqHp hMPeqJ"><button><div class="sc-carFqZ UksDl">Copy</div></button></div><div class="sc-iJCRrE jCdxGr sc-dPaNzc gyljjx"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"object"</span>: <span class="token string">"organization.project.user"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"email"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"role"</span>: <span class="token string">"owner"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"added_at"</span>: <span class="token number">0</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-477" aria-labelledby="react-tabs-476"></div></div></div></div></div></div><div id="tag/Projects/operation/retrieve-project-user" data-section-id="tag/Projects/operation/retrieve-project-user" class="sc-eCApnc liLqNm"><div data-section-id="operation/retrieve-project-user" id="operation/retrieve-project-user" class="sc-iCoGMd gLxhOh"><div class="sc-hKFxyN juinod"><h2 class="sc-pNWdM eftmgB"><a class="sc-crzoAE iUxAWq" href="#tag/Projects/operation/retrieve-project-user" aria-label="tag/Projects/operation/retrieve-project-user"></a>Retrieves a user in the project.<!-- --> </h2><div class="sc-fcmMJX cvfxAX"><div class="sc-jUfyBS bhDyou"><h5 class="sc-iqAclL sc-fuISkM eONCmm hZIgic">Authorizations:</h5><svg class="sc-dIsUp iPqByX" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jQAxuV ccffaZ"><span class="sc-daBunf fcvuS"><span class="sc-dsXzNU dPrSxx"><i>ApiKeyAuth</i></span></span></div></div><div><h5 class="sc-iqAclL eONCmm">path<!-- --> Parameters</h5><table class="sc-hHEiqL VCQHZ"><tbody><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="project_id"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">project_id</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The ID of the project.</p>
</div></div></div></td></tr><tr class="last "><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="user_id"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">user_id</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The ID of the user.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-fIxmyt DvFer">Responses</h3><div><button class="sc-htmcrh lbYftx"><svg class="sc-dIsUp dqYXmg" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-fWWYYk cMoEZ">200<!-- --> </strong><span class="sc-jcwpoC eDjFAZ"><p>Project user retrieved successfully.</p>
</span></button></div></div></div><div class="sc-jSFjdj sc-gKAaRy gBjRyf gcushC"><div class="sc-EZqKI fWsqvQ"><button class="sc-eEVmNe ilvUMs"><span type="get" class="sc-fmdNqN ihNycv http-verb get">get</span><span class="sc-jXcxbT fCEUju">/organization/projects/{project_id}/users/{user_id}</span><svg class="sc-dIsUp bRmrKA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ljsmAU flIrdF"><div class="sc-jlZJtj fQkroN"><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div><div tabindex="0" role="button"><div class="sc-dTSzeu dfUAUz"><span>https://api.openai.com/v1</span>/organization/projects/{project_id}/users/{user_id}</div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Response samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-478" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-479" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-479" aria-labelledby="react-tabs-478"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-bBjRSN kQSIAz">application/json</div></div><div class="sc-jgPyTC dSaTNC"><div class="sc-jNnpgg esZIbL"><div class="sc-giAqHp hMPeqJ"><button><div class="sc-carFqZ UksDl">Copy</div></button></div><div class="sc-iJCRrE jCdxGr sc-dPaNzc gyljjx"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"object"</span>: <span class="token string">"organization.project.user"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"email"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"role"</span>: <span class="token string">"owner"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"added_at"</span>: <span class="token number">0</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Projects/operation/modify-project-user" data-section-id="tag/Projects/operation/modify-project-user" class="sc-eCApnc liLqNm"><div data-section-id="operation/modify-project-user" id="operation/modify-project-user" class="sc-iCoGMd gLxhOh"><div class="sc-hKFxyN juinod"><h2 class="sc-pNWdM eftmgB"><a class="sc-crzoAE iUxAWq" href="#tag/Projects/operation/modify-project-user" aria-label="tag/Projects/operation/modify-project-user"></a>Modifies a user's role in the project.<!-- --> </h2><div class="sc-fcmMJX cvfxAX"><div class="sc-jUfyBS bhDyou"><h5 class="sc-iqAclL sc-fuISkM eONCmm hZIgic">Authorizations:</h5><svg class="sc-dIsUp iPqByX" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jQAxuV ccffaZ"><span class="sc-daBunf fcvuS"><span class="sc-dsXzNU dPrSxx"><i>ApiKeyAuth</i></span></span></div></div><div><h5 class="sc-iqAclL eONCmm">path<!-- --> Parameters</h5><table class="sc-hHEiqL VCQHZ"><tbody><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="project_id"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">project_id</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The ID of the project.</p>
</div></div></div></td></tr><tr class="last "><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="user_id"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">user_id</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The ID of the user.</p>
</div></div></div></td></tr></tbody></table></div><h5 class="sc-iqAclL eONCmm">Request Body schema: <span class="sc-cBoqAE eKyrDP">application/json</span></h5><div class="sc-iJCRrE sc-ciSkZP jCdxGr QGruV"><p>The project user update request payload.</p>
</div><table class="sc-hHEiqL VCQHZ"><tbody><tr class="last "><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="role"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">role</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div><div><span class="sc-laZMeE jWaWWE"> <!-- -->Enum<!-- -->:</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"owner"</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"member"</span> </div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p><code>owner</code> or <code>member</code></p>
</div></div></div></td></tr></tbody></table><div><h3 class="sc-fIxmyt DvFer">Responses</h3><div><button class="sc-htmcrh lbYftx"><svg class="sc-dIsUp dqYXmg" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-fWWYYk cMoEZ">200<!-- --> </strong><span class="sc-jcwpoC eDjFAZ"><p>Project user's role updated successfully.</p>
</span></button></div><div><button class="sc-htmcrh NAUPn"><svg class="sc-dIsUp dVWHLw" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-fWWYYk cMoEZ">400<!-- --> </strong><span class="sc-jcwpoC eDjFAZ"><p>Error response for various conditions.</p>
</span></button></div></div></div><div class="sc-jSFjdj sc-gKAaRy gBjRyf gcushC"><div class="sc-EZqKI fWsqvQ"><button class="sc-eEVmNe ilvUMs"><span type="post" class="sc-fmdNqN ldMUmp http-verb post">post</span><span class="sc-jXcxbT fCEUju">/organization/projects/{project_id}/users/{user_id}</span><svg class="sc-dIsUp bRmrKA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ljsmAU flIrdF"><div class="sc-jlZJtj fQkroN"><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div><div tabindex="0" role="button"><div class="sc-dTSzeu dfUAUz"><span>https://api.openai.com/v1</span>/organization/projects/{project_id}/users/{user_id}</div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Request samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="react-tabs-480" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-481" tabindex="0" data-rttab="true">Payload</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-481" aria-labelledby="react-tabs-480"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-bBjRSN kQSIAz">application/json</div></div><div class="sc-jgPyTC dSaTNC"><div class="sc-jNnpgg esZIbL"><div class="sc-giAqHp hMPeqJ"><button><div class="sc-carFqZ UksDl">Copy</div></button></div><div class="sc-iJCRrE jCdxGr sc-dPaNzc gyljjx"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"role"</span>: <span class="token string">"owner"</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Response samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-482" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-483" tabindex="0" data-rttab="true">200</li><li class="tab-error" role="tab" id="react-tabs-484" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-485" data-rttab="true">400</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-483" aria-labelledby="react-tabs-482"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-bBjRSN kQSIAz">application/json</div></div><div class="sc-jgPyTC dSaTNC"><div class="sc-jNnpgg esZIbL"><div class="sc-giAqHp hMPeqJ"><button><div class="sc-carFqZ UksDl">Copy</div></button></div><div class="sc-iJCRrE jCdxGr sc-dPaNzc gyljjx"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"object"</span>: <span class="token string">"organization.project.user"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"email"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"role"</span>: <span class="token string">"owner"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"added_at"</span>: <span class="token number">0</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-485" aria-labelledby="react-tabs-484"></div></div></div></div></div></div><div id="tag/Projects/operation/delete-project-user" data-section-id="tag/Projects/operation/delete-project-user" class="sc-eCApnc liLqNm"><div data-section-id="operation/delete-project-user" id="operation/delete-project-user" class="sc-iCoGMd gLxhOh"><div class="sc-hKFxyN juinod"><h2 class="sc-pNWdM eftmgB"><a class="sc-crzoAE iUxAWq" href="#tag/Projects/operation/delete-project-user" aria-label="tag/Projects/operation/delete-project-user"></a>Deletes a user from the project.
Returns confirmation of project user deletion, or an error if the project is
archived (archived projects have no users).
<!-- --> </h2><div class="sc-fcmMJX cvfxAX"><div class="sc-jUfyBS bhDyou"><h5 class="sc-iqAclL sc-fuISkM eONCmm hZIgic">Authorizations:</h5><svg class="sc-dIsUp iPqByX" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jQAxuV ccffaZ"><span class="sc-daBunf fcvuS"><span class="sc-dsXzNU dPrSxx"><i>ApiKeyAuth</i></span></span></div></div><div><h5 class="sc-iqAclL eONCmm">path<!-- --> Parameters</h5><table class="sc-hHEiqL VCQHZ"><tbody><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="project_id"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">project_id</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The ID of the project.</p>
</div></div></div></td></tr><tr class="last "><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="user_id"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">user_id</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The ID of the user.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-fIxmyt DvFer">Responses</h3><div><button class="sc-htmcrh lbYftx"><svg class="sc-dIsUp dqYXmg" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-fWWYYk cMoEZ">200<!-- --> </strong><span class="sc-jcwpoC eDjFAZ"><p>Project user deleted successfully.</p>
</span></button></div><div><button class="sc-htmcrh NAUPn"><svg class="sc-dIsUp dVWHLw" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-fWWYYk cMoEZ">400<!-- --> </strong><span class="sc-jcwpoC eDjFAZ"><p>Error response for various conditions.</p>
</span></button></div></div></div><div class="sc-jSFjdj sc-gKAaRy gBjRyf gcushC"><div class="sc-EZqKI fWsqvQ"><button class="sc-eEVmNe ilvUMs"><span type="delete" class="sc-fmdNqN bJzUtf http-verb delete">delete</span><span class="sc-jXcxbT fCEUju">/organization/projects/{project_id}/users/{user_id}</span><svg class="sc-dIsUp bRmrKA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ljsmAU flIrdF"><div class="sc-jlZJtj fQkroN"><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div><div tabindex="0" role="button"><div class="sc-dTSzeu dfUAUz"><span>https://api.openai.com/v1</span>/organization/projects/{project_id}/users/{user_id}</div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Response samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-486" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-487" tabindex="0" data-rttab="true">200</li><li class="tab-error" role="tab" id="react-tabs-488" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-489" data-rttab="true">400</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-487" aria-labelledby="react-tabs-486"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-bBjRSN kQSIAz">application/json</div></div><div class="sc-jgPyTC dSaTNC"><div class="sc-jNnpgg esZIbL"><div class="sc-giAqHp hMPeqJ"><button><div class="sc-carFqZ UksDl">Copy</div></button></div><div class="sc-iJCRrE jCdxGr sc-dPaNzc gyljjx"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"object"</span>: <span class="token string">"organization.project.user.deleted"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"deleted"</span>: <span class="token boolean">true</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-489" aria-labelledby="react-tabs-488"></div></div></div></div></div></div><div id="tag/Project-groups" data-section-id="tag/Project-groups" class="sc-eCApnc jlMQbh"><div class="sc-iCoGMd gLxhOh"><div class="sc-hKFxyN juinod"><h1 class="sc-fujyAs bpZWeL"><a class="sc-crzoAE iUxAWq" href="#tag/Project-groups" aria-label="tag/Project-groups"></a>Project groups</h1></div></div></div><div id="tag/Project-groups/operation/list-project-groups" data-section-id="tag/Project-groups/operation/list-project-groups" class="sc-eCApnc liLqNm"><div data-section-id="operation/list-project-groups" id="operation/list-project-groups" class="sc-iCoGMd gLxhOh"><div class="sc-hKFxyN juinod"><h2 class="sc-pNWdM eftmgB"><a class="sc-crzoAE iUxAWq" href="#tag/Project-groups/operation/list-project-groups" aria-label="tag/Project-groups/operation/list-project-groups"></a>Lists the groups that have access to a project.<!-- --> </h2><div class="sc-fcmMJX cvfxAX"><div class="sc-jUfyBS bhDyou"><h5 class="sc-iqAclL sc-fuISkM eONCmm hZIgic">Authorizations:</h5><svg class="sc-dIsUp iPqByX" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jQAxuV ccffaZ"><span class="sc-daBunf fcvuS"><span class="sc-dsXzNU dPrSxx"><i>ApiKeyAuth</i></span></span></div></div><div><h5 class="sc-iqAclL eONCmm">path<!-- --> Parameters</h5><table class="sc-hHEiqL VCQHZ"><tbody><tr class="last "><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="project_id"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">project_id</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The ID of the project to inspect.</p>
</div></div></div></td></tr></tbody></table></div><div><h5 class="sc-iqAclL eONCmm">query<!-- --> Parameters</h5><table class="sc-hHEiqL VCQHZ"><tbody><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="limit"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">limit</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">integer</span><span> <span class="sc-laZMeE sc-FRrlG jWaWWE gHBwqe"> <!-- -->[ 0 .. 100 ]<!-- --> </span></span></div><div><span class="sc-laZMeE jWaWWE"> <!-- -->Default:<!-- --> </span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">20</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>A limit on the number of project groups to return. Defaults to 20.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="after"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">after</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>Cursor for pagination. Provide the ID of the last group from the previous response to fetch the next page.</p>
</div></div></div></td></tr><tr class="last "><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="order"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">order</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div><div><span class="sc-laZMeE jWaWWE"> <!-- -->Default:<!-- --> </span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"asc"</span></div><div><span class="sc-laZMeE jWaWWE"> <!-- -->Enum<!-- -->:</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"asc"</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"desc"</span> </div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>Sort order for the returned groups.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-fIxmyt DvFer">Responses</h3><div><button class="sc-htmcrh lbYftx"><svg class="sc-dIsUp dqYXmg" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-fWWYYk cMoEZ">200<!-- --> </strong><span class="sc-jcwpoC eDjFAZ"><p>Project groups listed successfully.</p>
</span></button></div></div></div><div class="sc-jSFjdj sc-gKAaRy gBjRyf gcushC"><div class="sc-EZqKI fWsqvQ"><button class="sc-eEVmNe ilvUMs"><span type="get" class="sc-fmdNqN ihNycv http-verb get">get</span><span class="sc-jXcxbT fCEUju">/organization/projects/{project_id}/groups</span><svg class="sc-dIsUp bRmrKA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ljsmAU flIrdF"><div class="sc-jlZJtj fQkroN"><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div><div tabindex="0" role="button"><div class="sc-dTSzeu dfUAUz"><span>https://api.openai.com/v1</span>/organization/projects/{project_id}/groups</div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Response samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-490" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-491" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-491" aria-labelledby="react-tabs-490"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-bBjRSN kQSIAz">application/json</div></div><div class="sc-jgPyTC dSaTNC"><div class="sc-jNnpgg esZIbL"><div class="sc-giAqHp hMPeqJ"><button><div class="sc-carFqZ UksDl">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iJCRrE jCdxGr sc-dPaNzc gyljjx"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"object"</span>: <span class="token string">"list"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"object"</span>: <span class="token string">"project.group"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"project_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"group_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"group_name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"created_at"</span>: <span class="token number">0</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"has_more"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"next"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Project-groups/operation/add-project-group" data-section-id="tag/Project-groups/operation/add-project-group" class="sc-eCApnc liLqNm"><div data-section-id="operation/add-project-group" id="operation/add-project-group" class="sc-iCoGMd gLxhOh"><div class="sc-hKFxyN juinod"><h2 class="sc-pNWdM eftmgB"><a class="sc-crzoAE iUxAWq" href="#tag/Project-groups/operation/add-project-group" aria-label="tag/Project-groups/operation/add-project-group"></a>Grants a group access to a project.<!-- --> </h2><div class="sc-fcmMJX cvfxAX"><div class="sc-jUfyBS bhDyou"><h5 class="sc-iqAclL sc-fuISkM eONCmm hZIgic">Authorizations:</h5><svg class="sc-dIsUp iPqByX" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jQAxuV ccffaZ"><span class="sc-daBunf fcvuS"><span class="sc-dsXzNU dPrSxx"><i>ApiKeyAuth</i></span></span></div></div><div><h5 class="sc-iqAclL eONCmm">path<!-- --> Parameters</h5><table class="sc-hHEiqL VCQHZ"><tbody><tr class="last "><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="project_id"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">project_id</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The ID of the project to update.</p>
</div></div></div></td></tr></tbody></table></div><h5 class="sc-iqAclL eONCmm">Request Body schema: <span class="sc-cBoqAE eKyrDP">application/json</span></h5><div class="sc-iJCRrE sc-ciSkZP jCdxGr QGruV"><p>Identifies the group and role to assign to the project.</p>
</div><table class="sc-hHEiqL VCQHZ"><tbody><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="group_id"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">group_id</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>Identifier of the group to add to the project.</p>
</div></div></div></td></tr><tr class="last "><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="role"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">role</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>Identifier of the project role to grant to the group.</p>
</div></div></div></td></tr></tbody></table><div><h3 class="sc-fIxmyt DvFer">Responses</h3><div><button class="sc-htmcrh lbYftx"><svg class="sc-dIsUp dqYXmg" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-fWWYYk cMoEZ">200<!-- --> </strong><span class="sc-jcwpoC eDjFAZ"><p>Group granted access to the project successfully.</p>
</span></button></div></div></div><div class="sc-jSFjdj sc-gKAaRy gBjRyf gcushC"><div class="sc-EZqKI fWsqvQ"><button class="sc-eEVmNe ilvUMs"><span type="post" class="sc-fmdNqN ldMUmp http-verb post">post</span><span class="sc-jXcxbT fCEUju">/organization/projects/{project_id}/groups</span><svg class="sc-dIsUp bRmrKA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ljsmAU flIrdF"><div class="sc-jlZJtj fQkroN"><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div><div tabindex="0" role="button"><div class="sc-dTSzeu dfUAUz"><span>https://api.openai.com/v1</span>/organization/projects/{project_id}/groups</div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Request samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="react-tabs-492" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-493" tabindex="0" data-rttab="true">Payload</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-493" aria-labelledby="react-tabs-492"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-bBjRSN kQSIAz">application/json</div></div><div class="sc-jgPyTC dSaTNC"><div class="sc-jNnpgg esZIbL"><div class="sc-giAqHp hMPeqJ"><button><div class="sc-carFqZ UksDl">Copy</div></button></div><div class="sc-iJCRrE jCdxGr sc-dPaNzc gyljjx"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"group_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"role"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Response samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-494" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-495" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-495" aria-labelledby="react-tabs-494"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-bBjRSN kQSIAz">application/json</div></div><div class="sc-jgPyTC dSaTNC"><div class="sc-jNnpgg esZIbL"><div class="sc-giAqHp hMPeqJ"><button><div class="sc-carFqZ UksDl">Copy</div></button></div><div class="sc-iJCRrE jCdxGr sc-dPaNzc gyljjx"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"object"</span>: <span class="token string">"project.group"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"project_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"group_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"group_name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"created_at"</span>: <span class="token number">0</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Project-groups/operation/remove-project-group" data-section-id="tag/Project-groups/operation/remove-project-group" class="sc-eCApnc liLqNm"><div data-section-id="operation/remove-project-group" id="operation/remove-project-group" class="sc-iCoGMd gLxhOh"><div class="sc-hKFxyN juinod"><h2 class="sc-pNWdM eftmgB"><a class="sc-crzoAE iUxAWq" href="#tag/Project-groups/operation/remove-project-group" aria-label="tag/Project-groups/operation/remove-project-group"></a>Revokes a group's access to a project.<!-- --> </h2><div class="sc-fcmMJX cvfxAX"><div class="sc-jUfyBS bhDyou"><h5 class="sc-iqAclL sc-fuISkM eONCmm hZIgic">Authorizations:</h5><svg class="sc-dIsUp iPqByX" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jQAxuV ccffaZ"><span class="sc-daBunf fcvuS"><span class="sc-dsXzNU dPrSxx"><i>ApiKeyAuth</i></span></span></div></div><div><h5 class="sc-iqAclL eONCmm">path<!-- --> Parameters</h5><table class="sc-hHEiqL VCQHZ"><tbody><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="project_id"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">project_id</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The ID of the project to update.</p>
</div></div></div></td></tr><tr class="last "><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="group_id"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">group_id</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The ID of the group to remove from the project.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-fIxmyt DvFer">Responses</h3><div><button class="sc-htmcrh lbYftx"><svg class="sc-dIsUp dqYXmg" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-fWWYYk cMoEZ">200<!-- --> </strong><span class="sc-jcwpoC eDjFAZ"><p>Group removed from the project successfully.</p>
</span></button></div></div></div><div class="sc-jSFjdj sc-gKAaRy gBjRyf gcushC"><div class="sc-EZqKI fWsqvQ"><button class="sc-eEVmNe ilvUMs"><span type="delete" class="sc-fmdNqN bJzUtf http-verb delete">delete</span><span class="sc-jXcxbT fCEUju">/organization/projects/{project_id}/groups/{group_id}</span><svg class="sc-dIsUp bRmrKA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ljsmAU flIrdF"><div class="sc-jlZJtj fQkroN"><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div><div tabindex="0" role="button"><div class="sc-dTSzeu dfUAUz"><span>https://api.openai.com/v1</span>/organization/projects/{project_id}/groups/{group_id}</div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Response samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-496" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-497" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-497" aria-labelledby="react-tabs-496"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-bBjRSN kQSIAz">application/json</div></div><div class="sc-jgPyTC dSaTNC"><div class="sc-jNnpgg esZIbL"><div class="sc-giAqHp hMPeqJ"><button><div class="sc-carFqZ UksDl">Copy</div></button></div><div class="sc-iJCRrE jCdxGr sc-dPaNzc gyljjx"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"object"</span>: <span class="token string">"project.group.deleted"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"deleted"</span>: <span class="token boolean">true</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Roles" data-section-id="tag/Roles" class="sc-eCApnc jlMQbh"><div class="sc-iCoGMd gLxhOh"><div class="sc-hKFxyN juinod"><h1 class="sc-fujyAs bpZWeL"><a class="sc-crzoAE iUxAWq" href="#tag/Roles" aria-label="tag/Roles"></a>Roles</h1></div></div></div><div id="tag/Roles/operation/list-roles" data-section-id="tag/Roles/operation/list-roles" class="sc-eCApnc liLqNm"><div data-section-id="operation/list-roles" id="operation/list-roles" class="sc-iCoGMd gLxhOh"><div class="sc-hKFxyN juinod"><h2 class="sc-pNWdM eftmgB"><a class="sc-crzoAE iUxAWq" href="#tag/Roles/operation/list-roles" aria-label="tag/Roles/operation/list-roles"></a>Lists the roles configured for the organization.<!-- --> </h2><div class="sc-fcmMJX cvfxAX"><div class="sc-jUfyBS bhDyou"><h5 class="sc-iqAclL sc-fuISkM eONCmm hZIgic">Authorizations:</h5><svg class="sc-dIsUp iPqByX" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jQAxuV ccffaZ"><span class="sc-daBunf fcvuS"><span class="sc-dsXzNU dPrSxx"><i>ApiKeyAuth</i></span></span></div></div><div><h5 class="sc-iqAclL eONCmm">query<!-- --> Parameters</h5><table class="sc-hHEiqL VCQHZ"><tbody><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="limit"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">limit</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">integer</span><span> <span class="sc-laZMeE sc-FRrlG jWaWWE gHBwqe"> <!-- -->[ 0 .. 1000 ]<!-- --> </span></span></div><div><span class="sc-laZMeE jWaWWE"> <!-- -->Default:<!-- --> </span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">1000</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>A limit on the number of roles to return. Defaults to 1000.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="after"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">after</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>Cursor for pagination. Provide the value from the previous response's <code>next</code> field to continue listing roles.</p>
</div></div></div></td></tr><tr class="last "><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="order"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">order</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div><div><span class="sc-laZMeE jWaWWE"> <!-- -->Default:<!-- --> </span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"asc"</span></div><div><span class="sc-laZMeE jWaWWE"> <!-- -->Enum<!-- -->:</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"asc"</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"desc"</span> </div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>Sort order for the returned roles.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-fIxmyt DvFer">Responses</h3><div><button class="sc-htmcrh lbYftx"><svg class="sc-dIsUp dqYXmg" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-fWWYYk cMoEZ">200<!-- --> </strong><span class="sc-jcwpoC eDjFAZ"><p>Roles listed successfully.</p>
</span></button></div></div></div><div class="sc-jSFjdj sc-gKAaRy gBjRyf gcushC"><div class="sc-EZqKI fWsqvQ"><button class="sc-eEVmNe ilvUMs"><span type="get" class="sc-fmdNqN ihNycv http-verb get">get</span><span class="sc-jXcxbT fCEUju">/organization/roles</span><svg class="sc-dIsUp bRmrKA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ljsmAU flIrdF"><div class="sc-jlZJtj fQkroN"><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div><div tabindex="0" role="button"><div class="sc-dTSzeu dfUAUz"><span>https://api.openai.com/v1</span>/organization/roles</div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Response samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-498" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-499" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-499" aria-labelledby="react-tabs-498"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-bBjRSN kQSIAz">application/json</div></div><div class="sc-jgPyTC dSaTNC"><div class="sc-jNnpgg esZIbL"><div class="sc-giAqHp hMPeqJ"><button><div class="sc-carFqZ UksDl">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iJCRrE jCdxGr sc-dPaNzc gyljjx"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"object"</span>: <span class="token string">"list"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"object"</span>: <span class="token string">"role"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"description"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"permissions"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><span class="token string">"string"</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"resource_type"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"predefined_role"</span>: <span class="token boolean">true</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"has_more"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"next"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Roles/operation/create-role" data-section-id="tag/Roles/operation/create-role" class="sc-eCApnc liLqNm"><div data-section-id="operation/create-role" id="operation/create-role" class="sc-iCoGMd gLxhOh"><div class="sc-hKFxyN juinod"><h2 class="sc-pNWdM eftmgB"><a class="sc-crzoAE iUxAWq" href="#tag/Roles/operation/create-role" aria-label="tag/Roles/operation/create-role"></a>Creates a custom role for the organization.<!-- --> </h2><div class="sc-fcmMJX cvfxAX"><div class="sc-jUfyBS bhDyou"><h5 class="sc-iqAclL sc-fuISkM eONCmm hZIgic">Authorizations:</h5><svg class="sc-dIsUp iPqByX" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jQAxuV ccffaZ"><span class="sc-daBunf fcvuS"><span class="sc-dsXzNU dPrSxx"><i>ApiKeyAuth</i></span></span></div></div><h5 class="sc-iqAclL eONCmm">Request Body schema: <span class="sc-cBoqAE eKyrDP">application/json</span></h5><div class="sc-iJCRrE sc-ciSkZP jCdxGr QGruV"><p>Parameters for the role you want to create.</p>
</div><table class="sc-hHEiqL VCQHZ"><tbody><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="role_name"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">role_name</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>Unique name for the role.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="permissions"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">permissions</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa">Array of </span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">strings</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>Permissions to grant to the role.</p>
</div></div></div></td></tr><tr class="last "><td class="sc-hBMUJo sc-fFSPTT sc-gSYDnn iwcKgn cAqMTE hTttpy" kind="field" title="description"><span class="sc-iemWCZ bcnRwz"></span><button aria-label="expand properties"><span class="property-name">description</span><svg class="sc-dIsUp hGHhhO" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string or null</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>Optional description of the role.</p>
</div></div></div></td></tr></tbody></table><div><h3 class="sc-fIxmyt DvFer">Responses</h3><div><button class="sc-htmcrh lbYftx"><svg class="sc-dIsUp dqYXmg" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-fWWYYk cMoEZ">200<!-- --> </strong><span class="sc-jcwpoC eDjFAZ"><p>Role created successfully.</p>
</span></button></div></div></div><div class="sc-jSFjdj sc-gKAaRy gBjRyf gcushC"><div class="sc-EZqKI fWsqvQ"><button class="sc-eEVmNe ilvUMs"><span type="post" class="sc-fmdNqN ldMUmp http-verb post">post</span><span class="sc-jXcxbT fCEUju">/organization/roles</span><svg class="sc-dIsUp bRmrKA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ljsmAU flIrdF"><div class="sc-jlZJtj fQkroN"><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div><div tabindex="0" role="button"><div class="sc-dTSzeu dfUAUz"><span>https://api.openai.com/v1</span>/organization/roles</div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Request samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="react-tabs-500" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-501" tabindex="0" data-rttab="true">Payload</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-501" aria-labelledby="react-tabs-500"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-bBjRSN kQSIAz">application/json</div></div><div class="sc-jgPyTC dSaTNC"><div class="sc-jNnpgg esZIbL"><div class="sc-giAqHp hMPeqJ"><button><div class="sc-carFqZ UksDl">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iJCRrE jCdxGr sc-dPaNzc gyljjx"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"role_name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"permissions"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><span class="token string">"string"</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"description"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Response samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-502" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-503" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-503" aria-labelledby="react-tabs-502"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-bBjRSN kQSIAz">application/json</div></div><div class="sc-jgPyTC dSaTNC"><div class="sc-jNnpgg esZIbL"><div class="sc-giAqHp hMPeqJ"><button><div class="sc-carFqZ UksDl">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iJCRrE jCdxGr sc-dPaNzc gyljjx"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"object"</span>: <span class="token string">"role"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"description"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"permissions"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><span class="token string">"string"</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"resource_type"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"predefined_role"</span>: <span class="token boolean">true</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Roles/operation/update-role" data-section-id="tag/Roles/operation/update-role" class="sc-eCApnc liLqNm"><div data-section-id="operation/update-role" id="operation/update-role" class="sc-iCoGMd gLxhOh"><div class="sc-hKFxyN juinod"><h2 class="sc-pNWdM eftmgB"><a class="sc-crzoAE iUxAWq" href="#tag/Roles/operation/update-role" aria-label="tag/Roles/operation/update-role"></a>Updates an existing organization role.<!-- --> </h2><div class="sc-fcmMJX cvfxAX"><div class="sc-jUfyBS bhDyou"><h5 class="sc-iqAclL sc-fuISkM eONCmm hZIgic">Authorizations:</h5><svg class="sc-dIsUp iPqByX" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jQAxuV ccffaZ"><span class="sc-daBunf fcvuS"><span class="sc-dsXzNU dPrSxx"><i>ApiKeyAuth</i></span></span></div></div><div><h5 class="sc-iqAclL eONCmm">path<!-- --> Parameters</h5><table class="sc-hHEiqL VCQHZ"><tbody><tr class="last "><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="role_id"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">role_id</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The ID of the role to update.</p>
</div></div></div></td></tr></tbody></table></div><h5 class="sc-iqAclL eONCmm">Request Body schema: <span class="sc-cBoqAE eKyrDP">application/json</span></h5><div class="sc-iJCRrE sc-ciSkZP jCdxGr QGruV"><p>Fields to update on the role.</p>
</div><table class="sc-hHEiqL VCQHZ"><tbody><tr class=""><td class="sc-hBMUJo sc-fFSPTT sc-gSYDnn iwcKgn cAqMTE hTttpy" kind="field" title="permissions"><span class="sc-iemWCZ bcnRwz"></span><button aria-label="expand properties"><span class="property-name">permissions</span><svg class="sc-dIsUp hGHhhO" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">Array of strings or null</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>Updated set of permissions for the role.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT sc-gSYDnn iwcKgn cAqMTE hTttpy" kind="field" title="description"><span class="sc-iemWCZ bcnRwz"></span><button aria-label="expand properties"><span class="property-name">description</span><svg class="sc-dIsUp hGHhhO" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string or null</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>New description for the role.</p>
</div></div></div></td></tr><tr class="last "><td class="sc-hBMUJo sc-fFSPTT sc-gSYDnn iwcKgn cAqMTE hTttpy" kind="field" title="role_name"><span class="sc-iemWCZ bcnRwz"></span><button aria-label="expand properties"><span class="property-name">role_name</span><svg class="sc-dIsUp hGHhhO" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string or null</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>New name for the role.</p>
</div></div></div></td></tr></tbody></table><div><h3 class="sc-fIxmyt DvFer">Responses</h3><div><button class="sc-htmcrh lbYftx"><svg class="sc-dIsUp dqYXmg" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-fWWYYk cMoEZ">200<!-- --> </strong><span class="sc-jcwpoC eDjFAZ"><p>Role updated successfully.</p>
</span></button></div></div></div><div class="sc-jSFjdj sc-gKAaRy gBjRyf gcushC"><div class="sc-EZqKI fWsqvQ"><button class="sc-eEVmNe ilvUMs"><span type="post" class="sc-fmdNqN ldMUmp http-verb post">post</span><span class="sc-jXcxbT fCEUju">/organization/roles/{role_id}</span><svg class="sc-dIsUp bRmrKA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ljsmAU flIrdF"><div class="sc-jlZJtj fQkroN"><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div><div tabindex="0" role="button"><div class="sc-dTSzeu dfUAUz"><span>https://api.openai.com/v1</span>/organization/roles/{role_id}</div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Request samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="react-tabs-504" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-505" tabindex="0" data-rttab="true">Payload</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-505" aria-labelledby="react-tabs-504"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-bBjRSN kQSIAz">application/json</div></div><div class="sc-jgPyTC dSaTNC"><div class="sc-jNnpgg esZIbL"><div class="sc-giAqHp hMPeqJ"><button><div class="sc-carFqZ UksDl">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iJCRrE jCdxGr sc-dPaNzc gyljjx"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"permissions"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><span class="token string">"string"</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"description"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"role_name"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Response samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-506" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-507" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-507" aria-labelledby="react-tabs-506"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-bBjRSN kQSIAz">application/json</div></div><div class="sc-jgPyTC dSaTNC"><div class="sc-jNnpgg esZIbL"><div class="sc-giAqHp hMPeqJ"><button><div class="sc-carFqZ UksDl">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iJCRrE jCdxGr sc-dPaNzc gyljjx"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"object"</span>: <span class="token string">"role"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"description"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"permissions"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><span class="token string">"string"</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"resource_type"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"predefined_role"</span>: <span class="token boolean">true</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Roles/operation/delete-role" data-section-id="tag/Roles/operation/delete-role" class="sc-eCApnc liLqNm"><div data-section-id="operation/delete-role" id="operation/delete-role" class="sc-iCoGMd gLxhOh"><div class="sc-hKFxyN juinod"><h2 class="sc-pNWdM eftmgB"><a class="sc-crzoAE iUxAWq" href="#tag/Roles/operation/delete-role" aria-label="tag/Roles/operation/delete-role"></a>Deletes a custom role from the organization.<!-- --> </h2><div class="sc-fcmMJX cvfxAX"><div class="sc-jUfyBS bhDyou"><h5 class="sc-iqAclL sc-fuISkM eONCmm hZIgic">Authorizations:</h5><svg class="sc-dIsUp iPqByX" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jQAxuV ccffaZ"><span class="sc-daBunf fcvuS"><span class="sc-dsXzNU dPrSxx"><i>ApiKeyAuth</i></span></span></div></div><div><h5 class="sc-iqAclL eONCmm">path<!-- --> Parameters</h5><table class="sc-hHEiqL VCQHZ"><tbody><tr class="last "><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="role_id"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">role_id</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The ID of the role to delete.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-fIxmyt DvFer">Responses</h3><div><button class="sc-htmcrh lbYftx"><svg class="sc-dIsUp dqYXmg" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-fWWYYk cMoEZ">200<!-- --> </strong><span class="sc-jcwpoC eDjFAZ"><p>Role deleted successfully.</p>
</span></button></div></div></div><div class="sc-jSFjdj sc-gKAaRy gBjRyf gcushC"><div class="sc-EZqKI fWsqvQ"><button class="sc-eEVmNe ilvUMs"><span type="delete" class="sc-fmdNqN bJzUtf http-verb delete">delete</span><span class="sc-jXcxbT fCEUju">/organization/roles/{role_id}</span><svg class="sc-dIsUp bRmrKA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ljsmAU flIrdF"><div class="sc-jlZJtj fQkroN"><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div><div tabindex="0" role="button"><div class="sc-dTSzeu dfUAUz"><span>https://api.openai.com/v1</span>/organization/roles/{role_id}</div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Response samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-508" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-509" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-509" aria-labelledby="react-tabs-508"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-bBjRSN kQSIAz">application/json</div></div><div class="sc-jgPyTC dSaTNC"><div class="sc-jNnpgg esZIbL"><div class="sc-giAqHp hMPeqJ"><button><div class="sc-carFqZ UksDl">Copy</div></button></div><div class="sc-iJCRrE jCdxGr sc-dPaNzc gyljjx"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"object"</span>: <span class="token string">"role.deleted"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"deleted"</span>: <span class="token boolean">true</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Roles/operation/list-project-roles" data-section-id="tag/Roles/operation/list-project-roles" class="sc-eCApnc liLqNm"><div data-section-id="operation/list-project-roles" id="operation/list-project-roles" class="sc-iCoGMd gLxhOh"><div class="sc-hKFxyN juinod"><h2 class="sc-pNWdM eftmgB"><a class="sc-crzoAE iUxAWq" href="#tag/Roles/operation/list-project-roles" aria-label="tag/Roles/operation/list-project-roles"></a>Lists the roles configured for a project.<!-- --> </h2><div class="sc-fcmMJX cvfxAX"><div class="sc-jUfyBS bhDyou"><h5 class="sc-iqAclL sc-fuISkM eONCmm hZIgic">Authorizations:</h5><svg class="sc-dIsUp iPqByX" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jQAxuV ccffaZ"><span class="sc-daBunf fcvuS"><span class="sc-dsXzNU dPrSxx"><i>ApiKeyAuth</i></span></span></div></div><div><h5 class="sc-iqAclL eONCmm">path<!-- --> Parameters</h5><table class="sc-hHEiqL VCQHZ"><tbody><tr class="last "><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="project_id"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">project_id</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The ID of the project to inspect.</p>
</div></div></div></td></tr></tbody></table></div><div><h5 class="sc-iqAclL eONCmm">query<!-- --> Parameters</h5><table class="sc-hHEiqL VCQHZ"><tbody><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="limit"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">limit</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">integer</span><span> <span class="sc-laZMeE sc-FRrlG jWaWWE gHBwqe"> <!-- -->[ 0 .. 1000 ]<!-- --> </span></span></div><div><span class="sc-laZMeE jWaWWE"> <!-- -->Default:<!-- --> </span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">1000</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>A limit on the number of roles to return. Defaults to 1000.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="after"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">after</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>Cursor for pagination. Provide the value from the previous response's <code>next</code> field to continue listing roles.</p>
</div></div></div></td></tr><tr class="last "><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="order"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">order</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div><div><span class="sc-laZMeE jWaWWE"> <!-- -->Default:<!-- --> </span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"asc"</span></div><div><span class="sc-laZMeE jWaWWE"> <!-- -->Enum<!-- -->:</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"asc"</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"desc"</span> </div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>Sort order for the returned roles.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-fIxmyt DvFer">Responses</h3><div><button class="sc-htmcrh lbYftx"><svg class="sc-dIsUp dqYXmg" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-fWWYYk cMoEZ">200<!-- --> </strong><span class="sc-jcwpoC eDjFAZ"><p>Project roles listed successfully.</p>
</span></button></div></div></div><div class="sc-jSFjdj sc-gKAaRy gBjRyf gcushC"><div class="sc-EZqKI fWsqvQ"><button class="sc-eEVmNe ilvUMs"><span type="get" class="sc-fmdNqN ihNycv http-verb get">get</span><span class="sc-jXcxbT fCEUju">/projects/{project_id}/roles</span><svg class="sc-dIsUp bRmrKA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ljsmAU flIrdF"><div class="sc-jlZJtj fQkroN"><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div><div tabindex="0" role="button"><div class="sc-dTSzeu dfUAUz"><span>https://api.openai.com/v1</span>/projects/{project_id}/roles</div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Response samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-510" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-511" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-511" aria-labelledby="react-tabs-510"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-bBjRSN kQSIAz">application/json</div></div><div class="sc-jgPyTC dSaTNC"><div class="sc-jNnpgg esZIbL"><div class="sc-giAqHp hMPeqJ"><button><div class="sc-carFqZ UksDl">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iJCRrE jCdxGr sc-dPaNzc gyljjx"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"object"</span>: <span class="token string">"list"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"object"</span>: <span class="token string">"role"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"description"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"permissions"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><span class="token string">"string"</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"resource_type"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"predefined_role"</span>: <span class="token boolean">true</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"has_more"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"next"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Roles/operation/create-project-role" data-section-id="tag/Roles/operation/create-project-role" class="sc-eCApnc liLqNm"><div data-section-id="operation/create-project-role" id="operation/create-project-role" class="sc-iCoGMd gLxhOh"><div class="sc-hKFxyN juinod"><h2 class="sc-pNWdM eftmgB"><a class="sc-crzoAE iUxAWq" href="#tag/Roles/operation/create-project-role" aria-label="tag/Roles/operation/create-project-role"></a>Creates a custom role for a project.<!-- --> </h2><div class="sc-fcmMJX cvfxAX"><div class="sc-jUfyBS bhDyou"><h5 class="sc-iqAclL sc-fuISkM eONCmm hZIgic">Authorizations:</h5><svg class="sc-dIsUp iPqByX" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jQAxuV ccffaZ"><span class="sc-daBunf fcvuS"><span class="sc-dsXzNU dPrSxx"><i>ApiKeyAuth</i></span></span></div></div><div><h5 class="sc-iqAclL eONCmm">path<!-- --> Parameters</h5><table class="sc-hHEiqL VCQHZ"><tbody><tr class="last "><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="project_id"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">project_id</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The ID of the project to update.</p>
</div></div></div></td></tr></tbody></table></div><h5 class="sc-iqAclL eONCmm">Request Body schema: <span class="sc-cBoqAE eKyrDP">application/json</span></h5><div class="sc-iJCRrE sc-ciSkZP jCdxGr QGruV"><p>Parameters for the project role you want to create.</p>
</div><table class="sc-hHEiqL VCQHZ"><tbody><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="role_name"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">role_name</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>Unique name for the role.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="permissions"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">permissions</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa">Array of </span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">strings</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>Permissions to grant to the role.</p>
</div></div></div></td></tr><tr class="last "><td class="sc-hBMUJo sc-fFSPTT sc-gSYDnn iwcKgn cAqMTE hTttpy" kind="field" title="description"><span class="sc-iemWCZ bcnRwz"></span><button aria-label="expand properties"><span class="property-name">description</span><svg class="sc-dIsUp hGHhhO" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string or null</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>Optional description of the role.</p>
</div></div></div></td></tr></tbody></table><div><h3 class="sc-fIxmyt DvFer">Responses</h3><div><button class="sc-htmcrh lbYftx"><svg class="sc-dIsUp dqYXmg" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-fWWYYk cMoEZ">200<!-- --> </strong><span class="sc-jcwpoC eDjFAZ"><p>Project role created successfully.</p>
</span></button></div></div></div><div class="sc-jSFjdj sc-gKAaRy gBjRyf gcushC"><div class="sc-EZqKI fWsqvQ"><button class="sc-eEVmNe ilvUMs"><span type="post" class="sc-fmdNqN ldMUmp http-verb post">post</span><span class="sc-jXcxbT fCEUju">/projects/{project_id}/roles</span><svg class="sc-dIsUp bRmrKA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ljsmAU flIrdF"><div class="sc-jlZJtj fQkroN"><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div><div tabindex="0" role="button"><div class="sc-dTSzeu dfUAUz"><span>https://api.openai.com/v1</span>/projects/{project_id}/roles</div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Request samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="react-tabs-512" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-513" tabindex="0" data-rttab="true">Payload</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-513" aria-labelledby="react-tabs-512"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-bBjRSN kQSIAz">application/json</div></div><div class="sc-jgPyTC dSaTNC"><div class="sc-jNnpgg esZIbL"><div class="sc-giAqHp hMPeqJ"><button><div class="sc-carFqZ UksDl">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iJCRrE jCdxGr sc-dPaNzc gyljjx"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"role_name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"permissions"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><span class="token string">"string"</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"description"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Response samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-514" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-515" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-515" aria-labelledby="react-tabs-514"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-bBjRSN kQSIAz">application/json</div></div><div class="sc-jgPyTC dSaTNC"><div class="sc-jNnpgg esZIbL"><div class="sc-giAqHp hMPeqJ"><button><div class="sc-carFqZ UksDl">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iJCRrE jCdxGr sc-dPaNzc gyljjx"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"object"</span>: <span class="token string">"role"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"description"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"permissions"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><span class="token string">"string"</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"resource_type"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"predefined_role"</span>: <span class="token boolean">true</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Roles/operation/update-project-role" data-section-id="tag/Roles/operation/update-project-role" class="sc-eCApnc liLqNm"><div data-section-id="operation/update-project-role" id="operation/update-project-role" class="sc-iCoGMd gLxhOh"><div class="sc-hKFxyN juinod"><h2 class="sc-pNWdM eftmgB"><a class="sc-crzoAE iUxAWq" href="#tag/Roles/operation/update-project-role" aria-label="tag/Roles/operation/update-project-role"></a>Updates an existing project role.<!-- --> </h2><div class="sc-fcmMJX cvfxAX"><div class="sc-jUfyBS bhDyou"><h5 class="sc-iqAclL sc-fuISkM eONCmm hZIgic">Authorizations:</h5><svg class="sc-dIsUp iPqByX" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jQAxuV ccffaZ"><span class="sc-daBunf fcvuS"><span class="sc-dsXzNU dPrSxx"><i>ApiKeyAuth</i></span></span></div></div><div><h5 class="sc-iqAclL eONCmm">path<!-- --> Parameters</h5><table class="sc-hHEiqL VCQHZ"><tbody><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="project_id"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">project_id</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The ID of the project to update.</p>
</div></div></div></td></tr><tr class="last "><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="role_id"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">role_id</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The ID of the role to update.</p>
</div></div></div></td></tr></tbody></table></div><h5 class="sc-iqAclL eONCmm">Request Body schema: <span class="sc-cBoqAE eKyrDP">application/json</span></h5><div class="sc-iJCRrE sc-ciSkZP jCdxGr QGruV"><p>Fields to update on the project role.</p>
</div><table class="sc-hHEiqL VCQHZ"><tbody><tr class=""><td class="sc-hBMUJo sc-fFSPTT sc-gSYDnn iwcKgn cAqMTE hTttpy" kind="field" title="permissions"><span class="sc-iemWCZ bcnRwz"></span><button aria-label="expand properties"><span class="property-name">permissions</span><svg class="sc-dIsUp hGHhhO" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">Array of strings or null</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>Updated set of permissions for the role.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT sc-gSYDnn iwcKgn cAqMTE hTttpy" kind="field" title="description"><span class="sc-iemWCZ bcnRwz"></span><button aria-label="expand properties"><span class="property-name">description</span><svg class="sc-dIsUp hGHhhO" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string or null</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>New description for the role.</p>
</div></div></div></td></tr><tr class="last "><td class="sc-hBMUJo sc-fFSPTT sc-gSYDnn iwcKgn cAqMTE hTttpy" kind="field" title="role_name"><span class="sc-iemWCZ bcnRwz"></span><button aria-label="expand properties"><span class="property-name">role_name</span><svg class="sc-dIsUp hGHhhO" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string or null</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>New name for the role.</p>
</div></div></div></td></tr></tbody></table><div><h3 class="sc-fIxmyt DvFer">Responses</h3><div><button class="sc-htmcrh lbYftx"><svg class="sc-dIsUp dqYXmg" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-fWWYYk cMoEZ">200<!-- --> </strong><span class="sc-jcwpoC eDjFAZ"><p>Project role updated successfully.</p>
</span></button></div></div></div><div class="sc-jSFjdj sc-gKAaRy gBjRyf gcushC"><div class="sc-EZqKI fWsqvQ"><button class="sc-eEVmNe ilvUMs"><span type="post" class="sc-fmdNqN ldMUmp http-verb post">post</span><span class="sc-jXcxbT fCEUju">/projects/{project_id}/roles/{role_id}</span><svg class="sc-dIsUp bRmrKA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ljsmAU flIrdF"><div class="sc-jlZJtj fQkroN"><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div><div tabindex="0" role="button"><div class="sc-dTSzeu dfUAUz"><span>https://api.openai.com/v1</span>/projects/{project_id}/roles/{role_id}</div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Request samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="react-tabs-516" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-517" tabindex="0" data-rttab="true">Payload</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-517" aria-labelledby="react-tabs-516"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-bBjRSN kQSIAz">application/json</div></div><div class="sc-jgPyTC dSaTNC"><div class="sc-jNnpgg esZIbL"><div class="sc-giAqHp hMPeqJ"><button><div class="sc-carFqZ UksDl">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iJCRrE jCdxGr sc-dPaNzc gyljjx"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"permissions"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><span class="token string">"string"</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"description"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"role_name"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Response samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-518" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-519" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-519" aria-labelledby="react-tabs-518"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-bBjRSN kQSIAz">application/json</div></div><div class="sc-jgPyTC dSaTNC"><div class="sc-jNnpgg esZIbL"><div class="sc-giAqHp hMPeqJ"><button><div class="sc-carFqZ UksDl">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iJCRrE jCdxGr sc-dPaNzc gyljjx"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"object"</span>: <span class="token string">"role"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"description"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"permissions"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><span class="token string">"string"</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"resource_type"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"predefined_role"</span>: <span class="token boolean">true</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Roles/operation/delete-project-role" data-section-id="tag/Roles/operation/delete-project-role" class="sc-eCApnc liLqNm"><div data-section-id="operation/delete-project-role" id="operation/delete-project-role" class="sc-iCoGMd gLxhOh"><div class="sc-hKFxyN juinod"><h2 class="sc-pNWdM eftmgB"><a class="sc-crzoAE iUxAWq" href="#tag/Roles/operation/delete-project-role" aria-label="tag/Roles/operation/delete-project-role"></a>Deletes a custom role from a project.<!-- --> </h2><div class="sc-fcmMJX cvfxAX"><div class="sc-jUfyBS bhDyou"><h5 class="sc-iqAclL sc-fuISkM eONCmm hZIgic">Authorizations:</h5><svg class="sc-dIsUp iPqByX" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jQAxuV ccffaZ"><span class="sc-daBunf fcvuS"><span class="sc-dsXzNU dPrSxx"><i>ApiKeyAuth</i></span></span></div></div><div><h5 class="sc-iqAclL eONCmm">path<!-- --> Parameters</h5><table class="sc-hHEiqL VCQHZ"><tbody><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="project_id"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">project_id</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The ID of the project to update.</p>
</div></div></div></td></tr><tr class="last "><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="role_id"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">role_id</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The ID of the role to delete.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-fIxmyt DvFer">Responses</h3><div><button class="sc-htmcrh lbYftx"><svg class="sc-dIsUp dqYXmg" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-fWWYYk cMoEZ">200<!-- --> </strong><span class="sc-jcwpoC eDjFAZ"><p>Project role deleted successfully.</p>
</span></button></div></div></div><div class="sc-jSFjdj sc-gKAaRy gBjRyf gcushC"><div class="sc-EZqKI fWsqvQ"><button class="sc-eEVmNe ilvUMs"><span type="delete" class="sc-fmdNqN bJzUtf http-verb delete">delete</span><span class="sc-jXcxbT fCEUju">/projects/{project_id}/roles/{role_id}</span><svg class="sc-dIsUp bRmrKA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ljsmAU flIrdF"><div class="sc-jlZJtj fQkroN"><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div><div tabindex="0" role="button"><div class="sc-dTSzeu dfUAUz"><span>https://api.openai.com/v1</span>/projects/{project_id}/roles/{role_id}</div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Response samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-520" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-521" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-521" aria-labelledby="react-tabs-520"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-bBjRSN kQSIAz">application/json</div></div><div class="sc-jgPyTC dSaTNC"><div class="sc-jNnpgg esZIbL"><div class="sc-giAqHp hMPeqJ"><button><div class="sc-carFqZ UksDl">Copy</div></button></div><div class="sc-iJCRrE jCdxGr sc-dPaNzc gyljjx"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"object"</span>: <span class="token string">"role.deleted"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"deleted"</span>: <span class="token boolean">true</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Users" data-section-id="tag/Users" class="sc-eCApnc jlMQbh"><div class="sc-iCoGMd gLxhOh"><div class="sc-hKFxyN juinod"><h1 class="sc-fujyAs bpZWeL"><a class="sc-crzoAE iUxAWq" href="#tag/Users" aria-label="tag/Users"></a>Users</h1></div></div></div><div id="tag/Users/operation/list-users" data-section-id="tag/Users/operation/list-users" class="sc-eCApnc liLqNm"><div data-section-id="operation/list-users" id="operation/list-users" class="sc-iCoGMd gLxhOh"><div class="sc-hKFxyN juinod"><h2 class="sc-pNWdM eftmgB"><a class="sc-crzoAE iUxAWq" href="#tag/Users/operation/list-users" aria-label="tag/Users/operation/list-users"></a>Lists all of the users in the organization.<!-- --> </h2><div class="sc-fcmMJX cvfxAX"><div class="sc-jUfyBS bhDyou"><h5 class="sc-iqAclL sc-fuISkM eONCmm hZIgic">Authorizations:</h5><svg class="sc-dIsUp iPqByX" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jQAxuV ccffaZ"><span class="sc-daBunf fcvuS"><span class="sc-dsXzNU dPrSxx"><i>ApiKeyAuth</i></span></span></div></div><div><h5 class="sc-iqAclL eONCmm">query<!-- --> Parameters</h5><table class="sc-hHEiqL VCQHZ"><tbody><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="limit"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">limit</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">integer</span></div><div><span class="sc-laZMeE jWaWWE"> <!-- -->Default:<!-- --> </span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">20</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="after"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">after</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>A cursor for use in pagination. <code>after</code> is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list.</p>
</div></div></div></td></tr><tr class="last "><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="emails"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">emails</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa">Array of </span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">strings</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>Filter by the email address of users.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-fIxmyt DvFer">Responses</h3><div><button class="sc-htmcrh lbYftx"><svg class="sc-dIsUp dqYXmg" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-fWWYYk cMoEZ">200<!-- --> </strong><span class="sc-jcwpoC eDjFAZ"><p>Users listed successfully.</p>
</span></button></div></div></div><div class="sc-jSFjdj sc-gKAaRy gBjRyf gcushC"><div class="sc-EZqKI fWsqvQ"><button class="sc-eEVmNe ilvUMs"><span type="get" class="sc-fmdNqN ihNycv http-verb get">get</span><span class="sc-jXcxbT fCEUju">/organization/users</span><svg class="sc-dIsUp bRmrKA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ljsmAU flIrdF"><div class="sc-jlZJtj fQkroN"><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div><div tabindex="0" role="button"><div class="sc-dTSzeu dfUAUz"><span>https://api.openai.com/v1</span>/organization/users</div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Response samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-522" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-523" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-523" aria-labelledby="react-tabs-522"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-bBjRSN kQSIAz">application/json</div></div><div class="sc-jgPyTC dSaTNC"><div class="sc-jNnpgg esZIbL"><div class="sc-giAqHp hMPeqJ"><button><div class="sc-carFqZ UksDl">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iJCRrE jCdxGr sc-dPaNzc gyljjx"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"object"</span>: <span class="token string">"list"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"object"</span>: <span class="token string">"organization.user"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"email"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"role"</span>: <span class="token string">"owner"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"added_at"</span>: <span class="token number">0</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"first_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"last_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"has_more"</span>: <span class="token boolean">true</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Users/operation/retrieve-user" data-section-id="tag/Users/operation/retrieve-user" class="sc-eCApnc liLqNm"><div data-section-id="operation/retrieve-user" id="operation/retrieve-user" class="sc-iCoGMd gLxhOh"><div class="sc-hKFxyN juinod"><h2 class="sc-pNWdM eftmgB"><a class="sc-crzoAE iUxAWq" href="#tag/Users/operation/retrieve-user" aria-label="tag/Users/operation/retrieve-user"></a>Retrieves a user by their identifier.<!-- --> </h2><div class="sc-fcmMJX cvfxAX"><div class="sc-jUfyBS bhDyou"><h5 class="sc-iqAclL sc-fuISkM eONCmm hZIgic">Authorizations:</h5><svg class="sc-dIsUp iPqByX" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jQAxuV ccffaZ"><span class="sc-daBunf fcvuS"><span class="sc-dsXzNU dPrSxx"><i>ApiKeyAuth</i></span></span></div></div><div><h5 class="sc-iqAclL eONCmm">path<!-- --> Parameters</h5><table class="sc-hHEiqL VCQHZ"><tbody><tr class="last "><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="user_id"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">user_id</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The ID of the user.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-fIxmyt DvFer">Responses</h3><div><button class="sc-htmcrh lbYftx"><svg class="sc-dIsUp dqYXmg" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-fWWYYk cMoEZ">200<!-- --> </strong><span class="sc-jcwpoC eDjFAZ"><p>User retrieved successfully.</p>
</span></button></div></div></div><div class="sc-jSFjdj sc-gKAaRy gBjRyf gcushC"><div class="sc-EZqKI fWsqvQ"><button class="sc-eEVmNe ilvUMs"><span type="get" class="sc-fmdNqN ihNycv http-verb get">get</span><span class="sc-jXcxbT fCEUju">/organization/users/{user_id}</span><svg class="sc-dIsUp bRmrKA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ljsmAU flIrdF"><div class="sc-jlZJtj fQkroN"><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div><div tabindex="0" role="button"><div class="sc-dTSzeu dfUAUz"><span>https://api.openai.com/v1</span>/organization/users/{user_id}</div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Response samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-524" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-525" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-525" aria-labelledby="react-tabs-524"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-bBjRSN kQSIAz">application/json</div></div><div class="sc-jgPyTC dSaTNC"><div class="sc-jNnpgg esZIbL"><div class="sc-giAqHp hMPeqJ"><button><div class="sc-carFqZ UksDl">Copy</div></button></div><div class="sc-iJCRrE jCdxGr sc-dPaNzc gyljjx"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"object"</span>: <span class="token string">"organization.user"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"email"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"role"</span>: <span class="token string">"owner"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"added_at"</span>: <span class="token number">0</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Users/operation/modify-user" data-section-id="tag/Users/operation/modify-user" class="sc-eCApnc liLqNm"><div data-section-id="operation/modify-user" id="operation/modify-user" class="sc-iCoGMd gLxhOh"><div class="sc-hKFxyN juinod"><h2 class="sc-pNWdM eftmgB"><a class="sc-crzoAE iUxAWq" href="#tag/Users/operation/modify-user" aria-label="tag/Users/operation/modify-user"></a>Modifies a user's role in the organization.<!-- --> </h2><div class="sc-fcmMJX cvfxAX"><div class="sc-jUfyBS bhDyou"><h5 class="sc-iqAclL sc-fuISkM eONCmm hZIgic">Authorizations:</h5><svg class="sc-dIsUp iPqByX" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jQAxuV ccffaZ"><span class="sc-daBunf fcvuS"><span class="sc-dsXzNU dPrSxx"><i>ApiKeyAuth</i></span></span></div></div><div><h5 class="sc-iqAclL eONCmm">path<!-- --> Parameters</h5><table class="sc-hHEiqL VCQHZ"><tbody><tr class="last "><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="user_id"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">user_id</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The ID of the user.</p>
</div></div></div></td></tr></tbody></table></div><h5 class="sc-iqAclL eONCmm">Request Body schema: <span class="sc-cBoqAE eKyrDP">application/json</span></h5><div class="sc-iJCRrE sc-ciSkZP jCdxGr QGruV"><p>The new user role to modify. This must be one of <code>owner</code> or <code>member</code>.</p>
</div><table class="sc-hHEiqL VCQHZ"><tbody><tr class="last "><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="role"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">role</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div><div><span class="sc-laZMeE jWaWWE"> <!-- -->Enum<!-- -->:</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"owner"</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"reader"</span> </div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p><code>owner</code> or <code>reader</code></p>
</div></div></div></td></tr></tbody></table><div><h3 class="sc-fIxmyt DvFer">Responses</h3><div><button class="sc-htmcrh lbYftx"><svg class="sc-dIsUp dqYXmg" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-fWWYYk cMoEZ">200<!-- --> </strong><span class="sc-jcwpoC eDjFAZ"><p>User role updated successfully.</p>
</span></button></div></div></div><div class="sc-jSFjdj sc-gKAaRy gBjRyf gcushC"><div class="sc-EZqKI fWsqvQ"><button class="sc-eEVmNe ilvUMs"><span type="post" class="sc-fmdNqN ldMUmp http-verb post">post</span><span class="sc-jXcxbT fCEUju">/organization/users/{user_id}</span><svg class="sc-dIsUp bRmrKA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ljsmAU flIrdF"><div class="sc-jlZJtj fQkroN"><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div><div tabindex="0" role="button"><div class="sc-dTSzeu dfUAUz"><span>https://api.openai.com/v1</span>/organization/users/{user_id}</div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Request samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="react-tabs-526" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-527" tabindex="0" data-rttab="true">Payload</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-527" aria-labelledby="react-tabs-526"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-bBjRSN kQSIAz">application/json</div></div><div class="sc-jgPyTC dSaTNC"><div class="sc-jNnpgg esZIbL"><div class="sc-giAqHp hMPeqJ"><button><div class="sc-carFqZ UksDl">Copy</div></button></div><div class="sc-iJCRrE jCdxGr sc-dPaNzc gyljjx"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"role"</span>: <span class="token string">"owner"</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Response samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-528" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-529" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-529" aria-labelledby="react-tabs-528"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-bBjRSN kQSIAz">application/json</div></div><div class="sc-jgPyTC dSaTNC"><div class="sc-jNnpgg esZIbL"><div class="sc-giAqHp hMPeqJ"><button><div class="sc-carFqZ UksDl">Copy</div></button></div><div class="sc-iJCRrE jCdxGr sc-dPaNzc gyljjx"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"object"</span>: <span class="token string">"organization.user"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"email"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"role"</span>: <span class="token string">"owner"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"added_at"</span>: <span class="token number">0</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Users/operation/delete-user" data-section-id="tag/Users/operation/delete-user" class="sc-eCApnc liLqNm"><div data-section-id="operation/delete-user" id="operation/delete-user" class="sc-iCoGMd gLxhOh"><div class="sc-hKFxyN juinod"><h2 class="sc-pNWdM eftmgB"><a class="sc-crzoAE iUxAWq" href="#tag/Users/operation/delete-user" aria-label="tag/Users/operation/delete-user"></a>Deletes a user from the organization.<!-- --> </h2><div class="sc-fcmMJX cvfxAX"><div class="sc-jUfyBS bhDyou"><h5 class="sc-iqAclL sc-fuISkM eONCmm hZIgic">Authorizations:</h5><svg class="sc-dIsUp iPqByX" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jQAxuV ccffaZ"><span class="sc-daBunf fcvuS"><span class="sc-dsXzNU dPrSxx"><i>ApiKeyAuth</i></span></span></div></div><div><h5 class="sc-iqAclL eONCmm">path<!-- --> Parameters</h5><table class="sc-hHEiqL VCQHZ"><tbody><tr class="last "><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="user_id"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">user_id</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The ID of the user.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-fIxmyt DvFer">Responses</h3><div><button class="sc-htmcrh lbYftx"><svg class="sc-dIsUp dqYXmg" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-fWWYYk cMoEZ">200<!-- --> </strong><span class="sc-jcwpoC eDjFAZ"><p>User deleted successfully.</p>
</span></button></div></div></div><div class="sc-jSFjdj sc-gKAaRy gBjRyf gcushC"><div class="sc-EZqKI fWsqvQ"><button class="sc-eEVmNe ilvUMs"><span type="delete" class="sc-fmdNqN bJzUtf http-verb delete">delete</span><span class="sc-jXcxbT fCEUju">/organization/users/{user_id}</span><svg class="sc-dIsUp bRmrKA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ljsmAU flIrdF"><div class="sc-jlZJtj fQkroN"><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div><div tabindex="0" role="button"><div class="sc-dTSzeu dfUAUz"><span>https://api.openai.com/v1</span>/organization/users/{user_id}</div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Response samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-530" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-531" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-531" aria-labelledby="react-tabs-530"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-bBjRSN kQSIAz">application/json</div></div><div class="sc-jgPyTC dSaTNC"><div class="sc-jNnpgg esZIbL"><div class="sc-giAqHp hMPeqJ"><button><div class="sc-carFqZ UksDl">Copy</div></button></div><div class="sc-iJCRrE jCdxGr sc-dPaNzc gyljjx"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"object"</span>: <span class="token string">"organization.user.deleted"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"deleted"</span>: <span class="token boolean">true</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/User-organization-role-assignments" data-section-id="tag/User-organization-role-assignments" class="sc-eCApnc jlMQbh"><div class="sc-iCoGMd gLxhOh"><div class="sc-hKFxyN juinod"><h1 class="sc-fujyAs bpZWeL"><a class="sc-crzoAE iUxAWq" href="#tag/User-organization-role-assignments" aria-label="tag/User-organization-role-assignments"></a>User organization role assignments</h1></div></div></div><div id="tag/User-organization-role-assignments/operation/list-user-role-assignments" data-section-id="tag/User-organization-role-assignments/operation/list-user-role-assignments" class="sc-eCApnc liLqNm"><div data-section-id="operation/list-user-role-assignments" id="operation/list-user-role-assignments" class="sc-iCoGMd gLxhOh"><div class="sc-hKFxyN juinod"><h2 class="sc-pNWdM eftmgB"><a class="sc-crzoAE iUxAWq" href="#tag/User-organization-role-assignments/operation/list-user-role-assignments" aria-label="tag/User-organization-role-assignments/operation/list-user-role-assignments"></a>Lists the organization roles assigned to a user within the organization.<!-- --> </h2><div class="sc-fcmMJX cvfxAX"><div class="sc-jUfyBS bhDyou"><h5 class="sc-iqAclL sc-fuISkM eONCmm hZIgic">Authorizations:</h5><svg class="sc-dIsUp iPqByX" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jQAxuV ccffaZ"><span class="sc-daBunf fcvuS"><span class="sc-dsXzNU dPrSxx"><i>ApiKeyAuth</i></span></span></div></div><div><h5 class="sc-iqAclL eONCmm">path<!-- --> Parameters</h5><table class="sc-hHEiqL VCQHZ"><tbody><tr class="last "><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="user_id"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">user_id</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The ID of the user to inspect.</p>
</div></div></div></td></tr></tbody></table></div><div><h5 class="sc-iqAclL eONCmm">query<!-- --> Parameters</h5><table class="sc-hHEiqL VCQHZ"><tbody><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="limit"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">limit</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">integer</span><span> <span class="sc-laZMeE sc-FRrlG jWaWWE gHBwqe"> <!-- -->[ 0 .. 1000 ]<!-- --> </span></span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>A limit on the number of organization role assignments to return.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="after"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">after</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>Cursor for pagination. Provide the value from the previous response's <code>next</code> field to continue listing organization roles.</p>
</div></div></div></td></tr><tr class="last "><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="order"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">order</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div><div><span class="sc-laZMeE jWaWWE"> <!-- -->Enum<!-- -->:</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"asc"</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"desc"</span> </div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>Sort order for the returned organization roles.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-fIxmyt DvFer">Responses</h3><div><button class="sc-htmcrh lbYftx"><svg class="sc-dIsUp dqYXmg" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-fWWYYk cMoEZ">200<!-- --> </strong><span class="sc-jcwpoC eDjFAZ"><p>User organization role assignments listed successfully.</p>
</span></button></div></div></div><div class="sc-jSFjdj sc-gKAaRy gBjRyf gcushC"><div class="sc-EZqKI fWsqvQ"><button class="sc-eEVmNe ilvUMs"><span type="get" class="sc-fmdNqN ihNycv http-verb get">get</span><span class="sc-jXcxbT fCEUju">/organization/users/{user_id}/roles</span><svg class="sc-dIsUp bRmrKA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ljsmAU flIrdF"><div class="sc-jlZJtj fQkroN"><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div><div tabindex="0" role="button"><div class="sc-dTSzeu dfUAUz"><span>https://api.openai.com/v1</span>/organization/users/{user_id}/roles</div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Response samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-532" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-533" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-533" aria-labelledby="react-tabs-532"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-bBjRSN kQSIAz">application/json</div></div><div class="sc-jgPyTC dSaTNC"><div class="sc-jNnpgg esZIbL"><div class="sc-giAqHp hMPeqJ"><button><div class="sc-carFqZ UksDl">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iJCRrE jCdxGr sc-dPaNzc gyljjx"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"object"</span>: <span class="token string">"list"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"permissions"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><span class="token string">"string"</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"resource_type"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"predefined_role"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"description"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"created_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"updated_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"created_by"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"created_by_user_obj"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"has_more"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"next"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/User-organization-role-assignments/operation/assign-user-role" data-section-id="tag/User-organization-role-assignments/operation/assign-user-role" class="sc-eCApnc liLqNm"><div data-section-id="operation/assign-user-role" id="operation/assign-user-role" class="sc-iCoGMd gLxhOh"><div class="sc-hKFxyN juinod"><h2 class="sc-pNWdM eftmgB"><a class="sc-crzoAE iUxAWq" href="#tag/User-organization-role-assignments/operation/assign-user-role" aria-label="tag/User-organization-role-assignments/operation/assign-user-role"></a>Assigns an organization role to a user within the organization.<!-- --> </h2><div class="sc-fcmMJX cvfxAX"><div class="sc-jUfyBS bhDyou"><h5 class="sc-iqAclL sc-fuISkM eONCmm hZIgic">Authorizations:</h5><svg class="sc-dIsUp iPqByX" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jQAxuV ccffaZ"><span class="sc-daBunf fcvuS"><span class="sc-dsXzNU dPrSxx"><i>ApiKeyAuth</i></span></span></div></div><div><h5 class="sc-iqAclL eONCmm">path<!-- --> Parameters</h5><table class="sc-hHEiqL VCQHZ"><tbody><tr class="last "><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="user_id"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">user_id</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The ID of the user that should receive the organization role.</p>
</div></div></div></td></tr></tbody></table></div><h5 class="sc-iqAclL eONCmm">Request Body schema: <span class="sc-cBoqAE eKyrDP">application/json</span></h5><div class="sc-iJCRrE sc-ciSkZP jCdxGr QGruV"><p>Identifies the organization role to assign to the user.</p>
</div><table class="sc-hHEiqL VCQHZ"><tbody><tr class="last "><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="role_id"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">role_id</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>Identifier of the role to assign.</p>
</div></div></div></td></tr></tbody></table><div><h3 class="sc-fIxmyt DvFer">Responses</h3><div><button class="sc-htmcrh lbYftx"><svg class="sc-dIsUp dqYXmg" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-fWWYYk cMoEZ">200<!-- --> </strong><span class="sc-jcwpoC eDjFAZ"><p>Organization role assigned to the user successfully.</p>
</span></button></div></div></div><div class="sc-jSFjdj sc-gKAaRy gBjRyf gcushC"><div class="sc-EZqKI fWsqvQ"><button class="sc-eEVmNe ilvUMs"><span type="post" class="sc-fmdNqN ldMUmp http-verb post">post</span><span class="sc-jXcxbT fCEUju">/organization/users/{user_id}/roles</span><svg class="sc-dIsUp bRmrKA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ljsmAU flIrdF"><div class="sc-jlZJtj fQkroN"><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div><div tabindex="0" role="button"><div class="sc-dTSzeu dfUAUz"><span>https://api.openai.com/v1</span>/organization/users/{user_id}/roles</div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Request samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="react-tabs-534" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-535" tabindex="0" data-rttab="true">Payload</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-535" aria-labelledby="react-tabs-534"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-bBjRSN kQSIAz">application/json</div></div><div class="sc-jgPyTC dSaTNC"><div class="sc-jNnpgg esZIbL"><div class="sc-giAqHp hMPeqJ"><button><div class="sc-carFqZ UksDl">Copy</div></button></div><div class="sc-iJCRrE jCdxGr sc-dPaNzc gyljjx"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"role_id"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Response samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-536" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-537" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-537" aria-labelledby="react-tabs-536"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-bBjRSN kQSIAz">application/json</div></div><div class="sc-jgPyTC dSaTNC"><div class="sc-jNnpgg esZIbL"><div class="sc-giAqHp hMPeqJ"><button><div class="sc-carFqZ UksDl">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iJCRrE jCdxGr sc-dPaNzc gyljjx"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"object"</span>: <span class="token string">"user.role"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"user"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"object"</span>: <span class="token string">"organization.user"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"email"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"role"</span>: <span class="token string">"owner"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"added_at"</span>: <span class="token number">0</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"role"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"object"</span>: <span class="token string">"role"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"description"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"permissions"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><span class="token string">"string"</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"resource_type"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"predefined_role"</span>: <span class="token boolean">true</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/User-organization-role-assignments/operation/unassign-user-role" data-section-id="tag/User-organization-role-assignments/operation/unassign-user-role" class="sc-eCApnc liLqNm"><div data-section-id="operation/unassign-user-role" id="operation/unassign-user-role" class="sc-iCoGMd gLxhOh"><div class="sc-hKFxyN juinod"><h2 class="sc-pNWdM eftmgB"><a class="sc-crzoAE iUxAWq" href="#tag/User-organization-role-assignments/operation/unassign-user-role" aria-label="tag/User-organization-role-assignments/operation/unassign-user-role"></a>Unassigns an organization role from a user within the organization.<!-- --> </h2><div class="sc-fcmMJX cvfxAX"><div class="sc-jUfyBS bhDyou"><h5 class="sc-iqAclL sc-fuISkM eONCmm hZIgic">Authorizations:</h5><svg class="sc-dIsUp iPqByX" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jQAxuV ccffaZ"><span class="sc-daBunf fcvuS"><span class="sc-dsXzNU dPrSxx"><i>ApiKeyAuth</i></span></span></div></div><div><h5 class="sc-iqAclL eONCmm">path<!-- --> Parameters</h5><table class="sc-hHEiqL VCQHZ"><tbody><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="user_id"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">user_id</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The ID of the user to modify.</p>
</div></div></div></td></tr><tr class="last "><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="role_id"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">role_id</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The ID of the organization role to remove from the user.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-fIxmyt DvFer">Responses</h3><div><button class="sc-htmcrh lbYftx"><svg class="sc-dIsUp dqYXmg" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-fWWYYk cMoEZ">200<!-- --> </strong><span class="sc-jcwpoC eDjFAZ"><p>Organization role unassigned from the user successfully.</p>
</span></button></div></div></div><div class="sc-jSFjdj sc-gKAaRy gBjRyf gcushC"><div class="sc-EZqKI fWsqvQ"><button class="sc-eEVmNe ilvUMs"><span type="delete" class="sc-fmdNqN bJzUtf http-verb delete">delete</span><span class="sc-jXcxbT fCEUju">/organization/users/{user_id}/roles/{role_id}</span><svg class="sc-dIsUp bRmrKA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ljsmAU flIrdF"><div class="sc-jlZJtj fQkroN"><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div><div tabindex="0" role="button"><div class="sc-dTSzeu dfUAUz"><span>https://api.openai.com/v1</span>/organization/users/{user_id}/roles/{role_id}</div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Response samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-538" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-539" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-539" aria-labelledby="react-tabs-538"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-bBjRSN kQSIAz">application/json</div></div><div class="sc-jgPyTC dSaTNC"><div class="sc-jNnpgg esZIbL"><div class="sc-giAqHp hMPeqJ"><button><div class="sc-carFqZ UksDl">Copy</div></button></div><div class="sc-iJCRrE jCdxGr sc-dPaNzc gyljjx"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"object"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"deleted"</span>: <span class="token boolean">true</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Project-group-role-assignments" data-section-id="tag/Project-group-role-assignments" class="sc-eCApnc jlMQbh"><div class="sc-iCoGMd gLxhOh"><div class="sc-hKFxyN juinod"><h1 class="sc-fujyAs bpZWeL"><a class="sc-crzoAE iUxAWq" href="#tag/Project-group-role-assignments" aria-label="tag/Project-group-role-assignments"></a>Project group role assignments</h1></div></div></div><div id="tag/Project-group-role-assignments/operation/list-project-group-role-assignments" data-section-id="tag/Project-group-role-assignments/operation/list-project-group-role-assignments" class="sc-eCApnc liLqNm"><div data-section-id="operation/list-project-group-role-assignments" id="operation/list-project-group-role-assignments" class="sc-iCoGMd gLxhOh"><div class="sc-hKFxyN juinod"><h2 class="sc-pNWdM eftmgB"><a class="sc-crzoAE iUxAWq" href="#tag/Project-group-role-assignments/operation/list-project-group-role-assignments" aria-label="tag/Project-group-role-assignments/operation/list-project-group-role-assignments"></a>Lists the project roles assigned to a group within a project.<!-- --> </h2><div class="sc-fcmMJX cvfxAX"><div class="sc-jUfyBS bhDyou"><h5 class="sc-iqAclL sc-fuISkM eONCmm hZIgic">Authorizations:</h5><svg class="sc-dIsUp iPqByX" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jQAxuV ccffaZ"><span class="sc-daBunf fcvuS"><span class="sc-dsXzNU dPrSxx"><i>ApiKeyAuth</i></span></span></div></div><div><h5 class="sc-iqAclL eONCmm">path<!-- --> Parameters</h5><table class="sc-hHEiqL VCQHZ"><tbody><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="project_id"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">project_id</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The ID of the project to inspect.</p>
</div></div></div></td></tr><tr class="last "><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="group_id"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">group_id</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The ID of the group to inspect.</p>
</div></div></div></td></tr></tbody></table></div><div><h5 class="sc-iqAclL eONCmm">query<!-- --> Parameters</h5><table class="sc-hHEiqL VCQHZ"><tbody><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="limit"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">limit</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">integer</span><span> <span class="sc-laZMeE sc-FRrlG jWaWWE gHBwqe"> <!-- -->[ 0 .. 1000 ]<!-- --> </span></span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>A limit on the number of project role assignments to return.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="after"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">after</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>Cursor for pagination. Provide the value from the previous response's <code>next</code> field to continue listing project roles.</p>
</div></div></div></td></tr><tr class="last "><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="order"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">order</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div><div><span class="sc-laZMeE jWaWWE"> <!-- -->Enum<!-- -->:</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"asc"</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"desc"</span> </div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>Sort order for the returned project roles.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-fIxmyt DvFer">Responses</h3><div><button class="sc-htmcrh lbYftx"><svg class="sc-dIsUp dqYXmg" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-fWWYYk cMoEZ">200<!-- --> </strong><span class="sc-jcwpoC eDjFAZ"><p>Project group role assignments listed successfully.</p>
</span></button></div></div></div><div class="sc-jSFjdj sc-gKAaRy gBjRyf gcushC"><div class="sc-EZqKI fWsqvQ"><button class="sc-eEVmNe ilvUMs"><span type="get" class="sc-fmdNqN ihNycv http-verb get">get</span><span class="sc-jXcxbT fCEUju">/projects/{project_id}/groups/{group_id}/roles</span><svg class="sc-dIsUp bRmrKA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ljsmAU flIrdF"><div class="sc-jlZJtj fQkroN"><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div><div tabindex="0" role="button"><div class="sc-dTSzeu dfUAUz"><span>https://api.openai.com/v1</span>/projects/{project_id}/groups/{group_id}/roles</div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Response samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-540" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-541" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-541" aria-labelledby="react-tabs-540"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-bBjRSN kQSIAz">application/json</div></div><div class="sc-jgPyTC dSaTNC"><div class="sc-jNnpgg esZIbL"><div class="sc-giAqHp hMPeqJ"><button><div class="sc-carFqZ UksDl">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iJCRrE jCdxGr sc-dPaNzc gyljjx"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"object"</span>: <span class="token string">"list"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"permissions"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><span class="token string">"string"</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"resource_type"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"predefined_role"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"description"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"created_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"updated_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"created_by"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"created_by_user_obj"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"has_more"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"next"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Project-group-role-assignments/operation/assign-project-group-role" data-section-id="tag/Project-group-role-assignments/operation/assign-project-group-role" class="sc-eCApnc liLqNm"><div data-section-id="operation/assign-project-group-role" id="operation/assign-project-group-role" class="sc-iCoGMd gLxhOh"><div class="sc-hKFxyN juinod"><h2 class="sc-pNWdM eftmgB"><a class="sc-crzoAE iUxAWq" href="#tag/Project-group-role-assignments/operation/assign-project-group-role" aria-label="tag/Project-group-role-assignments/operation/assign-project-group-role"></a>Assigns a project role to a group within a project.<!-- --> </h2><div class="sc-fcmMJX cvfxAX"><div class="sc-jUfyBS bhDyou"><h5 class="sc-iqAclL sc-fuISkM eONCmm hZIgic">Authorizations:</h5><svg class="sc-dIsUp iPqByX" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jQAxuV ccffaZ"><span class="sc-daBunf fcvuS"><span class="sc-dsXzNU dPrSxx"><i>ApiKeyAuth</i></span></span></div></div><div><h5 class="sc-iqAclL eONCmm">path<!-- --> Parameters</h5><table class="sc-hHEiqL VCQHZ"><tbody><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="project_id"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">project_id</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The ID of the project to update.</p>
</div></div></div></td></tr><tr class="last "><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="group_id"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">group_id</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The ID of the group that should receive the project role.</p>
</div></div></div></td></tr></tbody></table></div><h5 class="sc-iqAclL eONCmm">Request Body schema: <span class="sc-cBoqAE eKyrDP">application/json</span></h5><div class="sc-iJCRrE sc-ciSkZP jCdxGr QGruV"><p>Identifies the project role to assign to the group.</p>
</div><table class="sc-hHEiqL VCQHZ"><tbody><tr class="last "><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="role_id"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">role_id</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>Identifier of the role to assign.</p>
</div></div></div></td></tr></tbody></table><div><h3 class="sc-fIxmyt DvFer">Responses</h3><div><button class="sc-htmcrh lbYftx"><svg class="sc-dIsUp dqYXmg" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-fWWYYk cMoEZ">200<!-- --> </strong><span class="sc-jcwpoC eDjFAZ"><p>Project role assigned to the group successfully.</p>
</span></button></div></div></div><div class="sc-jSFjdj sc-gKAaRy gBjRyf gcushC"><div class="sc-EZqKI fWsqvQ"><button class="sc-eEVmNe ilvUMs"><span type="post" class="sc-fmdNqN ldMUmp http-verb post">post</span><span class="sc-jXcxbT fCEUju">/projects/{project_id}/groups/{group_id}/roles</span><svg class="sc-dIsUp bRmrKA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ljsmAU flIrdF"><div class="sc-jlZJtj fQkroN"><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div><div tabindex="0" role="button"><div class="sc-dTSzeu dfUAUz"><span>https://api.openai.com/v1</span>/projects/{project_id}/groups/{group_id}/roles</div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Request samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="react-tabs-542" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-543" tabindex="0" data-rttab="true">Payload</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-543" aria-labelledby="react-tabs-542"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-bBjRSN kQSIAz">application/json</div></div><div class="sc-jgPyTC dSaTNC"><div class="sc-jNnpgg esZIbL"><div class="sc-giAqHp hMPeqJ"><button><div class="sc-carFqZ UksDl">Copy</div></button></div><div class="sc-iJCRrE jCdxGr sc-dPaNzc gyljjx"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"role_id"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Response samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-544" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-545" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-545" aria-labelledby="react-tabs-544"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-bBjRSN kQSIAz">application/json</div></div><div class="sc-jgPyTC dSaTNC"><div class="sc-jNnpgg esZIbL"><div class="sc-giAqHp hMPeqJ"><button><div class="sc-carFqZ UksDl">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iJCRrE jCdxGr sc-dPaNzc gyljjx"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"object"</span>: <span class="token string">"group.role"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"group"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"object"</span>: <span class="token string">"group"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"created_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"scim_managed"</span>: <span class="token boolean">true</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"role"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"object"</span>: <span class="token string">"role"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"description"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"permissions"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><span class="token string">"string"</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"resource_type"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"predefined_role"</span>: <span class="token boolean">true</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Project-group-role-assignments/operation/unassign-project-group-role" data-section-id="tag/Project-group-role-assignments/operation/unassign-project-group-role" class="sc-eCApnc liLqNm"><div data-section-id="operation/unassign-project-group-role" id="operation/unassign-project-group-role" class="sc-iCoGMd gLxhOh"><div class="sc-hKFxyN juinod"><h2 class="sc-pNWdM eftmgB"><a class="sc-crzoAE iUxAWq" href="#tag/Project-group-role-assignments/operation/unassign-project-group-role" aria-label="tag/Project-group-role-assignments/operation/unassign-project-group-role"></a>Unassigns a project role from a group within a project.<!-- --> </h2><div class="sc-fcmMJX cvfxAX"><div class="sc-jUfyBS bhDyou"><h5 class="sc-iqAclL sc-fuISkM eONCmm hZIgic">Authorizations:</h5><svg class="sc-dIsUp iPqByX" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jQAxuV ccffaZ"><span class="sc-daBunf fcvuS"><span class="sc-dsXzNU dPrSxx"><i>ApiKeyAuth</i></span></span></div></div><div><h5 class="sc-iqAclL eONCmm">path<!-- --> Parameters</h5><table class="sc-hHEiqL VCQHZ"><tbody><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="project_id"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">project_id</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The ID of the project to modify.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="group_id"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">group_id</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The ID of the group whose project role assignment should be removed.</p>
</div></div></div></td></tr><tr class="last "><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="role_id"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">role_id</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The ID of the project role to remove from the group.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-fIxmyt DvFer">Responses</h3><div><button class="sc-htmcrh lbYftx"><svg class="sc-dIsUp dqYXmg" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-fWWYYk cMoEZ">200<!-- --> </strong><span class="sc-jcwpoC eDjFAZ"><p>Project role unassigned from the group successfully.</p>
</span></button></div></div></div><div class="sc-jSFjdj sc-gKAaRy gBjRyf gcushC"><div class="sc-EZqKI fWsqvQ"><button class="sc-eEVmNe ilvUMs"><span type="delete" class="sc-fmdNqN bJzUtf http-verb delete">delete</span><span class="sc-jXcxbT fCEUju">/projects/{project_id}/groups/{group_id}/roles/{role_id}</span><svg class="sc-dIsUp bRmrKA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ljsmAU flIrdF"><div class="sc-jlZJtj fQkroN"><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div><div tabindex="0" role="button"><div class="sc-dTSzeu dfUAUz"><span>https://api.openai.com/v1</span>/projects/{project_id}/groups/{group_id}/roles/{role_id}</div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Response samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-546" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-547" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-547" aria-labelledby="react-tabs-546"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-bBjRSN kQSIAz">application/json</div></div><div class="sc-jgPyTC dSaTNC"><div class="sc-jNnpgg esZIbL"><div class="sc-giAqHp hMPeqJ"><button><div class="sc-carFqZ UksDl">Copy</div></button></div><div class="sc-iJCRrE jCdxGr sc-dPaNzc gyljjx"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"object"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"deleted"</span>: <span class="token boolean">true</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Project-user-role-assignments" data-section-id="tag/Project-user-role-assignments" class="sc-eCApnc jlMQbh"><div class="sc-iCoGMd gLxhOh"><div class="sc-hKFxyN juinod"><h1 class="sc-fujyAs bpZWeL"><a class="sc-crzoAE iUxAWq" href="#tag/Project-user-role-assignments" aria-label="tag/Project-user-role-assignments"></a>Project user role assignments</h1></div></div></div><div id="tag/Project-user-role-assignments/operation/list-project-user-role-assignments" data-section-id="tag/Project-user-role-assignments/operation/list-project-user-role-assignments" class="sc-eCApnc liLqNm"><div data-section-id="operation/list-project-user-role-assignments" id="operation/list-project-user-role-assignments" class="sc-iCoGMd gLxhOh"><div class="sc-hKFxyN juinod"><h2 class="sc-pNWdM eftmgB"><a class="sc-crzoAE iUxAWq" href="#tag/Project-user-role-assignments/operation/list-project-user-role-assignments" aria-label="tag/Project-user-role-assignments/operation/list-project-user-role-assignments"></a>Lists the project roles assigned to a user within a project.<!-- --> </h2><div class="sc-fcmMJX cvfxAX"><div class="sc-jUfyBS bhDyou"><h5 class="sc-iqAclL sc-fuISkM eONCmm hZIgic">Authorizations:</h5><svg class="sc-dIsUp iPqByX" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jQAxuV ccffaZ"><span class="sc-daBunf fcvuS"><span class="sc-dsXzNU dPrSxx"><i>ApiKeyAuth</i></span></span></div></div><div><h5 class="sc-iqAclL eONCmm">path<!-- --> Parameters</h5><table class="sc-hHEiqL VCQHZ"><tbody><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="project_id"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">project_id</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The ID of the project to inspect.</p>
</div></div></div></td></tr><tr class="last "><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="user_id"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">user_id</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The ID of the user to inspect.</p>
</div></div></div></td></tr></tbody></table></div><div><h5 class="sc-iqAclL eONCmm">query<!-- --> Parameters</h5><table class="sc-hHEiqL VCQHZ"><tbody><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="limit"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">limit</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">integer</span><span> <span class="sc-laZMeE sc-FRrlG jWaWWE gHBwqe"> <!-- -->[ 0 .. 1000 ]<!-- --> </span></span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>A limit on the number of project role assignments to return.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="after"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">after</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>Cursor for pagination. Provide the value from the previous response's <code>next</code> field to continue listing project roles.</p>
</div></div></div></td></tr><tr class="last "><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="order"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">order</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div><div><span class="sc-laZMeE jWaWWE"> <!-- -->Enum<!-- -->:</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"asc"</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"desc"</span> </div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>Sort order for the returned project roles.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-fIxmyt DvFer">Responses</h3><div><button class="sc-htmcrh lbYftx"><svg class="sc-dIsUp dqYXmg" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-fWWYYk cMoEZ">200<!-- --> </strong><span class="sc-jcwpoC eDjFAZ"><p>Project user role assignments listed successfully.</p>
</span></button></div></div></div><div class="sc-jSFjdj sc-gKAaRy gBjRyf gcushC"><div class="sc-EZqKI fWsqvQ"><button class="sc-eEVmNe ilvUMs"><span type="get" class="sc-fmdNqN ihNycv http-verb get">get</span><span class="sc-jXcxbT fCEUju">/projects/{project_id}/users/{user_id}/roles</span><svg class="sc-dIsUp bRmrKA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ljsmAU flIrdF"><div class="sc-jlZJtj fQkroN"><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div><div tabindex="0" role="button"><div class="sc-dTSzeu dfUAUz"><span>https://api.openai.com/v1</span>/projects/{project_id}/users/{user_id}/roles</div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Response samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-548" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-549" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-549" aria-labelledby="react-tabs-548"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-bBjRSN kQSIAz">application/json</div></div><div class="sc-jgPyTC dSaTNC"><div class="sc-jNnpgg esZIbL"><div class="sc-giAqHp hMPeqJ"><button><div class="sc-carFqZ UksDl">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iJCRrE jCdxGr sc-dPaNzc gyljjx"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"object"</span>: <span class="token string">"list"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"permissions"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><span class="token string">"string"</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"resource_type"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"predefined_role"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"description"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"created_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"updated_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"created_by"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"created_by_user_obj"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"has_more"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"next"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Project-user-role-assignments/operation/assign-project-user-role" data-section-id="tag/Project-user-role-assignments/operation/assign-project-user-role" class="sc-eCApnc liLqNm"><div data-section-id="operation/assign-project-user-role" id="operation/assign-project-user-role" class="sc-iCoGMd gLxhOh"><div class="sc-hKFxyN juinod"><h2 class="sc-pNWdM eftmgB"><a class="sc-crzoAE iUxAWq" href="#tag/Project-user-role-assignments/operation/assign-project-user-role" aria-label="tag/Project-user-role-assignments/operation/assign-project-user-role"></a>Assigns a project role to a user within a project.<!-- --> </h2><div class="sc-fcmMJX cvfxAX"><div class="sc-jUfyBS bhDyou"><h5 class="sc-iqAclL sc-fuISkM eONCmm hZIgic">Authorizations:</h5><svg class="sc-dIsUp iPqByX" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jQAxuV ccffaZ"><span class="sc-daBunf fcvuS"><span class="sc-dsXzNU dPrSxx"><i>ApiKeyAuth</i></span></span></div></div><div><h5 class="sc-iqAclL eONCmm">path<!-- --> Parameters</h5><table class="sc-hHEiqL VCQHZ"><tbody><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="project_id"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">project_id</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The ID of the project to update.</p>
</div></div></div></td></tr><tr class="last "><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="user_id"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">user_id</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The ID of the user that should receive the project role.</p>
</div></div></div></td></tr></tbody></table></div><h5 class="sc-iqAclL eONCmm">Request Body schema: <span class="sc-cBoqAE eKyrDP">application/json</span></h5><div class="sc-iJCRrE sc-ciSkZP jCdxGr QGruV"><p>Identifies the project role to assign to the user.</p>
</div><table class="sc-hHEiqL VCQHZ"><tbody><tr class="last "><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="role_id"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">role_id</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>Identifier of the role to assign.</p>
</div></div></div></td></tr></tbody></table><div><h3 class="sc-fIxmyt DvFer">Responses</h3><div><button class="sc-htmcrh lbYftx"><svg class="sc-dIsUp dqYXmg" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-fWWYYk cMoEZ">200<!-- --> </strong><span class="sc-jcwpoC eDjFAZ"><p>Project role assigned to the user successfully.</p>
</span></button></div></div></div><div class="sc-jSFjdj sc-gKAaRy gBjRyf gcushC"><div class="sc-EZqKI fWsqvQ"><button class="sc-eEVmNe ilvUMs"><span type="post" class="sc-fmdNqN ldMUmp http-verb post">post</span><span class="sc-jXcxbT fCEUju">/projects/{project_id}/users/{user_id}/roles</span><svg class="sc-dIsUp bRmrKA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ljsmAU flIrdF"><div class="sc-jlZJtj fQkroN"><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div><div tabindex="0" role="button"><div class="sc-dTSzeu dfUAUz"><span>https://api.openai.com/v1</span>/projects/{project_id}/users/{user_id}/roles</div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Request samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="react-tabs-550" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-551" tabindex="0" data-rttab="true">Payload</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-551" aria-labelledby="react-tabs-550"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-bBjRSN kQSIAz">application/json</div></div><div class="sc-jgPyTC dSaTNC"><div class="sc-jNnpgg esZIbL"><div class="sc-giAqHp hMPeqJ"><button><div class="sc-carFqZ UksDl">Copy</div></button></div><div class="sc-iJCRrE jCdxGr sc-dPaNzc gyljjx"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"role_id"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Response samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-552" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-553" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-553" aria-labelledby="react-tabs-552"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-bBjRSN kQSIAz">application/json</div></div><div class="sc-jgPyTC dSaTNC"><div class="sc-jNnpgg esZIbL"><div class="sc-giAqHp hMPeqJ"><button><div class="sc-carFqZ UksDl">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iJCRrE jCdxGr sc-dPaNzc gyljjx"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"object"</span>: <span class="token string">"user.role"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"user"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"object"</span>: <span class="token string">"organization.user"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"email"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"role"</span>: <span class="token string">"owner"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"added_at"</span>: <span class="token number">0</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"role"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"object"</span>: <span class="token string">"role"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"description"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"permissions"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><span class="token string">"string"</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"resource_type"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"predefined_role"</span>: <span class="token boolean">true</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Project-user-role-assignments/operation/unassign-project-user-role" data-section-id="tag/Project-user-role-assignments/operation/unassign-project-user-role" class="sc-eCApnc liLqNm"><div data-section-id="operation/unassign-project-user-role" id="operation/unassign-project-user-role" class="sc-iCoGMd gLxhOh"><div class="sc-hKFxyN juinod"><h2 class="sc-pNWdM eftmgB"><a class="sc-crzoAE iUxAWq" href="#tag/Project-user-role-assignments/operation/unassign-project-user-role" aria-label="tag/Project-user-role-assignments/operation/unassign-project-user-role"></a>Unassigns a project role from a user within a project.<!-- --> </h2><div class="sc-fcmMJX cvfxAX"><div class="sc-jUfyBS bhDyou"><h5 class="sc-iqAclL sc-fuISkM eONCmm hZIgic">Authorizations:</h5><svg class="sc-dIsUp iPqByX" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jQAxuV ccffaZ"><span class="sc-daBunf fcvuS"><span class="sc-dsXzNU dPrSxx"><i>ApiKeyAuth</i></span></span></div></div><div><h5 class="sc-iqAclL eONCmm">path<!-- --> Parameters</h5><table class="sc-hHEiqL VCQHZ"><tbody><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="project_id"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">project_id</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The ID of the project to modify.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="user_id"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">user_id</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The ID of the user whose project role assignment should be removed.</p>
</div></div></div></td></tr><tr class="last "><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="role_id"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">role_id</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The ID of the project role to remove from the user.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-fIxmyt DvFer">Responses</h3><div><button class="sc-htmcrh lbYftx"><svg class="sc-dIsUp dqYXmg" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-fWWYYk cMoEZ">200<!-- --> </strong><span class="sc-jcwpoC eDjFAZ"><p>Project role unassigned from the user successfully.</p>
</span></button></div></div></div><div class="sc-jSFjdj sc-gKAaRy gBjRyf gcushC"><div class="sc-EZqKI fWsqvQ"><button class="sc-eEVmNe ilvUMs"><span type="delete" class="sc-fmdNqN bJzUtf http-verb delete">delete</span><span class="sc-jXcxbT fCEUju">/projects/{project_id}/users/{user_id}/roles/{role_id}</span><svg class="sc-dIsUp bRmrKA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ljsmAU flIrdF"><div class="sc-jlZJtj fQkroN"><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div><div tabindex="0" role="button"><div class="sc-dTSzeu dfUAUz"><span>https://api.openai.com/v1</span>/projects/{project_id}/users/{user_id}/roles/{role_id}</div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Response samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-554" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-555" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-555" aria-labelledby="react-tabs-554"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-bBjRSN kQSIAz">application/json</div></div><div class="sc-jgPyTC dSaTNC"><div class="sc-jNnpgg esZIbL"><div class="sc-giAqHp hMPeqJ"><button><div class="sc-carFqZ UksDl">Copy</div></button></div><div class="sc-iJCRrE jCdxGr sc-dPaNzc gyljjx"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"object"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"deleted"</span>: <span class="token boolean">true</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Realtime" data-section-id="tag/Realtime" class="sc-eCApnc jlMQbh"><div class="sc-iCoGMd gLxhOh"><div class="sc-hKFxyN juinod"><h1 class="sc-fujyAs bpZWeL"><a class="sc-crzoAE iUxAWq" href="#tag/Realtime" aria-label="tag/Realtime"></a>Realtime</h1></div></div></div><div id="tag/Realtime/operation/create-realtime-call" data-section-id="tag/Realtime/operation/create-realtime-call" class="sc-eCApnc liLqNm"><div data-section-id="operation/create-realtime-call" id="operation/create-realtime-call" class="sc-iCoGMd gLxhOh"><div class="sc-hKFxyN juinod"><h2 class="sc-pNWdM eftmgB"><a class="sc-crzoAE iUxAWq" href="#tag/Realtime/operation/create-realtime-call" aria-label="tag/Realtime/operation/create-realtime-call"></a>Create a new Realtime API call over WebRTC and receive the SDP answer needed
to complete the peer connection.<!-- --> </h2><div class="sc-fcmMJX cvfxAX"><div class="sc-jUfyBS bhDyou"><h5 class="sc-iqAclL sc-fuISkM eONCmm hZIgic">Authorizations:</h5><svg class="sc-dIsUp iPqByX" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jQAxuV ccffaZ"><span class="sc-daBunf fcvuS"><span class="sc-dsXzNU dPrSxx"><i>ApiKeyAuth</i></span></span></div></div><h5 class="sc-iqAclL eONCmm">Request Body schema: <div class="sc-hiKfDv sc-gXfVKN bycQNU dhIYNk"><svg class="sc-jJMGnK hzcSs" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option selected="" value="multipart/form-data">multipart/form-data</option><option value="application/sdp">application/sdp</option></select><label>multipart/form-data</label></div></h5><div class="sc-iJCRrE sc-ciSkZP jCdxGr QGruV"></div><table class="sc-hHEiqL VCQHZ"><tbody><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="sdp"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">sdp</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>WebRTC Session Description Protocol (SDP) offer generated by the caller.</p>
</div></div></div></td></tr><tr class="last "><td class="sc-hBMUJo sc-fFSPTT sc-gSYDnn iwcKgn cAqMTE hTttpy" kind="field" title="session"><span class="sc-iemWCZ bcnRwz"></span><button aria-label="expand properties"><span class="property-name">session</span><svg class="sc-dIsUp hGHhhO" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">object</span><span class="sc-laZMeE sc-eJocfa jWaWWE bArHDh"> (<!-- -->Session configuration<!-- -->) </span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>Optional session configuration to apply before the realtime session is
created. Use the same parameters you would send in a <a href="/docs/api-reference/realtime-sessions/create-realtime-client-secret"><code>create client secret</code></a>
request.</p>
</div></div></div></td></tr></tbody></table><div><h3 class="sc-fIxmyt DvFer">Responses</h3><div><button class="sc-htmcrh lbYftx"><svg class="sc-dIsUp dqYXmg" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-fWWYYk cMoEZ">201<!-- --> </strong><span class="sc-jcwpoC eDjFAZ"><p>Realtime call created successfully.</p>
</span></button></div></div></div><div class="sc-jSFjdj sc-gKAaRy gBjRyf gcushC"><div class="sc-EZqKI fWsqvQ"><button class="sc-eEVmNe ilvUMs"><span type="post" class="sc-fmdNqN ldMUmp http-verb post">post</span><span class="sc-jXcxbT fCEUju">/realtime/calls</span><svg class="sc-dIsUp bRmrKA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ljsmAU flIrdF"><div class="sc-jlZJtj fQkroN"><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div><div tabindex="0" role="button"><div class="sc-dTSzeu dfUAUz"><span>https://api.openai.com/v1</span>/realtime/calls</div></div></div></div></div></div></div></div><div id="tag/Realtime/operation/accept-realtime-call" data-section-id="tag/Realtime/operation/accept-realtime-call" class="sc-eCApnc liLqNm"><div data-section-id="operation/accept-realtime-call" id="operation/accept-realtime-call" class="sc-iCoGMd gLxhOh"><div class="sc-hKFxyN juinod"><h2 class="sc-pNWdM eftmgB"><a class="sc-crzoAE iUxAWq" href="#tag/Realtime/operation/accept-realtime-call" aria-label="tag/Realtime/operation/accept-realtime-call"></a>Accept an incoming SIP call and configure the realtime session that will
handle it.<!-- --> </h2><div class="sc-fcmMJX cvfxAX"><div class="sc-jUfyBS bhDyou"><h5 class="sc-iqAclL sc-fuISkM eONCmm hZIgic">Authorizations:</h5><svg class="sc-dIsUp iPqByX" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jQAxuV ccffaZ"><span class="sc-daBunf fcvuS"><span class="sc-dsXzNU dPrSxx"><i>ApiKeyAuth</i></span></span></div></div><div><h5 class="sc-iqAclL eONCmm">path<!-- --> Parameters</h5><table class="sc-hHEiqL VCQHZ"><tbody><tr class="last "><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="call_id"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">call_id</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The identifier for the call provided in the
<a href="/docs/api-reference/webhook-events/realtime/call/incoming"><code>realtime.call.incoming</code></a>
webhook.</p>
</div></div></div></td></tr></tbody></table></div><h5 class="sc-iqAclL eONCmm">Request Body schema: <span class="sc-cBoqAE eKyrDP">application/json</span></h5><div class="sc-iJCRrE sc-ciSkZP jCdxGr QGruV"><p>Session configuration to apply before the caller is bridged to the model.</p>
</div><table class="sc-hHEiqL VCQHZ"><tbody><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="type"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">type</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div><div><span class="sc-laZMeE jWaWWE"> <!-- -->Value<!-- -->:</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"realtime"</span> </div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The type of session to create. Always <code>realtime</code> for the Realtime API.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="output_modalities"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">output_modalities</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa">Array of </span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">strings</span></div><div><span class="sc-laZMeE jWaWWE"> <!-- -->Default:<!-- --> </span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">["audio"]</span></div><div><span class="sc-laZMeE jWaWWE">Items<!-- --> <!-- -->Enum<!-- -->:</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"text"</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"audio"</span> </div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The set of modalities the model can respond with. It defaults to <code>["audio"]</code>, indicating
that the model will respond with audio plus a transcript. <code>["text"]</code> can be used to make
the model respond with text only. It is not possible to request both <code>text</code> and <code>audio</code> at the same time.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT sc-gSYDnn iwcKgn cAqMTE hTttpy" kind="field" title="model"><span class="sc-iemWCZ bcnRwz"></span><button aria-label="expand properties"><span class="property-name">model</span><svg class="sc-dIsUp hGHhhO" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string or string</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The Realtime model used for this session.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="instructions"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">instructions</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The default system instructions (i.e. system message) prepended to model calls. This field allows the client to guide the model on desired responses. The model can be instructed on response content and format, (e.g. "be extremely succinct", "act friendly", "here are examples of good responses") and on audio behavior (e.g. "talk quickly", "inject emotion into your voice", "laugh frequently"). The instructions are not guaranteed to be followed by the model, but they provide guidance to the model on the desired behavior.</p>
<p>Note that the server sets default instructions which will be used if this field is not set and are visible in the <code>session.created</code> event at the start of the session.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT sc-gSYDnn iwcKgn cAqMTE hTttpy" kind="field" title="audio"><span class="sc-iemWCZ bcnRwz"></span><button aria-label="expand properties"><span class="property-name">audio</span><svg class="sc-dIsUp hGHhhO" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">object</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>Configuration for input and output audio.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="include"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">include</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa">Array of </span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">strings</span></div><div><span class="sc-laZMeE jWaWWE">Items<!-- --> <!-- -->Value<!-- -->:</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"item.input_audio_transcription.logprobs"</span> </div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>Additional fields to include in server outputs.</p>
<p><code>item.input_audio_transcription.logprobs</code>: Include logprobs for input audio transcription.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT sc-gSYDnn iwcKgn cAqMTE hTttpy" kind="field" title="tracing"><span class="sc-iemWCZ bcnRwz"></span><button aria-label="expand properties"><span class="property-name">tracing</span><svg class="sc-dIsUp hGHhhO" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">(auto (string or null)) or (Tracing Configuration (object or null))</span><span class="sc-laZMeE sc-eJocfa jWaWWE bArHDh"> (<!-- -->Tracing Configuration<!-- -->) </span></div><div><span class="sc-laZMeE jWaWWE"> <!-- -->Default:<!-- --> </span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">null</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>Realtime API can write session traces to the <a href="https://platform.openai.com/logs?api=traces">Traces Dashboard</a>. Set to null to disable tracing. Once
tracing is enabled for a session, the configuration cannot be modified.</p>
<p><code>auto</code> will create a trace for the session with default values for the
workflow name, group id, and metadata.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT sc-gSYDnn iwcKgn cAqMTE hTttpy" kind="field" title="tools"><span class="sc-iemWCZ bcnRwz"></span><button aria-label="expand properties"><span class="property-name">tools</span><svg class="sc-dIsUp hGHhhO" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa">Array of </span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">Function tool (object) or MCP tool (object)</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>Tools available to the model.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT sc-gSYDnn iwcKgn cAqMTE hTttpy" kind="field" title="tool_choice"><span class="sc-iemWCZ bcnRwz"></span><button aria-label="expand properties"><span class="property-name">tool_choice</span><svg class="sc-dIsUp hGHhhO" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">Tool choice mode (string) or Function tool (object) or MCP tool (object)</span></div><div><span class="sc-laZMeE jWaWWE"> <!-- -->Default:<!-- --> </span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"auto"</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>How the model chooses tools. Provide one of the string modes or force a specific
function/MCP tool.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT sc-gSYDnn iwcKgn cAqMTE hTttpy" kind="field" title="max_output_tokens"><span class="sc-iemWCZ bcnRwz"></span><button aria-label="expand properties"><span class="property-name">max_output_tokens</span><svg class="sc-dIsUp hGHhhO" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">integer or string</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>Maximum number of output tokens for a single assistant response,
inclusive of tool calls. Provide an integer between 1 and 4096 to
limit output tokens, or <code>inf</code> for the maximum available tokens for a
given model. Defaults to <code>inf</code>.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT sc-gSYDnn iwcKgn cAqMTE hTttpy" kind="field" title="truncation"><span class="sc-iemWCZ bcnRwz"></span><button aria-label="expand properties"><span class="property-name">truncation</span><svg class="sc-dIsUp hGHhhO" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string or Retention ratio truncation (object)</span><span class="sc-laZMeE sc-eJocfa jWaWWE bArHDh"> (<!-- -->RealtimeTruncation<!-- -->) </span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div></div></div></td></tr><tr class="last "><td class="sc-hBMUJo sc-fFSPTT sc-gSYDnn iwcKgn cAqMTE hTttpy" kind="field" title="prompt"><span class="sc-iemWCZ bcnRwz"></span><button aria-label="expand properties"><span class="property-name">prompt</span><svg class="sc-dIsUp hGHhhO" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">Prompt (object) or Prompt (null)</span><span class="sc-laZMeE sc-eJocfa jWaWWE bArHDh"> (<!-- -->Prompt<!-- -->) </span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div></div></div></td></tr></tbody></table><div><h3 class="sc-fIxmyt DvFer">Responses</h3><div><button class="sc-htmcrh jUGDyD" disabled=""><strong class="sc-fWWYYk cMoEZ">200<!-- --> </strong><span class="sc-jcwpoC eDjFAZ"><p>Call accepted successfully.</p>
</span></button></div></div></div><div class="sc-jSFjdj sc-gKAaRy gBjRyf gcushC"><div class="sc-EZqKI fWsqvQ"><button class="sc-eEVmNe ilvUMs"><span type="post" class="sc-fmdNqN ldMUmp http-verb post">post</span><span class="sc-jXcxbT fCEUju">/realtime/calls/{call_id}/accept</span><svg class="sc-dIsUp bRmrKA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ljsmAU flIrdF"><div class="sc-jlZJtj fQkroN"><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div><div tabindex="0" role="button"><div class="sc-dTSzeu dfUAUz"><span>https://api.openai.com/v1</span>/realtime/calls/{call_id}/accept</div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Request samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="react-tabs-556" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-557" tabindex="0" data-rttab="true">Payload</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-557" aria-labelledby="react-tabs-556"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-bBjRSN kQSIAz">application/json</div></div><div class="sc-jgPyTC dSaTNC"><div class="sc-jNnpgg esZIbL"><div class="sc-giAqHp hMPeqJ"><button><div class="sc-carFqZ UksDl">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iJCRrE jCdxGr sc-dPaNzc gyljjx"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"type"</span>: <span class="token string">"realtime"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"output_modalities"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><span class="token string">"audio"</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"model"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"instructions"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"audio"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"input"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"format"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <span class="token string">"audio/pcm"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"rate"</span>: <span class="token number">24000</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"transcription"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"model"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"language"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"prompt"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"noise_reduction"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"turn_detection"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <span class="token string">"server_vad"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"threshold"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"prefix_padding_ms"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"silence_duration_ms"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"create_response"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"interrupt_response"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"idle_timeout_ms"</span>: <span class="token number">5000</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"output"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"format"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <span class="token string">"audio/pcm"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"rate"</span>: <span class="token number">24000</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"voice"</span>: <span class="token string">"ash"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"speed"</span>: <span class="token number">1</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"include"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><span class="token string">"item.input_audio_transcription.logprobs"</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"tracing"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"tools"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <span class="token string">"function"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"description"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"parameters"</span>: <span class="token punctuation">{ }</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"tool_choice"</span>: <span class="token string">"auto"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"max_output_tokens"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"truncation"</span>: <span class="token string">"auto"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"prompt"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"version"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"variables"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"property1"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"property2"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Realtime/operation/hangup-realtime-call" data-section-id="tag/Realtime/operation/hangup-realtime-call" class="sc-eCApnc liLqNm"><div data-section-id="operation/hangup-realtime-call" id="operation/hangup-realtime-call" class="sc-iCoGMd gLxhOh"><div class="sc-hKFxyN juinod"><h2 class="sc-pNWdM eftmgB"><a class="sc-crzoAE iUxAWq" href="#tag/Realtime/operation/hangup-realtime-call" aria-label="tag/Realtime/operation/hangup-realtime-call"></a>End an active Realtime API call, whether it was initiated over SIP or
WebRTC.<!-- --> </h2><div class="sc-fcmMJX cvfxAX"><div class="sc-jUfyBS bhDyou"><h5 class="sc-iqAclL sc-fuISkM eONCmm hZIgic">Authorizations:</h5><svg class="sc-dIsUp iPqByX" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jQAxuV ccffaZ"><span class="sc-daBunf fcvuS"><span class="sc-dsXzNU dPrSxx"><i>ApiKeyAuth</i></span></span></div></div><div><h5 class="sc-iqAclL eONCmm">path<!-- --> Parameters</h5><table class="sc-hHEiqL VCQHZ"><tbody><tr class="last "><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="call_id"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">call_id</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The identifier for the call. For SIP calls, use the value provided in the
<a href="/docs/api-reference/webhook-events/realtime/call/incoming"><code>realtime.call.incoming</code></a>
webhook. For WebRTC sessions, reuse the call ID returned in the <code>Location</code>
header when creating the call with
<a href="/docs/api-reference/realtime/create-call"><code>POST /v1/realtime/calls</code></a>.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-fIxmyt DvFer">Responses</h3><div><button class="sc-htmcrh jUGDyD" disabled=""><strong class="sc-fWWYYk cMoEZ">200<!-- --> </strong><span class="sc-jcwpoC eDjFAZ"><p>Call hangup initiated successfully.</p>
</span></button></div></div></div><div class="sc-jSFjdj sc-gKAaRy gBjRyf gcushC"><div class="sc-EZqKI fWsqvQ"><button class="sc-eEVmNe ilvUMs"><span type="post" class="sc-fmdNqN ldMUmp http-verb post">post</span><span class="sc-jXcxbT fCEUju">/realtime/calls/{call_id}/hangup</span><svg class="sc-dIsUp bRmrKA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ljsmAU flIrdF"><div class="sc-jlZJtj fQkroN"><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div><div tabindex="0" role="button"><div class="sc-dTSzeu dfUAUz"><span>https://api.openai.com/v1</span>/realtime/calls/{call_id}/hangup</div></div></div></div></div></div></div></div><div id="tag/Realtime/operation/refer-realtime-call" data-section-id="tag/Realtime/operation/refer-realtime-call" class="sc-eCApnc liLqNm"><div data-section-id="operation/refer-realtime-call" id="operation/refer-realtime-call" class="sc-iCoGMd gLxhOh"><div class="sc-hKFxyN juinod"><h2 class="sc-pNWdM eftmgB"><a class="sc-crzoAE iUxAWq" href="#tag/Realtime/operation/refer-realtime-call" aria-label="tag/Realtime/operation/refer-realtime-call"></a>Transfer an active SIP call to a new destination using the SIP REFER verb.<!-- --> </h2><div class="sc-fcmMJX cvfxAX"><div class="sc-jUfyBS bhDyou"><h5 class="sc-iqAclL sc-fuISkM eONCmm hZIgic">Authorizations:</h5><svg class="sc-dIsUp iPqByX" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jQAxuV ccffaZ"><span class="sc-daBunf fcvuS"><span class="sc-dsXzNU dPrSxx"><i>ApiKeyAuth</i></span></span></div></div><div><h5 class="sc-iqAclL eONCmm">path<!-- --> Parameters</h5><table class="sc-hHEiqL VCQHZ"><tbody><tr class="last "><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="call_id"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">call_id</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The identifier for the call provided in the
<a href="/docs/api-reference/webhook-events/realtime/call/incoming"><code>realtime.call.incoming</code></a>
webhook.</p>
</div></div></div></td></tr></tbody></table></div><h5 class="sc-iqAclL eONCmm">Request Body schema: <span class="sc-cBoqAE eKyrDP">application/json</span></h5><div class="sc-iJCRrE sc-ciSkZP jCdxGr QGruV"><p>Destination URI for the REFER request.</p>
</div><table class="sc-hHEiqL VCQHZ"><tbody><tr class="last "><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="target_uri"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">target_uri</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>URI that should appear in the SIP Refer-To header. Supports values like
<code>tel:+14155550123</code> or <code>sip:agent@example.com</code>.</p>
</div></div></div></td></tr></tbody></table><div><h3 class="sc-fIxmyt DvFer">Responses</h3><div><button class="sc-htmcrh jUGDyD" disabled=""><strong class="sc-fWWYYk cMoEZ">200<!-- --> </strong><span class="sc-jcwpoC eDjFAZ"><p>Call referred successfully.</p>
</span></button></div></div></div><div class="sc-jSFjdj sc-gKAaRy gBjRyf gcushC"><div class="sc-EZqKI fWsqvQ"><button class="sc-eEVmNe ilvUMs"><span type="post" class="sc-fmdNqN ldMUmp http-verb post">post</span><span class="sc-jXcxbT fCEUju">/realtime/calls/{call_id}/refer</span><svg class="sc-dIsUp bRmrKA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ljsmAU flIrdF"><div class="sc-jlZJtj fQkroN"><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div><div tabindex="0" role="button"><div class="sc-dTSzeu dfUAUz"><span>https://api.openai.com/v1</span>/realtime/calls/{call_id}/refer</div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Request samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="react-tabs-558" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-559" tabindex="0" data-rttab="true">Payload</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-559" aria-labelledby="react-tabs-558"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-bBjRSN kQSIAz">application/json</div></div><div class="sc-jgPyTC dSaTNC"><div class="sc-jNnpgg esZIbL"><div class="sc-giAqHp hMPeqJ"><button><div class="sc-carFqZ UksDl">Copy</div></button></div><div class="sc-iJCRrE jCdxGr sc-dPaNzc gyljjx"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"target_uri"</span>: <span class="token string">"tel:+14155550123"</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Realtime/operation/reject-realtime-call" data-section-id="tag/Realtime/operation/reject-realtime-call" class="sc-eCApnc liLqNm"><div data-section-id="operation/reject-realtime-call" id="operation/reject-realtime-call" class="sc-iCoGMd gLxhOh"><div class="sc-hKFxyN juinod"><h2 class="sc-pNWdM eftmgB"><a class="sc-crzoAE iUxAWq" href="#tag/Realtime/operation/reject-realtime-call" aria-label="tag/Realtime/operation/reject-realtime-call"></a>Decline an incoming SIP call by returning a SIP status code to the caller.<!-- --> </h2><div class="sc-fcmMJX cvfxAX"><div class="sc-jUfyBS bhDyou"><h5 class="sc-iqAclL sc-fuISkM eONCmm hZIgic">Authorizations:</h5><svg class="sc-dIsUp iPqByX" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jQAxuV ccffaZ"><span class="sc-daBunf fcvuS"><span class="sc-dsXzNU dPrSxx"><i>ApiKeyAuth</i></span></span></div></div><div><h5 class="sc-iqAclL eONCmm">path<!-- --> Parameters</h5><table class="sc-hHEiqL VCQHZ"><tbody><tr class="last "><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="call_id"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">call_id</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The identifier for the call provided in the
<a href="/docs/api-reference/webhook-events/realtime/call/incoming"><code>realtime.call.incoming</code></a>
webhook.</p>
</div></div></div></td></tr></tbody></table></div><h5 class="sc-iqAclL eONCmm">Request Body schema: <span class="sc-cBoqAE eKyrDP">application/json</span></h5><div class="sc-iJCRrE sc-ciSkZP jCdxGr QGruV"><p>Provide an optional SIP status code. When omitted the API responds with
<code>603 Decline</code>.</p>
</div><table class="sc-hHEiqL VCQHZ"><tbody><tr class="last "><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="status_code"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">status_code</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">integer</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>SIP response code to send back to the caller. Defaults to <code>603</code> (Decline)
when omitted.</p>
</div></div></div></td></tr></tbody></table><div><h3 class="sc-fIxmyt DvFer">Responses</h3><div><button class="sc-htmcrh jUGDyD" disabled=""><strong class="sc-fWWYYk cMoEZ">200<!-- --> </strong><span class="sc-jcwpoC eDjFAZ"><p>Call rejected successfully.</p>
</span></button></div></div></div><div class="sc-jSFjdj sc-gKAaRy gBjRyf gcushC"><div class="sc-EZqKI fWsqvQ"><button class="sc-eEVmNe ilvUMs"><span type="post" class="sc-fmdNqN ldMUmp http-verb post">post</span><span class="sc-jXcxbT fCEUju">/realtime/calls/{call_id}/reject</span><svg class="sc-dIsUp bRmrKA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ljsmAU flIrdF"><div class="sc-jlZJtj fQkroN"><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div><div tabindex="0" role="button"><div class="sc-dTSzeu dfUAUz"><span>https://api.openai.com/v1</span>/realtime/calls/{call_id}/reject</div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Request samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="react-tabs-560" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-561" tabindex="0" data-rttab="true">Payload</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-561" aria-labelledby="react-tabs-560"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-bBjRSN kQSIAz">application/json</div></div><div class="sc-jgPyTC dSaTNC"><div class="sc-jNnpgg esZIbL"><div class="sc-giAqHp hMPeqJ"><button><div class="sc-carFqZ UksDl">Copy</div></button></div><div class="sc-iJCRrE jCdxGr sc-dPaNzc gyljjx"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"status_code"</span>: <span class="token number">486</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Realtime/operation/create-realtime-client-secret" data-section-id="tag/Realtime/operation/create-realtime-client-secret" class="sc-eCApnc liLqNm"><div data-section-id="operation/create-realtime-client-secret" id="operation/create-realtime-client-secret" class="sc-iCoGMd gLxhOh"><div class="sc-hKFxyN juinod"><h2 class="sc-pNWdM eftmgB"><a class="sc-crzoAE iUxAWq" href="#tag/Realtime/operation/create-realtime-client-secret" aria-label="tag/Realtime/operation/create-realtime-client-secret"></a>Create a Realtime client secret with an associated session configuration.
Client secrets are short-lived tokens that can be passed to a client app,
such as a web frontend or mobile client, which grants access to the Realtime API without
leaking your main API key. You can configure a custom TTL for each client secret.
You can also attach session configuration options to the client secret, which will be
applied to any sessions created using that client secret, but these can also be overridden
by the client connection.
[Learn more about authentication with client secrets over WebRTC](/docs/guides/realtime-webrtc).
Returns the created client secret and the effective session object. The client secret is a string that looks like `ek_1234`.
<!-- --> </h2><div class="sc-fcmMJX cvfxAX"><div class="sc-jUfyBS bhDyou"><h5 class="sc-iqAclL sc-fuISkM eONCmm hZIgic">Authorizations:</h5><svg class="sc-dIsUp iPqByX" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jQAxuV ccffaZ"><span class="sc-daBunf fcvuS"><span class="sc-dsXzNU dPrSxx"><i>ApiKeyAuth</i></span></span></div></div><h5 class="sc-iqAclL eONCmm">Request Body schema: <span class="sc-cBoqAE eKyrDP">application/json</span></h5><div class="sc-iJCRrE sc-ciSkZP jCdxGr QGruV"><p>Create a client secret with the given session configuration.</p>
</div><table class="sc-hHEiqL VCQHZ"><tbody><tr class=""><td class="sc-hBMUJo sc-fFSPTT sc-gSYDnn iwcKgn cAqMTE hTttpy" kind="field" title="expires_after"><span class="sc-iemWCZ bcnRwz"></span><button aria-label="expand properties"><span class="property-name">expires_after</span><svg class="sc-dIsUp hGHhhO" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">object</span><span class="sc-laZMeE sc-eJocfa jWaWWE bArHDh"> (<!-- -->Client secret expiration<!-- -->) </span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>Configuration for the client secret expiration. Expiration refers to the time after which
a client secret will no longer be valid for creating sessions. The session itself may
continue after that time once started. A secret can be used to create multiple sessions
until it expires.</p>
</div></div></div></td></tr><tr class="last "><td class="sc-hBMUJo sc-fFSPTT sc-gSYDnn iwcKgn cAqMTE hTttpy" kind="field" title="session"><span class="sc-iemWCZ bcnRwz"></span><button aria-label="expand properties"><span class="property-name">session</span><svg class="sc-dIsUp hGHhhO" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">Realtime session configuration (object) or Realtime transcription session configuration (object)</span><span class="sc-laZMeE sc-eJocfa jWaWWE bArHDh"> (<!-- -->Session configuration<!-- -->) </span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>Session configuration to use for the client secret. Choose either a realtime
session or a transcription session.</p>
</div></div></div></td></tr></tbody></table><div><h3 class="sc-fIxmyt DvFer">Responses</h3><div><button class="sc-htmcrh lbYftx"><svg class="sc-dIsUp dqYXmg" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-fWWYYk cMoEZ">200<!-- --> </strong><span class="sc-jcwpoC eDjFAZ"><p>Client secret created successfully.</p>
</span></button></div></div></div><div class="sc-jSFjdj sc-gKAaRy gBjRyf gcushC"><div class="sc-EZqKI fWsqvQ"><button class="sc-eEVmNe ilvUMs"><span type="post" class="sc-fmdNqN ldMUmp http-verb post">post</span><span class="sc-jXcxbT fCEUju">/realtime/client_secrets</span><svg class="sc-dIsUp bRmrKA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ljsmAU flIrdF"><div class="sc-jlZJtj fQkroN"><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div><div tabindex="0" role="button"><div class="sc-dTSzeu dfUAUz"><span>https://api.openai.com/v1</span>/realtime/client_secrets</div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Request samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="react-tabs-562" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-563" tabindex="0" data-rttab="true">Payload</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-563" aria-labelledby="react-tabs-562"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-bBjRSN kQSIAz">application/json</div></div><div class="sc-jgPyTC dSaTNC"><div class="sc-jNnpgg esZIbL"><div class="sc-giAqHp hMPeqJ"><button><div class="sc-carFqZ UksDl">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iJCRrE jCdxGr sc-dPaNzc gyljjx"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"expires_after"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"anchor"</span>: <span class="token string">"created_at"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"seconds"</span>: <span class="token number">600</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"session"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <span class="token string">"realtime"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"output_modalities"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><span class="token string">"audio"</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"model"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"instructions"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"audio"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"input"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"format"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <span class="token string">"audio/pcm"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"rate"</span>: <span class="token number">24000</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"transcription"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"model"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"language"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"prompt"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"noise_reduction"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"turn_detection"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <span class="token string">"server_vad"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"threshold"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"prefix_padding_ms"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"silence_duration_ms"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"create_response"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"interrupt_response"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"idle_timeout_ms"</span>: <span class="token number">5000</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"output"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"format"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <span class="token string">"audio/pcm"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"rate"</span>: <span class="token number">24000</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"voice"</span>: <span class="token string">"ash"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"speed"</span>: <span class="token number">1</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"include"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><span class="token string">"item.input_audio_transcription.logprobs"</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"tracing"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"tools"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <span class="token string">"function"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"description"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"parameters"</span>: <span class="token punctuation">{ }</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"tool_choice"</span>: <span class="token string">"auto"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"max_output_tokens"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"truncation"</span>: <span class="token string">"auto"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"prompt"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"version"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"variables"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"property1"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"property2"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Response samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-564" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-565" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-565" aria-labelledby="react-tabs-564"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-bBjRSN kQSIAz">application/json</div></div><div class="sc-jgPyTC dSaTNC"><div class="sc-jNnpgg esZIbL"><div class="sc-giAqHp hMPeqJ"><button><div class="sc-carFqZ UksDl">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iJCRrE jCdxGr sc-dPaNzc gyljjx"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"value"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"expires_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"session"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"client_secret"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"value"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"expires_at"</span>: <span class="token number">0</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <span class="token string">"realtime"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"output_modalities"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><span class="token string">"audio"</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"model"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"instructions"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"audio"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"input"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"format"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <span class="token string">"audio/pcm"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"rate"</span>: <span class="token number">24000</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"transcription"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"model"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"language"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"prompt"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"noise_reduction"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"turn_detection"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <span class="token string">"server_vad"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"threshold"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"prefix_padding_ms"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"silence_duration_ms"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"create_response"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"interrupt_response"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"idle_timeout_ms"</span>: <span class="token number">5000</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"output"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"format"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <span class="token string">"audio/pcm"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"rate"</span>: <span class="token number">24000</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"voice"</span>: <span class="token string">"ash"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"speed"</span>: <span class="token number">1</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"include"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><span class="token string">"item.input_audio_transcription.logprobs"</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"tracing"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"tools"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <span class="token string">"function"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"description"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"parameters"</span>: <span class="token punctuation">{ }</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"tool_choice"</span>: <span class="token string">"auto"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"max_output_tokens"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"truncation"</span>: <span class="token string">"auto"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"prompt"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"version"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"variables"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"property1"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"property2"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Realtime/operation/create-realtime-session" data-section-id="tag/Realtime/operation/create-realtime-session" class="sc-eCApnc liLqNm"><div data-section-id="operation/create-realtime-session" id="operation/create-realtime-session" class="sc-iCoGMd gLxhOh"><div class="sc-hKFxyN juinod"><h2 class="sc-pNWdM eftmgB"><a class="sc-crzoAE iUxAWq" href="#tag/Realtime/operation/create-realtime-session" aria-label="tag/Realtime/operation/create-realtime-session"></a>Create an ephemeral API token for use in client-side applications with the
Realtime API. Can be configured with the same session parameters as the
`session.update` client event.
It responds with a session object, plus a `client_secret` key which contains
a usable ephemeral API token that can be used to authenticate browser clients
for the Realtime API.
Returns the created Realtime session object, plus an ephemeral key.
<!-- --> </h2><div class="sc-fcmMJX cvfxAX"><div class="sc-jUfyBS bhDyou"><h5 class="sc-iqAclL sc-fuISkM eONCmm hZIgic">Authorizations:</h5><svg class="sc-dIsUp iPqByX" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jQAxuV ccffaZ"><span class="sc-daBunf fcvuS"><span class="sc-dsXzNU dPrSxx"><i>ApiKeyAuth</i></span></span></div></div><h5 class="sc-iqAclL eONCmm">Request Body schema: <span class="sc-cBoqAE eKyrDP">application/json</span></h5><div class="sc-iJCRrE sc-ciSkZP jCdxGr QGruV"><p>Create an ephemeral API key with the given session configuration.</p>
</div><table class="sc-hHEiqL VCQHZ"><tbody><tr class=""><td class="sc-hBMUJo sc-fFSPTT sc-gSYDnn iwcKgn cAqMTE hTttpy" kind="field" title="client_secret"><span class="sc-iemWCZ bcnRwz"></span><button aria-label="expand properties"><span class="property-name">client_secret</span><svg class="sc-dIsUp hGHhhO" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">object</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>Ephemeral key returned by the API.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="modalities"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">modalities</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa">Array of </span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">strings</span></div><div><span class="sc-laZMeE jWaWWE">Items<!-- --> <!-- -->Enum<!-- -->:</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"text"</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"audio"</span> </div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The set of modalities the model can respond with. To disable audio,
set this to ["text"].</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="instructions"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">instructions</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The default system instructions (i.e. system message) prepended to model calls. This field allows the client to guide the model on desired responses. The model can be instructed on response content and format, (e.g. "be extremely succinct", "act friendly", "here are examples of good responses") and on audio behavior (e.g. "talk quickly", "inject emotion into your voice", "laugh frequently"). The instructions are not guaranteed to be followed by the model, but they provide guidance to the model on the desired behavior.
Note that the server sets default instructions which will be used if this field is not set and are visible in the <code>session.created</code> event at the start of the session.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT sc-gSYDnn iwcKgn cAqMTE hTttpy" kind="field" title="voice"><span class="sc-iemWCZ bcnRwz"></span><button aria-label="expand properties"><span class="property-name">voice</span><svg class="sc-dIsUp hGHhhO" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">(VoiceIdsShared (VoiceIdsShared (string) or VoiceIdsShared (string))) or VoiceIdsOrCustomVoice (object)</span><span class="sc-laZMeE sc-eJocfa jWaWWE bArHDh"> (<!-- -->VoiceIdsOrCustomVoice<!-- -->) </span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The voice the model uses to respond. Supported built-in voices are
<code>alloy</code>, <code>ash</code>, <code>ballad</code>, <code>coral</code>, <code>echo</code>, <code>sage</code>, <code>shimmer</code>, <code>verse</code>,
<code>marin</code>, and <code>cedar</code>. You may also provide a custom voice object with an
<code>id</code>, for example <code>{ "id": "voice_1234" }</code>. Voice cannot be changed during
the session once the model has responded with audio at least once.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="input_audio_format"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">input_audio_format</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The format of input audio. Options are <code>pcm16</code>, <code>g711_ulaw</code>, or <code>g711_alaw</code>.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="output_audio_format"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">output_audio_format</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The format of output audio. Options are <code>pcm16</code>, <code>g711_ulaw</code>, or <code>g711_alaw</code>.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT sc-gSYDnn iwcKgn cAqMTE hTttpy" kind="field" title="input_audio_transcription"><span class="sc-iemWCZ bcnRwz"></span><button aria-label="expand properties"><span class="property-name">input_audio_transcription</span><svg class="sc-dIsUp hGHhhO" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">object</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>Configuration for input audio transcription, defaults to off and can be
set to <code>null</code> to turn off once on. Input audio transcription is not native
to the model, since the model consumes audio directly. Transcription runs
asynchronously and should be treated as rough guidance
rather than the representation understood by the model.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="speed"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">speed</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">number</span><span> <span class="sc-laZMeE sc-FRrlG jWaWWE gHBwqe"> <!-- -->[ 0.25 .. 1.5 ]<!-- --> </span></span></div><div><span class="sc-laZMeE jWaWWE"> <!-- -->Default:<!-- --> </span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">1</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The speed of the model's spoken response. 1.0 is the default speed. 0.25 is
the minimum speed. 1.5 is the maximum speed. This value can only be changed
in between model turns, not while a response is in progress.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT sc-gSYDnn iwcKgn cAqMTE hTttpy" kind="field" title="tracing"><span class="sc-iemWCZ bcnRwz"></span><button aria-label="expand properties"><span class="property-name">tracing</span><svg class="sc-dIsUp hGHhhO" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">Tracing Configuration (string) or Tracing Configuration (object)</span><span class="sc-laZMeE sc-eJocfa jWaWWE bArHDh"> (<!-- -->Tracing Configuration<!-- -->) </span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>Configuration options for tracing. Set to null to disable tracing. Once
tracing is enabled for a session, the configuration cannot be modified.</p>
<p><code>auto</code> will create a trace for the session with default values for the
workflow name, group id, and metadata.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT sc-gSYDnn iwcKgn cAqMTE hTttpy" kind="field" title="turn_detection"><span class="sc-iemWCZ bcnRwz"></span><button aria-label="expand properties"><span class="property-name">turn_detection</span><svg class="sc-dIsUp hGHhhO" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">object</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>Configuration for turn detection. Can be set to <code>null</code> to turn off. Server
VAD means that the model will detect the start and end of speech based on
audio volume and respond at the end of user speech.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT sc-gSYDnn iwcKgn cAqMTE hTttpy" kind="field" title="tools"><span class="sc-iemWCZ bcnRwz"></span><button aria-label="expand properties"><span class="property-name">tools</span><svg class="sc-dIsUp hGHhhO" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa">Array of </span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">objects</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>Tools (functions) available to the model.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="tool_choice"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">tool_choice</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>How the model chooses tools. Options are <code>auto</code>, <code>none</code>, <code>required</code>, or
specify a function.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="temperature"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">temperature</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">number</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>Sampling temperature for the model, limited to [0.6, 1.2]. Defaults to 0.8.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT sc-gSYDnn iwcKgn cAqMTE hTttpy" kind="field" title="max_response_output_tokens"><span class="sc-iemWCZ bcnRwz"></span><button aria-label="expand properties"><span class="property-name">max_response_output_tokens</span><svg class="sc-dIsUp hGHhhO" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">integer or string</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>Maximum number of output tokens for a single assistant response,
inclusive of tool calls. Provide an integer between 1 and 4096 to
limit output tokens, or <code>inf</code> for the maximum available tokens for a
given model. Defaults to <code>inf</code>.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT sc-gSYDnn iwcKgn cAqMTE hTttpy" kind="field" title="truncation"><span class="sc-iemWCZ bcnRwz"></span><button aria-label="expand properties"><span class="property-name">truncation</span><svg class="sc-dIsUp hGHhhO" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string or Retention ratio truncation (object)</span><span class="sc-laZMeE sc-eJocfa jWaWWE bArHDh"> (<!-- -->RealtimeTruncation<!-- -->) </span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div></div></div></td></tr><tr class="last "><td class="sc-hBMUJo sc-fFSPTT sc-gSYDnn iwcKgn cAqMTE hTttpy" kind="field" title="prompt"><span class="sc-iemWCZ bcnRwz"></span><button aria-label="expand properties"><span class="property-name">prompt</span><svg class="sc-dIsUp hGHhhO" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">Prompt (object) or Prompt (null)</span><span class="sc-laZMeE sc-eJocfa jWaWWE bArHDh"> (<!-- -->Prompt<!-- -->) </span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div></div></div></td></tr></tbody></table><div><h3 class="sc-fIxmyt DvFer">Responses</h3><div><button class="sc-htmcrh lbYftx"><svg class="sc-dIsUp dqYXmg" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-fWWYYk cMoEZ">200<!-- --> </strong><span class="sc-jcwpoC eDjFAZ"><p>Session created successfully.</p>
</span></button></div></div></div><div class="sc-jSFjdj sc-gKAaRy gBjRyf gcushC"><div class="sc-EZqKI fWsqvQ"><button class="sc-eEVmNe ilvUMs"><span type="post" class="sc-fmdNqN ldMUmp http-verb post">post</span><span class="sc-jXcxbT fCEUju">/realtime/sessions</span><svg class="sc-dIsUp bRmrKA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ljsmAU flIrdF"><div class="sc-jlZJtj fQkroN"><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div><div tabindex="0" role="button"><div class="sc-dTSzeu dfUAUz"><span>https://api.openai.com/v1</span>/realtime/sessions</div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Request samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="react-tabs-566" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-567" tabindex="0" data-rttab="true">Payload</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-567" aria-labelledby="react-tabs-566"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-bBjRSN kQSIAz">application/json</div></div><div class="sc-jgPyTC dSaTNC"><div class="sc-jNnpgg esZIbL"><div class="sc-giAqHp hMPeqJ"><button><div class="sc-carFqZ UksDl">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iJCRrE jCdxGr sc-dPaNzc gyljjx"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"client_secret"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"value"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"expires_at"</span>: <span class="token number">0</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"modalities"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><span class="token string">"text"</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"instructions"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"voice"</span>: <span class="token string">"ash"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"input_audio_format"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"output_audio_format"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"input_audio_transcription"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"model"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"speed"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"tracing"</span>: <span class="token string">"auto"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"turn_detection"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"threshold"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"prefix_padding_ms"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"silence_duration_ms"</span>: <span class="token number">0</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"tools"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <span class="token string">"function"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"description"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"parameters"</span>: <span class="token punctuation">{ }</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"tool_choice"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"temperature"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"max_response_output_tokens"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"truncation"</span>: <span class="token string">"auto"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"prompt"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"version"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"variables"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"property1"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"property2"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Response samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-568" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-569" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-569" aria-labelledby="react-tabs-568"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-bBjRSN kQSIAz">application/json</div></div><div class="sc-jgPyTC dSaTNC"><div class="sc-jNnpgg esZIbL"><div class="sc-giAqHp hMPeqJ"><button><div class="sc-carFqZ UksDl">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iJCRrE jCdxGr sc-dPaNzc gyljjx"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"object"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"expires_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"include"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><span class="token string">"item.input_audio_transcription.logprobs"</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"model"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"output_modalities"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><span class="token string">"text"</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"instructions"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"audio"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"input"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"format"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <span class="token string">"audio/pcm"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"rate"</span>: <span class="token number">24000</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"transcription"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"model"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"language"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"prompt"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"noise_reduction"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <span class="token string">"near_field"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"turn_detection"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"threshold"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"prefix_padding_ms"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"silence_duration_ms"</span>: <span class="token number">0</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"output"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"format"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <span class="token string">"audio/pcm"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"rate"</span>: <span class="token number">24000</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"voice"</span>: <span class="token string">"ash"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"speed"</span>: <span class="token number">0</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"tracing"</span>: <span class="token string">"auto"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"turn_detection"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"threshold"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"prefix_padding_ms"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"silence_duration_ms"</span>: <span class="token number">0</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"tools"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <span class="token string">"function"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"description"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"parameters"</span>: <span class="token punctuation">{ }</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"tool_choice"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"max_output_tokens"</span>: <span class="token number">0</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Realtime/operation/create-realtime-transcription-session" data-section-id="tag/Realtime/operation/create-realtime-transcription-session" class="sc-eCApnc liLqNm"><div data-section-id="operation/create-realtime-transcription-session" id="operation/create-realtime-transcription-session" class="sc-iCoGMd gLxhOh"><div class="sc-hKFxyN juinod"><h2 class="sc-pNWdM eftmgB"><a class="sc-crzoAE iUxAWq" href="#tag/Realtime/operation/create-realtime-transcription-session" aria-label="tag/Realtime/operation/create-realtime-transcription-session"></a>Create an ephemeral API token for use in client-side applications with the
Realtime API specifically for realtime transcriptions.
Can be configured with the same session parameters as the `transcription_session.update` client event.
It responds with a session object, plus a `client_secret` key which contains
a usable ephemeral API token that can be used to authenticate browser clients
for the Realtime API.
Returns the created Realtime transcription session object, plus an ephemeral key.
<!-- --> </h2><div class="sc-fcmMJX cvfxAX"><div class="sc-jUfyBS bhDyou"><h5 class="sc-iqAclL sc-fuISkM eONCmm hZIgic">Authorizations:</h5><svg class="sc-dIsUp iPqByX" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jQAxuV ccffaZ"><span class="sc-daBunf fcvuS"><span class="sc-dsXzNU dPrSxx"><i>ApiKeyAuth</i></span></span></div></div><h5 class="sc-iqAclL eONCmm">Request Body schema: <span class="sc-cBoqAE eKyrDP">application/json</span></h5><div class="sc-iJCRrE sc-ciSkZP jCdxGr QGruV"><p>Create an ephemeral API key with the given session configuration.</p>
</div><table class="sc-hHEiqL VCQHZ"><tbody><tr class=""><td class="sc-hBMUJo sc-fFSPTT sc-gSYDnn iwcKgn cAqMTE hTttpy" kind="field" title="turn_detection"><span class="sc-iemWCZ bcnRwz"></span><button aria-label="expand properties"><span class="property-name">turn_detection</span><svg class="sc-dIsUp hGHhhO" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">object</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>Configuration for turn detection. Can be set to <code>null</code> to turn off. Server VAD means that the model will detect the start and end of speech based on audio volume and respond at the end of user speech.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT sc-gSYDnn iwcKgn cAqMTE hTttpy" kind="field" title="input_audio_noise_reduction"><span class="sc-iemWCZ bcnRwz"></span><button aria-label="expand properties"><span class="property-name">input_audio_noise_reduction</span><svg class="sc-dIsUp hGHhhO" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">object</span></div><div><span class="sc-laZMeE jWaWWE"> <!-- -->Default:<!-- --> </span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">null</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>Configuration for input audio noise reduction. This can be set to <code>null</code> to turn off.
Noise reduction filters audio added to the input audio buffer before it is sent to VAD and the model.
Filtering the audio can improve VAD and turn detection accuracy (reducing false positives) and model performance by improving perception of the input audio.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="input_audio_format"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">input_audio_format</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div><div><span class="sc-laZMeE jWaWWE"> <!-- -->Default:<!-- --> </span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"pcm16"</span></div><div><span class="sc-laZMeE jWaWWE"> <!-- -->Enum<!-- -->:</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"pcm16"</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"g711_ulaw"</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"g711_alaw"</span> </div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The format of input audio. Options are <code>pcm16</code>, <code>g711_ulaw</code>, or <code>g711_alaw</code>.
For <code>pcm16</code>, input audio must be 16-bit PCM at a 24kHz sample rate,
single channel (mono), and little-endian byte order.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT sc-gSYDnn iwcKgn cAqMTE hTttpy" kind="field" title="input_audio_transcription"><span class="sc-iemWCZ bcnRwz"></span><button aria-label="expand properties"><span class="property-name">input_audio_transcription</span><svg class="sc-dIsUp hGHhhO" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">object</span><span class="sc-laZMeE sc-eJocfa jWaWWE bArHDh"> (<!-- -->AudioTranscription<!-- -->) </span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>Configuration for input audio transcription. The client can optionally set the language and prompt for transcription, these offer additional guidance to the transcription service.</p>
</div></div></div></td></tr><tr class="last "><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="include"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">include</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa">Array of </span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">strings</span></div><div><span class="sc-laZMeE jWaWWE">Items<!-- --> <!-- -->Value<!-- -->:</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"item.input_audio_transcription.logprobs"</span> </div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The set of items to include in the transcription. Current available items are:
<code>item.input_audio_transcription.logprobs</code></p>
</div></div></div></td></tr></tbody></table><div><h3 class="sc-fIxmyt DvFer">Responses</h3><div><button class="sc-htmcrh lbYftx"><svg class="sc-dIsUp dqYXmg" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-fWWYYk cMoEZ">200<!-- --> </strong><span class="sc-jcwpoC eDjFAZ"><p>Session created successfully.</p>
</span></button></div></div></div><div class="sc-jSFjdj sc-gKAaRy gBjRyf gcushC"><div class="sc-EZqKI fWsqvQ"><button class="sc-eEVmNe ilvUMs"><span type="post" class="sc-fmdNqN ldMUmp http-verb post">post</span><span class="sc-jXcxbT fCEUju">/realtime/transcription_sessions</span><svg class="sc-dIsUp bRmrKA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ljsmAU flIrdF"><div class="sc-jlZJtj fQkroN"><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div><div tabindex="0" role="button"><div class="sc-dTSzeu dfUAUz"><span>https://api.openai.com/v1</span>/realtime/transcription_sessions</div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Request samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="react-tabs-570" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-571" tabindex="0" data-rttab="true">Payload</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-571" aria-labelledby="react-tabs-570"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-bBjRSN kQSIAz">application/json</div></div><div class="sc-jgPyTC dSaTNC"><div class="sc-jNnpgg esZIbL"><div class="sc-giAqHp hMPeqJ"><button><div class="sc-carFqZ UksDl">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iJCRrE jCdxGr sc-dPaNzc gyljjx"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"turn_detection"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <span class="token string">"server_vad"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"threshold"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"prefix_padding_ms"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"silence_duration_ms"</span>: <span class="token number">0</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"input_audio_noise_reduction"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"input_audio_format"</span>: <span class="token string">"pcm16"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"input_audio_transcription"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"model"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"language"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"prompt"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"include"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><span class="token string">"item.input_audio_transcription.logprobs"</span></div></li></ul><span class="token punctuation">]</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Response samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-572" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-573" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-573" aria-labelledby="react-tabs-572"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-bBjRSN kQSIAz">application/json</div></div><div class="sc-jgPyTC dSaTNC"><div class="sc-jNnpgg esZIbL"><div class="sc-giAqHp hMPeqJ"><button><div class="sc-carFqZ UksDl">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iJCRrE jCdxGr sc-dPaNzc gyljjx"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"client_secret"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"value"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"expires_at"</span>: <span class="token number">0</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"modalities"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><span class="token string">"text"</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"input_audio_format"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"input_audio_transcription"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"model"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"language"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"prompt"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"turn_detection"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"threshold"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"prefix_padding_ms"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"silence_duration_ms"</span>: <span class="token number">0</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Responses" data-section-id="tag/Responses" class="sc-eCApnc jlMQbh"><div class="sc-iCoGMd gLxhOh"><div class="sc-hKFxyN juinod"><h1 class="sc-fujyAs bpZWeL"><a class="sc-crzoAE iUxAWq" href="#tag/Responses" aria-label="tag/Responses"></a>Responses</h1></div></div></div><div id="tag/Responses/operation/createResponse" data-section-id="tag/Responses/operation/createResponse" class="sc-eCApnc liLqNm"><div data-section-id="operation/createResponse" id="operation/createResponse" class="sc-iCoGMd gLxhOh"><div class="sc-hKFxyN juinod"><h2 class="sc-pNWdM eftmgB"><a class="sc-crzoAE iUxAWq" href="#tag/Responses/operation/createResponse" aria-label="tag/Responses/operation/createResponse"></a>Creates a model response. Provide [text](/docs/guides/text) or
[image](/docs/guides/images) inputs to generate [text](/docs/guides/text)
or [JSON](/docs/guides/structured-outputs) outputs. Have the model call
your own [custom code](/docs/guides/function-calling) or use built-in
[tools](/docs/guides/tools) like [web search](/docs/guides/tools-web-search)
or [file search](/docs/guides/tools-file-search) to use your own data
as input for the model's response.
<!-- --> </h2><div class="sc-fcmMJX cvfxAX"><div class="sc-jUfyBS bhDyou"><h5 class="sc-iqAclL sc-fuISkM eONCmm hZIgic">Authorizations:</h5><svg class="sc-dIsUp iPqByX" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jQAxuV ccffaZ"><span class="sc-daBunf fcvuS"><span class="sc-dsXzNU dPrSxx"><i>ApiKeyAuth</i></span></span></div></div><h5 class="sc-iqAclL eONCmm">Request Body schema: <span class="sc-cBoqAE eKyrDP">application/json</span></h5><div class="sc-iJCRrE sc-ciSkZP jCdxGr QGruV"></div><table class="sc-hHEiqL VCQHZ"><tbody><tr class=""><td class="sc-hBMUJo sc-fFSPTT sc-gSYDnn iwcKgn cAqMTE hTttpy" kind="field" title="metadata"><span class="sc-iemWCZ bcnRwz"></span><button aria-label="expand properties"><span class="property-name">metadata</span><svg class="sc-dIsUp hGHhhO" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">Metadata (object) or Metadata (null)</span><span class="sc-laZMeE sc-eJocfa jWaWWE bArHDh"> (<!-- -->Metadata<!-- -->) </span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT sc-gSYDnn iwcKgn cAqMTE hTttpy" kind="field" title="top_logprobs"><span class="sc-iemWCZ bcnRwz"></span><button aria-label="expand properties"><span class="property-name">top_logprobs</span><svg class="sc-dIsUp hGHhhO" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">integer or integer</span><span> <span class="sc-laZMeE sc-FRrlG jWaWWE gHBwqe"> <!-- -->[ 0 .. 20 ]<!-- --> </span></span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>An integer between 0 and 20 specifying the number of most likely tokens to
return at each token position, each with an associated log probability.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT sc-gSYDnn iwcKgn cAqMTE hTttpy" kind="field" title="temperature"><span class="sc-iemWCZ bcnRwz"></span><button aria-label="expand properties"><span class="property-name">temperature</span><svg class="sc-dIsUp hGHhhO" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">number or null</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT sc-gSYDnn iwcKgn cAqMTE hTttpy" kind="field" title="top_p"><span class="sc-iemWCZ bcnRwz"></span><button aria-label="expand properties"><span class="property-name">top_p</span><svg class="sc-dIsUp hGHhhO" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">number or null</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE deprecated" kind="field" title="user"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">user</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div><div><span type="warning" class="sc-bqGGPW eSYQnm"> <!-- -->Deprecated<!-- --> </span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>This field is being replaced by <code>safety_identifier</code> and <code>prompt_cache_key</code>. Use <code>prompt_cache_key</code> instead to maintain caching optimizations.
A stable identifier for your end-users.
Used to boost cache hit rates by better bucketing similar requests and to help OpenAI detect and prevent abuse. <a href="/docs/guides/safety-best-practices#safety-identifiers">Learn more</a>.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="safety_identifier"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">safety_identifier</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span><span> <span class="sc-laZMeE sc-FRrlG jWaWWE gHBwqe"> <!-- --><= 64 characters<!-- --> </span></span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>A stable identifier used to help detect users of your application that may be violating OpenAI's usage policies.
The IDs should be a string that uniquely identifies each user, with a maximum length of 64 characters. We recommend hashing their username or email address, in order to avoid sending us any identifying information. <a href="/docs/guides/safety-best-practices#safety-identifiers">Learn more</a>.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="prompt_cache_key"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">prompt_cache_key</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>Used by OpenAI to cache responses for similar requests to optimize your cache hit rates. Replaces the <code>user</code> field. <a href="/docs/guides/prompt-caching">Learn more</a>.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT sc-gSYDnn iwcKgn cAqMTE hTttpy" kind="field" title="service_tier"><span class="sc-iemWCZ bcnRwz"></span><button aria-label="expand properties"><span class="property-name">service_tier</span><svg class="sc-dIsUp hGHhhO" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">ServiceTier (string) or ServiceTier (null)</span><span class="sc-laZMeE sc-eJocfa jWaWWE bArHDh"> (<!-- -->ServiceTier<!-- -->) </span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT sc-gSYDnn iwcKgn cAqMTE hTttpy" kind="field" title="prompt_cache_retention"><span class="sc-iemWCZ bcnRwz"></span><button aria-label="expand properties"><span class="property-name">prompt_cache_retention</span><svg class="sc-dIsUp hGHhhO" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string or null</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT sc-gSYDnn iwcKgn cAqMTE hTttpy" kind="field" title="previous_response_id"><span class="sc-iemWCZ bcnRwz"></span><button aria-label="expand properties"><span class="property-name">previous_response_id</span><svg class="sc-dIsUp hGHhhO" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string or null</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT sc-gSYDnn iwcKgn cAqMTE hTttpy" kind="field" title="model"><span class="sc-iemWCZ bcnRwz"></span><button aria-label="expand properties"><span class="property-name">model</span><svg class="sc-dIsUp hGHhhO" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">(ModelIdsShared (ModelIdsShared (string) or ModelIdsShared (string))) or ResponsesOnlyModel (string)</span><span class="sc-laZMeE sc-eJocfa jWaWWE bArHDh"> (<!-- -->ModelIdsResponses<!-- -->) </span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>Model ID used to generate the response, like <code>gpt-4o</code> or <code>o3</code>. OpenAI
offers a wide range of models with different capabilities, performance
characteristics, and price points. Refer to the <a href="/docs/models">model guide</a>
to browse and compare available models.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT sc-gSYDnn iwcKgn cAqMTE hTttpy" kind="field" title="reasoning"><span class="sc-iemWCZ bcnRwz"></span><button aria-label="expand properties"><span class="property-name">reasoning</span><svg class="sc-dIsUp hGHhhO" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">Reasoning (object) or null</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT sc-gSYDnn iwcKgn cAqMTE hTttpy" kind="field" title="background"><span class="sc-iemWCZ bcnRwz"></span><button aria-label="expand properties"><span class="property-name">background</span><svg class="sc-dIsUp hGHhhO" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">boolean or null</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT sc-gSYDnn iwcKgn cAqMTE hTttpy" kind="field" title="max_tool_calls"><span class="sc-iemWCZ bcnRwz"></span><button aria-label="expand properties"><span class="property-name">max_tool_calls</span><svg class="sc-dIsUp hGHhhO" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">integer or null</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT sc-gSYDnn iwcKgn cAqMTE hTttpy" kind="field" title="text"><span class="sc-iemWCZ bcnRwz"></span><button aria-label="expand properties"><span class="property-name">text</span><svg class="sc-dIsUp hGHhhO" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">object</span><span class="sc-laZMeE sc-eJocfa jWaWWE bArHDh"> (<!-- -->ResponseTextParam<!-- -->) </span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>Configuration options for a text response from the model. Can be plain
text or structured JSON data. Learn more:</p>
<ul>
<li><a href="/docs/guides/text">Text inputs and outputs</a></li>
<li><a href="/docs/guides/structured-outputs">Structured Outputs</a></li>
</ul>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT sc-gSYDnn iwcKgn cAqMTE hTttpy" kind="field" title="tools"><span class="sc-iemWCZ bcnRwz"></span><button aria-label="expand properties"><span class="property-name">tools</span><svg class="sc-dIsUp hGHhhO" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa">Array of </span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">any</span><span class="sc-laZMeE sc-eJocfa jWaWWE bArHDh"> (<!-- -->ToolsArray<!-- -->) </span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>An array of tools the model may call while generating a response. You
can specify which tool to use by setting the <code>tool_choice</code> parameter.</p>
<p>We support the following categories of tools:</p>
<ul>
<li><strong>Built-in tools</strong>: Tools that are provided by OpenAI that extend the
model's capabilities, like <a href="/docs/guides/tools-web-search">web search</a>
or <a href="/docs/guides/tools-file-search">file search</a>. Learn more about
<a href="/docs/guides/tools">built-in tools</a>.</li>
<li><strong>MCP Tools</strong>: Integrations with third-party systems via custom MCP servers
or predefined connectors such as Google Drive and SharePoint. Learn more about
<a href="/docs/guides/tools-connectors-mcp">MCP Tools</a>.</li>
<li><strong>Function calls (custom tools)</strong>: Functions that are defined by you,
enabling the model to call your own code with strongly typed arguments
and outputs. Learn more about
<a href="/docs/guides/function-calling">function calling</a>. You can also use
custom tools to call your own code.</li>
</ul>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT sc-gSYDnn iwcKgn cAqMTE hTttpy" kind="field" title="tool_choice"><span class="sc-iemWCZ bcnRwz"></span><button aria-label="expand properties"><span class="property-name">tool_choice</span><svg class="sc-dIsUp hGHhhO" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">Tool choice mode (string) or Allowed tools (object) or Hosted tool (object) or Function tool (object) or MCP tool (object) or Custom tool (object) or Specific apply patch tool choice (object) or Specific shell tool choice (object)</span><span class="sc-laZMeE sc-eJocfa jWaWWE bArHDh"> (<!-- -->ToolChoiceParam<!-- -->) </span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT sc-gSYDnn iwcKgn cAqMTE hTttpy" kind="field" title="prompt"><span class="sc-iemWCZ bcnRwz"></span><button aria-label="expand properties"><span class="property-name">prompt</span><svg class="sc-dIsUp hGHhhO" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">Prompt (object) or Prompt (null)</span><span class="sc-laZMeE sc-eJocfa jWaWWE bArHDh"> (<!-- -->Prompt<!-- -->) </span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT sc-gSYDnn iwcKgn cAqMTE hTttpy" kind="field" title="truncation"><span class="sc-iemWCZ bcnRwz"></span><button aria-label="expand properties"><span class="property-name">truncation</span><svg class="sc-dIsUp hGHhhO" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string or null</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT sc-gSYDnn iwcKgn cAqMTE hTttpy" kind="field" title="input"><span class="sc-iemWCZ bcnRwz"></span><button aria-label="expand properties"><span class="property-name">input</span><svg class="sc-dIsUp hGHhhO" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">Text input (string) or Array of Input item list (any)</span><span class="sc-laZMeE sc-eJocfa jWaWWE bArHDh"> (<!-- -->InputParam<!-- -->) </span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT sc-gSYDnn iwcKgn cAqMTE hTttpy" kind="field" title="include"><span class="sc-iemWCZ bcnRwz"></span><button aria-label="expand properties"><span class="property-name">include</span><svg class="sc-dIsUp hGHhhO" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">Array of IncludeEnum (strings) or null</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT sc-gSYDnn iwcKgn cAqMTE hTttpy" kind="field" title="parallel_tool_calls"><span class="sc-iemWCZ bcnRwz"></span><button aria-label="expand properties"><span class="property-name">parallel_tool_calls</span><svg class="sc-dIsUp hGHhhO" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">boolean or null</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT sc-gSYDnn iwcKgn cAqMTE hTttpy" kind="field" title="store"><span class="sc-iemWCZ bcnRwz"></span><button aria-label="expand properties"><span class="property-name">store</span><svg class="sc-dIsUp hGHhhO" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">boolean or null</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT sc-gSYDnn iwcKgn cAqMTE hTttpy" kind="field" title="instructions"><span class="sc-iemWCZ bcnRwz"></span><button aria-label="expand properties"><span class="property-name">instructions</span><svg class="sc-dIsUp hGHhhO" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string or null</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT sc-gSYDnn iwcKgn cAqMTE hTttpy" kind="field" title="stream"><span class="sc-iemWCZ bcnRwz"></span><button aria-label="expand properties"><span class="property-name">stream</span><svg class="sc-dIsUp hGHhhO" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">boolean or null</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT sc-gSYDnn iwcKgn cAqMTE hTttpy" kind="field" title="stream_options"><span class="sc-iemWCZ bcnRwz"></span><button aria-label="expand properties"><span class="property-name">stream_options</span><svg class="sc-dIsUp hGHhhO" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">ResponseStreamOptions (object) or ResponseStreamOptions (null)</span><span class="sc-laZMeE sc-eJocfa jWaWWE bArHDh"> (<!-- -->ResponseStreamOptions<!-- -->) </span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT sc-gSYDnn iwcKgn cAqMTE hTttpy" kind="field" title="conversation"><span class="sc-iemWCZ bcnRwz"></span><button aria-label="expand properties"><span class="property-name">conversation</span><svg class="sc-dIsUp hGHhhO" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">(ConversationParam (Conversation ID (string) or Conversation object (object))) or null</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT sc-gSYDnn iwcKgn cAqMTE hTttpy" kind="field" title="context_management"><span class="sc-iemWCZ bcnRwz"></span><button aria-label="expand properties"><span class="property-name">context_management</span><svg class="sc-dIsUp hGHhhO" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">Array of ContextManagementParam (objects) or null</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div></div></div></td></tr><tr class="last "><td class="sc-hBMUJo sc-fFSPTT sc-gSYDnn iwcKgn cAqMTE hTttpy" kind="field" title="max_output_tokens"><span class="sc-iemWCZ bcnRwz"></span><button aria-label="expand properties"><span class="property-name">max_output_tokens</span><svg class="sc-dIsUp hGHhhO" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">integer or null</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div></div></div></td></tr></tbody></table><div><h3 class="sc-fIxmyt DvFer">Responses</h3><div><button class="sc-htmcrh lbYftx"><svg class="sc-dIsUp dqYXmg" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-fWWYYk cMoEZ">200<!-- --> </strong><span class="sc-jcwpoC eDjFAZ"><p>OK</p>
</span></button></div></div></div><div class="sc-jSFjdj sc-gKAaRy gBjRyf gcushC"><div class="sc-EZqKI fWsqvQ"><button class="sc-eEVmNe ilvUMs"><span type="post" class="sc-fmdNqN ldMUmp http-verb post">post</span><span class="sc-jXcxbT fCEUju">/responses</span><svg class="sc-dIsUp bRmrKA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ljsmAU flIrdF"><div class="sc-jlZJtj fQkroN"><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div><div tabindex="0" role="button"><div class="sc-dTSzeu dfUAUz"><span>https://api.openai.com/v1</span>/responses</div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Request samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="react-tabs-574" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-575" tabindex="0" data-rttab="true">Payload</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-575" aria-labelledby="react-tabs-574"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-bBjRSN kQSIAz">application/json</div></div><div class="sc-jgPyTC dSaTNC"><div class="sc-jNnpgg esZIbL"><div class="sc-giAqHp hMPeqJ"><button><div class="sc-carFqZ UksDl">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iJCRrE jCdxGr sc-dPaNzc gyljjx"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"metadata"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"property1"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"property2"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"top_logprobs"</span>: <span class="token number">20</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"temperature"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"top_p"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"user"</span>: <span class="token string">"user-1234"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"safety_identifier"</span>: <span class="token string">"safety-identifier-1234"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"prompt_cache_key"</span>: <span class="token string">"prompt-cache-key-1234"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"service_tier"</span>: <span class="token string">"auto"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"prompt_cache_retention"</span>: <span class="token string">"in_memory"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"previous_response_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"model"</span>: <span class="token string">"gpt-5.1"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"reasoning"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"effort"</span>: <span class="token string">"none"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"summary"</span>: <span class="token string">"auto"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"generate_summary"</span>: <span class="token string">"auto"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"background"</span>: <span class="token boolean">false</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"max_tool_calls"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"text"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"format"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <span class="token string">"text"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"verbosity"</span>: <span class="token string">"low"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"tools"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <span class="token string">"function"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"description"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"parameters"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"property1"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"property2"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"strict"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"defer_loading"</span>: <span class="token boolean">true</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"tool_choice"</span>: <span class="token string">"none"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"prompt"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"version"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"variables"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"property1"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"property2"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"truncation"</span>: <span class="token string">"auto"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"input"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"include"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><span class="token string">"file_search_call.results"</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"parallel_tool_calls"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"store"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"instructions"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"stream"</span>: <span class="token boolean">false</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"stream_options"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"conversation"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"context_management"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"compact_threshold"</span>: <span class="token number">1000</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"max_output_tokens"</span>: <span class="token number">16</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Response samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-576" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-577" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-577" aria-labelledby="react-tabs-576"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-hiKfDv sc-khIgEk bycQNU hLNtis"><svg class="sc-jJMGnK gVpQmv" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option selected="" value="application/json">application/json</option><option value="text/event-stream">text/event-stream</option></select><label>application/json</label></div></div><div class="sc-jgPyTC dSaTNC"><div class="sc-jNnpgg esZIbL"><div class="sc-giAqHp hMPeqJ"><button><div class="sc-carFqZ UksDl">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iJCRrE jCdxGr sc-dPaNzc gyljjx"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">"resp_67ccd3a9da748190baa7f1570fe91ac604becb25c45c1d41"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"object"</span>: <span class="token string">"response"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"created_at"</span>: <span class="token number">1741476777</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token string">"completed"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"completed_at"</span>: <span class="token number">1741476778</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"error"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"incomplete_details"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"instructions"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"max_output_tokens"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"model"</span>: <span class="token string">"gpt-4o-2024-08-06"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"output"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <span class="token string">"message"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"id"</span>: <span class="token string">"msg_67ccd3acc8d48190a77525dc6de64b4104becb25c45c1d41"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"status"</span>: <span class="token string">"completed"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"role"</span>: <span class="token string">"assistant"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"content"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <span class="token string">"output_text"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"text"</span>: <span class="token string">"The image depicts a scenic landscape with a wooden boardwalk or pathway leading through lush, green grass under a blue sky with some clouds. The setting suggests a peaceful natural area, possibly a park or nature reserve. There are trees and shrubs in the background."</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"annotations"</span>: <span class="token punctuation">[ ]</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"parallel_tool_calls"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"previous_response_id"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"reasoning"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"effort"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"summary"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"store"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"temperature"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"text"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"format"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <span class="token string">"text"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"tool_choice"</span>: <span class="token string">"auto"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"tools"</span>: <span class="token punctuation">[ ]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"top_p"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"truncation"</span>: <span class="token string">"disabled"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"usage"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"input_tokens"</span>: <span class="token number">328</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"input_tokens_details"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"cached_tokens"</span>: <span class="token number">0</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"output_tokens"</span>: <span class="token number">52</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"output_tokens_details"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"reasoning_tokens"</span>: <span class="token number">0</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"total_tokens"</span>: <span class="token number">380</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"user"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Responses/operation/getResponse" data-section-id="tag/Responses/operation/getResponse" class="sc-eCApnc liLqNm"><div data-section-id="operation/getResponse" id="operation/getResponse" class="sc-iCoGMd gLxhOh"><div class="sc-hKFxyN juinod"><h2 class="sc-pNWdM eftmgB"><a class="sc-crzoAE iUxAWq" href="#tag/Responses/operation/getResponse" aria-label="tag/Responses/operation/getResponse"></a>Retrieves a model response with the given ID.
<!-- --> </h2><div class="sc-fcmMJX cvfxAX"><div class="sc-jUfyBS bhDyou"><h5 class="sc-iqAclL sc-fuISkM eONCmm hZIgic">Authorizations:</h5><svg class="sc-dIsUp iPqByX" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jQAxuV ccffaZ"><span class="sc-daBunf fcvuS"><span class="sc-dsXzNU dPrSxx"><i>ApiKeyAuth</i></span></span></div></div><div><h5 class="sc-iqAclL eONCmm">path<!-- --> Parameters</h5><table class="sc-hHEiqL VCQHZ"><tbody><tr class="last "><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="response_id"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">response_id</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><span class="sc-laZMeE jWaWWE"> <!-- -->Example:<!-- --> </span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">resp_677efb5139a88190b512bc3fef8e535d</span></div><div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The ID of the response to retrieve.</p>
</div></div></div></td></tr></tbody></table></div><div><h5 class="sc-iqAclL eONCmm">query<!-- --> Parameters</h5><table class="sc-hHEiqL VCQHZ"><tbody><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="include"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">include</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa">Array of </span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">strings</span><span class="sc-laZMeE sc-eJocfa jWaWWE bArHDh"> (<!-- -->IncludeEnum<!-- -->) </span></div><div><span class="sc-laZMeE jWaWWE">Items<!-- --> <!-- -->Enum<!-- -->:</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"file_search_call.results"</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"web_search_call.results"</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"web_search_call.action.sources"</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"message.input_image.image_url"</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"computer_call_output.output.image_url"</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"code_interpreter_call.outputs"</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"reasoning.encrypted_content"</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"message.output_text.logprobs"</span> </div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>Additional fields to include in the response. See the <code>include</code>
parameter for Response creation above for more information.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="stream"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">stream</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">boolean</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>If set to true, the model response data will be streamed to the client
as it is generated using <a href="https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events/Using_server-sent_events#Event_stream_format">server-sent events</a>.
See the <a href="/docs/api-reference/responses-streaming">Streaming section below</a>
for more information.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="starting_after"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">starting_after</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">integer</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The sequence number of the event after which to start streaming.</p>
</div></div></div></td></tr><tr class="last "><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="include_obfuscation"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">include_obfuscation</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">boolean</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>When true, stream obfuscation will be enabled. Stream obfuscation adds
random characters to an <code>obfuscation</code> field on streaming delta events
to normalize payload sizes as a mitigation to certain side-channel
attacks. These obfuscation fields are included by default, but add a
small amount of overhead to the data stream. You can set
<code>include_obfuscation</code> to false to optimize for bandwidth if you trust
the network links between your application and the OpenAI API.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-fIxmyt DvFer">Responses</h3><div><button class="sc-htmcrh lbYftx"><svg class="sc-dIsUp dqYXmg" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-fWWYYk cMoEZ">200<!-- --> </strong><span class="sc-jcwpoC eDjFAZ"><p>OK</p>
</span></button></div></div></div><div class="sc-jSFjdj sc-gKAaRy gBjRyf gcushC"><div class="sc-EZqKI fWsqvQ"><button class="sc-eEVmNe ilvUMs"><span type="get" class="sc-fmdNqN ihNycv http-verb get">get</span><span class="sc-jXcxbT fCEUju">/responses/{response_id}</span><svg class="sc-dIsUp bRmrKA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ljsmAU flIrdF"><div class="sc-jlZJtj fQkroN"><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div><div tabindex="0" role="button"><div class="sc-dTSzeu dfUAUz"><span>https://api.openai.com/v1</span>/responses/{response_id}</div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Response samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-578" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-579" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-579" aria-labelledby="react-tabs-578"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-bBjRSN kQSIAz">application/json</div></div><div class="sc-jgPyTC dSaTNC"><div class="sc-jNnpgg esZIbL"><div class="sc-giAqHp hMPeqJ"><button><div class="sc-carFqZ UksDl">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iJCRrE jCdxGr sc-dPaNzc gyljjx"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">"resp_67ccd3a9da748190baa7f1570fe91ac604becb25c45c1d41"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"object"</span>: <span class="token string">"response"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"created_at"</span>: <span class="token number">1741476777</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token string">"completed"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"completed_at"</span>: <span class="token number">1741476778</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"error"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"incomplete_details"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"instructions"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"max_output_tokens"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"model"</span>: <span class="token string">"gpt-4o-2024-08-06"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"output"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <span class="token string">"message"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"id"</span>: <span class="token string">"msg_67ccd3acc8d48190a77525dc6de64b4104becb25c45c1d41"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"status"</span>: <span class="token string">"completed"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"role"</span>: <span class="token string">"assistant"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"content"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <span class="token string">"output_text"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"text"</span>: <span class="token string">"The image depicts a scenic landscape with a wooden boardwalk or pathway leading through lush, green grass under a blue sky with some clouds. The setting suggests a peaceful natural area, possibly a park or nature reserve. There are trees and shrubs in the background."</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"annotations"</span>: <span class="token punctuation">[ ]</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"parallel_tool_calls"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"previous_response_id"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"reasoning"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"effort"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"summary"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"store"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"temperature"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"text"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"format"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <span class="token string">"text"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"tool_choice"</span>: <span class="token string">"auto"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"tools"</span>: <span class="token punctuation">[ ]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"top_p"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"truncation"</span>: <span class="token string">"disabled"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"usage"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"input_tokens"</span>: <span class="token number">328</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"input_tokens_details"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"cached_tokens"</span>: <span class="token number">0</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"output_tokens"</span>: <span class="token number">52</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"output_tokens_details"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"reasoning_tokens"</span>: <span class="token number">0</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"total_tokens"</span>: <span class="token number">380</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"user"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Responses/operation/deleteResponse" data-section-id="tag/Responses/operation/deleteResponse" class="sc-eCApnc liLqNm"><div data-section-id="operation/deleteResponse" id="operation/deleteResponse" class="sc-iCoGMd gLxhOh"><div class="sc-hKFxyN juinod"><h2 class="sc-pNWdM eftmgB"><a class="sc-crzoAE iUxAWq" href="#tag/Responses/operation/deleteResponse" aria-label="tag/Responses/operation/deleteResponse"></a>Deletes a model response with the given ID.
<!-- --> </h2><div class="sc-fcmMJX cvfxAX"><div class="sc-jUfyBS bhDyou"><h5 class="sc-iqAclL sc-fuISkM eONCmm hZIgic">Authorizations:</h5><svg class="sc-dIsUp iPqByX" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jQAxuV ccffaZ"><span class="sc-daBunf fcvuS"><span class="sc-dsXzNU dPrSxx"><i>ApiKeyAuth</i></span></span></div></div><div><h5 class="sc-iqAclL eONCmm">path<!-- --> Parameters</h5><table class="sc-hHEiqL VCQHZ"><tbody><tr class="last "><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="response_id"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">response_id</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><span class="sc-laZMeE jWaWWE"> <!-- -->Example:<!-- --> </span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">resp_677efb5139a88190b512bc3fef8e535d</span></div><div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The ID of the response to delete.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-fIxmyt DvFer">Responses</h3><div><button class="sc-htmcrh jUGDyD" disabled=""><strong class="sc-fWWYYk cMoEZ">200<!-- --> </strong><span class="sc-jcwpoC eDjFAZ"><p>OK</p>
</span></button></div><div><button class="sc-htmcrh NAUPn"><svg class="sc-dIsUp dVWHLw" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-fWWYYk cMoEZ">404<!-- --> </strong><span class="sc-jcwpoC eDjFAZ"><p>Not Found</p>
</span></button></div></div></div><div class="sc-jSFjdj sc-gKAaRy gBjRyf gcushC"><div class="sc-EZqKI fWsqvQ"><button class="sc-eEVmNe ilvUMs"><span type="delete" class="sc-fmdNqN bJzUtf http-verb delete">delete</span><span class="sc-jXcxbT fCEUju">/responses/{response_id}</span><svg class="sc-dIsUp bRmrKA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ljsmAU flIrdF"><div class="sc-jlZJtj fQkroN"><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div><div tabindex="0" role="button"><div class="sc-dTSzeu dfUAUz"><span>https://api.openai.com/v1</span>/responses/{response_id}</div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Response samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-error react-tabs__tab--selected" role="tab" id="react-tabs-580" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-581" tabindex="0" data-rttab="true">404</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-581" aria-labelledby="react-tabs-580"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-bBjRSN kQSIAz">application/json</div></div><div class="sc-jgPyTC dSaTNC"><div class="sc-jNnpgg esZIbL"><div class="sc-giAqHp hMPeqJ"><button><div class="sc-carFqZ UksDl">Copy</div></button></div><div class="sc-iJCRrE jCdxGr sc-dPaNzc gyljjx"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"code"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"message"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"param"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"type"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Responses/operation/cancelResponse" data-section-id="tag/Responses/operation/cancelResponse" class="sc-eCApnc liLqNm"><div data-section-id="operation/cancelResponse" id="operation/cancelResponse" class="sc-iCoGMd gLxhOh"><div class="sc-hKFxyN juinod"><h2 class="sc-pNWdM eftmgB"><a class="sc-crzoAE iUxAWq" href="#tag/Responses/operation/cancelResponse" aria-label="tag/Responses/operation/cancelResponse"></a>Cancels a model response with the given ID. Only responses created with
the `background` parameter set to `true` can be cancelled.
[Learn more](/docs/guides/background).
<!-- --> </h2><div class="sc-fcmMJX cvfxAX"><div class="sc-jUfyBS bhDyou"><h5 class="sc-iqAclL sc-fuISkM eONCmm hZIgic">Authorizations:</h5><svg class="sc-dIsUp iPqByX" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jQAxuV ccffaZ"><span class="sc-daBunf fcvuS"><span class="sc-dsXzNU dPrSxx"><i>ApiKeyAuth</i></span></span></div></div><div><h5 class="sc-iqAclL eONCmm">path<!-- --> Parameters</h5><table class="sc-hHEiqL VCQHZ"><tbody><tr class="last "><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="response_id"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">response_id</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><span class="sc-laZMeE jWaWWE"> <!-- -->Example:<!-- --> </span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">resp_677efb5139a88190b512bc3fef8e535d</span></div><div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The ID of the response to cancel.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-fIxmyt DvFer">Responses</h3><div><button class="sc-htmcrh lbYftx"><svg class="sc-dIsUp dqYXmg" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-fWWYYk cMoEZ">200<!-- --> </strong><span class="sc-jcwpoC eDjFAZ"><p>OK</p>
</span></button></div><div><button class="sc-htmcrh NAUPn"><svg class="sc-dIsUp dVWHLw" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-fWWYYk cMoEZ">404<!-- --> </strong><span class="sc-jcwpoC eDjFAZ"><p>Not Found</p>
</span></button></div></div></div><div class="sc-jSFjdj sc-gKAaRy gBjRyf gcushC"><div class="sc-EZqKI fWsqvQ"><button class="sc-eEVmNe ilvUMs"><span type="post" class="sc-fmdNqN ldMUmp http-verb post">post</span><span class="sc-jXcxbT fCEUju">/responses/{response_id}/cancel</span><svg class="sc-dIsUp bRmrKA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ljsmAU flIrdF"><div class="sc-jlZJtj fQkroN"><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div><div tabindex="0" role="button"><div class="sc-dTSzeu dfUAUz"><span>https://api.openai.com/v1</span>/responses/{response_id}/cancel</div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Response samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-582" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-583" tabindex="0" data-rttab="true">200</li><li class="tab-error" role="tab" id="react-tabs-584" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-585" data-rttab="true">404</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-583" aria-labelledby="react-tabs-582"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-bBjRSN kQSIAz">application/json</div></div><div class="sc-jgPyTC dSaTNC"><div class="sc-jNnpgg esZIbL"><div class="sc-giAqHp hMPeqJ"><button><div class="sc-carFqZ UksDl">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iJCRrE jCdxGr sc-dPaNzc gyljjx"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">"resp_67ccd3a9da748190baa7f1570fe91ac604becb25c45c1d41"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"object"</span>: <span class="token string">"response"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"created_at"</span>: <span class="token number">1741476777</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token string">"completed"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"completed_at"</span>: <span class="token number">1741476778</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"error"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"incomplete_details"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"instructions"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"max_output_tokens"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"model"</span>: <span class="token string">"gpt-4o-2024-08-06"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"output"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <span class="token string">"message"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"id"</span>: <span class="token string">"msg_67ccd3acc8d48190a77525dc6de64b4104becb25c45c1d41"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"status"</span>: <span class="token string">"completed"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"role"</span>: <span class="token string">"assistant"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"content"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <span class="token string">"output_text"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"text"</span>: <span class="token string">"The image depicts a scenic landscape with a wooden boardwalk or pathway leading through lush, green grass under a blue sky with some clouds. The setting suggests a peaceful natural area, possibly a park or nature reserve. There are trees and shrubs in the background."</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"annotations"</span>: <span class="token punctuation">[ ]</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"parallel_tool_calls"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"previous_response_id"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"reasoning"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"effort"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"summary"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"store"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"temperature"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"text"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"format"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <span class="token string">"text"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"tool_choice"</span>: <span class="token string">"auto"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"tools"</span>: <span class="token punctuation">[ ]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"top_p"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"truncation"</span>: <span class="token string">"disabled"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"usage"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"input_tokens"</span>: <span class="token number">328</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"input_tokens_details"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"cached_tokens"</span>: <span class="token number">0</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"output_tokens"</span>: <span class="token number">52</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"output_tokens_details"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"reasoning_tokens"</span>: <span class="token number">0</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"total_tokens"</span>: <span class="token number">380</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"user"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-585" aria-labelledby="react-tabs-584"></div></div></div></div></div></div><div id="tag/Responses/operation/listInputItems" data-section-id="tag/Responses/operation/listInputItems" class="sc-eCApnc liLqNm"><div data-section-id="operation/listInputItems" id="operation/listInputItems" class="sc-iCoGMd gLxhOh"><div class="sc-hKFxyN juinod"><h2 class="sc-pNWdM eftmgB"><a class="sc-crzoAE iUxAWq" href="#tag/Responses/operation/listInputItems" aria-label="tag/Responses/operation/listInputItems"></a>Returns a list of input items for a given response.<!-- --> </h2><div class="sc-fcmMJX cvfxAX"><div class="sc-jUfyBS bhDyou"><h5 class="sc-iqAclL sc-fuISkM eONCmm hZIgic">Authorizations:</h5><svg class="sc-dIsUp iPqByX" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jQAxuV ccffaZ"><span class="sc-daBunf fcvuS"><span class="sc-dsXzNU dPrSxx"><i>ApiKeyAuth</i></span></span></div></div><div><h5 class="sc-iqAclL eONCmm">path<!-- --> Parameters</h5><table class="sc-hHEiqL VCQHZ"><tbody><tr class="last "><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="response_id"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">response_id</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The ID of the response to retrieve input items for.</p>
</div></div></div></td></tr></tbody></table></div><div><h5 class="sc-iqAclL eONCmm">query<!-- --> Parameters</h5><table class="sc-hHEiqL VCQHZ"><tbody><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="limit"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">limit</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">integer</span></div><div><span class="sc-laZMeE jWaWWE"> <!-- -->Default:<!-- --> </span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">20</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>A limit on the number of objects to be returned. Limit can range between
1 and 100, and the default is 20.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="order"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">order</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div><div><span class="sc-laZMeE jWaWWE"> <!-- -->Enum<!-- -->:</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"asc"</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"desc"</span> </div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The order to return the input items in. Default is <code>desc</code>.</p>
<ul>
<li><code>asc</code>: Return the input items in ascending order.</li>
<li><code>desc</code>: Return the input items in descending order.</li>
</ul>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="after"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">after</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>An item ID to list items after, used in pagination.</p>
</div></div></div></td></tr><tr class="last "><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="include"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">include</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa">Array of </span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">strings</span><span class="sc-laZMeE sc-eJocfa jWaWWE bArHDh"> (<!-- -->IncludeEnum<!-- -->) </span></div><div><span class="sc-laZMeE jWaWWE">Items<!-- --> <!-- -->Enum<!-- -->:</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"file_search_call.results"</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"web_search_call.results"</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"web_search_call.action.sources"</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"message.input_image.image_url"</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"computer_call_output.output.image_url"</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"code_interpreter_call.outputs"</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"reasoning.encrypted_content"</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"message.output_text.logprobs"</span> </div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>Additional fields to include in the response. See the <code>include</code>
parameter for Response creation above for more information.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-fIxmyt DvFer">Responses</h3><div><button class="sc-htmcrh lbYftx"><svg class="sc-dIsUp dqYXmg" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-fWWYYk cMoEZ">200<!-- --> </strong><span class="sc-jcwpoC eDjFAZ"><p>OK</p>
</span></button></div></div></div><div class="sc-jSFjdj sc-gKAaRy gBjRyf gcushC"><div class="sc-EZqKI fWsqvQ"><button class="sc-eEVmNe ilvUMs"><span type="get" class="sc-fmdNqN ihNycv http-verb get">get</span><span class="sc-jXcxbT fCEUju">/responses/{response_id}/input_items</span><svg class="sc-dIsUp bRmrKA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ljsmAU flIrdF"><div class="sc-jlZJtj fQkroN"><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div><div tabindex="0" role="button"><div class="sc-dTSzeu dfUAUz"><span>https://api.openai.com/v1</span>/responses/{response_id}/input_items</div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Response samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-586" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-587" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-587" aria-labelledby="react-tabs-586"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-bBjRSN kQSIAz">application/json</div></div><div class="sc-jgPyTC dSaTNC"><div class="sc-jNnpgg esZIbL"><div class="sc-giAqHp hMPeqJ"><button><div class="sc-carFqZ UksDl">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iJCRrE jCdxGr sc-dPaNzc gyljjx"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"object"</span>: <span class="token string">"list"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <span class="token string">"message"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"role"</span>: <span class="token string">"user"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"status"</span>: <span class="token string">"in_progress"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"content"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <span class="token string">"input_text"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"text"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"id"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"has_more"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"first_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"last_id"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Vector-stores" data-section-id="tag/Vector-stores" class="sc-eCApnc jlMQbh"><div class="sc-iCoGMd gLxhOh"><div class="sc-hKFxyN juinod"><h1 class="sc-fujyAs bpZWeL"><a class="sc-crzoAE iUxAWq" href="#tag/Vector-stores" aria-label="tag/Vector-stores"></a>Vector stores</h1></div></div></div><div id="tag/Vector-stores/operation/listVectorStores" data-section-id="tag/Vector-stores/operation/listVectorStores" class="sc-eCApnc liLqNm"><div data-section-id="operation/listVectorStores" id="operation/listVectorStores" class="sc-iCoGMd gLxhOh"><div class="sc-hKFxyN juinod"><h2 class="sc-pNWdM eftmgB"><a class="sc-crzoAE iUxAWq" href="#tag/Vector-stores/operation/listVectorStores" aria-label="tag/Vector-stores/operation/listVectorStores"></a>Returns a list of vector stores.<!-- --> </h2><div class="sc-fcmMJX cvfxAX"><div class="sc-jUfyBS bhDyou"><h5 class="sc-iqAclL sc-fuISkM eONCmm hZIgic">Authorizations:</h5><svg class="sc-dIsUp iPqByX" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jQAxuV ccffaZ"><span class="sc-daBunf fcvuS"><span class="sc-dsXzNU dPrSxx"><i>ApiKeyAuth</i></span></span></div></div><div><h5 class="sc-iqAclL eONCmm">query<!-- --> Parameters</h5><table class="sc-hHEiqL VCQHZ"><tbody><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="limit"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">limit</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">integer</span></div><div><span class="sc-laZMeE jWaWWE"> <!-- -->Default:<!-- --> </span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">20</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="order"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">order</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div><div><span class="sc-laZMeE jWaWWE"> <!-- -->Default:<!-- --> </span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"desc"</span></div><div><span class="sc-laZMeE jWaWWE"> <!-- -->Enum<!-- -->:</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"asc"</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"desc"</span> </div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>Sort order by the <code>created_at</code> timestamp of the objects. <code>asc</code> for ascending order and <code>desc</code> for descending order.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="after"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">after</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>A cursor for use in pagination. <code>after</code> is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list.</p>
</div></div></div></td></tr><tr class="last "><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="before"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">before</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>A cursor for use in pagination. <code>before</code> is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_foo, your subsequent call can include before=obj_foo in order to fetch the previous page of the list.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-fIxmyt DvFer">Responses</h3><div><button class="sc-htmcrh lbYftx"><svg class="sc-dIsUp dqYXmg" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-fWWYYk cMoEZ">200<!-- --> </strong><span class="sc-jcwpoC eDjFAZ"><p>OK</p>
</span></button></div></div></div><div class="sc-jSFjdj sc-gKAaRy gBjRyf gcushC"><div class="sc-EZqKI fWsqvQ"><button class="sc-eEVmNe ilvUMs"><span type="get" class="sc-fmdNqN ihNycv http-verb get">get</span><span class="sc-jXcxbT fCEUju">/vector_stores</span><svg class="sc-dIsUp bRmrKA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ljsmAU flIrdF"><div class="sc-jlZJtj fQkroN"><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div><div tabindex="0" role="button"><div class="sc-dTSzeu dfUAUz"><span>https://api.openai.com/v1</span>/vector_stores</div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Response samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-588" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-589" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-589" aria-labelledby="react-tabs-588"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-bBjRSN kQSIAz">application/json</div></div><div class="sc-jgPyTC dSaTNC"><div class="sc-jNnpgg esZIbL"><div class="sc-giAqHp hMPeqJ"><button><div class="sc-carFqZ UksDl">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iJCRrE jCdxGr sc-dPaNzc gyljjx"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"object"</span>: <span class="token string">"list"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"object"</span>: <span class="token string">"vector_store"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"created_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"usage_bytes"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"file_counts"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"in_progress"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"completed"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"failed"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"cancelled"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"total"</span>: <span class="token number">0</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"status"</span>: <span class="token string">"expired"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"expires_after"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"anchor"</span>: <span class="token string">"last_active_at"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"days"</span>: <span class="token number">1</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"expires_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"last_active_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"metadata"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"property1"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"property2"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"first_id"</span>: <span class="token string">"vs_abc123"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"last_id"</span>: <span class="token string">"vs_abc456"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"has_more"</span>: <span class="token boolean">false</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Vector-stores/operation/createVectorStore" data-section-id="tag/Vector-stores/operation/createVectorStore" class="sc-eCApnc liLqNm"><div data-section-id="operation/createVectorStore" id="operation/createVectorStore" class="sc-iCoGMd gLxhOh"><div class="sc-hKFxyN juinod"><h2 class="sc-pNWdM eftmgB"><a class="sc-crzoAE iUxAWq" href="#tag/Vector-stores/operation/createVectorStore" aria-label="tag/Vector-stores/operation/createVectorStore"></a>Create a vector store.<!-- --> </h2><div class="sc-fcmMJX cvfxAX"><div class="sc-jUfyBS bhDyou"><h5 class="sc-iqAclL sc-fuISkM eONCmm hZIgic">Authorizations:</h5><svg class="sc-dIsUp iPqByX" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jQAxuV ccffaZ"><span class="sc-daBunf fcvuS"><span class="sc-dsXzNU dPrSxx"><i>ApiKeyAuth</i></span></span></div></div><h5 class="sc-iqAclL eONCmm">Request Body schema: <span class="sc-cBoqAE eKyrDP">application/json</span></h5><div class="sc-iJCRrE sc-ciSkZP jCdxGr QGruV"></div><table class="sc-hHEiqL VCQHZ"><tbody><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="file_ids"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">file_ids</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa">Array of </span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">strings</span><span> <span class="sc-laZMeE sc-FRrlG jWaWWE gHBwqe"> <!-- --><= 500 items<!-- --> </span></span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>A list of <a href="/docs/api-reference/files">File</a> IDs that the vector store should use. Useful for tools like <code>file_search</code> that can access files.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="name"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">name</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The name of the vector store.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="description"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">description</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>A description for the vector store. Can be used to describe the vector store's purpose.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT sc-gSYDnn iwcKgn cAqMTE hTttpy" kind="field" title="expires_after"><span class="sc-iemWCZ bcnRwz"></span><button aria-label="expand properties"><span class="property-name">expires_after</span><svg class="sc-dIsUp hGHhhO" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">object</span><span class="sc-laZMeE sc-eJocfa jWaWWE bArHDh"> (<!-- -->VectorStoreExpirationAfter<!-- -->) </span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The expiration policy for a vector store.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT sc-gSYDnn iwcKgn cAqMTE hTttpy" kind="field" title="chunking_strategy"><span class="sc-iemWCZ bcnRwz"></span><button aria-label="expand properties"><span class="property-name">chunking_strategy</span><svg class="sc-dIsUp hGHhhO" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">Auto Chunking Strategy (object) or Static Chunking Strategy (object)</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The chunking strategy used to chunk the file(s). If not set, will use the <code>auto</code> strategy. Only applicable if <code>file_ids</code> is non-empty.</p>
</div></div></div></td></tr><tr class="last "><td class="sc-hBMUJo sc-fFSPTT sc-gSYDnn iwcKgn cAqMTE hTttpy" kind="field" title="metadata"><span class="sc-iemWCZ bcnRwz"></span><button aria-label="expand properties"><span class="property-name">metadata</span><svg class="sc-dIsUp hGHhhO" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">Metadata (object) or Metadata (null)</span><span class="sc-laZMeE sc-eJocfa jWaWWE bArHDh"> (<!-- -->Metadata<!-- -->) </span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div></div></div></td></tr></tbody></table><div><h3 class="sc-fIxmyt DvFer">Responses</h3><div><button class="sc-htmcrh lbYftx"><svg class="sc-dIsUp dqYXmg" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-fWWYYk cMoEZ">200<!-- --> </strong><span class="sc-jcwpoC eDjFAZ"><p>OK</p>
</span></button></div></div></div><div class="sc-jSFjdj sc-gKAaRy gBjRyf gcushC"><div class="sc-EZqKI fWsqvQ"><button class="sc-eEVmNe ilvUMs"><span type="post" class="sc-fmdNqN ldMUmp http-verb post">post</span><span class="sc-jXcxbT fCEUju">/vector_stores</span><svg class="sc-dIsUp bRmrKA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ljsmAU flIrdF"><div class="sc-jlZJtj fQkroN"><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div><div tabindex="0" role="button"><div class="sc-dTSzeu dfUAUz"><span>https://api.openai.com/v1</span>/vector_stores</div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Request samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="react-tabs-590" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-591" tabindex="0" data-rttab="true">Payload</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-591" aria-labelledby="react-tabs-590"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-bBjRSN kQSIAz">application/json</div></div><div class="sc-jgPyTC dSaTNC"><div class="sc-jNnpgg esZIbL"><div class="sc-giAqHp hMPeqJ"><button><div class="sc-carFqZ UksDl">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iJCRrE jCdxGr sc-dPaNzc gyljjx"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"file_ids"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><span class="token string">"string"</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"description"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"expires_after"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"anchor"</span>: <span class="token string">"last_active_at"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"days"</span>: <span class="token number">1</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"chunking_strategy"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <span class="token string">"auto"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"property1"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"property2"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Response samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-592" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-593" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-593" aria-labelledby="react-tabs-592"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-bBjRSN kQSIAz">application/json</div></div><div class="sc-jgPyTC dSaTNC"><div class="sc-jNnpgg esZIbL"><div class="sc-giAqHp hMPeqJ"><button><div class="sc-carFqZ UksDl">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iJCRrE jCdxGr sc-dPaNzc gyljjx"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"object"</span>: <span class="token string">"vector_store"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"created_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"usage_bytes"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"file_counts"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"in_progress"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"completed"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"failed"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"cancelled"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"total"</span>: <span class="token number">0</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token string">"expired"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"expires_after"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"anchor"</span>: <span class="token string">"last_active_at"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"days"</span>: <span class="token number">1</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"expires_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"last_active_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"property1"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"property2"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Vector-stores/operation/getVectorStore" data-section-id="tag/Vector-stores/operation/getVectorStore" class="sc-eCApnc liLqNm"><div data-section-id="operation/getVectorStore" id="operation/getVectorStore" class="sc-iCoGMd gLxhOh"><div class="sc-hKFxyN juinod"><h2 class="sc-pNWdM eftmgB"><a class="sc-crzoAE iUxAWq" href="#tag/Vector-stores/operation/getVectorStore" aria-label="tag/Vector-stores/operation/getVectorStore"></a>Retrieves a vector store.<!-- --> </h2><div class="sc-fcmMJX cvfxAX"><div class="sc-jUfyBS bhDyou"><h5 class="sc-iqAclL sc-fuISkM eONCmm hZIgic">Authorizations:</h5><svg class="sc-dIsUp iPqByX" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jQAxuV ccffaZ"><span class="sc-daBunf fcvuS"><span class="sc-dsXzNU dPrSxx"><i>ApiKeyAuth</i></span></span></div></div><div><h5 class="sc-iqAclL eONCmm">path<!-- --> Parameters</h5><table class="sc-hHEiqL VCQHZ"><tbody><tr class="last "><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="vector_store_id"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">vector_store_id</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The ID of the vector store to retrieve.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-fIxmyt DvFer">Responses</h3><div><button class="sc-htmcrh lbYftx"><svg class="sc-dIsUp dqYXmg" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-fWWYYk cMoEZ">200<!-- --> </strong><span class="sc-jcwpoC eDjFAZ"><p>OK</p>
</span></button></div></div></div><div class="sc-jSFjdj sc-gKAaRy gBjRyf gcushC"><div class="sc-EZqKI fWsqvQ"><button class="sc-eEVmNe ilvUMs"><span type="get" class="sc-fmdNqN ihNycv http-verb get">get</span><span class="sc-jXcxbT fCEUju">/vector_stores/{vector_store_id}</span><svg class="sc-dIsUp bRmrKA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ljsmAU flIrdF"><div class="sc-jlZJtj fQkroN"><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div><div tabindex="0" role="button"><div class="sc-dTSzeu dfUAUz"><span>https://api.openai.com/v1</span>/vector_stores/{vector_store_id}</div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Response samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-594" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-595" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-595" aria-labelledby="react-tabs-594"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-bBjRSN kQSIAz">application/json</div></div><div class="sc-jgPyTC dSaTNC"><div class="sc-jNnpgg esZIbL"><div class="sc-giAqHp hMPeqJ"><button><div class="sc-carFqZ UksDl">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iJCRrE jCdxGr sc-dPaNzc gyljjx"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"object"</span>: <span class="token string">"vector_store"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"created_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"usage_bytes"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"file_counts"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"in_progress"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"completed"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"failed"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"cancelled"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"total"</span>: <span class="token number">0</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token string">"expired"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"expires_after"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"anchor"</span>: <span class="token string">"last_active_at"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"days"</span>: <span class="token number">1</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"expires_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"last_active_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"property1"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"property2"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Vector-stores/operation/modifyVectorStore" data-section-id="tag/Vector-stores/operation/modifyVectorStore" class="sc-eCApnc liLqNm"><div data-section-id="operation/modifyVectorStore" id="operation/modifyVectorStore" class="sc-iCoGMd gLxhOh"><div class="sc-hKFxyN juinod"><h2 class="sc-pNWdM eftmgB"><a class="sc-crzoAE iUxAWq" href="#tag/Vector-stores/operation/modifyVectorStore" aria-label="tag/Vector-stores/operation/modifyVectorStore"></a>Modifies a vector store.<!-- --> </h2><div class="sc-fcmMJX cvfxAX"><div class="sc-jUfyBS bhDyou"><h5 class="sc-iqAclL sc-fuISkM eONCmm hZIgic">Authorizations:</h5><svg class="sc-dIsUp iPqByX" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jQAxuV ccffaZ"><span class="sc-daBunf fcvuS"><span class="sc-dsXzNU dPrSxx"><i>ApiKeyAuth</i></span></span></div></div><div><h5 class="sc-iqAclL eONCmm">path<!-- --> Parameters</h5><table class="sc-hHEiqL VCQHZ"><tbody><tr class="last "><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="vector_store_id"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">vector_store_id</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The ID of the vector store to modify.</p>
</div></div></div></td></tr></tbody></table></div><h5 class="sc-iqAclL eONCmm">Request Body schema: <span class="sc-cBoqAE eKyrDP">application/json</span></h5><div class="sc-iJCRrE sc-ciSkZP jCdxGr QGruV"></div><table class="sc-hHEiqL VCQHZ"><tbody><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="name"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">name</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string or null</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The name of the vector store.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT sc-gSYDnn iwcKgn cAqMTE hTttpy" kind="field" title="expires_after"><span class="sc-iemWCZ bcnRwz"></span><button aria-label="expand properties"><span class="property-name">expires_after</span><svg class="sc-dIsUp hGHhhO" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">object or null</span><span class="sc-laZMeE sc-eJocfa jWaWWE bArHDh"> (<!-- -->Vector store expiration policy<!-- -->) </span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The expiration policy for a vector store.</p>
</div></div></div></td></tr><tr class="last "><td class="sc-hBMUJo sc-fFSPTT sc-gSYDnn iwcKgn cAqMTE hTttpy" kind="field" title="metadata"><span class="sc-iemWCZ bcnRwz"></span><button aria-label="expand properties"><span class="property-name">metadata</span><svg class="sc-dIsUp hGHhhO" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">Metadata (object) or Metadata (null)</span><span class="sc-laZMeE sc-eJocfa jWaWWE bArHDh"> (<!-- -->Metadata<!-- -->) </span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div></div></div></td></tr></tbody></table><div><h3 class="sc-fIxmyt DvFer">Responses</h3><div><button class="sc-htmcrh lbYftx"><svg class="sc-dIsUp dqYXmg" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-fWWYYk cMoEZ">200<!-- --> </strong><span class="sc-jcwpoC eDjFAZ"><p>OK</p>
</span></button></div></div></div><div class="sc-jSFjdj sc-gKAaRy gBjRyf gcushC"><div class="sc-EZqKI fWsqvQ"><button class="sc-eEVmNe ilvUMs"><span type="post" class="sc-fmdNqN ldMUmp http-verb post">post</span><span class="sc-jXcxbT fCEUju">/vector_stores/{vector_store_id}</span><svg class="sc-dIsUp bRmrKA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ljsmAU flIrdF"><div class="sc-jlZJtj fQkroN"><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div><div tabindex="0" role="button"><div class="sc-dTSzeu dfUAUz"><span>https://api.openai.com/v1</span>/vector_stores/{vector_store_id}</div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Request samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="react-tabs-596" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-597" tabindex="0" data-rttab="true">Payload</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-597" aria-labelledby="react-tabs-596"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-bBjRSN kQSIAz">application/json</div></div><div class="sc-jgPyTC dSaTNC"><div class="sc-jNnpgg esZIbL"><div class="sc-giAqHp hMPeqJ"><button><div class="sc-carFqZ UksDl">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iJCRrE jCdxGr sc-dPaNzc gyljjx"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"expires_after"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"anchor"</span>: <span class="token string">"last_active_at"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"days"</span>: <span class="token number">1</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"property1"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"property2"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Response samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-598" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-599" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-599" aria-labelledby="react-tabs-598"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-bBjRSN kQSIAz">application/json</div></div><div class="sc-jgPyTC dSaTNC"><div class="sc-jNnpgg esZIbL"><div class="sc-giAqHp hMPeqJ"><button><div class="sc-carFqZ UksDl">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iJCRrE jCdxGr sc-dPaNzc gyljjx"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"object"</span>: <span class="token string">"vector_store"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"created_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"usage_bytes"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"file_counts"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"in_progress"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"completed"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"failed"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"cancelled"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"total"</span>: <span class="token number">0</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token string">"expired"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"expires_after"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"anchor"</span>: <span class="token string">"last_active_at"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"days"</span>: <span class="token number">1</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"expires_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"last_active_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"property1"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"property2"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Vector-stores/operation/deleteVectorStore" data-section-id="tag/Vector-stores/operation/deleteVectorStore" class="sc-eCApnc liLqNm"><div data-section-id="operation/deleteVectorStore" id="operation/deleteVectorStore" class="sc-iCoGMd gLxhOh"><div class="sc-hKFxyN juinod"><h2 class="sc-pNWdM eftmgB"><a class="sc-crzoAE iUxAWq" href="#tag/Vector-stores/operation/deleteVectorStore" aria-label="tag/Vector-stores/operation/deleteVectorStore"></a>Delete a vector store.<!-- --> </h2><div class="sc-fcmMJX cvfxAX"><div class="sc-jUfyBS bhDyou"><h5 class="sc-iqAclL sc-fuISkM eONCmm hZIgic">Authorizations:</h5><svg class="sc-dIsUp iPqByX" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jQAxuV ccffaZ"><span class="sc-daBunf fcvuS"><span class="sc-dsXzNU dPrSxx"><i>ApiKeyAuth</i></span></span></div></div><div><h5 class="sc-iqAclL eONCmm">path<!-- --> Parameters</h5><table class="sc-hHEiqL VCQHZ"><tbody><tr class="last "><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="vector_store_id"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">vector_store_id</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The ID of the vector store to delete.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-fIxmyt DvFer">Responses</h3><div><button class="sc-htmcrh lbYftx"><svg class="sc-dIsUp dqYXmg" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-fWWYYk cMoEZ">200<!-- --> </strong><span class="sc-jcwpoC eDjFAZ"><p>OK</p>
</span></button></div></div></div><div class="sc-jSFjdj sc-gKAaRy gBjRyf gcushC"><div class="sc-EZqKI fWsqvQ"><button class="sc-eEVmNe ilvUMs"><span type="delete" class="sc-fmdNqN bJzUtf http-verb delete">delete</span><span class="sc-jXcxbT fCEUju">/vector_stores/{vector_store_id}</span><svg class="sc-dIsUp bRmrKA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ljsmAU flIrdF"><div class="sc-jlZJtj fQkroN"><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div><div tabindex="0" role="button"><div class="sc-dTSzeu dfUAUz"><span>https://api.openai.com/v1</span>/vector_stores/{vector_store_id}</div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Response samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-600" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-601" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-601" aria-labelledby="react-tabs-600"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-bBjRSN kQSIAz">application/json</div></div><div class="sc-jgPyTC dSaTNC"><div class="sc-jNnpgg esZIbL"><div class="sc-giAqHp hMPeqJ"><button><div class="sc-carFqZ UksDl">Copy</div></button></div><div class="sc-iJCRrE jCdxGr sc-dPaNzc gyljjx"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"deleted"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"object"</span>: <span class="token string">"vector_store.deleted"</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Vector-stores/operation/createVectorStoreFileBatch" data-section-id="tag/Vector-stores/operation/createVectorStoreFileBatch" class="sc-eCApnc liLqNm"><div data-section-id="operation/createVectorStoreFileBatch" id="operation/createVectorStoreFileBatch" class="sc-iCoGMd gLxhOh"><div class="sc-hKFxyN juinod"><h2 class="sc-pNWdM eftmgB"><a class="sc-crzoAE iUxAWq" href="#tag/Vector-stores/operation/createVectorStoreFileBatch" aria-label="tag/Vector-stores/operation/createVectorStoreFileBatch"></a>Create a vector store file batch.<!-- --> </h2><div class="sc-iGkqmO hCTIhr"><div class="sc-iJCRrE sc-ciSkZP jCdxGr QGruV"><p>The maximum number of files in a single batch request is 2000.
Vector store file attach requests are rate limited per vector store (300 requests per minute across both this endpoint and <code>/vector_stores/{vector_store_id}/files</code>).
For ingesting multiple files into the same vector store, this batch endpoint is recommended.</p>
</div></div><div class="sc-fcmMJX cvfxAX"><div class="sc-jUfyBS bhDyou"><h5 class="sc-iqAclL sc-fuISkM eONCmm hZIgic">Authorizations:</h5><svg class="sc-dIsUp iPqByX" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jQAxuV ccffaZ"><span class="sc-daBunf fcvuS"><span class="sc-dsXzNU dPrSxx"><i>ApiKeyAuth</i></span></span></div></div><div><h5 class="sc-iqAclL eONCmm">path<!-- --> Parameters</h5><table class="sc-hHEiqL VCQHZ"><tbody><tr class="last "><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="vector_store_id"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">vector_store_id</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><span class="sc-laZMeE jWaWWE"> <!-- -->Example:<!-- --> </span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">vs_abc123</span></div><div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The ID of the vector store for which to create a File Batch.</p>
</div></div></div></td></tr></tbody></table></div><h5 class="sc-iqAclL eONCmm">Request Body schema: <span class="sc-cBoqAE eKyrDP">application/json</span></h5><div class="sc-iJCRrE sc-ciSkZP jCdxGr QGruV"></div><div><span class="sc-kfYoZR juYXUf"> <!-- -->Any of<!-- --> </span><div class="sc-dlMDgC EoFth"><button class="sc-fKgJPI PukRR">object</button><button class="sc-fKgJPI bpjiHN">object</button></div><div></div><table class="sc-hHEiqL VCQHZ"><tbody><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="file_ids"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">file_ids</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa">Array of </span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">strings</span><span> <span class="sc-laZMeE sc-FRrlG jWaWWE gHBwqe"> <!-- -->[ 1 .. 2000 ] items<!-- --> </span></span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>A list of <a href="/docs/api-reference/files">File</a> IDs that the vector store should use. Useful for tools like <code>file_search</code> that can access files. If <code>attributes</code> or <code>chunking_strategy</code> are provided, they will be applied to all files in the batch. The maximum batch size is 2000 files. This endpoint is recommended for multi-file ingestion and helps reduce per-vector-store write request pressure. Mutually exclusive with <code>files</code>.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT sc-gSYDnn iwcKgn cAqMTE hTttpy" kind="field" title="files"><span class="sc-iemWCZ bcnRwz"></span><button aria-label="expand properties"><span class="property-name">files</span><svg class="sc-dIsUp hGHhhO" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa">Array of </span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">objects</span><span class="sc-laZMeE sc-eJocfa jWaWWE bArHDh"> (<!-- -->CreateVectorStoreFileRequest<!-- -->) </span><span> <span class="sc-laZMeE sc-FRrlG jWaWWE gHBwqe"> <!-- -->[ 1 .. 2000 ] items<!-- --> </span></span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>A list of objects that each include a <code>file_id</code> plus optional <code>attributes</code> or <code>chunking_strategy</code>. Use this when you need to override metadata for specific files. The global <code>attributes</code> or <code>chunking_strategy</code> will be ignored and must be specified for each file. The maximum batch size is 2000 files. This endpoint is recommended for multi-file ingestion and helps reduce per-vector-store write request pressure. Mutually exclusive with <code>file_ids</code>.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT sc-gSYDnn iwcKgn cAqMTE hTttpy" kind="field" title="chunking_strategy"><span class="sc-iemWCZ bcnRwz"></span><button aria-label="expand properties"><span class="property-name">chunking_strategy</span><svg class="sc-dIsUp hGHhhO" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">Auto Chunking Strategy (object) or Static Chunking Strategy (object)</span><span class="sc-laZMeE sc-eJocfa jWaWWE bArHDh"> (<!-- -->ChunkingStrategyRequestParam<!-- -->) </span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div></div></div></td></tr><tr class="last "><td class="sc-hBMUJo sc-fFSPTT sc-gSYDnn iwcKgn cAqMTE hTttpy" kind="field" title="attributes"><span class="sc-iemWCZ bcnRwz"></span><button aria-label="expand properties"><span class="property-name">attributes</span><svg class="sc-dIsUp hGHhhO" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">VectorStoreFileAttributes (object) or VectorStoreFileAttributes (null)</span><span class="sc-laZMeE sc-eJocfa jWaWWE bArHDh"> (<!-- -->VectorStoreFileAttributes<!-- -->) </span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div></div></div></td></tr></tbody></table></div><div><h3 class="sc-fIxmyt DvFer">Responses</h3><div><button class="sc-htmcrh lbYftx"><svg class="sc-dIsUp dqYXmg" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-fWWYYk cMoEZ">200<!-- --> </strong><span class="sc-jcwpoC eDjFAZ"><p>OK</p>
</span></button></div></div></div><div class="sc-jSFjdj sc-gKAaRy gBjRyf gcushC"><div class="sc-EZqKI fWsqvQ"><button class="sc-eEVmNe ilvUMs"><span type="post" class="sc-fmdNqN ldMUmp http-verb post">post</span><span class="sc-jXcxbT fCEUju">/vector_stores/{vector_store_id}/file_batches</span><svg class="sc-dIsUp bRmrKA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ljsmAU flIrdF"><div class="sc-jlZJtj fQkroN"><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div><div tabindex="0" role="button"><div class="sc-dTSzeu dfUAUz"><span>https://api.openai.com/v1</span>/vector_stores/{vector_store_id}/file_batches</div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Request samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="react-tabs-602" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-603" tabindex="0" data-rttab="true">Payload</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-603" aria-labelledby="react-tabs-602"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-bBjRSN kQSIAz">application/json</div></div><div class="sc-jgPyTC dSaTNC"><div class="sc-jNnpgg esZIbL"><div class="sc-giAqHp hMPeqJ"><button><div class="sc-carFqZ UksDl">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iJCRrE jCdxGr sc-dPaNzc gyljjx"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"file_ids"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><span class="token string">"string"</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"files"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"file_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"chunking_strategy"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <span class="token string">"auto"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"attributes"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"property1"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"property2"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"chunking_strategy"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <span class="token string">"auto"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"attributes"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"property1"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"property2"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Response samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-604" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-605" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-605" aria-labelledby="react-tabs-604"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-bBjRSN kQSIAz">application/json</div></div><div class="sc-jgPyTC dSaTNC"><div class="sc-jNnpgg esZIbL"><div class="sc-giAqHp hMPeqJ"><button><div class="sc-carFqZ UksDl">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iJCRrE jCdxGr sc-dPaNzc gyljjx"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"object"</span>: <span class="token string">"vector_store.files_batch"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"created_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"vector_store_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token string">"in_progress"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"file_counts"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"in_progress"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"completed"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"failed"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"cancelled"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"total"</span>: <span class="token number">0</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Vector-stores/operation/getVectorStoreFileBatch" data-section-id="tag/Vector-stores/operation/getVectorStoreFileBatch" class="sc-eCApnc liLqNm"><div data-section-id="operation/getVectorStoreFileBatch" id="operation/getVectorStoreFileBatch" class="sc-iCoGMd gLxhOh"><div class="sc-hKFxyN juinod"><h2 class="sc-pNWdM eftmgB"><a class="sc-crzoAE iUxAWq" href="#tag/Vector-stores/operation/getVectorStoreFileBatch" aria-label="tag/Vector-stores/operation/getVectorStoreFileBatch"></a>Retrieves a vector store file batch.<!-- --> </h2><div class="sc-fcmMJX cvfxAX"><div class="sc-jUfyBS bhDyou"><h5 class="sc-iqAclL sc-fuISkM eONCmm hZIgic">Authorizations:</h5><svg class="sc-dIsUp iPqByX" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jQAxuV ccffaZ"><span class="sc-daBunf fcvuS"><span class="sc-dsXzNU dPrSxx"><i>ApiKeyAuth</i></span></span></div></div><div><h5 class="sc-iqAclL eONCmm">path<!-- --> Parameters</h5><table class="sc-hHEiqL VCQHZ"><tbody><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="vector_store_id"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">vector_store_id</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><span class="sc-laZMeE jWaWWE"> <!-- -->Example:<!-- --> </span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">vs_abc123</span></div><div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The ID of the vector store that the file batch belongs to.</p>
</div></div></div></td></tr><tr class="last "><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="batch_id"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">batch_id</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><span class="sc-laZMeE jWaWWE"> <!-- -->Example:<!-- --> </span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">vsfb_abc123</span></div><div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The ID of the file batch being retrieved.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-fIxmyt DvFer">Responses</h3><div><button class="sc-htmcrh lbYftx"><svg class="sc-dIsUp dqYXmg" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-fWWYYk cMoEZ">200<!-- --> </strong><span class="sc-jcwpoC eDjFAZ"><p>OK</p>
</span></button></div></div></div><div class="sc-jSFjdj sc-gKAaRy gBjRyf gcushC"><div class="sc-EZqKI fWsqvQ"><button class="sc-eEVmNe ilvUMs"><span type="get" class="sc-fmdNqN ihNycv http-verb get">get</span><span class="sc-jXcxbT fCEUju">/vector_stores/{vector_store_id}/file_batches/{batch_id}</span><svg class="sc-dIsUp bRmrKA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ljsmAU flIrdF"><div class="sc-jlZJtj fQkroN"><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div><div tabindex="0" role="button"><div class="sc-dTSzeu dfUAUz"><span>https://api.openai.com/v1</span>/vector_stores/{vector_store_id}/file_batches/{batch_id}</div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Response samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-606" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-607" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-607" aria-labelledby="react-tabs-606"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-bBjRSN kQSIAz">application/json</div></div><div class="sc-jgPyTC dSaTNC"><div class="sc-jNnpgg esZIbL"><div class="sc-giAqHp hMPeqJ"><button><div class="sc-carFqZ UksDl">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iJCRrE jCdxGr sc-dPaNzc gyljjx"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"object"</span>: <span class="token string">"vector_store.files_batch"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"created_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"vector_store_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token string">"in_progress"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"file_counts"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"in_progress"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"completed"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"failed"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"cancelled"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"total"</span>: <span class="token number">0</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Vector-stores/operation/cancelVectorStoreFileBatch" data-section-id="tag/Vector-stores/operation/cancelVectorStoreFileBatch" class="sc-eCApnc liLqNm"><div data-section-id="operation/cancelVectorStoreFileBatch" id="operation/cancelVectorStoreFileBatch" class="sc-iCoGMd gLxhOh"><div class="sc-hKFxyN juinod"><h2 class="sc-pNWdM eftmgB"><a class="sc-crzoAE iUxAWq" href="#tag/Vector-stores/operation/cancelVectorStoreFileBatch" aria-label="tag/Vector-stores/operation/cancelVectorStoreFileBatch"></a>Cancel a vector store file batch. This attempts to cancel the processing of files in this batch as soon as possible.<!-- --> </h2><div class="sc-fcmMJX cvfxAX"><div class="sc-jUfyBS bhDyou"><h5 class="sc-iqAclL sc-fuISkM eONCmm hZIgic">Authorizations:</h5><svg class="sc-dIsUp iPqByX" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jQAxuV ccffaZ"><span class="sc-daBunf fcvuS"><span class="sc-dsXzNU dPrSxx"><i>ApiKeyAuth</i></span></span></div></div><div><h5 class="sc-iqAclL eONCmm">path<!-- --> Parameters</h5><table class="sc-hHEiqL VCQHZ"><tbody><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="vector_store_id"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">vector_store_id</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The ID of the vector store that the file batch belongs to.</p>
</div></div></div></td></tr><tr class="last "><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="batch_id"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">batch_id</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The ID of the file batch to cancel.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-fIxmyt DvFer">Responses</h3><div><button class="sc-htmcrh lbYftx"><svg class="sc-dIsUp dqYXmg" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-fWWYYk cMoEZ">200<!-- --> </strong><span class="sc-jcwpoC eDjFAZ"><p>OK</p>
</span></button></div></div></div><div class="sc-jSFjdj sc-gKAaRy gBjRyf gcushC"><div class="sc-EZqKI fWsqvQ"><button class="sc-eEVmNe ilvUMs"><span type="post" class="sc-fmdNqN ldMUmp http-verb post">post</span><span class="sc-jXcxbT fCEUju">/vector_stores/{vector_store_id}/file_batches/{batch_id}/cancel</span><svg class="sc-dIsUp bRmrKA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ljsmAU flIrdF"><div class="sc-jlZJtj fQkroN"><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div><div tabindex="0" role="button"><div class="sc-dTSzeu dfUAUz"><span>https://api.openai.com/v1</span>/vector_stores/{vector_store_id}/file_batches/{batch_id}/cancel</div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Response samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-608" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-609" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-609" aria-labelledby="react-tabs-608"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-bBjRSN kQSIAz">application/json</div></div><div class="sc-jgPyTC dSaTNC"><div class="sc-jNnpgg esZIbL"><div class="sc-giAqHp hMPeqJ"><button><div class="sc-carFqZ UksDl">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iJCRrE jCdxGr sc-dPaNzc gyljjx"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"object"</span>: <span class="token string">"vector_store.files_batch"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"created_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"vector_store_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token string">"in_progress"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"file_counts"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"in_progress"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"completed"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"failed"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"cancelled"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"total"</span>: <span class="token number">0</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Vector-stores/operation/listFilesInVectorStoreBatch" data-section-id="tag/Vector-stores/operation/listFilesInVectorStoreBatch" class="sc-eCApnc liLqNm"><div data-section-id="operation/listFilesInVectorStoreBatch" id="operation/listFilesInVectorStoreBatch" class="sc-iCoGMd gLxhOh"><div class="sc-hKFxyN juinod"><h2 class="sc-pNWdM eftmgB"><a class="sc-crzoAE iUxAWq" href="#tag/Vector-stores/operation/listFilesInVectorStoreBatch" aria-label="tag/Vector-stores/operation/listFilesInVectorStoreBatch"></a>Returns a list of vector store files in a batch.<!-- --> </h2><div class="sc-fcmMJX cvfxAX"><div class="sc-jUfyBS bhDyou"><h5 class="sc-iqAclL sc-fuISkM eONCmm hZIgic">Authorizations:</h5><svg class="sc-dIsUp iPqByX" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jQAxuV ccffaZ"><span class="sc-daBunf fcvuS"><span class="sc-dsXzNU dPrSxx"><i>ApiKeyAuth</i></span></span></div></div><div><h5 class="sc-iqAclL eONCmm">path<!-- --> Parameters</h5><table class="sc-hHEiqL VCQHZ"><tbody><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="vector_store_id"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">vector_store_id</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The ID of the vector store that the files belong to.</p>
</div></div></div></td></tr><tr class="last "><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="batch_id"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">batch_id</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The ID of the file batch that the files belong to.</p>
</div></div></div></td></tr></tbody></table></div><div><h5 class="sc-iqAclL eONCmm">query<!-- --> Parameters</h5><table class="sc-hHEiqL VCQHZ"><tbody><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="limit"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">limit</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">integer</span></div><div><span class="sc-laZMeE jWaWWE"> <!-- -->Default:<!-- --> </span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">20</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="order"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">order</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div><div><span class="sc-laZMeE jWaWWE"> <!-- -->Default:<!-- --> </span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"desc"</span></div><div><span class="sc-laZMeE jWaWWE"> <!-- -->Enum<!-- -->:</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"asc"</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"desc"</span> </div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>Sort order by the <code>created_at</code> timestamp of the objects. <code>asc</code> for ascending order and <code>desc</code> for descending order.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="after"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">after</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>A cursor for use in pagination. <code>after</code> is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="before"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">before</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>A cursor for use in pagination. <code>before</code> is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_foo, your subsequent call can include before=obj_foo in order to fetch the previous page of the list.</p>
</div></div></div></td></tr><tr class="last "><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="filter"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">filter</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div><div><span class="sc-laZMeE jWaWWE"> <!-- -->Enum<!-- -->:</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"in_progress"</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"completed"</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"failed"</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"cancelled"</span> </div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>Filter by file status. One of <code>in_progress</code>, <code>completed</code>, <code>failed</code>, <code>cancelled</code>.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-fIxmyt DvFer">Responses</h3><div><button class="sc-htmcrh lbYftx"><svg class="sc-dIsUp dqYXmg" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-fWWYYk cMoEZ">200<!-- --> </strong><span class="sc-jcwpoC eDjFAZ"><p>OK</p>
</span></button></div></div></div><div class="sc-jSFjdj sc-gKAaRy gBjRyf gcushC"><div class="sc-EZqKI fWsqvQ"><button class="sc-eEVmNe ilvUMs"><span type="get" class="sc-fmdNqN ihNycv http-verb get">get</span><span class="sc-jXcxbT fCEUju">/vector_stores/{vector_store_id}/file_batches/{batch_id}/files</span><svg class="sc-dIsUp bRmrKA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ljsmAU flIrdF"><div class="sc-jlZJtj fQkroN"><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div><div tabindex="0" role="button"><div class="sc-dTSzeu dfUAUz"><span>https://api.openai.com/v1</span>/vector_stores/{vector_store_id}/file_batches/{batch_id}/files</div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Response samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-610" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-611" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-611" aria-labelledby="react-tabs-610"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-bBjRSN kQSIAz">application/json</div></div><div class="sc-jgPyTC dSaTNC"><div class="sc-jNnpgg esZIbL"><div class="sc-giAqHp hMPeqJ"><button><div class="sc-carFqZ UksDl">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iJCRrE jCdxGr sc-dPaNzc gyljjx"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"object"</span>: <span class="token string">"list"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"object"</span>: <span class="token string">"vector_store.file"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"usage_bytes"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"created_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"vector_store_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"status"</span>: <span class="token string">"in_progress"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"last_error"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"code"</span>: <span class="token string">"server_error"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"message"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"chunking_strategy"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <span class="token string">"static"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"static"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"max_chunk_size_tokens"</span>: <span class="token number">100</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"chunk_overlap_tokens"</span>: <span class="token number">0</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"attributes"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"property1"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"property2"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"first_id"</span>: <span class="token string">"file-abc123"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"last_id"</span>: <span class="token string">"file-abc456"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"has_more"</span>: <span class="token boolean">false</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Vector-stores/operation/listVectorStoreFiles" data-section-id="tag/Vector-stores/operation/listVectorStoreFiles" class="sc-eCApnc liLqNm"><div data-section-id="operation/listVectorStoreFiles" id="operation/listVectorStoreFiles" class="sc-iCoGMd gLxhOh"><div class="sc-hKFxyN juinod"><h2 class="sc-pNWdM eftmgB"><a class="sc-crzoAE iUxAWq" href="#tag/Vector-stores/operation/listVectorStoreFiles" aria-label="tag/Vector-stores/operation/listVectorStoreFiles"></a>Returns a list of vector store files.<!-- --> </h2><div class="sc-fcmMJX cvfxAX"><div class="sc-jUfyBS bhDyou"><h5 class="sc-iqAclL sc-fuISkM eONCmm hZIgic">Authorizations:</h5><svg class="sc-dIsUp iPqByX" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jQAxuV ccffaZ"><span class="sc-daBunf fcvuS"><span class="sc-dsXzNU dPrSxx"><i>ApiKeyAuth</i></span></span></div></div><div><h5 class="sc-iqAclL eONCmm">path<!-- --> Parameters</h5><table class="sc-hHEiqL VCQHZ"><tbody><tr class="last "><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="vector_store_id"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">vector_store_id</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The ID of the vector store that the files belong to.</p>
</div></div></div></td></tr></tbody></table></div><div><h5 class="sc-iqAclL eONCmm">query<!-- --> Parameters</h5><table class="sc-hHEiqL VCQHZ"><tbody><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="limit"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">limit</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">integer</span></div><div><span class="sc-laZMeE jWaWWE"> <!-- -->Default:<!-- --> </span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">20</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="order"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">order</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div><div><span class="sc-laZMeE jWaWWE"> <!-- -->Default:<!-- --> </span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"desc"</span></div><div><span class="sc-laZMeE jWaWWE"> <!-- -->Enum<!-- -->:</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"asc"</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"desc"</span> </div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>Sort order by the <code>created_at</code> timestamp of the objects. <code>asc</code> for ascending order and <code>desc</code> for descending order.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="after"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">after</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>A cursor for use in pagination. <code>after</code> is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="before"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">before</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>A cursor for use in pagination. <code>before</code> is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_foo, your subsequent call can include before=obj_foo in order to fetch the previous page of the list.</p>
</div></div></div></td></tr><tr class="last "><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="filter"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">filter</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div><div><span class="sc-laZMeE jWaWWE"> <!-- -->Enum<!-- -->:</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"in_progress"</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"completed"</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"failed"</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"cancelled"</span> </div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>Filter by file status. One of <code>in_progress</code>, <code>completed</code>, <code>failed</code>, <code>cancelled</code>.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-fIxmyt DvFer">Responses</h3><div><button class="sc-htmcrh lbYftx"><svg class="sc-dIsUp dqYXmg" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-fWWYYk cMoEZ">200<!-- --> </strong><span class="sc-jcwpoC eDjFAZ"><p>OK</p>
</span></button></div></div></div><div class="sc-jSFjdj sc-gKAaRy gBjRyf gcushC"><div class="sc-EZqKI fWsqvQ"><button class="sc-eEVmNe ilvUMs"><span type="get" class="sc-fmdNqN ihNycv http-verb get">get</span><span class="sc-jXcxbT fCEUju">/vector_stores/{vector_store_id}/files</span><svg class="sc-dIsUp bRmrKA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ljsmAU flIrdF"><div class="sc-jlZJtj fQkroN"><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div><div tabindex="0" role="button"><div class="sc-dTSzeu dfUAUz"><span>https://api.openai.com/v1</span>/vector_stores/{vector_store_id}/files</div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Response samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-612" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-613" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-613" aria-labelledby="react-tabs-612"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-bBjRSN kQSIAz">application/json</div></div><div class="sc-jgPyTC dSaTNC"><div class="sc-jNnpgg esZIbL"><div class="sc-giAqHp hMPeqJ"><button><div class="sc-carFqZ UksDl">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iJCRrE jCdxGr sc-dPaNzc gyljjx"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"object"</span>: <span class="token string">"list"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"object"</span>: <span class="token string">"vector_store.file"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"usage_bytes"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"created_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"vector_store_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"status"</span>: <span class="token string">"in_progress"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"last_error"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"code"</span>: <span class="token string">"server_error"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"message"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"chunking_strategy"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <span class="token string">"static"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"static"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"max_chunk_size_tokens"</span>: <span class="token number">100</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"chunk_overlap_tokens"</span>: <span class="token number">0</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"attributes"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"property1"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"property2"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"first_id"</span>: <span class="token string">"file-abc123"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"last_id"</span>: <span class="token string">"file-abc456"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"has_more"</span>: <span class="token boolean">false</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Vector-stores/operation/createVectorStoreFile" data-section-id="tag/Vector-stores/operation/createVectorStoreFile" class="sc-eCApnc liLqNm"><div data-section-id="operation/createVectorStoreFile" id="operation/createVectorStoreFile" class="sc-iCoGMd gLxhOh"><div class="sc-hKFxyN juinod"><h2 class="sc-pNWdM eftmgB"><a class="sc-crzoAE iUxAWq" href="#tag/Vector-stores/operation/createVectorStoreFile" aria-label="tag/Vector-stores/operation/createVectorStoreFile"></a>Create a vector store file by attaching a [File](/docs/api-reference/files) to a [vector store](/docs/api-reference/vector-stores/object).<!-- --> </h2><div class="sc-iGkqmO hCTIhr"><div class="sc-iJCRrE sc-ciSkZP jCdxGr QGruV"><p>This endpoint is subject to a per-vector-store write rate limit of 300 requests per minute, shared with <code>/vector_stores/{vector_store_id}/file_batches</code>.
For uploading multiple files to the same vector store, use the file batches endpoint to reduce request volume.</p>
</div></div><div class="sc-fcmMJX cvfxAX"><div class="sc-jUfyBS bhDyou"><h5 class="sc-iqAclL sc-fuISkM eONCmm hZIgic">Authorizations:</h5><svg class="sc-dIsUp iPqByX" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jQAxuV ccffaZ"><span class="sc-daBunf fcvuS"><span class="sc-dsXzNU dPrSxx"><i>ApiKeyAuth</i></span></span></div></div><div><h5 class="sc-iqAclL eONCmm">path<!-- --> Parameters</h5><table class="sc-hHEiqL VCQHZ"><tbody><tr class="last "><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="vector_store_id"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">vector_store_id</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><span class="sc-laZMeE jWaWWE"> <!-- -->Example:<!-- --> </span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">vs_abc123</span></div><div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The ID of the vector store for which to create a File.</p>
</div></div></div></td></tr></tbody></table></div><h5 class="sc-iqAclL eONCmm">Request Body schema: <span class="sc-cBoqAE eKyrDP">application/json</span></h5><div class="sc-iJCRrE sc-ciSkZP jCdxGr QGruV"></div><table class="sc-hHEiqL VCQHZ"><tbody><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="file_id"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">file_id</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>A <a href="/docs/api-reference/files">File</a> ID that the vector store should use. Useful for tools like <code>file_search</code> that can access files. For multi-file ingestion, we recommend <a href="/docs/api-reference/vector-stores-file-batches/createBatch"><code>file_batches</code></a> to minimize per-vector-store write requests.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT sc-gSYDnn iwcKgn cAqMTE hTttpy" kind="field" title="chunking_strategy"><span class="sc-iemWCZ bcnRwz"></span><button aria-label="expand properties"><span class="property-name">chunking_strategy</span><svg class="sc-dIsUp hGHhhO" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">Auto Chunking Strategy (object) or Static Chunking Strategy (object)</span><span class="sc-laZMeE sc-eJocfa jWaWWE bArHDh"> (<!-- -->ChunkingStrategyRequestParam<!-- -->) </span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div></div></div></td></tr><tr class="last "><td class="sc-hBMUJo sc-fFSPTT sc-gSYDnn iwcKgn cAqMTE hTttpy" kind="field" title="attributes"><span class="sc-iemWCZ bcnRwz"></span><button aria-label="expand properties"><span class="property-name">attributes</span><svg class="sc-dIsUp hGHhhO" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">VectorStoreFileAttributes (object) or VectorStoreFileAttributes (null)</span><span class="sc-laZMeE sc-eJocfa jWaWWE bArHDh"> (<!-- -->VectorStoreFileAttributes<!-- -->) </span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div></div></div></td></tr></tbody></table><div><h3 class="sc-fIxmyt DvFer">Responses</h3><div><button class="sc-htmcrh lbYftx"><svg class="sc-dIsUp dqYXmg" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-fWWYYk cMoEZ">200<!-- --> </strong><span class="sc-jcwpoC eDjFAZ"><p>OK</p>
</span></button></div></div></div><div class="sc-jSFjdj sc-gKAaRy gBjRyf gcushC"><div class="sc-EZqKI fWsqvQ"><button class="sc-eEVmNe ilvUMs"><span type="post" class="sc-fmdNqN ldMUmp http-verb post">post</span><span class="sc-jXcxbT fCEUju">/vector_stores/{vector_store_id}/files</span><svg class="sc-dIsUp bRmrKA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ljsmAU flIrdF"><div class="sc-jlZJtj fQkroN"><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div><div tabindex="0" role="button"><div class="sc-dTSzeu dfUAUz"><span>https://api.openai.com/v1</span>/vector_stores/{vector_store_id}/files</div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Request samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="react-tabs-614" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-615" tabindex="0" data-rttab="true">Payload</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-615" aria-labelledby="react-tabs-614"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-bBjRSN kQSIAz">application/json</div></div><div class="sc-jgPyTC dSaTNC"><div class="sc-jNnpgg esZIbL"><div class="sc-giAqHp hMPeqJ"><button><div class="sc-carFqZ UksDl">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iJCRrE jCdxGr sc-dPaNzc gyljjx"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"file_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"chunking_strategy"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <span class="token string">"auto"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"attributes"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"property1"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"property2"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Response samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-616" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-617" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-617" aria-labelledby="react-tabs-616"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-bBjRSN kQSIAz">application/json</div></div><div class="sc-jgPyTC dSaTNC"><div class="sc-jNnpgg esZIbL"><div class="sc-giAqHp hMPeqJ"><button><div class="sc-carFqZ UksDl">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iJCRrE jCdxGr sc-dPaNzc gyljjx"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"object"</span>: <span class="token string">"vector_store.file"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"usage_bytes"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"created_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"vector_store_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token string">"in_progress"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"last_error"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"code"</span>: <span class="token string">"server_error"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"message"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"chunking_strategy"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <span class="token string">"static"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"static"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"max_chunk_size_tokens"</span>: <span class="token number">100</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"chunk_overlap_tokens"</span>: <span class="token number">0</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"attributes"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"property1"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"property2"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Vector-stores/operation/getVectorStoreFile" data-section-id="tag/Vector-stores/operation/getVectorStoreFile" class="sc-eCApnc liLqNm"><div data-section-id="operation/getVectorStoreFile" id="operation/getVectorStoreFile" class="sc-iCoGMd gLxhOh"><div class="sc-hKFxyN juinod"><h2 class="sc-pNWdM eftmgB"><a class="sc-crzoAE iUxAWq" href="#tag/Vector-stores/operation/getVectorStoreFile" aria-label="tag/Vector-stores/operation/getVectorStoreFile"></a>Retrieves a vector store file.<!-- --> </h2><div class="sc-fcmMJX cvfxAX"><div class="sc-jUfyBS bhDyou"><h5 class="sc-iqAclL sc-fuISkM eONCmm hZIgic">Authorizations:</h5><svg class="sc-dIsUp iPqByX" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jQAxuV ccffaZ"><span class="sc-daBunf fcvuS"><span class="sc-dsXzNU dPrSxx"><i>ApiKeyAuth</i></span></span></div></div><div><h5 class="sc-iqAclL eONCmm">path<!-- --> Parameters</h5><table class="sc-hHEiqL VCQHZ"><tbody><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="vector_store_id"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">vector_store_id</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><span class="sc-laZMeE jWaWWE"> <!-- -->Example:<!-- --> </span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">vs_abc123</span></div><div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The ID of the vector store that the file belongs to.</p>
</div></div></div></td></tr><tr class="last "><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="file_id"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">file_id</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><span class="sc-laZMeE jWaWWE"> <!-- -->Example:<!-- --> </span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">file-abc123</span></div><div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The ID of the file being retrieved.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-fIxmyt DvFer">Responses</h3><div><button class="sc-htmcrh lbYftx"><svg class="sc-dIsUp dqYXmg" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-fWWYYk cMoEZ">200<!-- --> </strong><span class="sc-jcwpoC eDjFAZ"><p>OK</p>
</span></button></div></div></div><div class="sc-jSFjdj sc-gKAaRy gBjRyf gcushC"><div class="sc-EZqKI fWsqvQ"><button class="sc-eEVmNe ilvUMs"><span type="get" class="sc-fmdNqN ihNycv http-verb get">get</span><span class="sc-jXcxbT fCEUju">/vector_stores/{vector_store_id}/files/{file_id}</span><svg class="sc-dIsUp bRmrKA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ljsmAU flIrdF"><div class="sc-jlZJtj fQkroN"><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div><div tabindex="0" role="button"><div class="sc-dTSzeu dfUAUz"><span>https://api.openai.com/v1</span>/vector_stores/{vector_store_id}/files/{file_id}</div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Response samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-618" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-619" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-619" aria-labelledby="react-tabs-618"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-bBjRSN kQSIAz">application/json</div></div><div class="sc-jgPyTC dSaTNC"><div class="sc-jNnpgg esZIbL"><div class="sc-giAqHp hMPeqJ"><button><div class="sc-carFqZ UksDl">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iJCRrE jCdxGr sc-dPaNzc gyljjx"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"object"</span>: <span class="token string">"vector_store.file"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"usage_bytes"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"created_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"vector_store_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token string">"in_progress"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"last_error"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"code"</span>: <span class="token string">"server_error"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"message"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"chunking_strategy"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <span class="token string">"static"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"static"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"max_chunk_size_tokens"</span>: <span class="token number">100</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"chunk_overlap_tokens"</span>: <span class="token number">0</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"attributes"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"property1"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"property2"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Vector-stores/operation/deleteVectorStoreFile" data-section-id="tag/Vector-stores/operation/deleteVectorStoreFile" class="sc-eCApnc liLqNm"><div data-section-id="operation/deleteVectorStoreFile" id="operation/deleteVectorStoreFile" class="sc-iCoGMd gLxhOh"><div class="sc-hKFxyN juinod"><h2 class="sc-pNWdM eftmgB"><a class="sc-crzoAE iUxAWq" href="#tag/Vector-stores/operation/deleteVectorStoreFile" aria-label="tag/Vector-stores/operation/deleteVectorStoreFile"></a>Delete a vector store file. This will remove the file from the vector store but the file itself will not be deleted. To delete the file, use the [delete file](/docs/api-reference/files/delete) endpoint.<!-- --> </h2><div class="sc-fcmMJX cvfxAX"><div class="sc-jUfyBS bhDyou"><h5 class="sc-iqAclL sc-fuISkM eONCmm hZIgic">Authorizations:</h5><svg class="sc-dIsUp iPqByX" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jQAxuV ccffaZ"><span class="sc-daBunf fcvuS"><span class="sc-dsXzNU dPrSxx"><i>ApiKeyAuth</i></span></span></div></div><div><h5 class="sc-iqAclL eONCmm">path<!-- --> Parameters</h5><table class="sc-hHEiqL VCQHZ"><tbody><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="vector_store_id"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">vector_store_id</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The ID of the vector store that the file belongs to.</p>
</div></div></div></td></tr><tr class="last "><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="file_id"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">file_id</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The ID of the file to delete.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-fIxmyt DvFer">Responses</h3><div><button class="sc-htmcrh lbYftx"><svg class="sc-dIsUp dqYXmg" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-fWWYYk cMoEZ">200<!-- --> </strong><span class="sc-jcwpoC eDjFAZ"><p>OK</p>
</span></button></div></div></div><div class="sc-jSFjdj sc-gKAaRy gBjRyf gcushC"><div class="sc-EZqKI fWsqvQ"><button class="sc-eEVmNe ilvUMs"><span type="delete" class="sc-fmdNqN bJzUtf http-verb delete">delete</span><span class="sc-jXcxbT fCEUju">/vector_stores/{vector_store_id}/files/{file_id}</span><svg class="sc-dIsUp bRmrKA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ljsmAU flIrdF"><div class="sc-jlZJtj fQkroN"><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div><div tabindex="0" role="button"><div class="sc-dTSzeu dfUAUz"><span>https://api.openai.com/v1</span>/vector_stores/{vector_store_id}/files/{file_id}</div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Response samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-620" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-621" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-621" aria-labelledby="react-tabs-620"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-bBjRSN kQSIAz">application/json</div></div><div class="sc-jgPyTC dSaTNC"><div class="sc-jNnpgg esZIbL"><div class="sc-giAqHp hMPeqJ"><button><div class="sc-carFqZ UksDl">Copy</div></button></div><div class="sc-iJCRrE jCdxGr sc-dPaNzc gyljjx"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"deleted"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"object"</span>: <span class="token string">"vector_store.file.deleted"</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Vector-stores/operation/updateVectorStoreFileAttributes" data-section-id="tag/Vector-stores/operation/updateVectorStoreFileAttributes" class="sc-eCApnc liLqNm"><div data-section-id="operation/updateVectorStoreFileAttributes" id="operation/updateVectorStoreFileAttributes" class="sc-iCoGMd gLxhOh"><div class="sc-hKFxyN juinod"><h2 class="sc-pNWdM eftmgB"><a class="sc-crzoAE iUxAWq" href="#tag/Vector-stores/operation/updateVectorStoreFileAttributes" aria-label="tag/Vector-stores/operation/updateVectorStoreFileAttributes"></a>Update attributes on a vector store file.<!-- --> </h2><div class="sc-fcmMJX cvfxAX"><div class="sc-jUfyBS bhDyou"><h5 class="sc-iqAclL sc-fuISkM eONCmm hZIgic">Authorizations:</h5><svg class="sc-dIsUp iPqByX" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jQAxuV ccffaZ"><span class="sc-daBunf fcvuS"><span class="sc-dsXzNU dPrSxx"><i>ApiKeyAuth</i></span></span></div></div><div><h5 class="sc-iqAclL eONCmm">path<!-- --> Parameters</h5><table class="sc-hHEiqL VCQHZ"><tbody><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="vector_store_id"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">vector_store_id</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><span class="sc-laZMeE jWaWWE"> <!-- -->Example:<!-- --> </span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">vs_abc123</span></div><div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The ID of the vector store the file belongs to.</p>
</div></div></div></td></tr><tr class="last "><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="file_id"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">file_id</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><span class="sc-laZMeE jWaWWE"> <!-- -->Example:<!-- --> </span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">file-abc123</span></div><div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The ID of the file to update attributes.</p>
</div></div></div></td></tr></tbody></table></div><h5 class="sc-iqAclL eONCmm">Request Body schema: <span class="sc-cBoqAE eKyrDP">application/json</span></h5><div class="sc-iJCRrE sc-ciSkZP jCdxGr QGruV"></div><table class="sc-hHEiqL VCQHZ"><tbody><tr class="last "><td class="sc-hBMUJo sc-fFSPTT sc-gSYDnn iwcKgn cAqMTE hTttpy" kind="field" title="attributes"><span class="sc-iemWCZ bcnRwz"></span><button aria-label="expand properties"><span class="property-name">attributes</span><svg class="sc-dIsUp hGHhhO" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">VectorStoreFileAttributes (object) or VectorStoreFileAttributes (null)</span><span class="sc-laZMeE sc-eJocfa jWaWWE bArHDh"> (<!-- -->VectorStoreFileAttributes<!-- -->) </span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div></div></div></td></tr></tbody></table><div><h3 class="sc-fIxmyt DvFer">Responses</h3><div><button class="sc-htmcrh lbYftx"><svg class="sc-dIsUp dqYXmg" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-fWWYYk cMoEZ">200<!-- --> </strong><span class="sc-jcwpoC eDjFAZ"><p>OK</p>
</span></button></div></div></div><div class="sc-jSFjdj sc-gKAaRy gBjRyf gcushC"><div class="sc-EZqKI fWsqvQ"><button class="sc-eEVmNe ilvUMs"><span type="post" class="sc-fmdNqN ldMUmp http-verb post">post</span><span class="sc-jXcxbT fCEUju">/vector_stores/{vector_store_id}/files/{file_id}</span><svg class="sc-dIsUp bRmrKA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ljsmAU flIrdF"><div class="sc-jlZJtj fQkroN"><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div><div tabindex="0" role="button"><div class="sc-dTSzeu dfUAUz"><span>https://api.openai.com/v1</span>/vector_stores/{vector_store_id}/files/{file_id}</div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Request samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="react-tabs-622" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-623" tabindex="0" data-rttab="true">Payload</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-623" aria-labelledby="react-tabs-622"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-bBjRSN kQSIAz">application/json</div></div><div class="sc-jgPyTC dSaTNC"><div class="sc-jNnpgg esZIbL"><div class="sc-giAqHp hMPeqJ"><button><div class="sc-carFqZ UksDl">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iJCRrE jCdxGr sc-dPaNzc gyljjx"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"attributes"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"property1"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"property2"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Response samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-624" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-625" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-625" aria-labelledby="react-tabs-624"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-bBjRSN kQSIAz">application/json</div></div><div class="sc-jgPyTC dSaTNC"><div class="sc-jNnpgg esZIbL"><div class="sc-giAqHp hMPeqJ"><button><div class="sc-carFqZ UksDl">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iJCRrE jCdxGr sc-dPaNzc gyljjx"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"object"</span>: <span class="token string">"vector_store.file"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"usage_bytes"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"created_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"vector_store_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token string">"in_progress"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"last_error"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"code"</span>: <span class="token string">"server_error"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"message"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"chunking_strategy"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <span class="token string">"static"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"static"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"max_chunk_size_tokens"</span>: <span class="token number">100</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"chunk_overlap_tokens"</span>: <span class="token number">0</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"attributes"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"property1"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"property2"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Vector-stores/operation/retrieveVectorStoreFileContent" data-section-id="tag/Vector-stores/operation/retrieveVectorStoreFileContent" class="sc-eCApnc liLqNm"><div data-section-id="operation/retrieveVectorStoreFileContent" id="operation/retrieveVectorStoreFileContent" class="sc-iCoGMd gLxhOh"><div class="sc-hKFxyN juinod"><h2 class="sc-pNWdM eftmgB"><a class="sc-crzoAE iUxAWq" href="#tag/Vector-stores/operation/retrieveVectorStoreFileContent" aria-label="tag/Vector-stores/operation/retrieveVectorStoreFileContent"></a>Retrieve the parsed contents of a vector store file.<!-- --> </h2><div class="sc-fcmMJX cvfxAX"><div class="sc-jUfyBS bhDyou"><h5 class="sc-iqAclL sc-fuISkM eONCmm hZIgic">Authorizations:</h5><svg class="sc-dIsUp iPqByX" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jQAxuV ccffaZ"><span class="sc-daBunf fcvuS"><span class="sc-dsXzNU dPrSxx"><i>ApiKeyAuth</i></span></span></div></div><div><h5 class="sc-iqAclL eONCmm">path<!-- --> Parameters</h5><table class="sc-hHEiqL VCQHZ"><tbody><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="vector_store_id"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">vector_store_id</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><span class="sc-laZMeE jWaWWE"> <!-- -->Example:<!-- --> </span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">vs_abc123</span></div><div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The ID of the vector store.</p>
</div></div></div></td></tr><tr class="last "><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="file_id"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">file_id</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><span class="sc-laZMeE jWaWWE"> <!-- -->Example:<!-- --> </span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">file-abc123</span></div><div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The ID of the file within the vector store.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-fIxmyt DvFer">Responses</h3><div><button class="sc-htmcrh lbYftx"><svg class="sc-dIsUp dqYXmg" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-fWWYYk cMoEZ">200<!-- --> </strong><span class="sc-jcwpoC eDjFAZ"><p>OK</p>
</span></button></div></div></div><div class="sc-jSFjdj sc-gKAaRy gBjRyf gcushC"><div class="sc-EZqKI fWsqvQ"><button class="sc-eEVmNe ilvUMs"><span type="get" class="sc-fmdNqN ihNycv http-verb get">get</span><span class="sc-jXcxbT fCEUju">/vector_stores/{vector_store_id}/files/{file_id}/content</span><svg class="sc-dIsUp bRmrKA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ljsmAU flIrdF"><div class="sc-jlZJtj fQkroN"><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div><div tabindex="0" role="button"><div class="sc-dTSzeu dfUAUz"><span>https://api.openai.com/v1</span>/vector_stores/{vector_store_id}/files/{file_id}/content</div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Response samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-626" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-627" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-627" aria-labelledby="react-tabs-626"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-bBjRSN kQSIAz">application/json</div></div><div class="sc-jgPyTC dSaTNC"><div class="sc-jNnpgg esZIbL"><div class="sc-giAqHp hMPeqJ"><button><div class="sc-carFqZ UksDl">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iJCRrE jCdxGr sc-dPaNzc gyljjx"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"object"</span>: <span class="token string">"vector_store.file_content.page"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"text"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"has_more"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"next_page"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Vector-stores/operation/searchVectorStore" data-section-id="tag/Vector-stores/operation/searchVectorStore" class="sc-eCApnc liLqNm"><div data-section-id="operation/searchVectorStore" id="operation/searchVectorStore" class="sc-iCoGMd gLxhOh"><div class="sc-hKFxyN juinod"><h2 class="sc-pNWdM eftmgB"><a class="sc-crzoAE iUxAWq" href="#tag/Vector-stores/operation/searchVectorStore" aria-label="tag/Vector-stores/operation/searchVectorStore"></a>Search a vector store for relevant chunks based on a query and file attributes filter.<!-- --> </h2><div class="sc-fcmMJX cvfxAX"><div class="sc-jUfyBS bhDyou"><h5 class="sc-iqAclL sc-fuISkM eONCmm hZIgic">Authorizations:</h5><svg class="sc-dIsUp iPqByX" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jQAxuV ccffaZ"><span class="sc-daBunf fcvuS"><span class="sc-dsXzNU dPrSxx"><i>ApiKeyAuth</i></span></span></div></div><div><h5 class="sc-iqAclL eONCmm">path<!-- --> Parameters</h5><table class="sc-hHEiqL VCQHZ"><tbody><tr class="last "><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="vector_store_id"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">vector_store_id</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><span class="sc-laZMeE jWaWWE"> <!-- -->Example:<!-- --> </span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">vs_abc123</span></div><div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The ID of the vector store to search.</p>
</div></div></div></td></tr></tbody></table></div><h5 class="sc-iqAclL eONCmm">Request Body schema: <span class="sc-cBoqAE eKyrDP">application/json</span></h5><div class="sc-iJCRrE sc-ciSkZP jCdxGr QGruV"></div><table class="sc-hHEiqL VCQHZ"><tbody><tr class=""><td class="sc-hBMUJo sc-fFSPTT sc-gSYDnn iwcKgn cAqMTE hTttpy" kind="field" title="query"><span class="sc-iemWCZ bcnRwz"></span><button aria-label="expand properties"><span class="property-name">query</span><svg class="sc-dIsUp hGHhhO" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string or Array of strings</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>A query string for a search</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="rewrite_query"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">rewrite_query</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">boolean</span></div><div><span class="sc-laZMeE jWaWWE"> <!-- -->Default:<!-- --> </span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">false</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>Whether to rewrite the natural language query for vector search.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="max_num_results"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">max_num_results</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">integer</span><span> <span class="sc-laZMeE sc-FRrlG jWaWWE gHBwqe"> <!-- -->[ 1 .. 50 ]<!-- --> </span></span></div><div><span class="sc-laZMeE jWaWWE"> <!-- -->Default:<!-- --> </span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">10</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The maximum number of results to return. This number should be between 1 and 50 inclusive.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT sc-gSYDnn iwcKgn cAqMTE hTttpy" kind="field" title="filters"><span class="sc-iemWCZ bcnRwz"></span><button aria-label="expand properties"><span class="property-name">filters</span><svg class="sc-dIsUp hGHhhO" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">Comparison Filter (object) or Compound Filter (object)</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>A filter to apply based on file attributes.</p>
</div></div></div></td></tr><tr class="last "><td class="sc-hBMUJo sc-fFSPTT sc-gSYDnn iwcKgn cAqMTE hTttpy" kind="field" title="ranking_options"><span class="sc-iemWCZ bcnRwz"></span><button aria-label="expand properties"><span class="property-name">ranking_options</span><svg class="sc-dIsUp hGHhhO" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">object</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>Ranking options for search.</p>
</div></div></div></td></tr></tbody></table><div><h3 class="sc-fIxmyt DvFer">Responses</h3><div><button class="sc-htmcrh lbYftx"><svg class="sc-dIsUp dqYXmg" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-fWWYYk cMoEZ">200<!-- --> </strong><span class="sc-jcwpoC eDjFAZ"><p>OK</p>
</span></button></div></div></div><div class="sc-jSFjdj sc-gKAaRy gBjRyf gcushC"><div class="sc-EZqKI fWsqvQ"><button class="sc-eEVmNe ilvUMs"><span type="post" class="sc-fmdNqN ldMUmp http-verb post">post</span><span class="sc-jXcxbT fCEUju">/vector_stores/{vector_store_id}/search</span><svg class="sc-dIsUp bRmrKA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ljsmAU flIrdF"><div class="sc-jlZJtj fQkroN"><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div><div tabindex="0" role="button"><div class="sc-dTSzeu dfUAUz"><span>https://api.openai.com/v1</span>/vector_stores/{vector_store_id}/search</div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Request samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="react-tabs-628" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-629" tabindex="0" data-rttab="true">Payload</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-629" aria-labelledby="react-tabs-628"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-bBjRSN kQSIAz">application/json</div></div><div class="sc-jgPyTC dSaTNC"><div class="sc-jNnpgg esZIbL"><div class="sc-giAqHp hMPeqJ"><button><div class="sc-carFqZ UksDl">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iJCRrE jCdxGr sc-dPaNzc gyljjx"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"query"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"rewrite_query"</span>: <span class="token boolean">false</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"max_num_results"</span>: <span class="token number">10</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"filters"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <span class="token string">"eq"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"key"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"value"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"ranking_options"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"ranker"</span>: <span class="token string">"none"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"score_threshold"</span>: <span class="token number">0</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Response samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-630" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-631" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-631" aria-labelledby="react-tabs-630"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-bBjRSN kQSIAz">application/json</div></div><div class="sc-jgPyTC dSaTNC"><div class="sc-jNnpgg esZIbL"><div class="sc-giAqHp hMPeqJ"><button><div class="sc-carFqZ UksDl">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iJCRrE jCdxGr sc-dPaNzc gyljjx"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"object"</span>: <span class="token string">"vector_store.search_results.page"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"search_query"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><span class="token string">"string"</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"file_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"filename"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"score"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"attributes"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"property1"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"property2"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"content"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <span class="token string">"text"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"text"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"has_more"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"next_page"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Videos" data-section-id="tag/Videos" class="sc-eCApnc jlMQbh"><div class="sc-iCoGMd gLxhOh"><div class="sc-hKFxyN juinod"><h1 class="sc-fujyAs bpZWeL"><a class="sc-crzoAE iUxAWq" href="#tag/Videos" aria-label="tag/Videos"></a>Videos</h1></div></div></div><div id="tag/Videos/operation/createVideo" data-section-id="tag/Videos/operation/createVideo" class="sc-eCApnc liLqNm"><div data-section-id="operation/createVideo" id="operation/createVideo" class="sc-iCoGMd gLxhOh"><div class="sc-hKFxyN juinod"><h2 class="sc-pNWdM eftmgB"><a class="sc-crzoAE iUxAWq" href="#tag/Videos/operation/createVideo" aria-label="tag/Videos/operation/createVideo"></a>Create a new video generation job from a prompt and optional reference assets.<!-- --> </h2><div class="sc-fcmMJX cvfxAX"><div class="sc-jUfyBS bhDyou"><h5 class="sc-iqAclL sc-fuISkM eONCmm hZIgic">Authorizations:</h5><svg class="sc-dIsUp iPqByX" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jQAxuV ccffaZ"><span class="sc-daBunf fcvuS"><span class="sc-dsXzNU dPrSxx"><i>ApiKeyAuth</i></span></span></div></div><h5 class="sc-iqAclL eONCmm">Request Body schema: <div class="sc-hiKfDv sc-gXfVKN bycQNU dhIYNk"><svg class="sc-jJMGnK hzcSs" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option selected="" value="multipart/form-data">multipart/form-data</option><option value="application/json">application/json</option></select><label>multipart/form-data</label></div></h5><div class="sc-iJCRrE sc-ciSkZP jCdxGr QGruV"></div><table class="sc-hHEiqL VCQHZ"><tbody><tr class=""><td class="sc-hBMUJo sc-fFSPTT sc-gSYDnn iwcKgn cAqMTE hTttpy" kind="field" title="model"><span class="sc-iemWCZ bcnRwz"></span><button aria-label="expand properties"><span class="property-name">model</span><svg class="sc-dIsUp hGHhhO" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">VideoModel (string) or VideoModel (string)</span><span class="sc-laZMeE sc-eJocfa jWaWWE bArHDh"> (<!-- -->VideoModel<!-- -->) </span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The video generation model to use (allowed values: sora-2, sora-2-pro). Defaults to <code>sora-2</code>.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="prompt"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">prompt</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span><span> <span class="sc-laZMeE sc-FRrlG jWaWWE gHBwqe"> <!-- -->[ 1 .. 32000 ] characters<!-- --> </span></span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>Text prompt that describes the video to generate.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT sc-gSYDnn iwcKgn cAqMTE hTttpy" kind="field" title="input_reference"><span class="sc-iemWCZ bcnRwz"></span><button aria-label="expand properties"><span class="property-name">input_reference</span><svg class="sc-dIsUp hGHhhO" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string or ImageRefParam-2 (object)</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="seconds"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">seconds</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span><span class="sc-laZMeE sc-eJocfa jWaWWE bArHDh"> (<!-- -->VideoSeconds<!-- -->) </span></div><div><span class="sc-laZMeE jWaWWE"> <!-- -->Enum<!-- -->:</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"4"</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"8"</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"12"</span> </div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>Clip duration in seconds (allowed values: 4, 8, 12). Defaults to 4 seconds.</p>
</div></div></div></td></tr><tr class="last "><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="size"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">size</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span><span class="sc-laZMeE sc-eJocfa jWaWWE bArHDh"> (<!-- -->VideoSize<!-- -->) </span></div><div><span class="sc-laZMeE jWaWWE"> <!-- -->Enum<!-- -->:</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"720x1280"</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"1280x720"</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"1024x1792"</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"1792x1024"</span> </div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>Output resolution formatted as width x height (allowed values: 720x1280, 1280x720, 1024x1792, 1792x1024). Defaults to 720x1280.</p>
</div></div></div></td></tr></tbody></table><div><h3 class="sc-fIxmyt DvFer">Responses</h3><div><button class="sc-htmcrh lbYftx"><svg class="sc-dIsUp dqYXmg" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-fWWYYk cMoEZ">200<!-- --> </strong><span class="sc-jcwpoC eDjFAZ"><p>Success</p>
</span></button></div></div></div><div class="sc-jSFjdj sc-gKAaRy gBjRyf gcushC"><div class="sc-EZqKI fWsqvQ"><button class="sc-eEVmNe ilvUMs"><span type="post" class="sc-fmdNqN ldMUmp http-verb post">post</span><span class="sc-jXcxbT fCEUju">/videos</span><svg class="sc-dIsUp bRmrKA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ljsmAU flIrdF"><div class="sc-jlZJtj fQkroN"><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div><div tabindex="0" role="button"><div class="sc-dTSzeu dfUAUz"><span>https://api.openai.com/v1</span>/videos</div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Request samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="react-tabs-632" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-633" tabindex="0" data-rttab="true">Payload</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-633" aria-labelledby="react-tabs-632"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-hiKfDv sc-khIgEk bycQNU hLNtis"><svg class="sc-jJMGnK gVpQmv" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option selected="" value="multipart/form-data">multipart/form-data</option><option value="application/json">application/json</option></select><label>multipart/form-data</label></div></div><div class="sc-hTRkXV kuxzOM">No sample</div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Response samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-634" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-635" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-635" aria-labelledby="react-tabs-634"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-bBjRSN kQSIAz">application/json</div></div><div class="sc-jgPyTC dSaTNC"><div class="sc-jNnpgg esZIbL"><div class="sc-giAqHp hMPeqJ"><button><div class="sc-carFqZ UksDl">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iJCRrE jCdxGr sc-dPaNzc gyljjx"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"object"</span>: <span class="token string">"video"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"model"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token string">"queued"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"progress"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"created_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"completed_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"expires_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"prompt"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"size"</span>: <span class="token string">"720x1280"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"seconds"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"remixed_from_video_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"error"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"code"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"message"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Videos/operation/ListVideos" data-section-id="tag/Videos/operation/ListVideos" class="sc-eCApnc liLqNm"><div data-section-id="operation/ListVideos" id="operation/ListVideos" class="sc-iCoGMd gLxhOh"><div class="sc-hKFxyN juinod"><h2 class="sc-pNWdM eftmgB"><a class="sc-crzoAE iUxAWq" href="#tag/Videos/operation/ListVideos" aria-label="tag/Videos/operation/ListVideos"></a>List recently generated videos for the current project.<!-- --> </h2><div class="sc-fcmMJX cvfxAX"><div class="sc-jUfyBS bhDyou"><h5 class="sc-iqAclL sc-fuISkM eONCmm hZIgic">Authorizations:</h5><svg class="sc-dIsUp iPqByX" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jQAxuV ccffaZ"><span class="sc-daBunf fcvuS"><span class="sc-dsXzNU dPrSxx"><i>ApiKeyAuth</i></span></span></div></div><div><h5 class="sc-iqAclL eONCmm">query<!-- --> Parameters</h5><table class="sc-hHEiqL VCQHZ"><tbody><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="limit"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">limit</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">integer</span><span> <span class="sc-laZMeE sc-FRrlG jWaWWE gHBwqe"> <!-- -->[ 0 .. 100 ]<!-- --> </span></span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>Number of items to retrieve</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="order"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">order</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span><span class="sc-laZMeE sc-eJocfa jWaWWE bArHDh"> (<!-- -->OrderEnum<!-- -->) </span></div><div><span class="sc-laZMeE jWaWWE"> <!-- -->Enum<!-- -->:</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"asc"</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"desc"</span> </div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>Sort order of results by timestamp. Use <code>asc</code> for ascending order or <code>desc</code> for descending order.</p>
</div></div></div></td></tr><tr class="last "><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="after"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">after</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>Identifier for the last item from the previous pagination request</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-fIxmyt DvFer">Responses</h3><div><button class="sc-htmcrh lbYftx"><svg class="sc-dIsUp dqYXmg" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-fWWYYk cMoEZ">200<!-- --> </strong><span class="sc-jcwpoC eDjFAZ"><p>Success</p>
</span></button></div></div></div><div class="sc-jSFjdj sc-gKAaRy gBjRyf gcushC"><div class="sc-EZqKI fWsqvQ"><button class="sc-eEVmNe ilvUMs"><span type="get" class="sc-fmdNqN ihNycv http-verb get">get</span><span class="sc-jXcxbT fCEUju">/videos</span><svg class="sc-dIsUp bRmrKA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ljsmAU flIrdF"><div class="sc-jlZJtj fQkroN"><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div><div tabindex="0" role="button"><div class="sc-dTSzeu dfUAUz"><span>https://api.openai.com/v1</span>/videos</div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Response samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-636" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-637" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-637" aria-labelledby="react-tabs-636"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-bBjRSN kQSIAz">application/json</div></div><div class="sc-jgPyTC dSaTNC"><div class="sc-jNnpgg esZIbL"><div class="sc-giAqHp hMPeqJ"><button><div class="sc-carFqZ UksDl">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iJCRrE jCdxGr sc-dPaNzc gyljjx"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"object"</span>: <span class="token string">"list"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"object"</span>: <span class="token string">"video"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"model"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"status"</span>: <span class="token string">"queued"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"progress"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"created_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"completed_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"expires_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"prompt"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"size"</span>: <span class="token string">"720x1280"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"seconds"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"remixed_from_video_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"error"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"code"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"message"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"first_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"last_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"has_more"</span>: <span class="token boolean">true</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Videos/operation/CreateVideoCharacter" data-section-id="tag/Videos/operation/CreateVideoCharacter" class="sc-eCApnc liLqNm"><div data-section-id="operation/CreateVideoCharacter" id="operation/CreateVideoCharacter" class="sc-iCoGMd gLxhOh"><div class="sc-hKFxyN juinod"><h2 class="sc-pNWdM eftmgB"><a class="sc-crzoAE iUxAWq" href="#tag/Videos/operation/CreateVideoCharacter" aria-label="tag/Videos/operation/CreateVideoCharacter"></a>Create a character from an uploaded video.<!-- --> </h2><div class="sc-fcmMJX cvfxAX"><div class="sc-jUfyBS bhDyou"><h5 class="sc-iqAclL sc-fuISkM eONCmm hZIgic">Authorizations:</h5><svg class="sc-dIsUp iPqByX" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jQAxuV ccffaZ"><span class="sc-daBunf fcvuS"><span class="sc-dsXzNU dPrSxx"><i>ApiKeyAuth</i></span></span></div></div><h5 class="sc-iqAclL eONCmm">Request Body schema: <span class="sc-cBoqAE eKyrDP">multipart/form-data</span></h5><div class="sc-iJCRrE sc-ciSkZP jCdxGr QGruV"></div><table class="sc-hHEiqL VCQHZ"><tbody><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="video"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">video</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa"> <!-- --><<!-- -->binary<!-- -->><!-- --> </span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>Video file used to create a character.</p>
</div></div></div></td></tr><tr class="last "><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="name"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">name</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span><span> <span class="sc-laZMeE sc-FRrlG jWaWWE gHBwqe"> <!-- -->[ 1 .. 80 ] characters<!-- --> </span></span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>Display name for this API character.</p>
</div></div></div></td></tr></tbody></table><div><h3 class="sc-fIxmyt DvFer">Responses</h3><div><button class="sc-htmcrh lbYftx"><svg class="sc-dIsUp dqYXmg" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-fWWYYk cMoEZ">200<!-- --> </strong><span class="sc-jcwpoC eDjFAZ"><p>Success</p>
</span></button></div></div></div><div class="sc-jSFjdj sc-gKAaRy gBjRyf gcushC"><div class="sc-EZqKI fWsqvQ"><button class="sc-eEVmNe ilvUMs"><span type="post" class="sc-fmdNqN ldMUmp http-verb post">post</span><span class="sc-jXcxbT fCEUju">/videos/characters</span><svg class="sc-dIsUp bRmrKA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ljsmAU flIrdF"><div class="sc-jlZJtj fQkroN"><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div><div tabindex="0" role="button"><div class="sc-dTSzeu dfUAUz"><span>https://api.openai.com/v1</span>/videos/characters</div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Response samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-638" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-639" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-639" aria-labelledby="react-tabs-638"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-bBjRSN kQSIAz">application/json</div></div><div class="sc-jgPyTC dSaTNC"><div class="sc-jNnpgg esZIbL"><div class="sc-giAqHp hMPeqJ"><button><div class="sc-carFqZ UksDl">Copy</div></button></div><div class="sc-iJCRrE jCdxGr sc-dPaNzc gyljjx"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"created_at"</span>: <span class="token number">0</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Videos/operation/GetVideoCharacter" data-section-id="tag/Videos/operation/GetVideoCharacter" class="sc-eCApnc liLqNm"><div data-section-id="operation/GetVideoCharacter" id="operation/GetVideoCharacter" class="sc-iCoGMd gLxhOh"><div class="sc-hKFxyN juinod"><h2 class="sc-pNWdM eftmgB"><a class="sc-crzoAE iUxAWq" href="#tag/Videos/operation/GetVideoCharacter" aria-label="tag/Videos/operation/GetVideoCharacter"></a>Fetch a character.<!-- --> </h2><div class="sc-fcmMJX cvfxAX"><div class="sc-jUfyBS bhDyou"><h5 class="sc-iqAclL sc-fuISkM eONCmm hZIgic">Authorizations:</h5><svg class="sc-dIsUp iPqByX" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jQAxuV ccffaZ"><span class="sc-daBunf fcvuS"><span class="sc-dsXzNU dPrSxx"><i>ApiKeyAuth</i></span></span></div></div><div><h5 class="sc-iqAclL eONCmm">path<!-- --> Parameters</h5><table class="sc-hHEiqL VCQHZ"><tbody><tr class="last "><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="character_id"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">character_id</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><span class="sc-laZMeE jWaWWE"> <!-- -->Example:<!-- --> </span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">char_123</span></div><div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The identifier of the character to retrieve.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-fIxmyt DvFer">Responses</h3><div><button class="sc-htmcrh lbYftx"><svg class="sc-dIsUp dqYXmg" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-fWWYYk cMoEZ">200<!-- --> </strong><span class="sc-jcwpoC eDjFAZ"><p>Success</p>
</span></button></div></div></div><div class="sc-jSFjdj sc-gKAaRy gBjRyf gcushC"><div class="sc-EZqKI fWsqvQ"><button class="sc-eEVmNe ilvUMs"><span type="get" class="sc-fmdNqN ihNycv http-verb get">get</span><span class="sc-jXcxbT fCEUju">/videos/characters/{character_id}</span><svg class="sc-dIsUp bRmrKA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ljsmAU flIrdF"><div class="sc-jlZJtj fQkroN"><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div><div tabindex="0" role="button"><div class="sc-dTSzeu dfUAUz"><span>https://api.openai.com/v1</span>/videos/characters/{character_id}</div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Response samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-640" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-641" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-641" aria-labelledby="react-tabs-640"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-bBjRSN kQSIAz">application/json</div></div><div class="sc-jgPyTC dSaTNC"><div class="sc-jNnpgg esZIbL"><div class="sc-giAqHp hMPeqJ"><button><div class="sc-carFqZ UksDl">Copy</div></button></div><div class="sc-iJCRrE jCdxGr sc-dPaNzc gyljjx"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"created_at"</span>: <span class="token number">0</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Videos/operation/CreateVideoEdit" data-section-id="tag/Videos/operation/CreateVideoEdit" class="sc-eCApnc liLqNm"><div data-section-id="operation/CreateVideoEdit" id="operation/CreateVideoEdit" class="sc-iCoGMd gLxhOh"><div class="sc-hKFxyN juinod"><h2 class="sc-pNWdM eftmgB"><a class="sc-crzoAE iUxAWq" href="#tag/Videos/operation/CreateVideoEdit" aria-label="tag/Videos/operation/CreateVideoEdit"></a>Create a new video generation job by editing a source video or existing generated video.<!-- --> </h2><div class="sc-fcmMJX cvfxAX"><div class="sc-jUfyBS bhDyou"><h5 class="sc-iqAclL sc-fuISkM eONCmm hZIgic">Authorizations:</h5><svg class="sc-dIsUp iPqByX" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jQAxuV ccffaZ"><span class="sc-daBunf fcvuS"><span class="sc-dsXzNU dPrSxx"><i>ApiKeyAuth</i></span></span></div></div><h5 class="sc-iqAclL eONCmm">Request Body schema: <div class="sc-hiKfDv sc-gXfVKN bycQNU dhIYNk"><svg class="sc-jJMGnK hzcSs" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option selected="" value="multipart/form-data">multipart/form-data</option><option value="application/json">application/json</option></select><label>multipart/form-data</label></div></h5><div class="sc-iJCRrE sc-ciSkZP jCdxGr QGruV"></div><table class="sc-hHEiqL VCQHZ"><tbody><tr class=""><td class="sc-hBMUJo sc-fFSPTT sc-gSYDnn iwcKgn cAqMTE hTttpy" kind="field" title="video"><span class="sc-iemWCZ bcnRwz"></span><button aria-label="expand properties"><span class="property-name">video</span><svg class="sc-dIsUp hGHhhO" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string or VideoReferenceInputParam (object)</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div></div></div></td></tr><tr class="last "><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="prompt"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">prompt</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span><span> <span class="sc-laZMeE sc-FRrlG jWaWWE gHBwqe"> <!-- -->[ 1 .. 32000 ] characters<!-- --> </span></span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>Text prompt that describes how to edit the source video.</p>
</div></div></div></td></tr></tbody></table><div><h3 class="sc-fIxmyt DvFer">Responses</h3><div><button class="sc-htmcrh lbYftx"><svg class="sc-dIsUp dqYXmg" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-fWWYYk cMoEZ">200<!-- --> </strong><span class="sc-jcwpoC eDjFAZ"><p>Success</p>
</span></button></div></div></div><div class="sc-jSFjdj sc-gKAaRy gBjRyf gcushC"><div class="sc-EZqKI fWsqvQ"><button class="sc-eEVmNe ilvUMs"><span type="post" class="sc-fmdNqN ldMUmp http-verb post">post</span><span class="sc-jXcxbT fCEUju">/videos/edits</span><svg class="sc-dIsUp bRmrKA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ljsmAU flIrdF"><div class="sc-jlZJtj fQkroN"><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div><div tabindex="0" role="button"><div class="sc-dTSzeu dfUAUz"><span>https://api.openai.com/v1</span>/videos/edits</div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Request samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="react-tabs-642" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-643" tabindex="0" data-rttab="true">Payload</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-643" aria-labelledby="react-tabs-642"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-hiKfDv sc-khIgEk bycQNU hLNtis"><svg class="sc-jJMGnK gVpQmv" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option selected="" value="multipart/form-data">multipart/form-data</option><option value="application/json">application/json</option></select><label>multipart/form-data</label></div></div><div class="sc-hTRkXV kuxzOM">No sample</div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Response samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-644" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-645" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-645" aria-labelledby="react-tabs-644"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-bBjRSN kQSIAz">application/json</div></div><div class="sc-jgPyTC dSaTNC"><div class="sc-jNnpgg esZIbL"><div class="sc-giAqHp hMPeqJ"><button><div class="sc-carFqZ UksDl">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iJCRrE jCdxGr sc-dPaNzc gyljjx"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"object"</span>: <span class="token string">"video"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"model"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token string">"queued"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"progress"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"created_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"completed_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"expires_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"prompt"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"size"</span>: <span class="token string">"720x1280"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"seconds"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"remixed_from_video_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"error"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"code"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"message"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Videos/operation/CreateVideoExtend" data-section-id="tag/Videos/operation/CreateVideoExtend" class="sc-eCApnc liLqNm"><div data-section-id="operation/CreateVideoExtend" id="operation/CreateVideoExtend" class="sc-iCoGMd gLxhOh"><div class="sc-hKFxyN juinod"><h2 class="sc-pNWdM eftmgB"><a class="sc-crzoAE iUxAWq" href="#tag/Videos/operation/CreateVideoExtend" aria-label="tag/Videos/operation/CreateVideoExtend"></a>Create an extension of a completed video.<!-- --> </h2><div class="sc-fcmMJX cvfxAX"><div class="sc-jUfyBS bhDyou"><h5 class="sc-iqAclL sc-fuISkM eONCmm hZIgic">Authorizations:</h5><svg class="sc-dIsUp iPqByX" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jQAxuV ccffaZ"><span class="sc-daBunf fcvuS"><span class="sc-dsXzNU dPrSxx"><i>ApiKeyAuth</i></span></span></div></div><h5 class="sc-iqAclL eONCmm">Request Body schema: <div class="sc-hiKfDv sc-gXfVKN bycQNU dhIYNk"><svg class="sc-jJMGnK hzcSs" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option selected="" value="multipart/form-data">multipart/form-data</option><option value="application/json">application/json</option></select><label>multipart/form-data</label></div></h5><div class="sc-iJCRrE sc-ciSkZP jCdxGr QGruV"></div><table class="sc-hHEiqL VCQHZ"><tbody><tr class=""><td class="sc-hBMUJo sc-fFSPTT sc-gSYDnn iwcKgn cAqMTE hTttpy" kind="field" title="video"><span class="sc-iemWCZ bcnRwz"></span><button aria-label="expand properties"><span class="property-name">video</span><svg class="sc-dIsUp hGHhhO" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">VideoReferenceInputParam (object) or string</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="prompt"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">prompt</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span><span> <span class="sc-laZMeE sc-FRrlG jWaWWE gHBwqe"> <!-- -->[ 1 .. 32000 ] characters<!-- --> </span></span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>Updated text prompt that directs the extension generation.</p>
</div></div></div></td></tr><tr class="last "><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="seconds"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">seconds</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span><span class="sc-laZMeE sc-eJocfa jWaWWE bArHDh"> (<!-- -->VideoSeconds<!-- -->) </span></div><div><span class="sc-laZMeE jWaWWE"> <!-- -->Enum<!-- -->:</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"4"</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"8"</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"12"</span> </div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>Length of the newly generated extension segment in seconds (allowed values: 4, 8, 12, 16, 20).</p>
</div></div></div></td></tr></tbody></table><div><h3 class="sc-fIxmyt DvFer">Responses</h3><div><button class="sc-htmcrh lbYftx"><svg class="sc-dIsUp dqYXmg" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-fWWYYk cMoEZ">200<!-- --> </strong><span class="sc-jcwpoC eDjFAZ"><p>Success</p>
</span></button></div></div></div><div class="sc-jSFjdj sc-gKAaRy gBjRyf gcushC"><div class="sc-EZqKI fWsqvQ"><button class="sc-eEVmNe ilvUMs"><span type="post" class="sc-fmdNqN ldMUmp http-verb post">post</span><span class="sc-jXcxbT fCEUju">/videos/extensions</span><svg class="sc-dIsUp bRmrKA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ljsmAU flIrdF"><div class="sc-jlZJtj fQkroN"><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div><div tabindex="0" role="button"><div class="sc-dTSzeu dfUAUz"><span>https://api.openai.com/v1</span>/videos/extensions</div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Request samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="react-tabs-646" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-647" tabindex="0" data-rttab="true">Payload</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-647" aria-labelledby="react-tabs-646"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-hiKfDv sc-khIgEk bycQNU hLNtis"><svg class="sc-jJMGnK gVpQmv" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option selected="" value="multipart/form-data">multipart/form-data</option><option value="application/json">application/json</option></select><label>multipart/form-data</label></div></div><div class="sc-hTRkXV kuxzOM">No sample</div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Response samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-648" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-649" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-649" aria-labelledby="react-tabs-648"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-bBjRSN kQSIAz">application/json</div></div><div class="sc-jgPyTC dSaTNC"><div class="sc-jNnpgg esZIbL"><div class="sc-giAqHp hMPeqJ"><button><div class="sc-carFqZ UksDl">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iJCRrE jCdxGr sc-dPaNzc gyljjx"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"object"</span>: <span class="token string">"video"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"model"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token string">"queued"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"progress"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"created_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"completed_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"expires_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"prompt"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"size"</span>: <span class="token string">"720x1280"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"seconds"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"remixed_from_video_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"error"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"code"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"message"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Videos/operation/GetVideo" data-section-id="tag/Videos/operation/GetVideo" class="sc-eCApnc liLqNm"><div data-section-id="operation/GetVideo" id="operation/GetVideo" class="sc-iCoGMd gLxhOh"><div class="sc-hKFxyN juinod"><h2 class="sc-pNWdM eftmgB"><a class="sc-crzoAE iUxAWq" href="#tag/Videos/operation/GetVideo" aria-label="tag/Videos/operation/GetVideo"></a>Fetch the latest metadata for a generated video.<!-- --> </h2><div class="sc-fcmMJX cvfxAX"><div class="sc-jUfyBS bhDyou"><h5 class="sc-iqAclL sc-fuISkM eONCmm hZIgic">Authorizations:</h5><svg class="sc-dIsUp iPqByX" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jQAxuV ccffaZ"><span class="sc-daBunf fcvuS"><span class="sc-dsXzNU dPrSxx"><i>ApiKeyAuth</i></span></span></div></div><div><h5 class="sc-iqAclL eONCmm">path<!-- --> Parameters</h5><table class="sc-hHEiqL VCQHZ"><tbody><tr class="last "><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="video_id"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">video_id</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><span class="sc-laZMeE jWaWWE"> <!-- -->Example:<!-- --> </span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">video_123</span></div><div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The identifier of the video to retrieve.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-fIxmyt DvFer">Responses</h3><div><button class="sc-htmcrh lbYftx"><svg class="sc-dIsUp dqYXmg" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-fWWYYk cMoEZ">200<!-- --> </strong><span class="sc-jcwpoC eDjFAZ"><p>Success</p>
</span></button></div></div></div><div class="sc-jSFjdj sc-gKAaRy gBjRyf gcushC"><div class="sc-EZqKI fWsqvQ"><button class="sc-eEVmNe ilvUMs"><span type="get" class="sc-fmdNqN ihNycv http-verb get">get</span><span class="sc-jXcxbT fCEUju">/videos/{video_id}</span><svg class="sc-dIsUp bRmrKA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ljsmAU flIrdF"><div class="sc-jlZJtj fQkroN"><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div><div tabindex="0" role="button"><div class="sc-dTSzeu dfUAUz"><span>https://api.openai.com/v1</span>/videos/{video_id}</div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Response samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-650" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-651" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-651" aria-labelledby="react-tabs-650"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-bBjRSN kQSIAz">application/json</div></div><div class="sc-jgPyTC dSaTNC"><div class="sc-jNnpgg esZIbL"><div class="sc-giAqHp hMPeqJ"><button><div class="sc-carFqZ UksDl">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iJCRrE jCdxGr sc-dPaNzc gyljjx"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"object"</span>: <span class="token string">"video"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"model"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token string">"queued"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"progress"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"created_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"completed_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"expires_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"prompt"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"size"</span>: <span class="token string">"720x1280"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"seconds"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"remixed_from_video_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"error"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"code"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"message"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Videos/operation/DeleteVideo" data-section-id="tag/Videos/operation/DeleteVideo" class="sc-eCApnc liLqNm"><div data-section-id="operation/DeleteVideo" id="operation/DeleteVideo" class="sc-iCoGMd gLxhOh"><div class="sc-hKFxyN juinod"><h2 class="sc-pNWdM eftmgB"><a class="sc-crzoAE iUxAWq" href="#tag/Videos/operation/DeleteVideo" aria-label="tag/Videos/operation/DeleteVideo"></a>Permanently delete a completed or failed video and its stored assets.<!-- --> </h2><div class="sc-fcmMJX cvfxAX"><div class="sc-jUfyBS bhDyou"><h5 class="sc-iqAclL sc-fuISkM eONCmm hZIgic">Authorizations:</h5><svg class="sc-dIsUp iPqByX" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jQAxuV ccffaZ"><span class="sc-daBunf fcvuS"><span class="sc-dsXzNU dPrSxx"><i>ApiKeyAuth</i></span></span></div></div><div><h5 class="sc-iqAclL eONCmm">path<!-- --> Parameters</h5><table class="sc-hHEiqL VCQHZ"><tbody><tr class="last "><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="video_id"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">video_id</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><span class="sc-laZMeE jWaWWE"> <!-- -->Example:<!-- --> </span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">video_123</span></div><div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The identifier of the video to delete.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-fIxmyt DvFer">Responses</h3><div><button class="sc-htmcrh lbYftx"><svg class="sc-dIsUp dqYXmg" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-fWWYYk cMoEZ">200<!-- --> </strong><span class="sc-jcwpoC eDjFAZ"><p>Success</p>
</span></button></div></div></div><div class="sc-jSFjdj sc-gKAaRy gBjRyf gcushC"><div class="sc-EZqKI fWsqvQ"><button class="sc-eEVmNe ilvUMs"><span type="delete" class="sc-fmdNqN bJzUtf http-verb delete">delete</span><span class="sc-jXcxbT fCEUju">/videos/{video_id}</span><svg class="sc-dIsUp bRmrKA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ljsmAU flIrdF"><div class="sc-jlZJtj fQkroN"><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div><div tabindex="0" role="button"><div class="sc-dTSzeu dfUAUz"><span>https://api.openai.com/v1</span>/videos/{video_id}</div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Response samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-652" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-653" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-653" aria-labelledby="react-tabs-652"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-bBjRSN kQSIAz">application/json</div></div><div class="sc-jgPyTC dSaTNC"><div class="sc-jNnpgg esZIbL"><div class="sc-giAqHp hMPeqJ"><button><div class="sc-carFqZ UksDl">Copy</div></button></div><div class="sc-iJCRrE jCdxGr sc-dPaNzc gyljjx"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"object"</span>: <span class="token string">"video.deleted"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"deleted"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Videos/operation/RetrieveVideoContent" data-section-id="tag/Videos/operation/RetrieveVideoContent" class="sc-eCApnc liLqNm"><div data-section-id="operation/RetrieveVideoContent" id="operation/RetrieveVideoContent" class="sc-iCoGMd gLxhOh"><div class="sc-hKFxyN juinod"><h2 class="sc-pNWdM eftmgB"><a class="sc-crzoAE iUxAWq" href="#tag/Videos/operation/RetrieveVideoContent" aria-label="tag/Videos/operation/RetrieveVideoContent"></a>Download the generated video bytes or a derived preview asset.
Streams the rendered video content for the specified video job.<!-- --> </h2><div class="sc-fcmMJX cvfxAX"><div class="sc-jUfyBS bhDyou"><h5 class="sc-iqAclL sc-fuISkM eONCmm hZIgic">Authorizations:</h5><svg class="sc-dIsUp iPqByX" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jQAxuV ccffaZ"><span class="sc-daBunf fcvuS"><span class="sc-dsXzNU dPrSxx"><i>ApiKeyAuth</i></span></span></div></div><div><h5 class="sc-iqAclL eONCmm">path<!-- --> Parameters</h5><table class="sc-hHEiqL VCQHZ"><tbody><tr class="last "><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="video_id"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">video_id</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><span class="sc-laZMeE jWaWWE"> <!-- -->Example:<!-- --> </span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">video_123</span></div><div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The identifier of the video whose media to download.</p>
</div></div></div></td></tr></tbody></table></div><div><h5 class="sc-iqAclL eONCmm">query<!-- --> Parameters</h5><table class="sc-hHEiqL VCQHZ"><tbody><tr class="last "><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="variant"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">variant</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span><span class="sc-laZMeE sc-eJocfa jWaWWE bArHDh"> (<!-- -->VideoContentVariant<!-- -->) </span></div><div><span class="sc-laZMeE jWaWWE"> <!-- -->Enum<!-- -->:</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"video"</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"thumbnail"</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"spritesheet"</span> </div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>Which downloadable asset to return. Defaults to the MP4 video.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-fIxmyt DvFer">Responses</h3><div><button class="sc-htmcrh lbYftx"><svg class="sc-dIsUp dqYXmg" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-fWWYYk cMoEZ">200<!-- --> </strong><span class="sc-jcwpoC eDjFAZ"><p>The video bytes or preview asset that matches the requested variant.</p>
</span></button></div></div></div><div class="sc-jSFjdj sc-gKAaRy gBjRyf gcushC"><div class="sc-EZqKI fWsqvQ"><button class="sc-eEVmNe ilvUMs"><span type="get" class="sc-fmdNqN ihNycv http-verb get">get</span><span class="sc-jXcxbT fCEUju">/videos/{video_id}/content</span><svg class="sc-dIsUp bRmrKA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ljsmAU flIrdF"><div class="sc-jlZJtj fQkroN"><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div><div tabindex="0" role="button"><div class="sc-dTSzeu dfUAUz"><span>https://api.openai.com/v1</span>/videos/{video_id}/content</div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Response samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-654" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-655" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-655" aria-labelledby="react-tabs-654"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-hiKfDv sc-khIgEk bycQNU hLNtis"><svg class="sc-jJMGnK gVpQmv" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option selected="" value="video/mp4">video/mp4</option><option value="image/webp">image/webp</option><option value="application/json">application/json</option></select><label>video/mp4</label></div></div><div class="sc-hTRkXV kuxzOM">No sample</div></div></div></div></div></div></div></div><div id="tag/Videos/operation/CreateVideoRemix" data-section-id="tag/Videos/operation/CreateVideoRemix" class="sc-eCApnc liLqNm"><div data-section-id="operation/CreateVideoRemix" id="operation/CreateVideoRemix" class="sc-iCoGMd gLxhOh"><div class="sc-hKFxyN juinod"><h2 class="sc-pNWdM eftmgB"><a class="sc-crzoAE iUxAWq" href="#tag/Videos/operation/CreateVideoRemix" aria-label="tag/Videos/operation/CreateVideoRemix"></a>Create a remix of a completed video using a refreshed prompt.<!-- --> </h2><div class="sc-fcmMJX cvfxAX"><div class="sc-jUfyBS bhDyou"><h5 class="sc-iqAclL sc-fuISkM eONCmm hZIgic">Authorizations:</h5><svg class="sc-dIsUp iPqByX" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jQAxuV ccffaZ"><span class="sc-daBunf fcvuS"><span class="sc-dsXzNU dPrSxx"><i>ApiKeyAuth</i></span></span></div></div><div><h5 class="sc-iqAclL eONCmm">path<!-- --> Parameters</h5><table class="sc-hHEiqL VCQHZ"><tbody><tr class="last "><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="video_id"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">video_id</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><span class="sc-laZMeE jWaWWE"> <!-- -->Example:<!-- --> </span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">video_123</span></div><div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The identifier of the completed video to remix.</p>
</div></div></div></td></tr></tbody></table></div><h5 class="sc-iqAclL eONCmm">Request Body schema: <div class="sc-hiKfDv sc-gXfVKN bycQNU dhIYNk"><svg class="sc-jJMGnK hzcSs" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option selected="" value="multipart/form-data">multipart/form-data</option><option value="application/json">application/json</option></select><label>multipart/form-data</label></div></h5><div class="sc-iJCRrE sc-ciSkZP jCdxGr QGruV"></div><table class="sc-hHEiqL VCQHZ"><tbody><tr class="last "><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="prompt"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">prompt</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span><span> <span class="sc-laZMeE sc-FRrlG jWaWWE gHBwqe"> <!-- -->[ 1 .. 32000 ] characters<!-- --> </span></span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>Updated text prompt that directs the remix generation.</p>
</div></div></div></td></tr></tbody></table><div><h3 class="sc-fIxmyt DvFer">Responses</h3><div><button class="sc-htmcrh lbYftx"><svg class="sc-dIsUp dqYXmg" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-fWWYYk cMoEZ">200<!-- --> </strong><span class="sc-jcwpoC eDjFAZ"><p>Success</p>
</span></button></div></div></div><div class="sc-jSFjdj sc-gKAaRy gBjRyf gcushC"><div class="sc-EZqKI fWsqvQ"><button class="sc-eEVmNe ilvUMs"><span type="post" class="sc-fmdNqN ldMUmp http-verb post">post</span><span class="sc-jXcxbT fCEUju">/videos/{video_id}/remix</span><svg class="sc-dIsUp bRmrKA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ljsmAU flIrdF"><div class="sc-jlZJtj fQkroN"><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div><div tabindex="0" role="button"><div class="sc-dTSzeu dfUAUz"><span>https://api.openai.com/v1</span>/videos/{video_id}/remix</div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Request samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="react-tabs-656" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-657" tabindex="0" data-rttab="true">Payload</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-657" aria-labelledby="react-tabs-656"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-hiKfDv sc-khIgEk bycQNU hLNtis"><svg class="sc-jJMGnK gVpQmv" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option selected="" value="multipart/form-data">multipart/form-data</option><option value="application/json">application/json</option></select><label>multipart/form-data</label></div></div><div class="sc-hTRkXV kuxzOM">No sample</div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Response samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-658" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-659" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-659" aria-labelledby="react-tabs-658"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-bBjRSN kQSIAz">application/json</div></div><div class="sc-jgPyTC dSaTNC"><div class="sc-jNnpgg esZIbL"><div class="sc-giAqHp hMPeqJ"><button><div class="sc-carFqZ UksDl">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iJCRrE jCdxGr sc-dPaNzc gyljjx"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"object"</span>: <span class="token string">"video"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"model"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token string">"queued"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"progress"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"created_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"completed_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"expires_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"prompt"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"size"</span>: <span class="token string">"720x1280"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"seconds"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"remixed_from_video_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"error"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"code"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"message"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Skills" data-section-id="tag/Skills" class="sc-eCApnc jlMQbh"><div class="sc-iCoGMd gLxhOh"><div class="sc-hKFxyN juinod"><h1 class="sc-fujyAs bpZWeL"><a class="sc-crzoAE iUxAWq" href="#tag/Skills" aria-label="tag/Skills"></a>Skills</h1></div></div></div><div id="tag/Skills/operation/CreateSkill" data-section-id="tag/Skills/operation/CreateSkill" class="sc-eCApnc liLqNm"><div data-section-id="operation/CreateSkill" id="operation/CreateSkill" class="sc-iCoGMd gLxhOh"><div class="sc-hKFxyN juinod"><h2 class="sc-pNWdM eftmgB"><a class="sc-crzoAE iUxAWq" href="#tag/Skills/operation/CreateSkill" aria-label="tag/Skills/operation/CreateSkill"></a>Create a new skill.<!-- --> </h2><div class="sc-fcmMJX cvfxAX"><div class="sc-jUfyBS bhDyou"><h5 class="sc-iqAclL sc-fuISkM eONCmm hZIgic">Authorizations:</h5><svg class="sc-dIsUp iPqByX" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jQAxuV ccffaZ"><span class="sc-daBunf fcvuS"><span class="sc-dsXzNU dPrSxx"><i>ApiKeyAuth</i></span></span></div></div><h5 class="sc-iqAclL eONCmm">Request Body schema: <div class="sc-hiKfDv sc-gXfVKN bycQNU dhIYNk"><svg class="sc-jJMGnK hzcSs" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option selected="" value="multipart/form-data">multipart/form-data</option><option value="application/json">application/json</option></select><label>multipart/form-data</label></div></h5><div class="sc-iJCRrE sc-ciSkZP jCdxGr QGruV"></div><table class="sc-hHEiqL VCQHZ"><tbody><tr class="last "><td class="sc-hBMUJo sc-fFSPTT sc-gSYDnn iwcKgn cAqMTE hTttpy" kind="field" title="files"><span class="sc-iemWCZ bcnRwz"></span><button aria-label="expand properties"><span class="property-name">files</span><svg class="sc-dIsUp hGHhhO" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">Array of strings or string</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div></div></div></td></tr></tbody></table><div><h3 class="sc-fIxmyt DvFer">Responses</h3><div><button class="sc-htmcrh lbYftx"><svg class="sc-dIsUp dqYXmg" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-fWWYYk cMoEZ">200<!-- --> </strong><span class="sc-jcwpoC eDjFAZ"><p>Success</p>
</span></button></div></div></div><div class="sc-jSFjdj sc-gKAaRy gBjRyf gcushC"><div class="sc-EZqKI fWsqvQ"><button class="sc-eEVmNe ilvUMs"><span type="post" class="sc-fmdNqN ldMUmp http-verb post">post</span><span class="sc-jXcxbT fCEUju">/skills</span><svg class="sc-dIsUp bRmrKA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ljsmAU flIrdF"><div class="sc-jlZJtj fQkroN"><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div><div tabindex="0" role="button"><div class="sc-dTSzeu dfUAUz"><span>https://api.openai.com/v1</span>/skills</div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Request samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="react-tabs-660" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-661" tabindex="0" data-rttab="true">Payload</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-661" aria-labelledby="react-tabs-660"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-hiKfDv sc-khIgEk bycQNU hLNtis"><svg class="sc-jJMGnK gVpQmv" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option selected="" value="multipart/form-data">multipart/form-data</option><option value="application/json">application/json</option></select><label>multipart/form-data</label></div></div><div class="sc-hTRkXV kuxzOM">No sample</div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Response samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-662" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-663" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-663" aria-labelledby="react-tabs-662"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-bBjRSN kQSIAz">application/json</div></div><div class="sc-jgPyTC dSaTNC"><div class="sc-jNnpgg esZIbL"><div class="sc-giAqHp hMPeqJ"><button><div class="sc-carFqZ UksDl">Copy</div></button></div><div class="sc-iJCRrE jCdxGr sc-dPaNzc gyljjx"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"object"</span>: <span class="token string">"skill"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"description"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"created_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"default_version"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"latest_version"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Skills/operation/ListSkills" data-section-id="tag/Skills/operation/ListSkills" class="sc-eCApnc liLqNm"><div data-section-id="operation/ListSkills" id="operation/ListSkills" class="sc-iCoGMd gLxhOh"><div class="sc-hKFxyN juinod"><h2 class="sc-pNWdM eftmgB"><a class="sc-crzoAE iUxAWq" href="#tag/Skills/operation/ListSkills" aria-label="tag/Skills/operation/ListSkills"></a>List all skills for the current project.<!-- --> </h2><div class="sc-fcmMJX cvfxAX"><div class="sc-jUfyBS bhDyou"><h5 class="sc-iqAclL sc-fuISkM eONCmm hZIgic">Authorizations:</h5><svg class="sc-dIsUp iPqByX" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jQAxuV ccffaZ"><span class="sc-daBunf fcvuS"><span class="sc-dsXzNU dPrSxx"><i>ApiKeyAuth</i></span></span></div></div><div><h5 class="sc-iqAclL eONCmm">query<!-- --> Parameters</h5><table class="sc-hHEiqL VCQHZ"><tbody><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="limit"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">limit</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">integer</span><span> <span class="sc-laZMeE sc-FRrlG jWaWWE gHBwqe"> <!-- -->[ 0 .. 100 ]<!-- --> </span></span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>Number of items to retrieve</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="order"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">order</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span><span class="sc-laZMeE sc-eJocfa jWaWWE bArHDh"> (<!-- -->OrderEnum<!-- -->) </span></div><div><span class="sc-laZMeE jWaWWE"> <!-- -->Enum<!-- -->:</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"asc"</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"desc"</span> </div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>Sort order of results by timestamp. Use <code>asc</code> for ascending order or <code>desc</code> for descending order.</p>
</div></div></div></td></tr><tr class="last "><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="after"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">after</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>Identifier for the last item from the previous pagination request</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-fIxmyt DvFer">Responses</h3><div><button class="sc-htmcrh lbYftx"><svg class="sc-dIsUp dqYXmg" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-fWWYYk cMoEZ">200<!-- --> </strong><span class="sc-jcwpoC eDjFAZ"><p>Success</p>
</span></button></div></div></div><div class="sc-jSFjdj sc-gKAaRy gBjRyf gcushC"><div class="sc-EZqKI fWsqvQ"><button class="sc-eEVmNe ilvUMs"><span type="get" class="sc-fmdNqN ihNycv http-verb get">get</span><span class="sc-jXcxbT fCEUju">/skills</span><svg class="sc-dIsUp bRmrKA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ljsmAU flIrdF"><div class="sc-jlZJtj fQkroN"><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div><div tabindex="0" role="button"><div class="sc-dTSzeu dfUAUz"><span>https://api.openai.com/v1</span>/skills</div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Response samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-664" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-665" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-665" aria-labelledby="react-tabs-664"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-bBjRSN kQSIAz">application/json</div></div><div class="sc-jgPyTC dSaTNC"><div class="sc-jNnpgg esZIbL"><div class="sc-giAqHp hMPeqJ"><button><div class="sc-carFqZ UksDl">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iJCRrE jCdxGr sc-dPaNzc gyljjx"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"object"</span>: <span class="token string">"list"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"object"</span>: <span class="token string">"skill"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"description"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"created_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"default_version"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"latest_version"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"first_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"last_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"has_more"</span>: <span class="token boolean">true</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Skills/operation/DeleteSkill" data-section-id="tag/Skills/operation/DeleteSkill" class="sc-eCApnc liLqNm"><div data-section-id="operation/DeleteSkill" id="operation/DeleteSkill" class="sc-iCoGMd gLxhOh"><div class="sc-hKFxyN juinod"><h2 class="sc-pNWdM eftmgB"><a class="sc-crzoAE iUxAWq" href="#tag/Skills/operation/DeleteSkill" aria-label="tag/Skills/operation/DeleteSkill"></a>Delete a skill by its ID.<!-- --> </h2><div class="sc-fcmMJX cvfxAX"><div class="sc-jUfyBS bhDyou"><h5 class="sc-iqAclL sc-fuISkM eONCmm hZIgic">Authorizations:</h5><svg class="sc-dIsUp iPqByX" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jQAxuV ccffaZ"><span class="sc-daBunf fcvuS"><span class="sc-dsXzNU dPrSxx"><i>ApiKeyAuth</i></span></span></div></div><div><h5 class="sc-iqAclL eONCmm">path<!-- --> Parameters</h5><table class="sc-hHEiqL VCQHZ"><tbody><tr class="last "><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="skill_id"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">skill_id</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><span class="sc-laZMeE jWaWWE"> <!-- -->Example:<!-- --> </span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">skill_123</span></div><div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The identifier of the skill to delete.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-fIxmyt DvFer">Responses</h3><div><button class="sc-htmcrh lbYftx"><svg class="sc-dIsUp dqYXmg" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-fWWYYk cMoEZ">200<!-- --> </strong><span class="sc-jcwpoC eDjFAZ"><p>Success</p>
</span></button></div></div></div><div class="sc-jSFjdj sc-gKAaRy gBjRyf gcushC"><div class="sc-EZqKI fWsqvQ"><button class="sc-eEVmNe ilvUMs"><span type="delete" class="sc-fmdNqN bJzUtf http-verb delete">delete</span><span class="sc-jXcxbT fCEUju">/skills/{skill_id}</span><svg class="sc-dIsUp bRmrKA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ljsmAU flIrdF"><div class="sc-jlZJtj fQkroN"><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div><div tabindex="0" role="button"><div class="sc-dTSzeu dfUAUz"><span>https://api.openai.com/v1</span>/skills/{skill_id}</div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Response samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-666" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-667" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-667" aria-labelledby="react-tabs-666"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-bBjRSN kQSIAz">application/json</div></div><div class="sc-jgPyTC dSaTNC"><div class="sc-jNnpgg esZIbL"><div class="sc-giAqHp hMPeqJ"><button><div class="sc-carFqZ UksDl">Copy</div></button></div><div class="sc-iJCRrE jCdxGr sc-dPaNzc gyljjx"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"object"</span>: <span class="token string">"skill.deleted"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"deleted"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Skills/operation/GetSkill" data-section-id="tag/Skills/operation/GetSkill" class="sc-eCApnc liLqNm"><div data-section-id="operation/GetSkill" id="operation/GetSkill" class="sc-iCoGMd gLxhOh"><div class="sc-hKFxyN juinod"><h2 class="sc-pNWdM eftmgB"><a class="sc-crzoAE iUxAWq" href="#tag/Skills/operation/GetSkill" aria-label="tag/Skills/operation/GetSkill"></a>Get a skill by its ID.<!-- --> </h2><div class="sc-fcmMJX cvfxAX"><div class="sc-jUfyBS bhDyou"><h5 class="sc-iqAclL sc-fuISkM eONCmm hZIgic">Authorizations:</h5><svg class="sc-dIsUp iPqByX" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jQAxuV ccffaZ"><span class="sc-daBunf fcvuS"><span class="sc-dsXzNU dPrSxx"><i>ApiKeyAuth</i></span></span></div></div><div><h5 class="sc-iqAclL eONCmm">path<!-- --> Parameters</h5><table class="sc-hHEiqL VCQHZ"><tbody><tr class="last "><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="skill_id"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">skill_id</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><span class="sc-laZMeE jWaWWE"> <!-- -->Example:<!-- --> </span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">skill_123</span></div><div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The identifier of the skill to retrieve.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-fIxmyt DvFer">Responses</h3><div><button class="sc-htmcrh lbYftx"><svg class="sc-dIsUp dqYXmg" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-fWWYYk cMoEZ">200<!-- --> </strong><span class="sc-jcwpoC eDjFAZ"><p>Success</p>
</span></button></div></div></div><div class="sc-jSFjdj sc-gKAaRy gBjRyf gcushC"><div class="sc-EZqKI fWsqvQ"><button class="sc-eEVmNe ilvUMs"><span type="get" class="sc-fmdNqN ihNycv http-verb get">get</span><span class="sc-jXcxbT fCEUju">/skills/{skill_id}</span><svg class="sc-dIsUp bRmrKA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ljsmAU flIrdF"><div class="sc-jlZJtj fQkroN"><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div><div tabindex="0" role="button"><div class="sc-dTSzeu dfUAUz"><span>https://api.openai.com/v1</span>/skills/{skill_id}</div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Response samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-668" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-669" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-669" aria-labelledby="react-tabs-668"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-bBjRSN kQSIAz">application/json</div></div><div class="sc-jgPyTC dSaTNC"><div class="sc-jNnpgg esZIbL"><div class="sc-giAqHp hMPeqJ"><button><div class="sc-carFqZ UksDl">Copy</div></button></div><div class="sc-iJCRrE jCdxGr sc-dPaNzc gyljjx"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"object"</span>: <span class="token string">"skill"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"description"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"created_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"default_version"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"latest_version"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Skills/operation/UpdateSkillDefaultVersion" data-section-id="tag/Skills/operation/UpdateSkillDefaultVersion" class="sc-eCApnc liLqNm"><div data-section-id="operation/UpdateSkillDefaultVersion" id="operation/UpdateSkillDefaultVersion" class="sc-iCoGMd gLxhOh"><div class="sc-hKFxyN juinod"><h2 class="sc-pNWdM eftmgB"><a class="sc-crzoAE iUxAWq" href="#tag/Skills/operation/UpdateSkillDefaultVersion" aria-label="tag/Skills/operation/UpdateSkillDefaultVersion"></a>Update the default version pointer for a skill.<!-- --> </h2><div class="sc-fcmMJX cvfxAX"><div class="sc-jUfyBS bhDyou"><h5 class="sc-iqAclL sc-fuISkM eONCmm hZIgic">Authorizations:</h5><svg class="sc-dIsUp iPqByX" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jQAxuV ccffaZ"><span class="sc-daBunf fcvuS"><span class="sc-dsXzNU dPrSxx"><i>ApiKeyAuth</i></span></span></div></div><div><h5 class="sc-iqAclL eONCmm">path<!-- --> Parameters</h5><table class="sc-hHEiqL VCQHZ"><tbody><tr class="last "><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="skill_id"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">skill_id</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><span class="sc-laZMeE jWaWWE"> <!-- -->Example:<!-- --> </span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">skill_123</span></div><div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The identifier of the skill.</p>
</div></div></div></td></tr></tbody></table></div><h5 class="sc-iqAclL eONCmm">Request Body schema: <div class="sc-hiKfDv sc-gXfVKN bycQNU dhIYNk"><svg class="sc-jJMGnK hzcSs" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option selected="" value="application/json">application/json</option><option value="application/x-www-form-urlencoded">application/x-www-form-urlencoded</option></select><label>application/json</label></div></h5><div class="sc-iJCRrE sc-ciSkZP jCdxGr QGruV"></div><table class="sc-hHEiqL VCQHZ"><tbody><tr class="last "><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="default_version"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">default_version</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The skill version number to set as default.</p>
</div></div></div></td></tr></tbody></table><div><h3 class="sc-fIxmyt DvFer">Responses</h3><div><button class="sc-htmcrh lbYftx"><svg class="sc-dIsUp dqYXmg" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-fWWYYk cMoEZ">200<!-- --> </strong><span class="sc-jcwpoC eDjFAZ"><p>Success</p>
</span></button></div></div></div><div class="sc-jSFjdj sc-gKAaRy gBjRyf gcushC"><div class="sc-EZqKI fWsqvQ"><button class="sc-eEVmNe ilvUMs"><span type="post" class="sc-fmdNqN ldMUmp http-verb post">post</span><span class="sc-jXcxbT fCEUju">/skills/{skill_id}</span><svg class="sc-dIsUp bRmrKA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ljsmAU flIrdF"><div class="sc-jlZJtj fQkroN"><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div><div tabindex="0" role="button"><div class="sc-dTSzeu dfUAUz"><span>https://api.openai.com/v1</span>/skills/{skill_id}</div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Request samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="react-tabs-670" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-671" tabindex="0" data-rttab="true">Payload</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-671" aria-labelledby="react-tabs-670"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-hiKfDv sc-khIgEk bycQNU hLNtis"><svg class="sc-jJMGnK gVpQmv" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option selected="" value="application/json">application/json</option><option value="application/x-www-form-urlencoded">application/x-www-form-urlencoded</option></select><label>application/json</label></div></div><div class="sc-jgPyTC dSaTNC"><div class="sc-jNnpgg esZIbL"><div class="sc-giAqHp hMPeqJ"><button><div class="sc-carFqZ UksDl">Copy</div></button></div><div class="sc-iJCRrE jCdxGr sc-dPaNzc gyljjx"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"default_version"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Response samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-672" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-673" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-673" aria-labelledby="react-tabs-672"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-bBjRSN kQSIAz">application/json</div></div><div class="sc-jgPyTC dSaTNC"><div class="sc-jNnpgg esZIbL"><div class="sc-giAqHp hMPeqJ"><button><div class="sc-carFqZ UksDl">Copy</div></button></div><div class="sc-iJCRrE jCdxGr sc-dPaNzc gyljjx"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"object"</span>: <span class="token string">"skill"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"description"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"created_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"default_version"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"latest_version"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Skills/operation/GetSkillContent" data-section-id="tag/Skills/operation/GetSkillContent" class="sc-eCApnc liLqNm"><div data-section-id="operation/GetSkillContent" id="operation/GetSkillContent" class="sc-iCoGMd gLxhOh"><div class="sc-hKFxyN juinod"><h2 class="sc-pNWdM eftmgB"><a class="sc-crzoAE iUxAWq" href="#tag/Skills/operation/GetSkillContent" aria-label="tag/Skills/operation/GetSkillContent"></a>Download a skill zip bundle by its ID.<!-- --> </h2><div class="sc-fcmMJX cvfxAX"><div class="sc-jUfyBS bhDyou"><h5 class="sc-iqAclL sc-fuISkM eONCmm hZIgic">Authorizations:</h5><svg class="sc-dIsUp iPqByX" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jQAxuV ccffaZ"><span class="sc-daBunf fcvuS"><span class="sc-dsXzNU dPrSxx"><i>ApiKeyAuth</i></span></span></div></div><div><h5 class="sc-iqAclL eONCmm">path<!-- --> Parameters</h5><table class="sc-hHEiqL VCQHZ"><tbody><tr class="last "><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="skill_id"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">skill_id</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><span class="sc-laZMeE jWaWWE"> <!-- -->Example:<!-- --> </span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">skill_123</span></div><div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The identifier of the skill to download.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-fIxmyt DvFer">Responses</h3><div><button class="sc-htmcrh lbYftx"><svg class="sc-dIsUp dqYXmg" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-fWWYYk cMoEZ">200<!-- --> </strong><span class="sc-jcwpoC eDjFAZ"><p>The skill zip bundle.</p>
</span></button></div></div></div><div class="sc-jSFjdj sc-gKAaRy gBjRyf gcushC"><div class="sc-EZqKI fWsqvQ"><button class="sc-eEVmNe ilvUMs"><span type="get" class="sc-fmdNqN ihNycv http-verb get">get</span><span class="sc-jXcxbT fCEUju">/skills/{skill_id}/content</span><svg class="sc-dIsUp bRmrKA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ljsmAU flIrdF"><div class="sc-jlZJtj fQkroN"><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div><div tabindex="0" role="button"><div class="sc-dTSzeu dfUAUz"><span>https://api.openai.com/v1</span>/skills/{skill_id}/content</div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Response samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-674" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-675" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-675" aria-labelledby="react-tabs-674"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-hiKfDv sc-khIgEk bycQNU hLNtis"><svg class="sc-jJMGnK gVpQmv" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option selected="" value="application/zip">application/zip</option><option value="application/json">application/json</option></select><label>application/zip</label></div></div><div class="sc-hTRkXV kuxzOM">No sample</div></div></div></div></div></div></div></div><div id="tag/Skills/operation/CreateSkillVersion" data-section-id="tag/Skills/operation/CreateSkillVersion" class="sc-eCApnc liLqNm"><div data-section-id="operation/CreateSkillVersion" id="operation/CreateSkillVersion" class="sc-iCoGMd gLxhOh"><div class="sc-hKFxyN juinod"><h2 class="sc-pNWdM eftmgB"><a class="sc-crzoAE iUxAWq" href="#tag/Skills/operation/CreateSkillVersion" aria-label="tag/Skills/operation/CreateSkillVersion"></a>Create a new immutable skill version.<!-- --> </h2><div class="sc-fcmMJX cvfxAX"><div class="sc-jUfyBS bhDyou"><h5 class="sc-iqAclL sc-fuISkM eONCmm hZIgic">Authorizations:</h5><svg class="sc-dIsUp iPqByX" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jQAxuV ccffaZ"><span class="sc-daBunf fcvuS"><span class="sc-dsXzNU dPrSxx"><i>ApiKeyAuth</i></span></span></div></div><div><h5 class="sc-iqAclL eONCmm">path<!-- --> Parameters</h5><table class="sc-hHEiqL VCQHZ"><tbody><tr class="last "><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="skill_id"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">skill_id</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><span class="sc-laZMeE jWaWWE"> <!-- -->Example:<!-- --> </span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">skill_123</span></div><div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The identifier of the skill to version.</p>
</div></div></div></td></tr></tbody></table></div><h5 class="sc-iqAclL eONCmm">Request Body schema: <div class="sc-hiKfDv sc-gXfVKN bycQNU dhIYNk"><svg class="sc-jJMGnK hzcSs" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option selected="" value="multipart/form-data">multipart/form-data</option><option value="application/json">application/json</option></select><label>multipart/form-data</label></div></h5><div class="sc-iJCRrE sc-ciSkZP jCdxGr QGruV"></div><table class="sc-hHEiqL VCQHZ"><tbody><tr class=""><td class="sc-hBMUJo sc-fFSPTT sc-gSYDnn iwcKgn cAqMTE hTttpy" kind="field" title="files"><span class="sc-iemWCZ bcnRwz"></span><button aria-label="expand properties"><span class="property-name">files</span><svg class="sc-dIsUp hGHhhO" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">Array of strings or string</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div></div></div></td></tr><tr class="last "><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="default"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">default</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">boolean</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>Whether to set this version as the default.</p>
</div></div></div></td></tr></tbody></table><div><h3 class="sc-fIxmyt DvFer">Responses</h3><div><button class="sc-htmcrh lbYftx"><svg class="sc-dIsUp dqYXmg" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-fWWYYk cMoEZ">200<!-- --> </strong><span class="sc-jcwpoC eDjFAZ"><p>Success</p>
</span></button></div></div></div><div class="sc-jSFjdj sc-gKAaRy gBjRyf gcushC"><div class="sc-EZqKI fWsqvQ"><button class="sc-eEVmNe ilvUMs"><span type="post" class="sc-fmdNqN ldMUmp http-verb post">post</span><span class="sc-jXcxbT fCEUju">/skills/{skill_id}/versions</span><svg class="sc-dIsUp bRmrKA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ljsmAU flIrdF"><div class="sc-jlZJtj fQkroN"><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div><div tabindex="0" role="button"><div class="sc-dTSzeu dfUAUz"><span>https://api.openai.com/v1</span>/skills/{skill_id}/versions</div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Request samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="react-tabs-676" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-677" tabindex="0" data-rttab="true">Payload</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-677" aria-labelledby="react-tabs-676"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-hiKfDv sc-khIgEk bycQNU hLNtis"><svg class="sc-jJMGnK gVpQmv" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option selected="" value="multipart/form-data">multipart/form-data</option><option value="application/json">application/json</option></select><label>multipart/form-data</label></div></div><div class="sc-hTRkXV kuxzOM">No sample</div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Response samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-678" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-679" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-679" aria-labelledby="react-tabs-678"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-bBjRSN kQSIAz">application/json</div></div><div class="sc-jgPyTC dSaTNC"><div class="sc-jNnpgg esZIbL"><div class="sc-giAqHp hMPeqJ"><button><div class="sc-carFqZ UksDl">Copy</div></button></div><div class="sc-iJCRrE jCdxGr sc-dPaNzc gyljjx"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"object"</span>: <span class="token string">"skill.version"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"skill_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"version"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"created_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"description"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Skills/operation/ListSkillVersions" data-section-id="tag/Skills/operation/ListSkillVersions" class="sc-eCApnc liLqNm"><div data-section-id="operation/ListSkillVersions" id="operation/ListSkillVersions" class="sc-iCoGMd gLxhOh"><div class="sc-hKFxyN juinod"><h2 class="sc-pNWdM eftmgB"><a class="sc-crzoAE iUxAWq" href="#tag/Skills/operation/ListSkillVersions" aria-label="tag/Skills/operation/ListSkillVersions"></a>List skill versions for a skill.<!-- --> </h2><div class="sc-fcmMJX cvfxAX"><div class="sc-jUfyBS bhDyou"><h5 class="sc-iqAclL sc-fuISkM eONCmm hZIgic">Authorizations:</h5><svg class="sc-dIsUp iPqByX" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jQAxuV ccffaZ"><span class="sc-daBunf fcvuS"><span class="sc-dsXzNU dPrSxx"><i>ApiKeyAuth</i></span></span></div></div><div><h5 class="sc-iqAclL eONCmm">path<!-- --> Parameters</h5><table class="sc-hHEiqL VCQHZ"><tbody><tr class="last "><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="skill_id"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">skill_id</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><span class="sc-laZMeE jWaWWE"> <!-- -->Example:<!-- --> </span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">skill_123</span></div><div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The identifier of the skill.</p>
</div></div></div></td></tr></tbody></table></div><div><h5 class="sc-iqAclL eONCmm">query<!-- --> Parameters</h5><table class="sc-hHEiqL VCQHZ"><tbody><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="limit"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">limit</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">integer</span><span> <span class="sc-laZMeE sc-FRrlG jWaWWE gHBwqe"> <!-- -->[ 0 .. 100 ]<!-- --> </span></span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>Number of versions to retrieve.</p>
</div></div></div></td></tr><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="order"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">order</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span><span class="sc-laZMeE sc-eJocfa jWaWWE bArHDh"> (<!-- -->OrderEnum<!-- -->) </span></div><div><span class="sc-laZMeE jWaWWE"> <!-- -->Enum<!-- -->:</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"asc"</span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">"desc"</span> </div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>Sort order of results by version number.</p>
</div></div></div></td></tr><tr class="last "><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="after"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">after</span></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><span class="sc-laZMeE jWaWWE"> <!-- -->Example:<!-- --> </span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">after=skillver_123</span></div><div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The skill version ID to start after.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-fIxmyt DvFer">Responses</h3><div><button class="sc-htmcrh lbYftx"><svg class="sc-dIsUp dqYXmg" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-fWWYYk cMoEZ">200<!-- --> </strong><span class="sc-jcwpoC eDjFAZ"><p>Success</p>
</span></button></div></div></div><div class="sc-jSFjdj sc-gKAaRy gBjRyf gcushC"><div class="sc-EZqKI fWsqvQ"><button class="sc-eEVmNe ilvUMs"><span type="get" class="sc-fmdNqN ihNycv http-verb get">get</span><span class="sc-jXcxbT fCEUju">/skills/{skill_id}/versions</span><svg class="sc-dIsUp bRmrKA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ljsmAU flIrdF"><div class="sc-jlZJtj fQkroN"><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div><div tabindex="0" role="button"><div class="sc-dTSzeu dfUAUz"><span>https://api.openai.com/v1</span>/skills/{skill_id}/versions</div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Response samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-680" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-681" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-681" aria-labelledby="react-tabs-680"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-bBjRSN kQSIAz">application/json</div></div><div class="sc-jgPyTC dSaTNC"><div class="sc-jNnpgg esZIbL"><div class="sc-giAqHp hMPeqJ"><button><div class="sc-carFqZ UksDl">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iJCRrE jCdxGr sc-dPaNzc gyljjx"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"object"</span>: <span class="token string">"list"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"object"</span>: <span class="token string">"skill.version"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"skill_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"version"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"created_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"description"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"first_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"last_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"has_more"</span>: <span class="token boolean">true</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Skills/operation/GetSkillVersion" data-section-id="tag/Skills/operation/GetSkillVersion" class="sc-eCApnc liLqNm"><div data-section-id="operation/GetSkillVersion" id="operation/GetSkillVersion" class="sc-iCoGMd gLxhOh"><div class="sc-hKFxyN juinod"><h2 class="sc-pNWdM eftmgB"><a class="sc-crzoAE iUxAWq" href="#tag/Skills/operation/GetSkillVersion" aria-label="tag/Skills/operation/GetSkillVersion"></a>Get a specific skill version.<!-- --> </h2><div class="sc-fcmMJX cvfxAX"><div class="sc-jUfyBS bhDyou"><h5 class="sc-iqAclL sc-fuISkM eONCmm hZIgic">Authorizations:</h5><svg class="sc-dIsUp iPqByX" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jQAxuV ccffaZ"><span class="sc-daBunf fcvuS"><span class="sc-dsXzNU dPrSxx"><i>ApiKeyAuth</i></span></span></div></div><div><h5 class="sc-iqAclL eONCmm">path<!-- --> Parameters</h5><table class="sc-hHEiqL VCQHZ"><tbody><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="skill_id"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">skill_id</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><span class="sc-laZMeE jWaWWE"> <!-- -->Example:<!-- --> </span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">skill_123</span></div><div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The identifier of the skill.</p>
</div></div></div></td></tr><tr class="last "><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="version"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">version</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The version number to retrieve.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-fIxmyt DvFer">Responses</h3><div><button class="sc-htmcrh lbYftx"><svg class="sc-dIsUp dqYXmg" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-fWWYYk cMoEZ">200<!-- --> </strong><span class="sc-jcwpoC eDjFAZ"><p>Success</p>
</span></button></div></div></div><div class="sc-jSFjdj sc-gKAaRy gBjRyf gcushC"><div class="sc-EZqKI fWsqvQ"><button class="sc-eEVmNe ilvUMs"><span type="get" class="sc-fmdNqN ihNycv http-verb get">get</span><span class="sc-jXcxbT fCEUju">/skills/{skill_id}/versions/{version}</span><svg class="sc-dIsUp bRmrKA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ljsmAU flIrdF"><div class="sc-jlZJtj fQkroN"><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div><div tabindex="0" role="button"><div class="sc-dTSzeu dfUAUz"><span>https://api.openai.com/v1</span>/skills/{skill_id}/versions/{version}</div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Response samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-682" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-683" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-683" aria-labelledby="react-tabs-682"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-bBjRSN kQSIAz">application/json</div></div><div class="sc-jgPyTC dSaTNC"><div class="sc-jNnpgg esZIbL"><div class="sc-giAqHp hMPeqJ"><button><div class="sc-carFqZ UksDl">Copy</div></button></div><div class="sc-iJCRrE jCdxGr sc-dPaNzc gyljjx"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"object"</span>: <span class="token string">"skill.version"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"skill_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"version"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"created_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"description"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Skills/operation/DeleteSkillVersion" data-section-id="tag/Skills/operation/DeleteSkillVersion" class="sc-eCApnc liLqNm"><div data-section-id="operation/DeleteSkillVersion" id="operation/DeleteSkillVersion" class="sc-iCoGMd gLxhOh"><div class="sc-hKFxyN juinod"><h2 class="sc-pNWdM eftmgB"><a class="sc-crzoAE iUxAWq" href="#tag/Skills/operation/DeleteSkillVersion" aria-label="tag/Skills/operation/DeleteSkillVersion"></a>Delete a skill version.<!-- --> </h2><div class="sc-fcmMJX cvfxAX"><div class="sc-jUfyBS bhDyou"><h5 class="sc-iqAclL sc-fuISkM eONCmm hZIgic">Authorizations:</h5><svg class="sc-dIsUp iPqByX" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jQAxuV ccffaZ"><span class="sc-daBunf fcvuS"><span class="sc-dsXzNU dPrSxx"><i>ApiKeyAuth</i></span></span></div></div><div><h5 class="sc-iqAclL eONCmm">path<!-- --> Parameters</h5><table class="sc-hHEiqL VCQHZ"><tbody><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="skill_id"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">skill_id</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><span class="sc-laZMeE jWaWWE"> <!-- -->Example:<!-- --> </span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">skill_123</span></div><div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The identifier of the skill.</p>
</div></div></div></td></tr><tr class="last "><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="version"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">version</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The skill version number.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-fIxmyt DvFer">Responses</h3><div><button class="sc-htmcrh lbYftx"><svg class="sc-dIsUp dqYXmg" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-fWWYYk cMoEZ">200<!-- --> </strong><span class="sc-jcwpoC eDjFAZ"><p>Success</p>
</span></button></div></div></div><div class="sc-jSFjdj sc-gKAaRy gBjRyf gcushC"><div class="sc-EZqKI fWsqvQ"><button class="sc-eEVmNe ilvUMs"><span type="delete" class="sc-fmdNqN bJzUtf http-verb delete">delete</span><span class="sc-jXcxbT fCEUju">/skills/{skill_id}/versions/{version}</span><svg class="sc-dIsUp bRmrKA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ljsmAU flIrdF"><div class="sc-jlZJtj fQkroN"><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div><div tabindex="0" role="button"><div class="sc-dTSzeu dfUAUz"><span>https://api.openai.com/v1</span>/skills/{skill_id}/versions/{version}</div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Response samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-684" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-685" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-685" aria-labelledby="react-tabs-684"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-bBjRSN kQSIAz">application/json</div></div><div class="sc-jgPyTC dSaTNC"><div class="sc-jNnpgg esZIbL"><div class="sc-giAqHp hMPeqJ"><button><div class="sc-carFqZ UksDl">Copy</div></button></div><div class="sc-iJCRrE jCdxGr sc-dPaNzc gyljjx"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"object"</span>: <span class="token string">"skill.version.deleted"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"deleted"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"version"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Skills/operation/GetSkillVersionContent" data-section-id="tag/Skills/operation/GetSkillVersionContent" class="sc-eCApnc liLqNm"><div data-section-id="operation/GetSkillVersionContent" id="operation/GetSkillVersionContent" class="sc-iCoGMd gLxhOh"><div class="sc-hKFxyN juinod"><h2 class="sc-pNWdM eftmgB"><a class="sc-crzoAE iUxAWq" href="#tag/Skills/operation/GetSkillVersionContent" aria-label="tag/Skills/operation/GetSkillVersionContent"></a>Download a skill version zip bundle.<!-- --> </h2><div class="sc-fcmMJX cvfxAX"><div class="sc-jUfyBS bhDyou"><h5 class="sc-iqAclL sc-fuISkM eONCmm hZIgic">Authorizations:</h5><svg class="sc-dIsUp iPqByX" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jQAxuV ccffaZ"><span class="sc-daBunf fcvuS"><span class="sc-dsXzNU dPrSxx"><i>ApiKeyAuth</i></span></span></div></div><div><h5 class="sc-iqAclL eONCmm">path<!-- --> Parameters</h5><table class="sc-hHEiqL VCQHZ"><tbody><tr class=""><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="skill_id"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">skill_id</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><span class="sc-laZMeE jWaWWE"> <!-- -->Example:<!-- --> </span> <span class="sc-laZMeE sc-ckTSus jWaWWE fElSEN">skill_123</span></div><div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The identifier of the skill.</p>
</div></div></div></td></tr><tr class="last "><td class="sc-hBMUJo sc-fFSPTT iwcKgn cAqMTE" kind="field" title="version"><span class="sc-iemWCZ bcnRwz"></span><span class="property-name">version</span><div class="sc-oeezt sc-hhIiOg dLCGMn hIkHYw">required</div></td><td class="sc-bkbkJK ctPuOP"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">string</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>The skill version number.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-fIxmyt DvFer">Responses</h3><div><button class="sc-htmcrh lbYftx"><svg class="sc-dIsUp dqYXmg" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-fWWYYk cMoEZ">200<!-- --> </strong><span class="sc-jcwpoC eDjFAZ"><p>The skill zip bundle.</p>
</span></button></div></div></div><div class="sc-jSFjdj sc-gKAaRy gBjRyf gcushC"><div class="sc-EZqKI fWsqvQ"><button class="sc-eEVmNe ilvUMs"><span type="get" class="sc-fmdNqN ihNycv http-verb get">get</span><span class="sc-jXcxbT fCEUju">/skills/{skill_id}/versions/{version}/content</span><svg class="sc-dIsUp bRmrKA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ljsmAU flIrdF"><div class="sc-jlZJtj fQkroN"><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div><div tabindex="0" role="button"><div class="sc-dTSzeu dfUAUz"><span>https://api.openai.com/v1</span>/skills/{skill_id}/versions/{version}/content</div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Response samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-686" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-687" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-687" aria-labelledby="react-tabs-686"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-hiKfDv sc-khIgEk bycQNU hLNtis"><svg class="sc-jJMGnK gVpQmv" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option selected="" value="application/zip">application/zip</option><option value="application/json">application/json</option></select><label>application/zip</label></div></div><div class="sc-hTRkXV kuxzOM">No sample</div></div></div></div></div></div></div></div></div><div class="sc-ellfGf bgakXB"></div></div></div>
<script>
const __redoc_state = {"menu":{"activeItemIdx":-1},"spec":{"data":{"openapi":"3.1.0","info":{"title":"OpenAI API","description":"The OpenAI REST API. Please see https://platform.openai.com/docs/api-reference for more details.","version":"2.3.0","termsOfService":"https://openai.com/policies/terms-of-use","contact":{"name":"OpenAI Support","url":"https://help.openai.com/"},"license":{"name":"MIT","url":"https://github.com/openai/openai-openapi/blob/master/LICENSE"}},"servers":[{"url":"https://api.openai.com/v1"}],"security":[{"ApiKeyAuth":[]}],"tags":[{"name":"Assistants","description":"Build Assistants that can call models and use tools."},{"name":"Audio","description":"Turn audio into text or text into audio."},{"name":"Chat","description":"Given a list of messages comprising a conversation, the model will return a response."},{"name":"Conversations","description":"Manage conversations and conversation items."},{"name":"Completions","description":"Given a prompt, the model will return one or more predicted completions, and can also return the probabilities of alternative tokens at each position."},{"name":"Embeddings","description":"Get a vector representation of a given input that can be easily consumed by machine learning models and algorithms."},{"name":"Evals","description":"Manage and run evals in the OpenAI platform."},{"name":"Fine-tuning","description":"Manage fine-tuning jobs to tailor a model to your specific training data."},{"name":"Graders","description":"Manage and run graders in the OpenAI platform."},{"name":"Batch","description":"Create large batches of API requests to run asynchronously."},{"name":"Files","description":"Files are used to upload documents that can be used with features like Assistants and Fine-tuning."},{"name":"Uploads","description":"Use Uploads to upload large files in multiple parts."},{"name":"Images","description":"Given a prompt and/or an input image, the model will generate a new image."},{"name":"Models","description":"List and describe the various models available in the API."},{"name":"Moderations","description":"Given text and/or image inputs, classifies if those inputs are potentially harmful."},{"name":"Audit Logs","description":"List user actions and configuration changes within this organization."}],"paths":{"/assistants":{"get":{"operationId":"listAssistants","tags":["Assistants"],"summary":"Returns a list of assistants.","deprecated":true,"parameters":[{"name":"limit","in":"query","description":"A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.\n","required":false,"schema":{"type":"integer","default":20}},{"name":"order","in":"query","description":"Sort order by the `created_at` timestamp of the objects. `asc` for ascending order and `desc` for descending order.\n","schema":{"type":"string","default":"desc","enum":["asc","desc"]}},{"name":"after","in":"query","description":"A cursor for use in pagination. `after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list.\n","schema":{"type":"string"}},{"name":"before","in":"query","description":"A cursor for use in pagination. `before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_foo, your subsequent call can include before=obj_foo in order to fetch the previous page of the list.\n","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListAssistantsResponse"}}}}},"x-oaiMeta":{"name":"List assistants","group":"assistants","examples":{"request":{"curl":"curl \"https://api.openai.com/v1/assistants?order=desc&limit=20\" \\\n -H \"Content-Type: application/json\" \\\n -H \"Authorization: Bearer $OPENAI_API_KEY\" \\\n -H \"OpenAI-Beta: assistants=v2\"\n","python":"import os\nfrom openai import OpenAI\n\nclient = OpenAI(\n api_key=os.environ.get(\"OPENAI_API_KEY\"), # This is the default and can be omitted\n)\npage = client.beta.assistants.list()\npage = page.data[0]\nprint(page.id)","javascript":"import OpenAI from \"openai\";\n\nconst openai = new OpenAI();\n\nasync function main() {\n const myAssistants = await openai.beta.assistants.list({\n order: \"desc\",\n limit: \"20\",\n });\n\n console.log(myAssistants.data);\n}\n\nmain();","node.js":"import OpenAI from 'openai';\n\nconst client = new OpenAI({\n apiKey: process.env['OPENAI_API_KEY'], // This is the default and can be omitted\n});\n\n// Automatically fetches more pages as needed.\nfor await (const assistant of client.beta.assistants.list()) {\n console.log(assistant.id);\n}","go":"package main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\n\t\"github.com/openai/openai-go\"\n\t\"github.com/openai/openai-go/option\"\n)\n\nfunc main() {\n\tclient := openai.NewClient(\n\t\toption.WithAPIKey(\"My API Key\"),\n\t)\n\tpage, err := client.Beta.Assistants.List(context.TODO(), openai.BetaAssistantListParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf(\"%+v\\n\", page)\n}\n","java":"package com.openai.example;\n\nimport com.openai.client.OpenAIClient;\nimport com.openai.client.okhttp.OpenAIOkHttpClient;\nimport com.openai.models.beta.assistants.AssistantListPage;\nimport com.openai.models.beta.assistants.AssistantListParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n OpenAIClient client = OpenAIOkHttpClient.fromEnv();\n\n AssistantListPage page = client.beta().assistants().list();\n }\n}","ruby":"require \"openai\"\n\nopenai = OpenAI::Client.new(api_key: \"My API Key\")\n\npage = openai.beta.assistants.list\n\nputs(page)"},"response":"{\n \"object\": \"list\",\n \"data\": [\n {\n \"id\": \"asst_abc123\",\n \"object\": \"assistant\",\n \"created_at\": 1698982736,\n \"name\": \"Coding Tutor\",\n \"description\": null,\n \"model\": \"gpt-4o\",\n \"instructions\": \"You are a helpful assistant designed to make me better at coding!\",\n \"tools\": [],\n \"tool_resources\": {},\n \"metadata\": {},\n \"top_p\": 1.0,\n \"temperature\": 1.0,\n \"response_format\": \"auto\"\n },\n {\n \"id\": \"asst_abc456\",\n \"object\": \"assistant\",\n \"created_at\": 1698982718,\n \"name\": \"My Assistant\",\n \"description\": null,\n \"model\": \"gpt-4o\",\n \"instructions\": \"You are a helpful assistant designed to make me better at coding!\",\n \"tools\": [],\n \"tool_resources\": {},\n \"metadata\": {},\n \"top_p\": 1.0,\n \"temperature\": 1.0,\n \"response_format\": \"auto\"\n },\n {\n \"id\": \"asst_abc789\",\n \"object\": \"assistant\",\n \"created_at\": 1698982643,\n \"name\": null,\n \"description\": null,\n \"model\": \"gpt-4o\",\n \"instructions\": null,\n \"tools\": [],\n \"tool_resources\": {},\n \"metadata\": {},\n \"top_p\": 1.0,\n \"temperature\": 1.0,\n \"response_format\": \"auto\"\n }\n ],\n \"first_id\": \"asst_abc123\",\n \"last_id\": \"asst_abc789\",\n \"has_more\": false\n}\n"}}},"post":{"operationId":"createAssistant","tags":["Assistants"],"summary":"Create an assistant with a model and instructions.","deprecated":true,"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateAssistantRequest"}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AssistantObject"}}}}},"x-oaiMeta":{"name":"Create assistant","group":"assistants","examples":[{"title":"Code Interpreter","request":{"curl":"curl \"https://api.openai.com/v1/assistants\" \\\n -H \"Content-Type: application/json\" \\\n -H \"Authorization: Bearer $OPENAI_API_KEY\" \\\n -H \"OpenAI-Beta: assistants=v2\" \\\n -d '{\n \"instructions\": \"You are a personal math tutor. When asked a question, write and run Python code to answer the question.\",\n \"name\": \"Math Tutor\",\n \"tools\": [{\"type\": \"code_interpreter\"}],\n \"model\": \"gpt-4o\"\n }'\n","python":"import os\nfrom openai import OpenAI\n\nclient = OpenAI(\n api_key=os.environ.get(\"OPENAI_API_KEY\"), # This is the default and can be omitted\n)\nassistant = client.beta.assistants.create(\n model=\"gpt-4o\",\n)\nprint(assistant.id)","javascript":"import OpenAI from \"openai\";\n\nconst openai = new OpenAI();\n\nasync function main() {\n const myAssistant = await openai.beta.assistants.create({\n instructions:\n \"You are a personal math tutor. When asked a question, write and run Python code to answer the question.\",\n name: \"Math Tutor\",\n tools: [{ type: \"code_interpreter\" }],\n model: \"gpt-4o\",\n });\n\n console.log(myAssistant);\n}\n\nmain();","node.js":"import OpenAI from 'openai';\n\nconst client = new OpenAI({\n apiKey: process.env['OPENAI_API_KEY'], // This is the default and can be omitted\n});\n\nconst assistant = await client.beta.assistants.create({ model: 'gpt-4o' });\n\nconsole.log(assistant.id);","go":"package main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\n\t\"github.com/openai/openai-go\"\n\t\"github.com/openai/openai-go/option\"\n\t\"github.com/openai/openai-go/shared\"\n)\n\nfunc main() {\n\tclient := openai.NewClient(\n\t\toption.WithAPIKey(\"My API Key\"),\n\t)\n\tassistant, err := client.Beta.Assistants.New(context.TODO(), openai.BetaAssistantNewParams{\n\t\tModel: shared.ChatModelGPT4o,\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf(\"%+v\\n\", assistant.ID)\n}\n","java":"package com.openai.example;\n\nimport com.openai.client.OpenAIClient;\nimport com.openai.client.okhttp.OpenAIOkHttpClient;\nimport com.openai.models.ChatModel;\nimport com.openai.models.beta.assistants.Assistant;\nimport com.openai.models.beta.assistants.AssistantCreateParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n OpenAIClient client = OpenAIOkHttpClient.fromEnv();\n\n AssistantCreateParams params = AssistantCreateParams.builder()\n .model(ChatModel.GPT_4O)\n .build();\n Assistant assistant = client.beta().assistants().create(params);\n }\n}","ruby":"require \"openai\"\n\nopenai = OpenAI::Client.new(api_key: \"My API Key\")\n\nassistant = openai.beta.assistants.create(model: :\"gpt-4o\")\n\nputs(assistant)"},"response":"{\n \"id\": \"asst_abc123\",\n \"object\": \"assistant\",\n \"created_at\": 1698984975,\n \"name\": \"Math Tutor\",\n \"description\": null,\n \"model\": \"gpt-4o\",\n \"instructions\": \"You are a personal math tutor. When asked a question, write and run Python code to answer the question.\",\n \"tools\": [\n {\n \"type\": \"code_interpreter\"\n }\n ],\n \"metadata\": {},\n \"top_p\": 1.0,\n \"temperature\": 1.0,\n \"response_format\": \"auto\"\n}\n"},{"title":"Files","request":{"curl":"curl https://api.openai.com/v1/assistants \\\n -H \"Content-Type: application/json\" \\\n -H \"Authorization: Bearer $OPENAI_API_KEY\" \\\n -H \"OpenAI-Beta: assistants=v2\" \\\n -d '{\n \"instructions\": \"You are an HR bot, and you have access to files to answer employee questions about company policies.\",\n \"tools\": [{\"type\": \"file_search\"}],\n \"tool_resources\": {\"file_search\": {\"vector_store_ids\": [\"vs_123\"]}},\n \"model\": \"gpt-4o\"\n }'\n","python":"import os\nfrom openai import OpenAI\n\nclient = OpenAI(\n api_key=os.environ.get(\"OPENAI_API_KEY\"), # This is the default and can be omitted\n)\nassistant = client.beta.assistants.create(\n model=\"gpt-4o\",\n)\nprint(assistant.id)","javascript":"import OpenAI from \"openai\";\n\nconst openai = new OpenAI();\n\nasync function main() {\n const myAssistant = await openai.beta.assistants.create({\n instructions:\n \"You are an HR bot, and you have access to files to answer employee questions about company policies.\",\n name: \"HR Helper\",\n tools: [{ type: \"file_search\" }],\n tool_resources: {\n file_search: {\n vector_store_ids: [\"vs_123\"]\n }\n },\n model: \"gpt-4o\"\n });\n\n console.log(myAssistant);\n}\n\nmain();","node.js":"import OpenAI from 'openai';\n\nconst client = new OpenAI({\n apiKey: process.env['OPENAI_API_KEY'], // This is the default and can be omitted\n});\n\nconst assistant = await client.beta.assistants.create({ model: 'gpt-4o' });\n\nconsole.log(assistant.id);","go":"package main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\n\t\"github.com/openai/openai-go\"\n\t\"github.com/openai/openai-go/option\"\n\t\"github.com/openai/openai-go/shared\"\n)\n\nfunc main() {\n\tclient := openai.NewClient(\n\t\toption.WithAPIKey(\"My API Key\"),\n\t)\n\tassistant, err := client.Beta.Assistants.New(context.TODO(), openai.BetaAssistantNewParams{\n\t\tModel: shared.ChatModelGPT4o,\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf(\"%+v\\n\", assistant.ID)\n}\n","java":"package com.openai.example;\n\nimport com.openai.client.OpenAIClient;\nimport com.openai.client.okhttp.OpenAIOkHttpClient;\nimport com.openai.models.ChatModel;\nimport com.openai.models.beta.assistants.Assistant;\nimport com.openai.models.beta.assistants.AssistantCreateParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n OpenAIClient client = OpenAIOkHttpClient.fromEnv();\n\n AssistantCreateParams params = AssistantCreateParams.builder()\n .model(ChatModel.GPT_4O)\n .build();\n Assistant assistant = client.beta().assistants().create(params);\n }\n}","ruby":"require \"openai\"\n\nopenai = OpenAI::Client.new(api_key: \"My API Key\")\n\nassistant = openai.beta.assistants.create(model: :\"gpt-4o\")\n\nputs(assistant)"},"response":"{\n \"id\": \"asst_abc123\",\n \"object\": \"assistant\",\n \"created_at\": 1699009403,\n \"name\": \"HR Helper\",\n \"description\": null,\n \"model\": \"gpt-4o\",\n \"instructions\": \"You are an HR bot, and you have access to files to answer employee questions about company policies.\",\n \"tools\": [\n {\n \"type\": \"file_search\"\n }\n ],\n \"tool_resources\": {\n \"file_search\": {\n \"vector_store_ids\": [\"vs_123\"]\n }\n },\n \"metadata\": {},\n \"top_p\": 1.0,\n \"temperature\": 1.0,\n \"response_format\": \"auto\"\n}\n"}]}}},"/assistants/{assistant_id}":{"get":{"operationId":"getAssistant","tags":["Assistants"],"summary":"Retrieves an assistant.","deprecated":true,"parameters":[{"in":"path","name":"assistant_id","required":true,"schema":{"type":"string"},"description":"The ID of the assistant to retrieve."}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AssistantObject"}}}}},"x-oaiMeta":{"name":"Retrieve assistant","group":"assistants","examples":{"request":{"curl":"curl https://api.openai.com/v1/assistants/asst_abc123 \\\n -H \"Content-Type: application/json\" \\\n -H \"Authorization: Bearer $OPENAI_API_KEY\" \\\n -H \"OpenAI-Beta: assistants=v2\"\n","python":"import os\nfrom openai import OpenAI\n\nclient = OpenAI(\n api_key=os.environ.get(\"OPENAI_API_KEY\"), # This is the default and can be omitted\n)\nassistant = client.beta.assistants.retrieve(\n \"assistant_id\",\n)\nprint(assistant.id)","javascript":"import OpenAI from \"openai\";\n\nconst openai = new OpenAI();\n\nasync function main() {\n const myAssistant = await openai.beta.assistants.retrieve(\n \"asst_abc123\"\n );\n\n console.log(myAssistant);\n}\n\nmain();","node.js":"import OpenAI from 'openai';\n\nconst client = new OpenAI({\n apiKey: process.env['OPENAI_API_KEY'], // This is the default and can be omitted\n});\n\nconst assistant = await client.beta.assistants.retrieve('assistant_id');\n\nconsole.log(assistant.id);","go":"package main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\n\t\"github.com/openai/openai-go\"\n\t\"github.com/openai/openai-go/option\"\n)\n\nfunc main() {\n\tclient := openai.NewClient(\n\t\toption.WithAPIKey(\"My API Key\"),\n\t)\n\tassistant, err := client.Beta.Assistants.Get(context.TODO(), \"assistant_id\")\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf(\"%+v\\n\", assistant.ID)\n}\n","java":"package com.openai.example;\n\nimport com.openai.client.OpenAIClient;\nimport com.openai.client.okhttp.OpenAIOkHttpClient;\nimport com.openai.models.beta.assistants.Assistant;\nimport com.openai.models.beta.assistants.AssistantRetrieveParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n OpenAIClient client = OpenAIOkHttpClient.fromEnv();\n\n Assistant assistant = client.beta().assistants().retrieve(\"assistant_id\");\n }\n}","ruby":"require \"openai\"\n\nopenai = OpenAI::Client.new(api_key: \"My API Key\")\n\nassistant = openai.beta.assistants.retrieve(\"assistant_id\")\n\nputs(assistant)"},"response":"{\n \"id\": \"asst_abc123\",\n \"object\": \"assistant\",\n \"created_at\": 1699009709,\n \"name\": \"HR Helper\",\n \"description\": null,\n \"model\": \"gpt-4o\",\n \"instructions\": \"You are an HR bot, and you have access to files to answer employee questions about company policies.\",\n \"tools\": [\n {\n \"type\": \"file_search\"\n }\n ],\n \"metadata\": {},\n \"top_p\": 1.0,\n \"temperature\": 1.0,\n \"response_format\": \"auto\"\n}\n"}}},"post":{"operationId":"modifyAssistant","tags":["Assistants"],"summary":"Modifies an assistant.","deprecated":true,"parameters":[{"in":"path","name":"assistant_id","required":true,"schema":{"type":"string"},"description":"The ID of the assistant to modify."}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModifyAssistantRequest"}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AssistantObject"}}}}},"x-oaiMeta":{"name":"Modify assistant","group":"assistants","examples":{"request":{"curl":"curl https://api.openai.com/v1/assistants/asst_abc123 \\\n -H \"Content-Type: application/json\" \\\n -H \"Authorization: Bearer $OPENAI_API_KEY\" \\\n -H \"OpenAI-Beta: assistants=v2\" \\\n -d '{\n \"instructions\": \"You are an HR bot, and you have access to files to answer employee questions about company policies. Always response with info from either of the files.\",\n \"tools\": [{\"type\": \"file_search\"}],\n \"model\": \"gpt-4o\"\n }'\n","python":"import os\nfrom openai import OpenAI\n\nclient = OpenAI(\n api_key=os.environ.get(\"OPENAI_API_KEY\"), # This is the default and can be omitted\n)\nassistant = client.beta.assistants.update(\n assistant_id=\"assistant_id\",\n)\nprint(assistant.id)","javascript":"import OpenAI from \"openai\";\n\nconst openai = new OpenAI();\n\nasync function main() {\n const myUpdatedAssistant = await openai.beta.assistants.update(\n \"asst_abc123\",\n {\n instructions:\n \"You are an HR bot, and you have access to files to answer employee questions about company policies. Always response with info from either of the files.\",\n name: \"HR Helper\",\n tools: [{ type: \"file_search\" }],\n model: \"gpt-4o\"\n }\n );\n\n console.log(myUpdatedAssistant);\n}\n\nmain();","node.js":"import OpenAI from 'openai';\n\nconst client = new OpenAI({\n apiKey: process.env['OPENAI_API_KEY'], // This is the default and can be omitted\n});\n\nconst assistant = await client.beta.assistants.update('assistant_id');\n\nconsole.log(assistant.id);","go":"package main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\n\t\"github.com/openai/openai-go\"\n\t\"github.com/openai/openai-go/option\"\n)\n\nfunc main() {\n\tclient := openai.NewClient(\n\t\toption.WithAPIKey(\"My API Key\"),\n\t)\n\tassistant, err := client.Beta.Assistants.Update(\n\t\tcontext.TODO(),\n\t\t\"assistant_id\",\n\t\topenai.BetaAssistantUpdateParams{},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf(\"%+v\\n\", assistant.ID)\n}\n","java":"package com.openai.example;\n\nimport com.openai.client.OpenAIClient;\nimport com.openai.client.okhttp.OpenAIOkHttpClient;\nimport com.openai.models.beta.assistants.Assistant;\nimport com.openai.models.beta.assistants.AssistantUpdateParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n OpenAIClient client = OpenAIOkHttpClient.fromEnv();\n\n Assistant assistant = client.beta().assistants().update(\"assistant_id\");\n }\n}","ruby":"require \"openai\"\n\nopenai = OpenAI::Client.new(api_key: \"My API Key\")\n\nassistant = openai.beta.assistants.update(\"assistant_id\")\n\nputs(assistant)"},"response":"{\n \"id\": \"asst_123\",\n \"object\": \"assistant\",\n \"created_at\": 1699009709,\n \"name\": \"HR Helper\",\n \"description\": null,\n \"model\": \"gpt-4o\",\n \"instructions\": \"You are an HR bot, and you have access to files to answer employee questions about company policies. Always response with info from either of the files.\",\n \"tools\": [\n {\n \"type\": \"file_search\"\n }\n ],\n \"tool_resources\": {\n \"file_search\": {\n \"vector_store_ids\": []\n }\n },\n \"metadata\": {},\n \"top_p\": 1.0,\n \"temperature\": 1.0,\n \"response_format\": \"auto\"\n}\n"}}},"delete":{"operationId":"deleteAssistant","tags":["Assistants"],"summary":"Delete an assistant.","deprecated":true,"parameters":[{"in":"path","name":"assistant_id","required":true,"schema":{"type":"string"},"description":"The ID of the assistant to delete."}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteAssistantResponse"}}}}},"x-oaiMeta":{"name":"Delete assistant","group":"assistants","examples":{"request":{"curl":"curl https://api.openai.com/v1/assistants/asst_abc123 \\\n -H \"Content-Type: application/json\" \\\n -H \"Authorization: Bearer $OPENAI_API_KEY\" \\\n -H \"OpenAI-Beta: assistants=v2\" \\\n -X DELETE\n","python":"import os\nfrom openai import OpenAI\n\nclient = OpenAI(\n api_key=os.environ.get(\"OPENAI_API_KEY\"), # This is the default and can be omitted\n)\nassistant_deleted = client.beta.assistants.delete(\n \"assistant_id\",\n)\nprint(assistant_deleted.id)","javascript":"import OpenAI from \"openai\";\n\nconst openai = new OpenAI();\n\nasync function main() {\n const response = await openai.beta.assistants.delete(\"asst_abc123\");\n\n console.log(response);\n}\nmain();","node.js":"import OpenAI from 'openai';\n\nconst client = new OpenAI({\n apiKey: process.env['OPENAI_API_KEY'], // This is the default and can be omitted\n});\n\nconst assistantDeleted = await client.beta.assistants.delete('assistant_id');\n\nconsole.log(assistantDeleted.id);","go":"package main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\n\t\"github.com/openai/openai-go\"\n\t\"github.com/openai/openai-go/option\"\n)\n\nfunc main() {\n\tclient := openai.NewClient(\n\t\toption.WithAPIKey(\"My API Key\"),\n\t)\n\tassistantDeleted, err := client.Beta.Assistants.Delete(context.TODO(), \"assistant_id\")\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf(\"%+v\\n\", assistantDeleted.ID)\n}\n","java":"package com.openai.example;\n\nimport com.openai.client.OpenAIClient;\nimport com.openai.client.okhttp.OpenAIOkHttpClient;\nimport com.openai.models.beta.assistants.AssistantDeleteParams;\nimport com.openai.models.beta.assistants.AssistantDeleted;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n OpenAIClient client = OpenAIOkHttpClient.fromEnv();\n\n AssistantDeleted assistantDeleted = client.beta().assistants().delete(\"assistant_id\");\n }\n}","ruby":"require \"openai\"\n\nopenai = OpenAI::Client.new(api_key: \"My API Key\")\n\nassistant_deleted = openai.beta.assistants.delete(\"assistant_id\")\n\nputs(assistant_deleted)"},"response":"{\n \"id\": \"asst_abc123\",\n \"object\": \"assistant.deleted\",\n \"deleted\": true\n}\n"}}}},"/audio/speech":{"post":{"operationId":"createSpeech","tags":["Audio"],"summary":"Generates audio from the input text.\n\nReturns the audio file content, or a stream of audio events.\n","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateSpeechRequest"}}}},"responses":{"200":{"description":"OK","headers":{"Transfer-Encoding":{"schema":{"type":"string"},"description":"chunked"}},"content":{"application/octet-stream":{"schema":{"type":"string","format":"binary"}},"text/event-stream":{"schema":{"$ref":"#/components/schemas/CreateSpeechResponseStreamEvent"}}}}},"x-oaiMeta":{"name":"Create speech","group":"audio","examples":[{"title":"Default","request":{"curl":"curl https://api.openai.com/v1/audio/speech \\\n -H \"Authorization: Bearer $OPENAI_API_KEY\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"model\": \"gpt-4o-mini-tts\",\n \"input\": \"The quick brown fox jumped over the lazy dog.\",\n \"voice\": \"alloy\"\n }' \\\n --output speech.mp3\n","python":"import os\nfrom openai import OpenAI\n\nclient = OpenAI(\n api_key=os.environ.get(\"OPENAI_API_KEY\"), # This is the default and can be omitted\n)\nspeech = client.audio.speech.create(\n input=\"input\",\n model=\"tts-1\",\n voice=\"alloy\",\n)\nprint(speech)\ncontent = speech.read()\nprint(content)","javascript":"import fs from \"fs\";\nimport path from \"path\";\nimport OpenAI from \"openai\";\n\nconst openai = new OpenAI();\n\nconst speechFile = path.resolve(\"./speech.mp3\");\n\nasync function main() {\n const mp3 = await openai.audio.speech.create({\n model: \"gpt-4o-mini-tts\",\n voice: \"alloy\",\n input: \"Today is a wonderful day to build something people love!\",\n });\n console.log(speechFile);\n const buffer = Buffer.from(await mp3.arrayBuffer());\n await fs.promises.writeFile(speechFile, buffer);\n}\nmain();\n","csharp":"using System;\nusing System.IO;\n\nusing OpenAI.Audio;\n\nAudioClient client = new(\n model: \"gpt-4o-mini-tts\",\n apiKey: Environment.GetEnvironmentVariable(\"OPENAI_API_KEY\")\n);\n\nBinaryData speech = client.GenerateSpeech(\n text: \"The quick brown fox jumped over the lazy dog.\",\n voice: GeneratedSpeechVoice.Alloy\n);\n\nusing FileStream stream = File.OpenWrite(\"speech.mp3\");\nspeech.ToStream().CopyTo(stream);\n","node.js":"import OpenAI from 'openai';\n\nconst client = new OpenAI({\n apiKey: process.env['OPENAI_API_KEY'], // This is the default and can be omitted\n});\n\nconst speech = await client.audio.speech.create({\n input: 'input',\n model: 'tts-1',\n voice: 'alloy',\n});\n\nconsole.log(speech);\n\nconst content = await speech.blob();\nconsole.log(content);","go":"package main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\n\t\"github.com/openai/openai-go\"\n\t\"github.com/openai/openai-go/option\"\n)\n\nfunc main() {\n\tclient := openai.NewClient(\n\t\toption.WithAPIKey(\"My API Key\"),\n\t)\n\tspeech, err := client.Audio.Speech.New(context.TODO(), openai.AudioSpeechNewParams{\n\t\tInput: \"input\",\n\t\tModel: openai.SpeechModelTTS1,\n\t\tVoice: openai.AudioSpeechNewParamsVoiceUnion{\n\t\t\tOfAudioSpeechNewsVoiceString2: openai.String(\"alloy\"),\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf(\"%+v\\n\", speech)\n}\n","java":"package com.openai.example;\n\nimport com.openai.client.OpenAIClient;\nimport com.openai.client.okhttp.OpenAIOkHttpClient;\nimport com.openai.core.http.HttpResponse;\nimport com.openai.models.audio.speech.SpeechCreateParams;\nimport com.openai.models.audio.speech.SpeechModel;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n OpenAIClient client = OpenAIOkHttpClient.fromEnv();\n\n SpeechCreateParams params = SpeechCreateParams.builder()\n .input(\"input\")\n .model(SpeechModel.TTS_1)\n .voice(SpeechCreateParams.Voice.UnionMember1.ALLOY)\n .build();\n HttpResponse speech = client.audio().speech().create(params);\n }\n}","ruby":"require \"openai\"\n\nopenai = OpenAI::Client.new(api_key: \"My API Key\")\n\nspeech = openai.audio.speech.create(input: \"input\", model: :\"tts-1\", voice: :alloy)\n\nputs(speech)"}},{"title":"SSE Stream Format","request":{"curl":"curl https://api.openai.com/v1/audio/speech \\\n -H \"Authorization: Bearer $OPENAI_API_KEY\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"model\": \"gpt-4o-mini-tts\",\n \"input\": \"The quick brown fox jumped over the lazy dog.\",\n \"voice\": \"alloy\",\n \"stream_format\": \"sse\"\n }'\n","node.js":"import OpenAI from 'openai';\n\nconst client = new OpenAI({\n apiKey: process.env['OPENAI_API_KEY'], // This is the default and can be omitted\n});\n\nconst speech = await client.audio.speech.create({\n input: 'input',\n model: 'tts-1',\n voice: 'alloy',\n});\n\nconsole.log(speech);\n\nconst content = await speech.blob();\nconsole.log(content);","python":"import os\nfrom openai import OpenAI\n\nclient = OpenAI(\n api_key=os.environ.get(\"OPENAI_API_KEY\"), # This is the default and can be omitted\n)\nspeech = client.audio.speech.create(\n input=\"input\",\n model=\"tts-1\",\n voice=\"alloy\",\n)\nprint(speech)\ncontent = speech.read()\nprint(content)","go":"package main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\n\t\"github.com/openai/openai-go\"\n\t\"github.com/openai/openai-go/option\"\n)\n\nfunc main() {\n\tclient := openai.NewClient(\n\t\toption.WithAPIKey(\"My API Key\"),\n\t)\n\tspeech, err := client.Audio.Speech.New(context.TODO(), openai.AudioSpeechNewParams{\n\t\tInput: \"input\",\n\t\tModel: openai.SpeechModelTTS1,\n\t\tVoice: openai.AudioSpeechNewParamsVoiceUnion{\n\t\t\tOfAudioSpeechNewsVoiceString2: openai.String(\"alloy\"),\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf(\"%+v\\n\", speech)\n}\n","java":"package com.openai.example;\n\nimport com.openai.client.OpenAIClient;\nimport com.openai.client.okhttp.OpenAIOkHttpClient;\nimport com.openai.core.http.HttpResponse;\nimport com.openai.models.audio.speech.SpeechCreateParams;\nimport com.openai.models.audio.speech.SpeechModel;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n OpenAIClient client = OpenAIOkHttpClient.fromEnv();\n\n SpeechCreateParams params = SpeechCreateParams.builder()\n .input(\"input\")\n .model(SpeechModel.TTS_1)\n .voice(SpeechCreateParams.Voice.UnionMember1.ALLOY)\n .build();\n HttpResponse speech = client.audio().speech().create(params);\n }\n}","ruby":"require \"openai\"\n\nopenai = OpenAI::Client.new(api_key: \"My API Key\")\n\nspeech = openai.audio.speech.create(input: \"input\", model: :\"tts-1\", voice: :alloy)\n\nputs(speech)"}}]}}},"/audio/transcriptions":{"post":{"operationId":"createTranscription","tags":["Audio"],"summary":"Transcribes audio into the input language.\n\nReturns a transcription object in `json`, `diarized_json`, or `verbose_json`\nformat, or a stream of transcript events.\n","requestBody":{"required":true,"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/CreateTranscriptionRequest"}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/CreateTranscriptionResponseJson"},{"$ref":"#/components/schemas/CreateTranscriptionResponseDiarizedJson"},{"$ref":"#/components/schemas/CreateTranscriptionResponseVerboseJson"}]}},"text/event-stream":{"schema":{"$ref":"#/components/schemas/CreateTranscriptionResponseStreamEvent"}}}}},"x-oaiMeta":{"name":"Create transcription","group":"audio","examples":[{"title":"Default","request":{"curl":"curl https://api.openai.com/v1/audio/transcriptions \\\n -H \"Authorization: Bearer $OPENAI_API_KEY\" \\\n -H \"Content-Type: multipart/form-data\" \\\n -F file=\"@/path/to/file/audio.mp3\" \\\n -F model=\"gpt-4o-transcribe\"\n","python":"import os\nfrom openai import OpenAI\n\nclient = OpenAI(\n api_key=os.environ.get(\"OPENAI_API_KEY\"), # This is the default and can be omitted\n)\nfor transcription in client.audio.transcriptions.create(\n file=b\"Example data\",\n model=\"gpt-4o-transcribe\",\n):\n print(transcription)","javascript":"import fs from \"fs\";\nimport OpenAI from \"openai\";\n\nconst openai = new OpenAI();\n\nasync function main() {\n const transcription = await openai.audio.transcriptions.create({\n file: fs.createReadStream(\"audio.mp3\"),\n model: \"gpt-4o-transcribe\",\n });\n\n console.log(transcription.text);\n}\nmain();\n","csharp":"using System;\n\nusing OpenAI.Audio;\nstring audioFilePath = \"audio.mp3\";\n\nAudioClient client = new(\n model: \"gpt-4o-transcribe\",\n apiKey: Environment.GetEnvironmentVariable(\"OPENAI_API_KEY\")\n);\n\nAudioTranscription transcription = client.TranscribeAudio(audioFilePath);\n\nConsole.WriteLine($\"{transcription.Text}\");\n","node.js":"import fs from 'fs';\nimport OpenAI from 'openai';\n\nconst client = new OpenAI({\n apiKey: process.env['OPENAI_API_KEY'], // This is the default and can be omitted\n});\n\nconst transcription = await client.audio.transcriptions.create({\n file: fs.createReadStream('speech.mp3'),\n model: 'gpt-4o-transcribe',\n});\n\nconsole.log(transcription);","go":"package main\n\nimport (\n\t\"bytes\"\n\t\"context\"\n\t\"fmt\"\n\t\"io\"\n\n\t\"github.com/openai/openai-go\"\n\t\"github.com/openai/openai-go/option\"\n)\n\nfunc main() {\n\tclient := openai.NewClient(\n\t\toption.WithAPIKey(\"My API Key\"),\n\t)\n\ttranscription, err := client.Audio.Transcriptions.New(context.TODO(), openai.AudioTranscriptionNewParams{\n\t\tFile: io.Reader(bytes.NewBuffer([]byte(\"Example data\"))),\n\t\tModel: openai.AudioModelGPT4oTranscribe,\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf(\"%+v\\n\", transcription)\n}\n","java":"package com.openai.example;\n\nimport com.openai.client.OpenAIClient;\nimport com.openai.client.okhttp.OpenAIOkHttpClient;\nimport com.openai.models.audio.AudioModel;\nimport com.openai.models.audio.transcriptions.TranscriptionCreateParams;\nimport com.openai.models.audio.transcriptions.TranscriptionCreateResponse;\nimport java.io.ByteArrayInputStream;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n OpenAIClient client = OpenAIOkHttpClient.fromEnv();\n\n TranscriptionCreateParams params = TranscriptionCreateParams.builder()\n .file(new ByteArrayInputStream(\"Example data\".getBytes()))\n .model(AudioModel.GPT_4O_TRANSCRIBE)\n .build();\n TranscriptionCreateResponse transcription = client.audio().transcriptions().create(params);\n }\n}","ruby":"require \"openai\"\n\nopenai = OpenAI::Client.new(api_key: \"My API Key\")\n\ntranscription = openai.audio.transcriptions.create(file: StringIO.new(\"Example data\"), model: :\"gpt-4o-transcribe\")\n\nputs(transcription)"},"response":"{\n \"text\": \"Imagine the wildest idea that you've ever had, and you're curious about how it might scale to something that's a 100, a 1,000 times bigger. This is a place where you can get to do that.\",\n \"usage\": {\n \"type\": \"tokens\",\n \"input_tokens\": 14,\n \"input_token_details\": {\n \"text_tokens\": 0,\n \"audio_tokens\": 14\n },\n \"output_tokens\": 45,\n \"total_tokens\": 59\n }\n}\n"},{"title":"Diarization","request":{"curl":"curl https://api.openai.com/v1/audio/transcriptions \\\n -H \"Authorization: Bearer $OPENAI_API_KEY\" \\\n -H \"Content-Type: multipart/form-data\" \\\n -F file=\"@/path/to/file/meeting.wav\" \\\n -F model=\"gpt-4o-transcribe-diarize\" \\\n -F response_format=\"diarized_json\" \\\n -F chunking_strategy=auto \\\n -F 'known_speaker_names[]=agent' \\\n -F 'known_speaker_references[]=data:audio/wav;base64,AAA...'\n","python":"import os\nfrom openai import OpenAI\n\nclient = OpenAI(\n api_key=os.environ.get(\"OPENAI_API_KEY\"), # This is the default and can be omitted\n)\nfor transcription in client.audio.transcriptions.create(\n file=b\"Example data\",\n model=\"gpt-4o-transcribe\",\n):\n print(transcription)","javascript":"import fs from \"fs\";\nimport OpenAI from \"openai\";\n\nconst openai = new OpenAI();\n\nconst speakerRef = fs.readFileSync(\"agent.wav\").toString(\"base64\");\n\nconst transcript = await openai.audio.transcriptions.create({\n file: fs.createReadStream(\"meeting.wav\"),\n model: \"gpt-4o-transcribe-diarize\",\n response_format: \"diarized_json\",\n chunking_strategy: \"auto\",\n extra_body: {\n known_speaker_names: [\"agent\"],\n known_speaker_references: [`data:audio/wav;base64,${speakerRef}`],\n },\n});\n\nconsole.log(transcript.segments);\n","node.js":"import fs from 'fs';\nimport OpenAI from 'openai';\n\nconst client = new OpenAI({\n apiKey: process.env['OPENAI_API_KEY'], // This is the default and can be omitted\n});\n\nconst transcription = await client.audio.transcriptions.create({\n file: fs.createReadStream('speech.mp3'),\n model: 'gpt-4o-transcribe',\n});\n\nconsole.log(transcription);","go":"package main\n\nimport (\n\t\"bytes\"\n\t\"context\"\n\t\"fmt\"\n\t\"io\"\n\n\t\"github.com/openai/openai-go\"\n\t\"github.com/openai/openai-go/option\"\n)\n\nfunc main() {\n\tclient := openai.NewClient(\n\t\toption.WithAPIKey(\"My API Key\"),\n\t)\n\ttranscription, err := client.Audio.Transcriptions.New(context.TODO(), openai.AudioTranscriptionNewParams{\n\t\tFile: io.Reader(bytes.NewBuffer([]byte(\"Example data\"))),\n\t\tModel: openai.AudioModelGPT4oTranscribe,\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf(\"%+v\\n\", transcription)\n}\n","java":"package com.openai.example;\n\nimport com.openai.client.OpenAIClient;\nimport com.openai.client.okhttp.OpenAIOkHttpClient;\nimport com.openai.models.audio.AudioModel;\nimport com.openai.models.audio.transcriptions.TranscriptionCreateParams;\nimport com.openai.models.audio.transcriptions.TranscriptionCreateResponse;\nimport java.io.ByteArrayInputStream;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n OpenAIClient client = OpenAIOkHttpClient.fromEnv();\n\n TranscriptionCreateParams params = TranscriptionCreateParams.builder()\n .file(new ByteArrayInputStream(\"Example data\".getBytes()))\n .model(AudioModel.GPT_4O_TRANSCRIBE)\n .build();\n TranscriptionCreateResponse transcription = client.audio().transcriptions().create(params);\n }\n}","ruby":"require \"openai\"\n\nopenai = OpenAI::Client.new(api_key: \"My API Key\")\n\ntranscription = openai.audio.transcriptions.create(file: StringIO.new(\"Example data\"), model: :\"gpt-4o-transcribe\")\n\nputs(transcription)"},"response":"{\n \"task\": \"transcribe\",\n \"duration\": 27.4,\n \"text\": \"Agent: Thanks for calling OpenAI support.\\nA: Hi, I'm trying to enable diarization.\\nAgent: Happy to walk you through the steps.\",\n \"segments\": [\n {\n \"type\": \"transcript.text.segment\",\n \"id\": \"seg_001\",\n \"start\": 0.0,\n \"end\": 4.7,\n \"text\": \"Thanks for calling OpenAI support.\",\n \"speaker\": \"agent\"\n },\n {\n \"type\": \"transcript.text.segment\",\n \"id\": \"seg_002\",\n \"start\": 4.7,\n \"end\": 11.8,\n \"text\": \"Hi, I'm trying to enable diarization.\",\n \"speaker\": \"A\"\n },\n {\n \"type\": \"transcript.text.segment\",\n \"id\": \"seg_003\",\n \"start\": 12.1,\n \"end\": 18.5,\n \"text\": \"Happy to walk you through the steps.\",\n \"speaker\": \"agent\"\n }\n ],\n \"usage\": {\n \"type\": \"duration\",\n \"seconds\": 27\n }\n}\n"},{"title":"Streaming","request":{"curl":"curl https://api.openai.com/v1/audio/transcriptions \\\n -H \"Authorization: Bearer $OPENAI_API_KEY\" \\\n -H \"Content-Type: multipart/form-data\" \\\n -F file=\"@/path/to/file/audio.mp3\" \\\n -F model=\"gpt-4o-mini-transcribe\" \\\n -F stream=true\n","python":"import os\nfrom openai import OpenAI\n\nclient = OpenAI(\n api_key=os.environ.get(\"OPENAI_API_KEY\"), # This is the default and can be omitted\n)\nfor transcription in client.audio.transcriptions.create(\n file=b\"Example data\",\n model=\"gpt-4o-transcribe\",\n):\n print(transcription)","javascript":"import fs from \"fs\";\nimport OpenAI from \"openai\";\n\nconst openai = new OpenAI();\n\nconst stream = await openai.audio.transcriptions.create({\n file: fs.createReadStream(\"audio.mp3\"),\n model: \"gpt-4o-mini-transcribe\",\n stream: true,\n});\n\nfor await (const event of stream) {\n console.log(event);\n}\n","node.js":"import fs from 'fs';\nimport OpenAI from 'openai';\n\nconst client = new OpenAI({\n apiKey: process.env['OPENAI_API_KEY'], // This is the default and can be omitted\n});\n\nconst transcription = await client.audio.transcriptions.create({\n file: fs.createReadStream('speech.mp3'),\n model: 'gpt-4o-transcribe',\n});\n\nconsole.log(transcription);","go":"package main\n\nimport (\n\t\"bytes\"\n\t\"context\"\n\t\"fmt\"\n\t\"io\"\n\n\t\"github.com/openai/openai-go\"\n\t\"github.com/openai/openai-go/option\"\n)\n\nfunc main() {\n\tclient := openai.NewClient(\n\t\toption.WithAPIKey(\"My API Key\"),\n\t)\n\ttranscription, err := client.Audio.Transcriptions.New(context.TODO(), openai.AudioTranscriptionNewParams{\n\t\tFile: io.Reader(bytes.NewBuffer([]byte(\"Example data\"))),\n\t\tModel: openai.AudioModelGPT4oTranscribe,\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf(\"%+v\\n\", transcription)\n}\n","java":"package com.openai.example;\n\nimport com.openai.client.OpenAIClient;\nimport com.openai.client.okhttp.OpenAIOkHttpClient;\nimport com.openai.models.audio.AudioModel;\nimport com.openai.models.audio.transcriptions.TranscriptionCreateParams;\nimport com.openai.models.audio.transcriptions.TranscriptionCreateResponse;\nimport java.io.ByteArrayInputStream;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n OpenAIClient client = OpenAIOkHttpClient.fromEnv();\n\n TranscriptionCreateParams params = TranscriptionCreateParams.builder()\n .file(new ByteArrayInputStream(\"Example data\".getBytes()))\n .model(AudioModel.GPT_4O_TRANSCRIBE)\n .build();\n TranscriptionCreateResponse transcription = client.audio().transcriptions().create(params);\n }\n}","ruby":"require \"openai\"\n\nopenai = OpenAI::Client.new(api_key: \"My API Key\")\n\ntranscription = openai.audio.transcriptions.create(file: StringIO.new(\"Example data\"), model: :\"gpt-4o-transcribe\")\n\nputs(transcription)"},"response":"data: {\"type\":\"transcript.text.delta\",\"delta\":\"I\",\"logprobs\":[{\"token\":\"I\",\"logprob\":-0.00007588794,\"bytes\":[73]}]}\n\ndata: {\"type\":\"transcript.text.delta\",\"delta\":\" see\",\"logprobs\":[{\"token\":\" see\",\"logprob\":-3.1281633e-7,\"bytes\":[32,115,101,101]}]}\n\ndata: {\"type\":\"transcript.text.delta\",\"delta\":\" skies\",\"logprobs\":[{\"token\":\" skies\",\"logprob\":-2.3392786e-6,\"bytes\":[32,115,107,105,101,115]}]}\n\ndata: {\"type\":\"transcript.text.delta\",\"delta\":\" of\",\"logprobs\":[{\"token\":\" of\",\"logprob\":-3.1281633e-7,\"bytes\":[32,111,102]}]}\n\ndata: {\"type\":\"transcript.text.delta\",\"delta\":\" blue\",\"logprobs\":[{\"token\":\" blue\",\"logprob\":-1.0280384e-6,\"bytes\":[32,98,108,117,101]}]}\n\ndata: {\"type\":\"transcript.text.delta\",\"delta\":\" and\",\"logprobs\":[{\"token\":\" and\",\"logprob\":-0.0005108566,\"bytes\":[32,97,110,100]}]}\n\ndata: {\"type\":\"transcript.text.delta\",\"delta\":\" clouds\",\"logprobs\":[{\"token\":\" clouds\",\"logprob\":-1.9361265e-7,\"bytes\":[32,99,108,111,117,100,115]}]}\n\ndata: {\"type\":\"transcript.text.delta\",\"delta\":\" of\",\"logprobs\":[{\"token\":\" of\",\"logprob\":-1.9361265e-7,\"bytes\":[32,111,102]}]}\n\ndata: {\"type\":\"transcript.text.delta\",\"delta\":\" white\",\"logprobs\":[{\"token\":\" white\",\"logprob\":-7.89631e-7,\"bytes\":[32,119,104,105,116,101]}]}\n\ndata: {\"type\":\"transcript.text.delta\",\"delta\":\",\",\"logprobs\":[{\"token\":\",\",\"logprob\":-0.0014890312,\"bytes\":[44]}]}\n\ndata: {\"type\":\"transcript.text.delta\",\"delta\":\" the\",\"logprobs\":[{\"token\":\" the\",\"logprob\":-0.0110956915,\"bytes\":[32,116,104,101]}]}\n\ndata: {\"type\":\"transcript.text.delta\",\"delta\":\" bright\",\"logprobs\":[{\"token\":\" bright\",\"logprob\":0.0,\"bytes\":[32,98,114,105,103,104,116]}]}\n\ndata: {\"type\":\"transcript.text.delta\",\"delta\":\" blessed\",\"logprobs\":[{\"token\":\" blessed\",\"logprob\":-0.000045848617,\"bytes\":[32,98,108,101,115,115,101,100]}]}\n\ndata: {\"type\":\"transcript.text.delta\",\"delta\":\" days\",\"logprobs\":[{\"token\":\" days\",\"logprob\":-0.000010802739,\"bytes\":[32,100,97,121,115]}]}\n\ndata: {\"type\":\"transcript.text.delta\",\"delta\":\",\",\"logprobs\":[{\"token\":\",\",\"logprob\":-0.00001700133,\"bytes\":[44]}]}\n\ndata: {\"type\":\"transcript.text.delta\",\"delta\":\" the\",\"logprobs\":[{\"token\":\" the\",\"logprob\":-0.0000118755715,\"bytes\":[32,116,104,101]}]}\n\ndata: {\"type\":\"transcript.text.delta\",\"delta\":\" dark\",\"logprobs\":[{\"token\":\" dark\",\"logprob\":-5.5122365e-7,\"bytes\":[32,100,97,114,107]}]}\n\ndata: {\"type\":\"transcript.text.delta\",\"delta\":\" sacred\",\"logprobs\":[{\"token\":\" sacred\",\"logprob\":-5.4385737e-6,\"bytes\":[32,115,97,99,114,101,100]}]}\n\ndata: {\"type\":\"transcript.text.delta\",\"delta\":\" nights\",\"logprobs\":[{\"token\":\" nights\",\"logprob\":-4.00813e-6,\"bytes\":[32,110,105,103,104,116,115]}]}\n\ndata: {\"type\":\"transcript.text.delta\",\"delta\":\",\",\"logprobs\":[{\"token\":\",\",\"logprob\":-0.0036910512,\"bytes\":[44]}]}\n\ndata: {\"type\":\"transcript.text.delta\",\"delta\":\" and\",\"logprobs\":[{\"token\":\" and\",\"logprob\":-0.0031903093,\"bytes\":[32,97,110,100]}]}\n\ndata: {\"type\":\"transcript.text.delta\",\"delta\":\" I\",\"logprobs\":[{\"token\":\" I\",\"logprob\":-1.504853e-6,\"bytes\":[32,73]}]}\n\ndata: {\"type\":\"transcript.text.delta\",\"delta\":\" think\",\"logprobs\":[{\"token\":\" think\",\"logprob\":-4.3202e-7,\"bytes\":[32,116,104,105,110,107]}]}\n\ndata: {\"type\":\"transcript.text.delta\",\"delta\":\" to\",\"logprobs\":[{\"token\":\" to\",\"logprob\":-1.9361265e-7,\"bytes\":[32,116,111]}]}\n\ndata: {\"type\":\"transcript.text.delta\",\"delta\":\" myself\",\"logprobs\":[{\"token\":\" myself\",\"logprob\":-1.7432603e-6,\"bytes\":[32,109,121,115,101,108,102]}]}\n\ndata: {\"type\":\"transcript.text.delta\",\"delta\":\",\",\"logprobs\":[{\"token\":\",\",\"logprob\":-0.29254505,\"bytes\":[44]}]}\n\ndata: {\"type\":\"transcript.text.delta\",\"delta\":\" what\",\"logprobs\":[{\"token\":\" what\",\"logprob\":-0.016815351,\"bytes\":[32,119,104,97,116]}]}\n\ndata: {\"type\":\"transcript.text.delta\",\"delta\":\" a\",\"logprobs\":[{\"token\":\" a\",\"logprob\":-3.1281633e-7,\"bytes\":[32,97]}]}\n\ndata: {\"type\":\"transcript.text.delta\",\"delta\":\" wonderful\",\"logprobs\":[{\"token\":\" wonderful\",\"logprob\":-2.1008714e-6,\"bytes\":[32,119,111,110,100,101,114,102,117,108]}]}\n\ndata: {\"type\":\"transcript.text.delta\",\"delta\":\" world\",\"logprobs\":[{\"token\":\" world\",\"logprob\":-8.180258e-6,\"bytes\":[32,119,111,114,108,100]}]}\n\ndata: {\"type\":\"transcript.text.delta\",\"delta\":\".\",\"logprobs\":[{\"token\":\".\",\"logprob\":-0.014231676,\"bytes\":[46]}]}\n\ndata: {\"type\":\"transcript.text.done\",\"text\":\"I see skies of blue and clouds of white, the bright blessed days, the dark sacred nights, and I think to myself, what a wonderful world.\",\"logprobs\":[{\"token\":\"I\",\"logprob\":-0.00007588794,\"bytes\":[73]},{\"token\":\" see\",\"logprob\":-3.1281633e-7,\"bytes\":[32,115,101,101]},{\"token\":\" skies\",\"logprob\":-2.3392786e-6,\"bytes\":[32,115,107,105,101,115]},{\"token\":\" of\",\"logprob\":-3.1281633e-7,\"bytes\":[32,111,102]},{\"token\":\" blue\",\"logprob\":-1.0280384e-6,\"bytes\":[32,98,108,117,101]},{\"token\":\" and\",\"logprob\":-0.0005108566,\"bytes\":[32,97,110,100]},{\"token\":\" clouds\",\"logprob\":-1.9361265e-7,\"bytes\":[32,99,108,111,117,100,115]},{\"token\":\" of\",\"logprob\":-1.9361265e-7,\"bytes\":[32,111,102]},{\"token\":\" white\",\"logprob\":-7.89631e-7,\"bytes\":[32,119,104,105,116,101]},{\"token\":\",\",\"logprob\":-0.0014890312,\"bytes\":[44]},{\"token\":\" the\",\"logprob\":-0.0110956915,\"bytes\":[32,116,104,101]},{\"token\":\" bright\",\"logprob\":0.0,\"bytes\":[32,98,114,105,103,104,116]},{\"token\":\" blessed\",\"logprob\":-0.000045848617,\"bytes\":[32,98,108,101,115,115,101,100]},{\"token\":\" days\",\"logprob\":-0.000010802739,\"bytes\":[32,100,97,121,115]},{\"token\":\",\",\"logprob\":-0.00001700133,\"bytes\":[44]},{\"token\":\" the\",\"logprob\":-0.0000118755715,\"bytes\":[32,116,104,101]},{\"token\":\" dark\",\"logprob\":-5.5122365e-7,\"bytes\":[32,100,97,114,107]},{\"token\":\" sacred\",\"logprob\":-5.4385737e-6,\"bytes\":[32,115,97,99,114,101,100]},{\"token\":\" nights\",\"logprob\":-4.00813e-6,\"bytes\":[32,110,105,103,104,116,115]},{\"token\":\",\",\"logprob\":-0.0036910512,\"bytes\":[44]},{\"token\":\" and\",\"logprob\":-0.0031903093,\"bytes\":[32,97,110,100]},{\"token\":\" I\",\"logprob\":-1.504853e-6,\"bytes\":[32,73]},{\"token\":\" think\",\"logprob\":-4.3202e-7,\"bytes\":[32,116,104,105,110,107]},{\"token\":\" to\",\"logprob\":-1.9361265e-7,\"bytes\":[32,116,111]},{\"token\":\" myself\",\"logprob\":-1.7432603e-6,\"bytes\":[32,109,121,115,101,108,102]},{\"token\":\",\",\"logprob\":-0.29254505,\"bytes\":[44]},{\"token\":\" what\",\"logprob\":-0.016815351,\"bytes\":[32,119,104,97,116]},{\"token\":\" a\",\"logprob\":-3.1281633e-7,\"bytes\":[32,97]},{\"token\":\" wonderful\",\"logprob\":-2.1008714e-6,\"bytes\":[32,119,111,110,100,101,114,102,117,108]},{\"token\":\" world\",\"logprob\":-8.180258e-6,\"bytes\":[32,119,111,114,108,100]},{\"token\":\".\",\"logprob\":-0.014231676,\"bytes\":[46]}],\"usage\":{\"input_tokens\":14,\"input_token_details\":{\"text_tokens\":0,\"audio_tokens\":14},\"output_tokens\":45,\"total_tokens\":59}}\n"},{"title":"Logprobs","request":{"curl":"curl https://api.openai.com/v1/audio/transcriptions \\\n -H \"Authorization: Bearer $OPENAI_API_KEY\" \\\n -H \"Content-Type: multipart/form-data\" \\\n -F file=\"@/path/to/file/audio.mp3\" \\\n -F \"include[]=logprobs\" \\\n -F model=\"gpt-4o-transcribe\" \\\n -F response_format=\"json\"\n","python":"import os\nfrom openai import OpenAI\n\nclient = OpenAI(\n api_key=os.environ.get(\"OPENAI_API_KEY\"), # This is the default and can be omitted\n)\nfor transcription in client.audio.transcriptions.create(\n file=b\"Example data\",\n model=\"gpt-4o-transcribe\",\n):\n print(transcription)","javascript":"import fs from \"fs\";\nimport OpenAI from \"openai\";\n\nconst openai = new OpenAI();\n\nasync function main() {\n const transcription = await openai.audio.transcriptions.create({\n file: fs.createReadStream(\"audio.mp3\"),\n model: \"gpt-4o-transcribe\",\n response_format: \"json\",\n include: [\"logprobs\"]\n });\n\n console.log(transcription);\n}\nmain();\n","node.js":"import fs from 'fs';\nimport OpenAI from 'openai';\n\nconst client = new OpenAI({\n apiKey: process.env['OPENAI_API_KEY'], // This is the default and can be omitted\n});\n\nconst transcription = await client.audio.transcriptions.create({\n file: fs.createReadStream('speech.mp3'),\n model: 'gpt-4o-transcribe',\n});\n\nconsole.log(transcription);","go":"package main\n\nimport (\n\t\"bytes\"\n\t\"context\"\n\t\"fmt\"\n\t\"io\"\n\n\t\"github.com/openai/openai-go\"\n\t\"github.com/openai/openai-go/option\"\n)\n\nfunc main() {\n\tclient := openai.NewClient(\n\t\toption.WithAPIKey(\"My API Key\"),\n\t)\n\ttranscription, err := client.Audio.Transcriptions.New(context.TODO(), openai.AudioTranscriptionNewParams{\n\t\tFile: io.Reader(bytes.NewBuffer([]byte(\"Example data\"))),\n\t\tModel: openai.AudioModelGPT4oTranscribe,\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf(\"%+v\\n\", transcription)\n}\n","java":"package com.openai.example;\n\nimport com.openai.client.OpenAIClient;\nimport com.openai.client.okhttp.OpenAIOkHttpClient;\nimport com.openai.models.audio.AudioModel;\nimport com.openai.models.audio.transcriptions.TranscriptionCreateParams;\nimport com.openai.models.audio.transcriptions.TranscriptionCreateResponse;\nimport java.io.ByteArrayInputStream;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n OpenAIClient client = OpenAIOkHttpClient.fromEnv();\n\n TranscriptionCreateParams params = TranscriptionCreateParams.builder()\n .file(new ByteArrayInputStream(\"Example data\".getBytes()))\n .model(AudioModel.GPT_4O_TRANSCRIBE)\n .build();\n TranscriptionCreateResponse transcription = client.audio().transcriptions().create(params);\n }\n}","ruby":"require \"openai\"\n\nopenai = OpenAI::Client.new(api_key: \"My API Key\")\n\ntranscription = openai.audio.transcriptions.create(file: StringIO.new(\"Example data\"), model: :\"gpt-4o-transcribe\")\n\nputs(transcription)"},"response":"{\n \"text\": \"Hey, my knee is hurting and I want to see the doctor tomorrow ideally.\",\n \"logprobs\": [\n { \"token\": \"Hey\", \"logprob\": -1.0415299, \"bytes\": [72, 101, 121] },\n { \"token\": \",\", \"logprob\": -9.805982e-5, \"bytes\": [44] },\n { \"token\": \" my\", \"logprob\": -0.00229799, \"bytes\": [32, 109, 121] },\n {\n \"token\": \" knee\",\n \"logprob\": -4.7159858e-5,\n \"bytes\": [32, 107, 110, 101, 101]\n },\n { \"token\": \" is\", \"logprob\": -0.043909557, \"bytes\": [32, 105, 115] },\n {\n \"token\": \" hurting\",\n \"logprob\": -1.1041146e-5,\n \"bytes\": [32, 104, 117, 114, 116, 105, 110, 103]\n },\n { \"token\": \" and\", \"logprob\": -0.011076359, \"bytes\": [32, 97, 110, 100] },\n { \"token\": \" I\", \"logprob\": -5.3193703e-6, \"bytes\": [32, 73] },\n {\n \"token\": \" want\",\n \"logprob\": -0.0017156356,\n \"bytes\": [32, 119, 97, 110, 116]\n },\n { \"token\": \" to\", \"logprob\": -7.89631e-7, \"bytes\": [32, 116, 111] },\n { \"token\": \" see\", \"logprob\": -5.5122365e-7, \"bytes\": [32, 115, 101, 101] },\n { \"token\": \" the\", \"logprob\": -0.0040786397, \"bytes\": [32, 116, 104, 101] },\n {\n \"token\": \" doctor\",\n \"logprob\": -2.3392786e-6,\n \"bytes\": [32, 100, 111, 99, 116, 111, 114]\n },\n {\n \"token\": \" tomorrow\",\n \"logprob\": -7.89631e-7,\n \"bytes\": [32, 116, 111, 109, 111, 114, 114, 111, 119]\n },\n {\n \"token\": \" ideally\",\n \"logprob\": -0.5800861,\n \"bytes\": [32, 105, 100, 101, 97, 108, 108, 121]\n },\n { \"token\": \".\", \"logprob\": -0.00011093382, \"bytes\": [46] }\n ],\n \"usage\": {\n \"type\": \"tokens\",\n \"input_tokens\": 14,\n \"input_token_details\": {\n \"text_tokens\": 0,\n \"audio_tokens\": 14\n },\n \"output_tokens\": 45,\n \"total_tokens\": 59\n }\n}\n"},{"title":"Word timestamps","request":{"curl":"curl https://api.openai.com/v1/audio/transcriptions \\\n -H \"Authorization: Bearer $OPENAI_API_KEY\" \\\n -H \"Content-Type: multipart/form-data\" \\\n -F file=\"@/path/to/file/audio.mp3\" \\\n -F \"timestamp_granularities[]=word\" \\\n -F model=\"whisper-1\" \\\n -F response_format=\"verbose_json\"\n","python":"import os\nfrom openai import OpenAI\n\nclient = OpenAI(\n api_key=os.environ.get(\"OPENAI_API_KEY\"), # This is the default and can be omitted\n)\nfor transcription in client.audio.transcriptions.create(\n file=b\"Example data\",\n model=\"gpt-4o-transcribe\",\n):\n print(transcription)","javascript":"import fs from \"fs\";\nimport OpenAI from \"openai\";\n\nconst openai = new OpenAI();\n\nasync function main() {\n const transcription = await openai.audio.transcriptions.create({\n file: fs.createReadStream(\"audio.mp3\"),\n model: \"whisper-1\",\n response_format: \"verbose_json\",\n timestamp_granularities: [\"word\"]\n });\n\n console.log(transcription.text);\n}\nmain();\n","csharp":"using System;\n\nusing OpenAI.Audio;\n\nstring audioFilePath = \"audio.mp3\";\n\nAudioClient client = new(\n model: \"whisper-1\",\n apiKey: Environment.GetEnvironmentVariable(\"OPENAI_API_KEY\")\n);\n\nAudioTranscriptionOptions options = new()\n{\n ResponseFormat = AudioTranscriptionFormat.Verbose,\n TimestampGranularities = AudioTimestampGranularities.Word,\n};\n\nAudioTranscription transcription = client.TranscribeAudio(audioFilePath, options);\n\nConsole.WriteLine($\"{transcription.Text}\");\n","node.js":"import fs from 'fs';\nimport OpenAI from 'openai';\n\nconst client = new OpenAI({\n apiKey: process.env['OPENAI_API_KEY'], // This is the default and can be omitted\n});\n\nconst transcription = await client.audio.transcriptions.create({\n file: fs.createReadStream('speech.mp3'),\n model: 'gpt-4o-transcribe',\n});\n\nconsole.log(transcription);","go":"package main\n\nimport (\n\t\"bytes\"\n\t\"context\"\n\t\"fmt\"\n\t\"io\"\n\n\t\"github.com/openai/openai-go\"\n\t\"github.com/openai/openai-go/option\"\n)\n\nfunc main() {\n\tclient := openai.NewClient(\n\t\toption.WithAPIKey(\"My API Key\"),\n\t)\n\ttranscription, err := client.Audio.Transcriptions.New(context.TODO(), openai.AudioTranscriptionNewParams{\n\t\tFile: io.Reader(bytes.NewBuffer([]byte(\"Example data\"))),\n\t\tModel: openai.AudioModelGPT4oTranscribe,\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf(\"%+v\\n\", transcription)\n}\n","java":"package com.openai.example;\n\nimport com.openai.client.OpenAIClient;\nimport com.openai.client.okhttp.OpenAIOkHttpClient;\nimport com.openai.models.audio.AudioModel;\nimport com.openai.models.audio.transcriptions.TranscriptionCreateParams;\nimport com.openai.models.audio.transcriptions.TranscriptionCreateResponse;\nimport java.io.ByteArrayInputStream;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n OpenAIClient client = OpenAIOkHttpClient.fromEnv();\n\n TranscriptionCreateParams params = TranscriptionCreateParams.builder()\n .file(new ByteArrayInputStream(\"Example data\".getBytes()))\n .model(AudioModel.GPT_4O_TRANSCRIBE)\n .build();\n TranscriptionCreateResponse transcription = client.audio().transcriptions().create(params);\n }\n}","ruby":"require \"openai\"\n\nopenai = OpenAI::Client.new(api_key: \"My API Key\")\n\ntranscription = openai.audio.transcriptions.create(file: StringIO.new(\"Example data\"), model: :\"gpt-4o-transcribe\")\n\nputs(transcription)"},"response":"{\n \"task\": \"transcribe\",\n \"language\": \"english\",\n \"duration\": 8.470000267028809,\n \"text\": \"The beach was a popular spot on a hot summer day. People were swimming in the ocean, building sandcastles, and playing beach volleyball.\",\n \"words\": [\n {\n \"word\": \"The\",\n \"start\": 0.0,\n \"end\": 0.23999999463558197\n },\n ...\n {\n \"word\": \"volleyball\",\n \"start\": 7.400000095367432,\n \"end\": 7.900000095367432\n }\n ],\n \"usage\": {\n \"type\": \"duration\",\n \"seconds\": 9\n }\n}\n"},{"title":"Segment timestamps","request":{"curl":"curl https://api.openai.com/v1/audio/transcriptions \\\n -H \"Authorization: Bearer $OPENAI_API_KEY\" \\\n -H \"Content-Type: multipart/form-data\" \\\n -F file=\"@/path/to/file/audio.mp3\" \\\n -F \"timestamp_granularities[]=segment\" \\\n -F model=\"whisper-1\" \\\n -F response_format=\"verbose_json\"\n","python":"import os\nfrom openai import OpenAI\n\nclient = OpenAI(\n api_key=os.environ.get(\"OPENAI_API_KEY\"), # This is the default and can be omitted\n)\nfor transcription in client.audio.transcriptions.create(\n file=b\"Example data\",\n model=\"gpt-4o-transcribe\",\n):\n print(transcription)","javascript":"import fs from \"fs\";\nimport OpenAI from \"openai\";\n\nconst openai = new OpenAI();\n\nasync function main() {\n const transcription = await openai.audio.transcriptions.create({\n file: fs.createReadStream(\"audio.mp3\"),\n model: \"whisper-1\",\n response_format: \"verbose_json\",\n timestamp_granularities: [\"segment\"]\n });\n\n console.log(transcription.text);\n}\nmain();\n","csharp":"using System;\n\nusing OpenAI.Audio;\n\nstring audioFilePath = \"audio.mp3\";\n\nAudioClient client = new(\n model: \"whisper-1\",\n apiKey: Environment.GetEnvironmentVariable(\"OPENAI_API_KEY\")\n);\n\nAudioTranscriptionOptions options = new()\n{\n ResponseFormat = AudioTranscriptionFormat.Verbose,\n TimestampGranularities = AudioTimestampGranularities.Segment,\n};\n\nAudioTranscription transcription = client.TranscribeAudio(audioFilePath, options);\n\nConsole.WriteLine($\"{transcription.Text}\");\n","node.js":"import fs from 'fs';\nimport OpenAI from 'openai';\n\nconst client = new OpenAI({\n apiKey: process.env['OPENAI_API_KEY'], // This is the default and can be omitted\n});\n\nconst transcription = await client.audio.transcriptions.create({\n file: fs.createReadStream('speech.mp3'),\n model: 'gpt-4o-transcribe',\n});\n\nconsole.log(transcription);","go":"package main\n\nimport (\n\t\"bytes\"\n\t\"context\"\n\t\"fmt\"\n\t\"io\"\n\n\t\"github.com/openai/openai-go\"\n\t\"github.com/openai/openai-go/option\"\n)\n\nfunc main() {\n\tclient := openai.NewClient(\n\t\toption.WithAPIKey(\"My API Key\"),\n\t)\n\ttranscription, err := client.Audio.Transcriptions.New(context.TODO(), openai.AudioTranscriptionNewParams{\n\t\tFile: io.Reader(bytes.NewBuffer([]byte(\"Example data\"))),\n\t\tModel: openai.AudioModelGPT4oTranscribe,\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf(\"%+v\\n\", transcription)\n}\n","java":"package com.openai.example;\n\nimport com.openai.client.OpenAIClient;\nimport com.openai.client.okhttp.OpenAIOkHttpClient;\nimport com.openai.models.audio.AudioModel;\nimport com.openai.models.audio.transcriptions.TranscriptionCreateParams;\nimport com.openai.models.audio.transcriptions.TranscriptionCreateResponse;\nimport java.io.ByteArrayInputStream;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n OpenAIClient client = OpenAIOkHttpClient.fromEnv();\n\n TranscriptionCreateParams params = TranscriptionCreateParams.builder()\n .file(new ByteArrayInputStream(\"Example data\".getBytes()))\n .model(AudioModel.GPT_4O_TRANSCRIBE)\n .build();\n TranscriptionCreateResponse transcription = client.audio().transcriptions().create(params);\n }\n}","ruby":"require \"openai\"\n\nopenai = OpenAI::Client.new(api_key: \"My API Key\")\n\ntranscription = openai.audio.transcriptions.create(file: StringIO.new(\"Example data\"), model: :\"gpt-4o-transcribe\")\n\nputs(transcription)"},"response":"{\n \"task\": \"transcribe\",\n \"language\": \"english\",\n \"duration\": 8.470000267028809,\n \"text\": \"The beach was a popular spot on a hot summer day. People were swimming in the ocean, building sandcastles, and playing beach volleyball.\",\n \"segments\": [\n {\n \"id\": 0,\n \"seek\": 0,\n \"start\": 0.0,\n \"end\": 3.319999933242798,\n \"text\": \" The beach was a popular spot on a hot summer day.\",\n \"tokens\": [\n 50364, 440, 7534, 390, 257, 3743, 4008, 322, 257, 2368, 4266, 786, 13, 50530\n ],\n \"temperature\": 0.0,\n \"avg_logprob\": -0.2860786020755768,\n \"compression_ratio\": 1.2363636493682861,\n \"no_speech_prob\": 0.00985979475080967\n },\n ...\n ],\n \"usage\": {\n \"type\": \"duration\",\n \"seconds\": 9\n }\n}\n"}]}}},"/audio/translations":{"post":{"operationId":"createTranslation","tags":["Audio"],"summary":"Translates audio into English.","requestBody":{"required":true,"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/CreateTranslationRequest"}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/CreateTranslationResponseJson"},{"$ref":"#/components/schemas/CreateTranslationResponseVerboseJson"}]}}}}},"x-oaiMeta":{"name":"Create translation","group":"audio","examples":{"request":{"curl":"curl https://api.openai.com/v1/audio/translations \\\n -H \"Authorization: Bearer $OPENAI_API_KEY\" \\\n -H \"Content-Type: multipart/form-data\" \\\n -F file=\"@/path/to/file/german.m4a\" \\\n -F model=\"whisper-1\"\n","python":"import os\nfrom openai import OpenAI\n\nclient = OpenAI(\n api_key=os.environ.get(\"OPENAI_API_KEY\"), # This is the default and can be omitted\n)\ntranslation = client.audio.translations.create(\n file=b\"Example data\",\n model=\"whisper-1\",\n)\nprint(translation)","javascript":"import fs from \"fs\";\nimport OpenAI from \"openai\";\n\nconst openai = new OpenAI();\n\nasync function main() {\n const translation = await openai.audio.translations.create({\n file: fs.createReadStream(\"speech.mp3\"),\n model: \"whisper-1\",\n });\n\n console.log(translation.text);\n}\nmain();\n","csharp":"using System;\n\nusing OpenAI.Audio;\n\nstring audioFilePath = \"audio.mp3\";\n\nAudioClient client = new(\n model: \"whisper-1\",\n apiKey: Environment.GetEnvironmentVariable(\"OPENAI_API_KEY\")\n);\n\nAudioTranscription transcription = client.TranscribeAudio(audioFilePath);\n\nConsole.WriteLine($\"{transcription.Text}\");\n","node.js":"import fs from 'fs';\nimport OpenAI from 'openai';\n\nconst client = new OpenAI({\n apiKey: process.env['OPENAI_API_KEY'], // This is the default and can be omitted\n});\n\nconst translation = await client.audio.translations.create({\n file: fs.createReadStream('speech.mp3'),\n model: 'whisper-1',\n});\n\nconsole.log(translation);","go":"package main\n\nimport (\n\t\"bytes\"\n\t\"context\"\n\t\"fmt\"\n\t\"io\"\n\n\t\"github.com/openai/openai-go\"\n\t\"github.com/openai/openai-go/option\"\n)\n\nfunc main() {\n\tclient := openai.NewClient(\n\t\toption.WithAPIKey(\"My API Key\"),\n\t)\n\ttranslation, err := client.Audio.Translations.New(context.TODO(), openai.AudioTranslationNewParams{\n\t\tFile: io.Reader(bytes.NewBuffer([]byte(\"Example data\"))),\n\t\tModel: openai.AudioModelWhisper1,\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf(\"%+v\\n\", translation)\n}\n","java":"package com.openai.example;\n\nimport com.openai.client.OpenAIClient;\nimport com.openai.client.okhttp.OpenAIOkHttpClient;\nimport com.openai.models.audio.AudioModel;\nimport com.openai.models.audio.translations.TranslationCreateParams;\nimport com.openai.models.audio.translations.TranslationCreateResponse;\nimport java.io.ByteArrayInputStream;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n OpenAIClient client = OpenAIOkHttpClient.fromEnv();\n\n TranslationCreateParams params = TranslationCreateParams.builder()\n .file(new ByteArrayInputStream(\"Example data\".getBytes()))\n .model(AudioModel.WHISPER_1)\n .build();\n TranslationCreateResponse translation = client.audio().translations().create(params);\n }\n}","ruby":"require \"openai\"\n\nopenai = OpenAI::Client.new(api_key: \"My API Key\")\n\ntranslation = openai.audio.translations.create(file: StringIO.new(\"Example data\"), model: :\"whisper-1\")\n\nputs(translation)"},"response":"{\n \"text\": \"Hello, my name is Wolfgang and I come from Germany. Where are you heading today?\"\n}\n"}}}},"/audio/voice_consents":{"post":{"operationId":"createVoiceConsent","tags":["Audio"],"summary":"Upload a voice consent recording.","description":"Upload a consent recording that authorizes creation of a custom voice.\n\nSee the [custom voices guide](/docs/guides/text-to-speech#custom-voices) for requirements and best practices. Custom voices are limited to eligible customers.\n","requestBody":{"required":true,"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/CreateVoiceConsentRequest"}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VoiceConsentResource"}}}}},"x-oaiMeta":{"name":"Create voice consent","group":"audio","examples":{"request":{"curl":"curl https://api.openai.com/v1/audio/voice_consents \\\n -X POST \\\n -H \"Authorization: Bearer $OPENAI_API_KEY\" \\\n -F \"name=John Doe\" \\\n -F \"language=en-US\" \\\n -F \"recording=@$HOME/consent_recording.wav;type=audio/x-wav\"\n"},"response":""}}},"get":{"operationId":"listVoiceConsents","tags":["Audio"],"summary":"Returns a list of voice consent recordings.","description":"List consent recordings available to your organization for creating custom voices.\n\nSee the [custom voices guide](/docs/guides/text-to-speech#custom-voices). Custom voices are limited to eligible customers.\n","parameters":[{"in":"query","name":"after","required":false,"schema":{"type":"string"},"description":"A cursor for use in pagination. `after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list.\n"},{"name":"limit","in":"query","description":"A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.\n","required":false,"schema":{"type":"integer","default":20}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VoiceConsentListResource"}}}}},"x-oaiMeta":{"name":"List voice consents","group":"audio","examples":{"request":{"curl":"curl https://api.openai.com/v1/audio/voice_consents?limit=20 \\\n -H \"Authorization: Bearer $OPENAI_API_KEY\"\n"},"response":""}}}},"/audio/voice_consents/{consent_id}":{"get":{"operationId":"getVoiceConsent","tags":["Audio"],"summary":"Retrieves a voice consent recording.","description":"Retrieve consent recording metadata used for creating custom voices.\n\nSee the [custom voices guide](/docs/guides/text-to-speech#custom-voices). Custom voices are limited to eligible customers.\n","parameters":[{"in":"path","name":"consent_id","required":true,"schema":{"type":"string"},"description":"The ID of the consent recording to retrieve."}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VoiceConsentResource"}}}}},"x-oaiMeta":{"name":"Retrieve voice consent","group":"audio","examples":{"request":{"curl":"curl https://api.openai.com/v1/audio/voice_consents/cons_1234 \\\n -H \"Authorization: Bearer $OPENAI_API_KEY\"\n"},"response":""}}},"post":{"operationId":"updateVoiceConsent","tags":["Audio"],"summary":"Updates a voice consent recording (metadata only).","description":"Update consent recording metadata used for creating custom voices. This endpoint updates metadata only and does not replace the underlying audio.\n\nSee the [custom voices guide](/docs/guides/text-to-speech#custom-voices). Custom voices are limited to eligible customers.\n","parameters":[{"in":"path","name":"consent_id","required":true,"schema":{"type":"string"},"description":"The ID of the consent recording to update."}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateVoiceConsentRequest"}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VoiceConsentResource"}}}}},"x-oaiMeta":{"name":"Update voice consent","group":"audio","examples":{"request":{"curl":"curl https://api.openai.com/v1/audio/voice_consents/cons_1234 \\\n -X POST \\\n -H \"Authorization: Bearer $OPENAI_API_KEY\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"name\": \"John Doe\"\n }'\n"},"response":""}}},"delete":{"operationId":"deleteVoiceConsent","tags":["Audio"],"summary":"Deletes a voice consent recording.","description":"Delete a consent recording that was uploaded for creating custom voices.\n\nSee the [custom voices guide](/docs/guides/text-to-speech#custom-voices). Custom voices are limited to eligible customers.\n","parameters":[{"in":"path","name":"consent_id","required":true,"schema":{"type":"string"},"description":"The ID of the consent recording to delete."}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VoiceConsentDeletedResource"}}}}},"x-oaiMeta":{"name":"Delete voice consent","group":"audio","examples":{"request":{"curl":"curl https://api.openai.com/v1/audio/voice_consents/cons_1234 \\\n -X DELETE \\\n -H \"Authorization: Bearer $OPENAI_API_KEY\"\n"},"response":""}}}},"/audio/voices":{"post":{"operationId":"createVoice","tags":["Audio"],"summary":"Creates a custom voice.","description":"Create a custom voice you can use for audio output (for example, in Text-to-Speech and the Realtime API). This requires an audio sample and a previously uploaded consent recording.\n\nSee the [custom voices guide](/docs/guides/text-to-speech#custom-voices) for requirements and best practices. Custom voices are limited to eligible customers.\n","requestBody":{"required":true,"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/CreateVoiceRequest"}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VoiceResource"}}}}},"x-oaiMeta":{"name":"Create voice","group":"audio","examples":{"request":{"curl":"curl https://api.openai.com/v1/audio/voices \\\n -X POST \\\n -H \"Authorization: Bearer $OPENAI_API_KEY\" \\\n -F \"name=My new voice\" \\\n -F \"consent=cons_1234\" \\\n -F \"audio_sample=@$HOME/audio_sample.wav;type=audio/x-wav\"\n"},"response":""}}}},"/batches":{"post":{"summary":"Creates and executes a batch from an uploaded file of requests","operationId":"createBatch","tags":["Batch"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["input_file_id","endpoint","completion_window"],"properties":{"input_file_id":{"type":"string","description":"The ID of an uploaded file that contains requests for the new batch.\n\nSee [upload file](/docs/api-reference/files/create) for how to upload a file.\n\nYour input file must be formatted as a [JSONL file](/docs/api-reference/batch/request-input), and must be uploaded with the purpose `batch`. The file can contain up to 50,000 requests, and can be up to 200 MB in size.\n"},"endpoint":{"type":"string","enum":["/v1/responses","/v1/chat/completions","/v1/embeddings","/v1/completions","/v1/moderations","/v1/images/generations","/v1/images/edits","/v1/videos"],"description":"The endpoint to be used for all requests in the batch. Currently `/v1/responses`, `/v1/chat/completions`, `/v1/embeddings`, `/v1/completions`, `/v1/moderations`, `/v1/images/generations`, `/v1/images/edits`, and `/v1/videos` are supported. Note that `/v1/embeddings` batches are also restricted to a maximum of 50,000 embedding inputs across all requests in the batch."},"completion_window":{"type":"string","enum":["24h"],"description":"The time frame within which the batch should be processed. Currently only `24h` is supported."},"metadata":{"$ref":"#/components/schemas/Metadata"},"output_expires_after":{"$ref":"#/components/schemas/BatchFileExpirationAfter"}}}}}},"responses":{"200":{"description":"Batch created successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Batch"}}}}},"x-oaiMeta":{"name":"Create batch","group":"batch","examples":{"request":{"curl":"curl https://api.openai.com/v1/batches \\\n -H \"Authorization: Bearer $OPENAI_API_KEY\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"input_file_id\": \"file-abc123\",\n \"endpoint\": \"/v1/chat/completions\",\n \"completion_window\": \"24h\"\n }'\n","python":"import os\nfrom openai import OpenAI\n\nclient = OpenAI(\n api_key=os.environ.get(\"OPENAI_API_KEY\"), # This is the default and can be omitted\n)\nbatch = client.batches.create(\n completion_window=\"24h\",\n endpoint=\"/v1/responses\",\n input_file_id=\"input_file_id\",\n)\nprint(batch.id)","javascript":"import OpenAI from \"openai\";\n\nconst openai = new OpenAI();\n\nasync function main() {\n const batch = await openai.batches.create({\n input_file_id: \"file-abc123\",\n endpoint: \"/v1/chat/completions\",\n completion_window: \"24h\"\n });\n\n console.log(batch);\n}\n\nmain();\n","node.js":"import OpenAI from 'openai';\n\nconst client = new OpenAI({\n apiKey: process.env['OPENAI_API_KEY'], // This is the default and can be omitted\n});\n\nconst batch = await client.batches.create({\n completion_window: '24h',\n endpoint: '/v1/responses',\n input_file_id: 'input_file_id',\n});\n\nconsole.log(batch.id);","go":"package main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\n\t\"github.com/openai/openai-go\"\n\t\"github.com/openai/openai-go/option\"\n)\n\nfunc main() {\n\tclient := openai.NewClient(\n\t\toption.WithAPIKey(\"My API Key\"),\n\t)\n\tbatch, err := client.Batches.New(context.TODO(), openai.BatchNewParams{\n\t\tCompletionWindow: openai.BatchNewParamsCompletionWindow24h,\n\t\tEndpoint: openai.BatchNewParamsEndpointV1Responses,\n\t\tInputFileID: \"input_file_id\",\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf(\"%+v\\n\", batch.ID)\n}\n","java":"package com.openai.example;\n\nimport com.openai.client.OpenAIClient;\nimport com.openai.client.okhttp.OpenAIOkHttpClient;\nimport com.openai.models.batches.Batch;\nimport com.openai.models.batches.BatchCreateParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n OpenAIClient client = OpenAIOkHttpClient.fromEnv();\n\n BatchCreateParams params = BatchCreateParams.builder()\n .completionWindow(BatchCreateParams.CompletionWindow._24H)\n .endpoint(BatchCreateParams.Endpoint.V1_RESPONSES)\n .inputFileId(\"input_file_id\")\n .build();\n Batch batch = client.batches().create(params);\n }\n}","ruby":"require \"openai\"\n\nopenai = OpenAI::Client.new(api_key: \"My API Key\")\n\nbatch = openai.batches.create(\n completion_window: :\"24h\",\n endpoint: :\"/v1/responses\",\n input_file_id: \"input_file_id\"\n)\n\nputs(batch)"},"response":"{\n \"id\": \"batch_abc123\",\n \"object\": \"batch\",\n \"endpoint\": \"/v1/chat/completions\",\n \"errors\": null,\n \"input_file_id\": \"file-abc123\",\n \"completion_window\": \"24h\",\n \"status\": \"validating\",\n \"output_file_id\": null,\n \"error_file_id\": null,\n \"created_at\": 1711471533,\n \"in_progress_at\": null,\n \"expires_at\": null,\n \"finalizing_at\": null,\n \"completed_at\": null,\n \"failed_at\": null,\n \"expired_at\": null,\n \"cancelling_at\": null,\n \"cancelled_at\": null,\n \"request_counts\": {\n \"total\": 0,\n \"completed\": 0,\n \"failed\": 0\n },\n \"metadata\": {\n \"customer_id\": \"user_123456789\",\n \"batch_description\": \"Nightly eval job\",\n }\n}\n"}}},"get":{"operationId":"listBatches","tags":["Batch"],"summary":"List your organization's batches.","parameters":[{"in":"query","name":"after","required":false,"schema":{"type":"string"},"description":"A cursor for use in pagination. `after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list.\n"},{"name":"limit","in":"query","description":"A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.\n","required":false,"schema":{"type":"integer","default":20}}],"responses":{"200":{"description":"Batch listed successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListBatchesResponse"}}}}},"x-oaiMeta":{"name":"List batches","group":"batch","examples":{"request":{"curl":"curl https://api.openai.com/v1/batches?limit=2 \\\n -H \"Authorization: Bearer $OPENAI_API_KEY\" \\\n -H \"Content-Type: application/json\"\n","python":"import os\nfrom openai import OpenAI\n\nclient = OpenAI(\n api_key=os.environ.get(\"OPENAI_API_KEY\"), # This is the default and can be omitted\n)\npage = client.batches.list()\npage = page.data[0]\nprint(page.id)","javascript":"import OpenAI from \"openai\";\n\nconst openai = new OpenAI();\n\nasync function main() {\n const list = await openai.batches.list();\n\n for await (const batch of list) {\n console.log(batch);\n }\n}\n\nmain();\n","node.js":"import OpenAI from 'openai';\n\nconst client = new OpenAI({\n apiKey: process.env['OPENAI_API_KEY'], // This is the default and can be omitted\n});\n\n// Automatically fetches more pages as needed.\nfor await (const batch of client.batches.list()) {\n console.log(batch.id);\n}","go":"package main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\n\t\"github.com/openai/openai-go\"\n\t\"github.com/openai/openai-go/option\"\n)\n\nfunc main() {\n\tclient := openai.NewClient(\n\t\toption.WithAPIKey(\"My API Key\"),\n\t)\n\tpage, err := client.Batches.List(context.TODO(), openai.BatchListParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf(\"%+v\\n\", page)\n}\n","java":"package com.openai.example;\n\nimport com.openai.client.OpenAIClient;\nimport com.openai.client.okhttp.OpenAIOkHttpClient;\nimport com.openai.models.batches.BatchListPage;\nimport com.openai.models.batches.BatchListParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n OpenAIClient client = OpenAIOkHttpClient.fromEnv();\n\n BatchListPage page = client.batches().list();\n }\n}","ruby":"require \"openai\"\n\nopenai = OpenAI::Client.new(api_key: \"My API Key\")\n\npage = openai.batches.list\n\nputs(page)"},"response":"{\n \"object\": \"list\",\n \"data\": [\n {\n \"id\": \"batch_abc123\",\n \"object\": \"batch\",\n \"endpoint\": \"/v1/chat/completions\",\n \"errors\": null,\n \"input_file_id\": \"file-abc123\",\n \"completion_window\": \"24h\",\n \"status\": \"completed\",\n \"output_file_id\": \"file-cvaTdG\",\n \"error_file_id\": \"file-HOWS94\",\n \"created_at\": 1711471533,\n \"in_progress_at\": 1711471538,\n \"expires_at\": 1711557933,\n \"finalizing_at\": 1711493133,\n \"completed_at\": 1711493163,\n \"failed_at\": null,\n \"expired_at\": null,\n \"cancelling_at\": null,\n \"cancelled_at\": null,\n \"request_counts\": {\n \"total\": 100,\n \"completed\": 95,\n \"failed\": 5\n },\n \"metadata\": {\n \"customer_id\": \"user_123456789\",\n \"batch_description\": \"Nightly job\",\n }\n },\n { ... },\n ],\n \"first_id\": \"batch_abc123\",\n \"last_id\": \"batch_abc456\",\n \"has_more\": true\n}\n"}}}},"/batches/{batch_id}":{"get":{"operationId":"retrieveBatch","tags":["Batch"],"summary":"Retrieves a batch.","parameters":[{"in":"path","name":"batch_id","required":true,"schema":{"type":"string"},"description":"The ID of the batch to retrieve."}],"responses":{"200":{"description":"Batch retrieved successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Batch"}}}}},"x-oaiMeta":{"name":"Retrieve batch","group":"batch","examples":{"request":{"curl":"curl https://api.openai.com/v1/batches/batch_abc123 \\\n -H \"Authorization: Bearer $OPENAI_API_KEY\" \\\n -H \"Content-Type: application/json\" \\\n","python":"import os\nfrom openai import OpenAI\n\nclient = OpenAI(\n api_key=os.environ.get(\"OPENAI_API_KEY\"), # This is the default and can be omitted\n)\nbatch = client.batches.retrieve(\n \"batch_id\",\n)\nprint(batch.id)","javascript":"import OpenAI from \"openai\";\n\nconst openai = new OpenAI();\n\nasync function main() {\n const batch = await openai.batches.retrieve(\"batch_abc123\");\n\n console.log(batch);\n}\n\nmain();\n","node.js":"import OpenAI from 'openai';\n\nconst client = new OpenAI({\n apiKey: process.env['OPENAI_API_KEY'], // This is the default and can be omitted\n});\n\nconst batch = await client.batches.retrieve('batch_id');\n\nconsole.log(batch.id);","go":"package main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\n\t\"github.com/openai/openai-go\"\n\t\"github.com/openai/openai-go/option\"\n)\n\nfunc main() {\n\tclient := openai.NewClient(\n\t\toption.WithAPIKey(\"My API Key\"),\n\t)\n\tbatch, err := client.Batches.Get(context.TODO(), \"batch_id\")\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf(\"%+v\\n\", batch.ID)\n}\n","java":"package com.openai.example;\n\nimport com.openai.client.OpenAIClient;\nimport com.openai.client.okhttp.OpenAIOkHttpClient;\nimport com.openai.models.batches.Batch;\nimport com.openai.models.batches.BatchRetrieveParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n OpenAIClient client = OpenAIOkHttpClient.fromEnv();\n\n Batch batch = client.batches().retrieve(\"batch_id\");\n }\n}","ruby":"require \"openai\"\n\nopenai = OpenAI::Client.new(api_key: \"My API Key\")\n\nbatch = openai.batches.retrieve(\"batch_id\")\n\nputs(batch)"},"response":"{\n \"id\": \"batch_abc123\",\n \"object\": \"batch\",\n \"endpoint\": \"/v1/completions\",\n \"errors\": null,\n \"input_file_id\": \"file-abc123\",\n \"completion_window\": \"24h\",\n \"status\": \"completed\",\n \"output_file_id\": \"file-cvaTdG\",\n \"error_file_id\": \"file-HOWS94\",\n \"created_at\": 1711471533,\n \"in_progress_at\": 1711471538,\n \"expires_at\": 1711557933,\n \"finalizing_at\": 1711493133,\n \"completed_at\": 1711493163,\n \"failed_at\": null,\n \"expired_at\": null,\n \"cancelling_at\": null,\n \"cancelled_at\": null,\n \"request_counts\": {\n \"total\": 100,\n \"completed\": 95,\n \"failed\": 5\n },\n \"metadata\": {\n \"customer_id\": \"user_123456789\",\n \"batch_description\": \"Nightly eval job\",\n }\n}\n"}}}},"/batches/{batch_id}/cancel":{"post":{"operationId":"cancelBatch","tags":["Batch"],"summary":"Cancels an in-progress batch. The batch will be in status `cancelling` for up to 10 minutes, before changing to `cancelled`, where it will have partial results (if any) available in the output file.","parameters":[{"in":"path","name":"batch_id","required":true,"schema":{"type":"string"},"description":"The ID of the batch to cancel."}],"responses":{"200":{"description":"Batch is cancelling. Returns the cancelling batch's details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Batch"}}}}},"x-oaiMeta":{"name":"Cancel batch","group":"batch","examples":{"request":{"curl":"curl https://api.openai.com/v1/batches/batch_abc123/cancel \\\n -H \"Authorization: Bearer $OPENAI_API_KEY\" \\\n -H \"Content-Type: application/json\" \\\n -X POST\n","python":"import os\nfrom openai import OpenAI\n\nclient = OpenAI(\n api_key=os.environ.get(\"OPENAI_API_KEY\"), # This is the default and can be omitted\n)\nbatch = client.batches.cancel(\n \"batch_id\",\n)\nprint(batch.id)","javascript":"import OpenAI from \"openai\";\n\nconst openai = new OpenAI();\n\nasync function main() {\n const batch = await openai.batches.cancel(\"batch_abc123\");\n\n console.log(batch);\n}\n\nmain();\n","node.js":"import OpenAI from 'openai';\n\nconst client = new OpenAI({\n apiKey: process.env['OPENAI_API_KEY'], // This is the default and can be omitted\n});\n\nconst batch = await client.batches.cancel('batch_id');\n\nconsole.log(batch.id);","go":"package main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\n\t\"github.com/openai/openai-go\"\n\t\"github.com/openai/openai-go/option\"\n)\n\nfunc main() {\n\tclient := openai.NewClient(\n\t\toption.WithAPIKey(\"My API Key\"),\n\t)\n\tbatch, err := client.Batches.Cancel(context.TODO(), \"batch_id\")\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf(\"%+v\\n\", batch.ID)\n}\n","java":"package com.openai.example;\n\nimport com.openai.client.OpenAIClient;\nimport com.openai.client.okhttp.OpenAIOkHttpClient;\nimport com.openai.models.batches.Batch;\nimport com.openai.models.batches.BatchCancelParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n OpenAIClient client = OpenAIOkHttpClient.fromEnv();\n\n Batch batch = client.batches().cancel(\"batch_id\");\n }\n}","ruby":"require \"openai\"\n\nopenai = OpenAI::Client.new(api_key: \"My API Key\")\n\nbatch = openai.batches.cancel(\"batch_id\")\n\nputs(batch)"},"response":"{\n \"id\": \"batch_abc123\",\n \"object\": \"batch\",\n \"endpoint\": \"/v1/chat/completions\",\n \"errors\": null,\n \"input_file_id\": \"file-abc123\",\n \"completion_window\": \"24h\",\n \"status\": \"cancelling\",\n \"output_file_id\": null,\n \"error_file_id\": null,\n \"created_at\": 1711471533,\n \"in_progress_at\": 1711471538,\n \"expires_at\": 1711557933,\n \"finalizing_at\": null,\n \"completed_at\": null,\n \"failed_at\": null,\n \"expired_at\": null,\n \"cancelling_at\": 1711475133,\n \"cancelled_at\": null,\n \"request_counts\": {\n \"total\": 100,\n \"completed\": 23,\n \"failed\": 1\n },\n \"metadata\": {\n \"customer_id\": \"user_123456789\",\n \"batch_description\": \"Nightly eval job\",\n }\n}\n"}}}},"/chat/completions":{"get":{"operationId":"listChatCompletions","tags":["Chat"],"summary":"List stored Chat Completions. Only Chat Completions that have been stored\nwith the `store` parameter set to `true` will be returned.\n","parameters":[{"name":"model","in":"query","description":"The model used to generate the Chat Completions.","required":false,"schema":{"type":"string"}},{"name":"metadata","in":"query","description":"A list of metadata keys to filter the Chat Completions by. Example:\n\n`metadata[key1]=value1&metadata[key2]=value2`\n","required":false,"schema":{"$ref":"#/components/schemas/Metadata"}},{"name":"after","in":"query","description":"Identifier for the last chat completion from the previous pagination request.","required":false,"schema":{"type":"string"}},{"name":"limit","in":"query","description":"Number of Chat Completions to retrieve.","required":false,"schema":{"type":"integer","default":20}},{"name":"order","in":"query","description":"Sort order for Chat Completions by timestamp. Use `asc` for ascending order or `desc` for descending order. Defaults to `asc`.","required":false,"schema":{"type":"string","enum":["asc","desc"],"default":"asc"}}],"responses":{"200":{"description":"A list of Chat Completions","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChatCompletionList"}}}}},"x-oaiMeta":{"name":"List Chat Completions","group":"chat","path":"list","examples":{"request":{"curl":"curl https://api.openai.com/v1/chat/completions \\\n -H \"Authorization: Bearer $OPENAI_API_KEY\" \\\n -H \"Content-Type: application/json\"\n","python":"import os\nfrom openai import OpenAI\n\nclient = OpenAI(\n api_key=os.environ.get(\"OPENAI_API_KEY\"), # This is the default and can be omitted\n)\npage = client.chat.completions.list()\npage = page.data[0]\nprint(page.id)","node.js":"import OpenAI from 'openai';\n\nconst client = new OpenAI({\n apiKey: process.env['OPENAI_API_KEY'], // This is the default and can be omitted\n});\n\n// Automatically fetches more pages as needed.\nfor await (const chatCompletion of client.chat.completions.list()) {\n console.log(chatCompletion.id);\n}","go":"package main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\n\t\"github.com/openai/openai-go\"\n\t\"github.com/openai/openai-go/option\"\n)\n\nfunc main() {\n\tclient := openai.NewClient(\n\t\toption.WithAPIKey(\"My API Key\"),\n\t)\n\tpage, err := client.Chat.Completions.List(context.TODO(), openai.ChatCompletionListParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf(\"%+v\\n\", page)\n}\n","java":"package com.openai.example;\n\nimport com.openai.client.OpenAIClient;\nimport com.openai.client.okhttp.OpenAIOkHttpClient;\nimport com.openai.models.chat.completions.ChatCompletionListPage;\nimport com.openai.models.chat.completions.ChatCompletionListParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n OpenAIClient client = OpenAIOkHttpClient.fromEnv();\n\n ChatCompletionListPage page = client.chat().completions().list();\n }\n}","ruby":"require \"openai\"\n\nopenai = OpenAI::Client.new(api_key: \"My API Key\")\n\npage = openai.chat.completions.list\n\nputs(page)"},"response":"{\n \"object\": \"list\",\n \"data\": [\n {\n \"object\": \"chat.completion\",\n \"id\": \"chatcmpl-AyPNinnUqUDYo9SAdA52NobMflmj2\",\n \"model\": \"gpt-5.4\",\n \"created\": 1738960610,\n \"request_id\": \"req_ded8ab984ec4bf840f37566c1011c417\",\n \"tool_choice\": null,\n \"usage\": {\n \"total_tokens\": 31,\n \"completion_tokens\": 18,\n \"prompt_tokens\": 13\n },\n \"seed\": 4944116822809979520,\n \"top_p\": 1.0,\n \"temperature\": 1.0,\n \"presence_penalty\": 0.0,\n \"frequency_penalty\": 0.0,\n \"system_fingerprint\": \"fp_50cad350e4\",\n \"input_user\": null,\n \"service_tier\": \"default\",\n \"tools\": null,\n \"metadata\": {},\n \"choices\": [\n {\n \"index\": 0,\n \"message\": {\n \"content\": \"Mind of circuits hum, \\nLearning patterns in silence— \\nFuture's quiet spark.\",\n \"role\": \"assistant\",\n \"tool_calls\": null,\n \"function_call\": null\n },\n \"finish_reason\": \"stop\",\n \"logprobs\": null\n }\n ],\n \"response_format\": null\n }\n ],\n \"first_id\": \"chatcmpl-AyPNinnUqUDYo9SAdA52NobMflmj2\",\n \"last_id\": \"chatcmpl-AyPNinnUqUDYo9SAdA52NobMflmj2\",\n \"has_more\": false\n}\n"}}},"post":{"operationId":"createChatCompletion","tags":["Chat"],"summary":"**Starting a new project?** We recommend trying [Responses](/docs/api-reference/responses)\nto take advantage of the latest OpenAI platform features. Compare\n[Chat Completions with Responses](/docs/guides/responses-vs-chat-completions?api-mode=responses).\n\n---\n\nCreates a model response for the given chat conversation. Learn more in the\n[text generation](/docs/guides/text-generation), [vision](/docs/guides/vision),\nand [audio](/docs/guides/audio) guides.\n\nParameter support can differ depending on the model used to generate the\nresponse, particularly for newer reasoning models. Parameters that are only\nsupported for reasoning models are noted below. For the current state of\nunsupported parameters in reasoning models,\n[refer to the reasoning guide](/docs/guides/reasoning).\n\nReturns a chat completion object, or a streamed sequence of chat completion\nchunk objects if the request is streamed.\n","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateChatCompletionRequest"}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateChatCompletionResponse"}},"text/event-stream":{"schema":{"$ref":"#/components/schemas/CreateChatCompletionStreamResponse"}}}}},"x-oaiMeta":{"name":"Create chat completion","group":"chat","path":"create","examples":[{"title":"Default","request":{"curl":"curl https://api.openai.com/v1/chat/completions \\\n -H \"Content-Type: application/json\" \\\n -H \"Authorization: Bearer $OPENAI_API_KEY\" \\\n -d '{\n \"model\": \"VAR_chat_model_id\",\n \"messages\": [\n {\n \"role\": \"developer\",\n \"content\": \"You are a helpful assistant.\"\n },\n {\n \"role\": \"user\",\n \"content\": \"Hello!\"\n }\n ]\n }'\n","python":"import os\nfrom openai import OpenAI\n\nclient = OpenAI(\n api_key=os.environ.get(\"OPENAI_API_KEY\"), # This is the default and can be omitted\n)\nfor completion in client.chat.completions.create(\n messages=[{\n \"content\": \"string\",\n \"role\": \"developer\",\n }],\n model=\"gpt-5.4\",\n):\n print(completion)","javascript":"import OpenAI from \"openai\";\n\nconst openai = new OpenAI();\n\nasync function main() {\n const completion = await openai.chat.completions.create({\n messages: [{ role: \"developer\", content: \"You are a helpful assistant.\" }],\n model: \"VAR_chat_model_id\",\n store: true,\n });\n\n console.log(completion.choices[0]);\n}\n\nmain();\n","csharp":"using System;\nusing System.Collections.Generic;\n\nusing OpenAI.Chat;\n\nChatClient client = new(\n model: \"gpt-5.4\",\n apiKey: Environment.GetEnvironmentVariable(\"OPENAI_API_KEY\")\n);\n\nList<ChatMessage> messages =\n[\n new SystemChatMessage(\"You are a helpful assistant.\"),\n new UserChatMessage(\"Hello!\")\n];\n\nChatCompletion completion = client.CompleteChat(messages);\n\nConsole.WriteLine(completion.Content[0].Text);\n","node.js":"import OpenAI from 'openai';\n\nconst client = new OpenAI({\n apiKey: process.env['OPENAI_API_KEY'], // This is the default and can be omitted\n});\n\nconst chatCompletion = await client.chat.completions.create({\n messages: [{ content: 'string', role: 'developer' }],\n model: 'gpt-5.4',\n});\n\nconsole.log(chatCompletion);","go":"package main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\n\t\"github.com/openai/openai-go\"\n\t\"github.com/openai/openai-go/option\"\n\t\"github.com/openai/openai-go/shared\"\n)\n\nfunc main() {\n\tclient := openai.NewClient(\n\t\toption.WithAPIKey(\"My API Key\"),\n\t)\n\tchatCompletion, err := client.Chat.Completions.New(context.TODO(), openai.ChatCompletionNewParams{\n\t\tMessages: []openai.ChatCompletionMessageParamUnion{{\n\t\t\tOfDeveloper: &openai.ChatCompletionDeveloperMessageParam{\n\t\t\t\tContent: openai.ChatCompletionDeveloperMessageParamContentUnion{\n\t\t\t\t\tOfString: openai.String(\"string\"),\n\t\t\t\t},\n\t\t\t},\n\t\t}},\n\t\tModel: shared.ChatModelGPT5_4,\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf(\"%+v\\n\", chatCompletion)\n}\n","java":"package com.openai.example;\n\nimport com.openai.client.OpenAIClient;\nimport com.openai.client.okhttp.OpenAIOkHttpClient;\nimport com.openai.models.ChatModel;\nimport com.openai.models.chat.completions.ChatCompletion;\nimport com.openai.models.chat.completions.ChatCompletionCreateParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n OpenAIClient client = OpenAIOkHttpClient.fromEnv();\n\n ChatCompletionCreateParams params = ChatCompletionCreateParams.builder()\n .addDeveloperMessage(\"string\")\n .model(ChatModel.GPT_5_4)\n .build();\n ChatCompletion chatCompletion = client.chat().completions().create(params);\n }\n}","ruby":"require \"openai\"\n\nopenai = OpenAI::Client.new(api_key: \"My API Key\")\n\nchat_completion = openai.chat.completions.create(messages: [{content: \"string\", role: :developer}], model: :\"gpt-5.4\")\n\nputs(chat_completion)"},"response":"{\n \"id\": \"chatcmpl-B9MBs8CjcvOU2jLn4n570S5qMJKcT\",\n \"object\": \"chat.completion\",\n \"created\": 1741569952,\n \"model\": \"gpt-5.4\",\n \"choices\": [\n {\n \"index\": 0,\n \"message\": {\n \"role\": \"assistant\",\n \"content\": \"Hello! How can I assist you today?\",\n \"refusal\": null,\n \"annotations\": []\n },\n \"logprobs\": null,\n \"finish_reason\": \"stop\"\n }\n ],\n \"usage\": {\n \"prompt_tokens\": 19,\n \"completion_tokens\": 10,\n \"total_tokens\": 29,\n \"prompt_tokens_details\": {\n \"cached_tokens\": 0,\n \"audio_tokens\": 0\n },\n \"completion_tokens_details\": {\n \"reasoning_tokens\": 0,\n \"audio_tokens\": 0,\n \"accepted_prediction_tokens\": 0,\n \"rejected_prediction_tokens\": 0\n }\n },\n \"service_tier\": \"default\"\n}\n"},{"title":"Image input","request":{"curl":"curl https://api.openai.com/v1/chat/completions \\\n -H \"Content-Type: application/json\" \\\n -H \"Authorization: Bearer $OPENAI_API_KEY\" \\\n -d '{\n \"model\": \"gpt-5.4\",\n \"messages\": [\n {\n \"role\": \"user\",\n \"content\": [\n {\n \"type\": \"text\",\n \"text\": \"What is in this image?\"\n },\n {\n \"type\": \"image_url\",\n \"image_url\": {\n \"url\": \"https://upload.wikimedia.org/wikipedia/commons/thumb/d/dd/Gfp-wisconsin-madison-the-nature-boardwalk.jpg/2560px-Gfp-wisconsin-madison-the-nature-boardwalk.jpg\"\n }\n }\n ]\n }\n ],\n \"max_tokens\": 300\n }'\n","python":"import os\nfrom openai import OpenAI\n\nclient = OpenAI(\n api_key=os.environ.get(\"OPENAI_API_KEY\"), # This is the default and can be omitted\n)\nfor completion in client.chat.completions.create(\n messages=[{\n \"content\": \"string\",\n \"role\": \"developer\",\n }],\n model=\"gpt-5.4\",\n):\n print(completion)","javascript":"import OpenAI from \"openai\";\n\nconst openai = new OpenAI();\n\nasync function main() {\n const response = await openai.chat.completions.create({\n model: \"gpt-5.4\",\n messages: [\n {\n role: \"user\",\n content: [\n { type: \"text\", text: \"What's in this image?\" },\n {\n type: \"image_url\",\n image_url: {\n \"url\": \"https://upload.wikimedia.org/wikipedia/commons/thumb/d/dd/Gfp-wisconsin-madison-the-nature-boardwalk.jpg/2560px-Gfp-wisconsin-madison-the-nature-boardwalk.jpg\",\n },\n }\n ],\n },\n ],\n });\n console.log(response.choices[0]);\n}\nmain();\n","csharp":"using System;\nusing System.Collections.Generic;\n\nusing OpenAI.Chat;\n\nChatClient client = new(\n model: \"gpt-5.4\",\n apiKey: Environment.GetEnvironmentVariable(\"OPENAI_API_KEY\")\n);\n\nList<ChatMessage> messages =\n[\n new UserChatMessage(\n [\n ChatMessageContentPart.CreateTextPart(\"What's in this image?\"),\n ChatMessageContentPart.CreateImagePart(new Uri(\"https://upload.wikimedia.org/wikipedia/commons/thumb/d/dd/Gfp-wisconsin-madison-the-nature-boardwalk.jpg/2560px-Gfp-wisconsin-madison-the-nature-boardwalk.jpg\"))\n ])\n];\n\nChatCompletion completion = client.CompleteChat(messages);\n\nConsole.WriteLine(completion.Content[0].Text);\n","node.js":"import OpenAI from 'openai';\n\nconst client = new OpenAI({\n apiKey: process.env['OPENAI_API_KEY'], // This is the default and can be omitted\n});\n\nconst chatCompletion = await client.chat.completions.create({\n messages: [{ content: 'string', role: 'developer' }],\n model: 'gpt-5.4',\n});\n\nconsole.log(chatCompletion);","go":"package main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\n\t\"github.com/openai/openai-go\"\n\t\"github.com/openai/openai-go/option\"\n\t\"github.com/openai/openai-go/shared\"\n)\n\nfunc main() {\n\tclient := openai.NewClient(\n\t\toption.WithAPIKey(\"My API Key\"),\n\t)\n\tchatCompletion, err := client.Chat.Completions.New(context.TODO(), openai.ChatCompletionNewParams{\n\t\tMessages: []openai.ChatCompletionMessageParamUnion{{\n\t\t\tOfDeveloper: &openai.ChatCompletionDeveloperMessageParam{\n\t\t\t\tContent: openai.ChatCompletionDeveloperMessageParamContentUnion{\n\t\t\t\t\tOfString: openai.String(\"string\"),\n\t\t\t\t},\n\t\t\t},\n\t\t}},\n\t\tModel: shared.ChatModelGPT5_4,\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf(\"%+v\\n\", chatCompletion)\n}\n","java":"package com.openai.example;\n\nimport com.openai.client.OpenAIClient;\nimport com.openai.client.okhttp.OpenAIOkHttpClient;\nimport com.openai.models.ChatModel;\nimport com.openai.models.chat.completions.ChatCompletion;\nimport com.openai.models.chat.completions.ChatCompletionCreateParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n OpenAIClient client = OpenAIOkHttpClient.fromEnv();\n\n ChatCompletionCreateParams params = ChatCompletionCreateParams.builder()\n .addDeveloperMessage(\"string\")\n .model(ChatModel.GPT_5_4)\n .build();\n ChatCompletion chatCompletion = client.chat().completions().create(params);\n }\n}","ruby":"require \"openai\"\n\nopenai = OpenAI::Client.new(api_key: \"My API Key\")\n\nchat_completion = openai.chat.completions.create(messages: [{content: \"string\", role: :developer}], model: :\"gpt-5.4\")\n\nputs(chat_completion)"},"response":"{\n \"id\": \"chatcmpl-B9MHDbslfkBeAs8l4bebGdFOJ6PeG\",\n \"object\": \"chat.completion\",\n \"created\": 1741570283,\n \"model\": \"gpt-5.4\",\n \"choices\": [\n {\n \"index\": 0,\n \"message\": {\n \"role\": \"assistant\",\n \"content\": \"The image shows a wooden boardwalk path running through a lush green field or meadow. The sky is bright blue with some scattered clouds, giving the scene a serene and peaceful atmosphere. Trees and shrubs are visible in the background.\",\n \"refusal\": null,\n \"annotations\": []\n },\n \"logprobs\": null,\n \"finish_reason\": \"stop\"\n }\n ],\n \"usage\": {\n \"prompt_tokens\": 1117,\n \"completion_tokens\": 46,\n \"total_tokens\": 1163,\n \"prompt_tokens_details\": {\n \"cached_tokens\": 0,\n \"audio_tokens\": 0\n },\n \"completion_tokens_details\": {\n \"reasoning_tokens\": 0,\n \"audio_tokens\": 0,\n \"accepted_prediction_tokens\": 0,\n \"rejected_prediction_tokens\": 0\n }\n },\n \"service_tier\": \"default\"\n}\n"},{"title":"Streaming","request":{"curl":"curl https://api.openai.com/v1/chat/completions \\\n -H \"Content-Type: application/json\" \\\n -H \"Authorization: Bearer $OPENAI_API_KEY\" \\\n -d '{\n \"model\": \"VAR_chat_model_id\",\n \"messages\": [\n {\n \"role\": \"developer\",\n \"content\": \"You are a helpful assistant.\"\n },\n {\n \"role\": \"user\",\n \"content\": \"Hello!\"\n }\n ],\n \"stream\": true\n }'\n","python":"import os\nfrom openai import OpenAI\n\nclient = OpenAI(\n api_key=os.environ.get(\"OPENAI_API_KEY\"), # This is the default and can be omitted\n)\nfor completion in client.chat.completions.create(\n messages=[{\n \"content\": \"string\",\n \"role\": \"developer\",\n }],\n model=\"gpt-5.4\",\n):\n print(completion)","javascript":"import OpenAI from \"openai\";\n\nconst openai = new OpenAI();\n\nasync function main() {\n const completion = await openai.chat.completions.create({\n model: \"VAR_chat_model_id\",\n messages: [\n {\"role\": \"developer\", \"content\": \"You are a helpful assistant.\"},\n {\"role\": \"user\", \"content\": \"Hello!\"}\n ],\n stream: true,\n });\n\n for await (const chunk of completion) {\n console.log(chunk.choices[0].delta.content);\n }\n}\n\nmain();\n","csharp":"using System;\nusing System.ClientModel;\nusing System.Collections.Generic;\nusing System.Threading.Tasks;\n\nusing OpenAI.Chat;\n\nChatClient client = new(\n model: \"gpt-5.4\",\n apiKey: Environment.GetEnvironmentVariable(\"OPENAI_API_KEY\")\n);\n\nList<ChatMessage> messages =\n[\n new SystemChatMessage(\"You are a helpful assistant.\"),\n new UserChatMessage(\"Hello!\")\n];\n\nAsyncCollectionResult<StreamingChatCompletionUpdate> completionUpdates = client.CompleteChatStreamingAsync(messages);\n\nawait foreach (StreamingChatCompletionUpdate completionUpdate in completionUpdates)\n{\n if (completionUpdate.ContentUpdate.Count > 0)\n {\n Console.Write(completionUpdate.ContentUpdate[0].Text);\n }\n}\n","node.js":"import OpenAI from 'openai';\n\nconst client = new OpenAI({\n apiKey: process.env['OPENAI_API_KEY'], // This is the default and can be omitted\n});\n\nconst chatCompletion = await client.chat.completions.create({\n messages: [{ content: 'string', role: 'developer' }],\n model: 'gpt-5.4',\n});\n\nconsole.log(chatCompletion);","go":"package main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\n\t\"github.com/openai/openai-go\"\n\t\"github.com/openai/openai-go/option\"\n\t\"github.com/openai/openai-go/shared\"\n)\n\nfunc main() {\n\tclient := openai.NewClient(\n\t\toption.WithAPIKey(\"My API Key\"),\n\t)\n\tchatCompletion, err := client.Chat.Completions.New(context.TODO(), openai.ChatCompletionNewParams{\n\t\tMessages: []openai.ChatCompletionMessageParamUnion{{\n\t\t\tOfDeveloper: &openai.ChatCompletionDeveloperMessageParam{\n\t\t\t\tContent: openai.ChatCompletionDeveloperMessageParamContentUnion{\n\t\t\t\t\tOfString: openai.String(\"string\"),\n\t\t\t\t},\n\t\t\t},\n\t\t}},\n\t\tModel: shared.ChatModelGPT5_4,\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf(\"%+v\\n\", chatCompletion)\n}\n","java":"package com.openai.example;\n\nimport com.openai.client.OpenAIClient;\nimport com.openai.client.okhttp.OpenAIOkHttpClient;\nimport com.openai.models.ChatModel;\nimport com.openai.models.chat.completions.ChatCompletion;\nimport com.openai.models.chat.completions.ChatCompletionCreateParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n OpenAIClient client = OpenAIOkHttpClient.fromEnv();\n\n ChatCompletionCreateParams params = ChatCompletionCreateParams.builder()\n .addDeveloperMessage(\"string\")\n .model(ChatModel.GPT_5_4)\n .build();\n ChatCompletion chatCompletion = client.chat().completions().create(params);\n }\n}","ruby":"require \"openai\"\n\nopenai = OpenAI::Client.new(api_key: \"My API Key\")\n\nchat_completion = openai.chat.completions.create(messages: [{content: \"string\", role: :developer}], model: :\"gpt-5.4\")\n\nputs(chat_completion)"},"response":"{\"id\":\"chatcmpl-123\",\"object\":\"chat.completion.chunk\",\"created\":1694268190,\"model\":\"gpt-4o-mini\", \"system_fingerprint\": \"fp_44709d6fcb\", \"choices\":[{\"index\":0,\"delta\":{\"role\":\"assistant\",\"content\":\"\"},\"logprobs\":null,\"finish_reason\":null}]}\n\n{\"id\":\"chatcmpl-123\",\"object\":\"chat.completion.chunk\",\"created\":1694268190,\"model\":\"gpt-4o-mini\", \"system_fingerprint\": \"fp_44709d6fcb\", \"choices\":[{\"index\":0,\"delta\":{\"content\":\"Hello\"},\"logprobs\":null,\"finish_reason\":null}]}\n\n....\n\n{\"id\":\"chatcmpl-123\",\"object\":\"chat.completion.chunk\",\"created\":1694268190,\"model\":\"gpt-4o-mini\", \"system_fingerprint\": \"fp_44709d6fcb\", \"choices\":[{\"index\":0,\"delta\":{},\"logprobs\":null,\"finish_reason\":\"stop\"}]}\n"},{"title":"Functions","request":{"curl":"curl https://api.openai.com/v1/chat/completions \\\n-H \"Content-Type: application/json\" \\\n-H \"Authorization: Bearer $OPENAI_API_KEY\" \\\n-d '{\n \"model\": \"gpt-5.4\",\n \"messages\": [\n {\n \"role\": \"user\",\n \"content\": \"What is the weather like in Boston today?\"\n }\n ],\n \"tools\": [\n {\n \"type\": \"function\",\n \"function\": {\n \"name\": \"get_current_weather\",\n \"description\": \"Get the current weather in a given location\",\n \"parameters\": {\n \"type\": \"object\",\n \"properties\": {\n \"location\": {\n \"type\": \"string\",\n \"description\": \"The city and state, e.g. San Francisco, CA\"\n },\n \"unit\": {\n \"type\": \"string\",\n \"enum\": [\"celsius\", \"fahrenheit\"]\n }\n },\n \"required\": [\"location\"]\n }\n }\n }\n ],\n \"tool_choice\": \"auto\"\n}'\n","python":"import os\nfrom openai import OpenAI\n\nclient = OpenAI(\n api_key=os.environ.get(\"OPENAI_API_KEY\"), # This is the default and can be omitted\n)\nfor completion in client.chat.completions.create(\n messages=[{\n \"content\": \"string\",\n \"role\": \"developer\",\n }],\n model=\"gpt-5.4\",\n):\n print(completion)","javascript":"import OpenAI from \"openai\";\n\nconst openai = new OpenAI();\n\nasync function main() {\n const messages = [{\"role\": \"user\", \"content\": \"What's the weather like in Boston today?\"}];\n const tools = [\n {\n \"type\": \"function\",\n \"function\": {\n \"name\": \"get_current_weather\",\n \"description\": \"Get the current weather in a given location\",\n \"parameters\": {\n \"type\": \"object\",\n \"properties\": {\n \"location\": {\n \"type\": \"string\",\n \"description\": \"The city and state, e.g. San Francisco, CA\",\n },\n \"unit\": {\"type\": \"string\", \"enum\": [\"celsius\", \"fahrenheit\"]},\n },\n \"required\": [\"location\"],\n },\n }\n }\n ];\n\n const response = await openai.chat.completions.create({\n model: \"gpt-5.4\",\n messages: messages,\n tools: tools,\n tool_choice: \"auto\",\n });\n\n console.log(response);\n}\n\nmain();\n","csharp":"using System;\nusing System.Collections.Generic;\n\nusing OpenAI.Chat;\n\nChatClient client = new(\n model: \"gpt-5.4\",\n apiKey: Environment.GetEnvironmentVariable(\"OPENAI_API_KEY\")\n);\n\nChatTool getCurrentWeatherTool = ChatTool.CreateFunctionTool(\n functionName: \"get_current_weather\",\n functionDescription: \"Get the current weather in a given location\",\n functionParameters: BinaryData.FromString(\"\"\"\n {\n \"type\": \"object\",\n \"properties\": {\n \"location\": {\n \"type\": \"string\",\n \"description\": \"The city and state, e.g. San Francisco, CA\"\n },\n \"unit\": {\n \"type\": \"string\",\n \"enum\": [ \"celsius\", \"fahrenheit\" ]\n }\n },\n \"required\": [ \"location\" ]\n }\n \"\"\")\n);\n\nList<ChatMessage> messages =\n[\n new UserChatMessage(\"What's the weather like in Boston today?\"),\n];\n\nChatCompletionOptions options = new()\n{\n Tools =\n {\n getCurrentWeatherTool\n },\n ToolChoice = ChatToolChoice.CreateAutoChoice(),\n};\n\nChatCompletion completion = client.CompleteChat(messages, options);\n","node.js":"import OpenAI from 'openai';\n\nconst client = new OpenAI({\n apiKey: process.env['OPENAI_API_KEY'], // This is the default and can be omitted\n});\n\nconst chatCompletion = await client.chat.completions.create({\n messages: [{ content: 'string', role: 'developer' }],\n model: 'gpt-5.4',\n});\n\nconsole.log(chatCompletion);","go":"package main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\n\t\"github.com/openai/openai-go\"\n\t\"github.com/openai/openai-go/option\"\n\t\"github.com/openai/openai-go/shared\"\n)\n\nfunc main() {\n\tclient := openai.NewClient(\n\t\toption.WithAPIKey(\"My API Key\"),\n\t)\n\tchatCompletion, err := client.Chat.Completions.New(context.TODO(), openai.ChatCompletionNewParams{\n\t\tMessages: []openai.ChatCompletionMessageParamUnion{{\n\t\t\tOfDeveloper: &openai.ChatCompletionDeveloperMessageParam{\n\t\t\t\tContent: openai.ChatCompletionDeveloperMessageParamContentUnion{\n\t\t\t\t\tOfString: openai.String(\"string\"),\n\t\t\t\t},\n\t\t\t},\n\t\t}},\n\t\tModel: shared.ChatModelGPT5_4,\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf(\"%+v\\n\", chatCompletion)\n}\n","java":"package com.openai.example;\n\nimport com.openai.client.OpenAIClient;\nimport com.openai.client.okhttp.OpenAIOkHttpClient;\nimport com.openai.models.ChatModel;\nimport com.openai.models.chat.completions.ChatCompletion;\nimport com.openai.models.chat.completions.ChatCompletionCreateParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n OpenAIClient client = OpenAIOkHttpClient.fromEnv();\n\n ChatCompletionCreateParams params = ChatCompletionCreateParams.builder()\n .addDeveloperMessage(\"string\")\n .model(ChatModel.GPT_5_4)\n .build();\n ChatCompletion chatCompletion = client.chat().completions().create(params);\n }\n}","ruby":"require \"openai\"\n\nopenai = OpenAI::Client.new(api_key: \"My API Key\")\n\nchat_completion = openai.chat.completions.create(messages: [{content: \"string\", role: :developer}], model: :\"gpt-5.4\")\n\nputs(chat_completion)"},"response":"{\n \"id\": \"chatcmpl-abc123\",\n \"object\": \"chat.completion\",\n \"created\": 1699896916,\n \"model\": \"gpt-4o-mini\",\n \"choices\": [\n {\n \"index\": 0,\n \"message\": {\n \"role\": \"assistant\",\n \"content\": null,\n \"tool_calls\": [\n {\n \"id\": \"call_abc123\",\n \"type\": \"function\",\n \"function\": {\n \"name\": \"get_current_weather\",\n \"arguments\": \"{\\n\\\"location\\\": \\\"Boston, MA\\\"\\n}\"\n }\n }\n ]\n },\n \"logprobs\": null,\n \"finish_reason\": \"tool_calls\"\n }\n ],\n \"usage\": {\n \"prompt_tokens\": 82,\n \"completion_tokens\": 17,\n \"total_tokens\": 99,\n \"completion_tokens_details\": {\n \"reasoning_tokens\": 0,\n \"accepted_prediction_tokens\": 0,\n \"rejected_prediction_tokens\": 0\n }\n }\n}\n"},{"title":"Logprobs","request":{"curl":"curl https://api.openai.com/v1/chat/completions \\\n -H \"Content-Type: application/json\" \\\n -H \"Authorization: Bearer $OPENAI_API_KEY\" \\\n -d '{\n \"model\": \"VAR_chat_model_id\",\n \"messages\": [\n {\n \"role\": \"user\",\n \"content\": \"Hello!\"\n }\n ],\n \"logprobs\": true,\n \"top_logprobs\": 2\n }'\n","python":"import os\nfrom openai import OpenAI\n\nclient = OpenAI(\n api_key=os.environ.get(\"OPENAI_API_KEY\"), # This is the default and can be omitted\n)\nfor completion in client.chat.completions.create(\n messages=[{\n \"content\": \"string\",\n \"role\": \"developer\",\n }],\n model=\"gpt-5.4\",\n):\n print(completion)","javascript":"import OpenAI from \"openai\";\n\nconst openai = new OpenAI();\n\nasync function main() {\n const completion = await openai.chat.completions.create({\n messages: [{ role: \"user\", content: \"Hello!\" }],\n model: \"VAR_chat_model_id\",\n logprobs: true,\n top_logprobs: 2,\n });\n\n console.log(completion.choices[0]);\n}\n\nmain();\n","csharp":"using System;\nusing System.Collections.Generic;\n\nusing OpenAI.Chat;\n\nChatClient client = new(\n model: \"gpt-5.4\",\n apiKey: Environment.GetEnvironmentVariable(\"OPENAI_API_KEY\")\n);\n\nList<ChatMessage> messages =\n[\n new UserChatMessage(\"Hello!\")\n];\n\nChatCompletionOptions options = new()\n{\n IncludeLogProbabilities = true,\n TopLogProbabilityCount = 2\n};\n\nChatCompletion completion = client.CompleteChat(messages, options);\n\nConsole.WriteLine(completion.Content[0].Text);\n","node.js":"import OpenAI from 'openai';\n\nconst client = new OpenAI({\n apiKey: process.env['OPENAI_API_KEY'], // This is the default and can be omitted\n});\n\nconst chatCompletion = await client.chat.completions.create({\n messages: [{ content: 'string', role: 'developer' }],\n model: 'gpt-5.4',\n});\n\nconsole.log(chatCompletion);","go":"package main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\n\t\"github.com/openai/openai-go\"\n\t\"github.com/openai/openai-go/option\"\n\t\"github.com/openai/openai-go/shared\"\n)\n\nfunc main() {\n\tclient := openai.NewClient(\n\t\toption.WithAPIKey(\"My API Key\"),\n\t)\n\tchatCompletion, err := client.Chat.Completions.New(context.TODO(), openai.ChatCompletionNewParams{\n\t\tMessages: []openai.ChatCompletionMessageParamUnion{{\n\t\t\tOfDeveloper: &openai.ChatCompletionDeveloperMessageParam{\n\t\t\t\tContent: openai.ChatCompletionDeveloperMessageParamContentUnion{\n\t\t\t\t\tOfString: openai.String(\"string\"),\n\t\t\t\t},\n\t\t\t},\n\t\t}},\n\t\tModel: shared.ChatModelGPT5_4,\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf(\"%+v\\n\", chatCompletion)\n}\n","java":"package com.openai.example;\n\nimport com.openai.client.OpenAIClient;\nimport com.openai.client.okhttp.OpenAIOkHttpClient;\nimport com.openai.models.ChatModel;\nimport com.openai.models.chat.completions.ChatCompletion;\nimport com.openai.models.chat.completions.ChatCompletionCreateParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n OpenAIClient client = OpenAIOkHttpClient.fromEnv();\n\n ChatCompletionCreateParams params = ChatCompletionCreateParams.builder()\n .addDeveloperMessage(\"string\")\n .model(ChatModel.GPT_5_4)\n .build();\n ChatCompletion chatCompletion = client.chat().completions().create(params);\n }\n}","ruby":"require \"openai\"\n\nopenai = OpenAI::Client.new(api_key: \"My API Key\")\n\nchat_completion = openai.chat.completions.create(messages: [{content: \"string\", role: :developer}], model: :\"gpt-5.4\")\n\nputs(chat_completion)"},"response":"{\n \"id\": \"chatcmpl-123\",\n \"object\": \"chat.completion\",\n \"created\": 1702685778,\n \"model\": \"gpt-4o-mini\",\n \"choices\": [\n {\n \"index\": 0,\n \"message\": {\n \"role\": \"assistant\",\n \"content\": \"Hello! How can I assist you today?\"\n },\n \"logprobs\": {\n \"content\": [\n {\n \"token\": \"Hello\",\n \"logprob\": -0.31725305,\n \"bytes\": [72, 101, 108, 108, 111],\n \"top_logprobs\": [\n {\n \"token\": \"Hello\",\n \"logprob\": -0.31725305,\n \"bytes\": [72, 101, 108, 108, 111]\n },\n {\n \"token\": \"Hi\",\n \"logprob\": -1.3190403,\n \"bytes\": [72, 105]\n }\n ]\n },\n {\n \"token\": \"!\",\n \"logprob\": -0.02380986,\n \"bytes\": [\n 33\n ],\n \"top_logprobs\": [\n {\n \"token\": \"!\",\n \"logprob\": -0.02380986,\n \"bytes\": [33]\n },\n {\n \"token\": \" there\",\n \"logprob\": -3.787621,\n \"bytes\": [32, 116, 104, 101, 114, 101]\n }\n ]\n },\n {\n \"token\": \" How\",\n \"logprob\": -0.000054669687,\n \"bytes\": [32, 72, 111, 119],\n \"top_logprobs\": [\n {\n \"token\": \" How\",\n \"logprob\": -0.000054669687,\n \"bytes\": [32, 72, 111, 119]\n },\n {\n \"token\": \"<|end|>\",\n \"logprob\": -10.953937,\n \"bytes\": null\n }\n ]\n },\n {\n \"token\": \" can\",\n \"logprob\": -0.015801601,\n \"bytes\": [32, 99, 97, 110],\n \"top_logprobs\": [\n {\n \"token\": \" can\",\n \"logprob\": -0.015801601,\n \"bytes\": [32, 99, 97, 110]\n },\n {\n \"token\": \" may\",\n \"logprob\": -4.161023,\n \"bytes\": [32, 109, 97, 121]\n }\n ]\n },\n {\n \"token\": \" I\",\n \"logprob\": -3.7697225e-6,\n \"bytes\": [\n 32,\n 73\n ],\n \"top_logprobs\": [\n {\n \"token\": \" I\",\n \"logprob\": -3.7697225e-6,\n \"bytes\": [32, 73]\n },\n {\n \"token\": \" assist\",\n \"logprob\": -13.596657,\n \"bytes\": [32, 97, 115, 115, 105, 115, 116]\n }\n ]\n },\n {\n \"token\": \" assist\",\n \"logprob\": -0.04571125,\n \"bytes\": [32, 97, 115, 115, 105, 115, 116],\n \"top_logprobs\": [\n {\n \"token\": \" assist\",\n \"logprob\": -0.04571125,\n \"bytes\": [32, 97, 115, 115, 105, 115, 116]\n },\n {\n \"token\": \" help\",\n \"logprob\": -3.1089056,\n \"bytes\": [32, 104, 101, 108, 112]\n }\n ]\n },\n {\n \"token\": \" you\",\n \"logprob\": -5.4385737e-6,\n \"bytes\": [32, 121, 111, 117],\n \"top_logprobs\": [\n {\n \"token\": \" you\",\n \"logprob\": -5.4385737e-6,\n \"bytes\": [32, 121, 111, 117]\n },\n {\n \"token\": \" today\",\n \"logprob\": -12.807695,\n \"bytes\": [32, 116, 111, 100, 97, 121]\n }\n ]\n },\n {\n \"token\": \" today\",\n \"logprob\": -0.0040071653,\n \"bytes\": [32, 116, 111, 100, 97, 121],\n \"top_logprobs\": [\n {\n \"token\": \" today\",\n \"logprob\": -0.0040071653,\n \"bytes\": [32, 116, 111, 100, 97, 121]\n },\n {\n \"token\": \"?\",\n \"logprob\": -5.5247097,\n \"bytes\": [63]\n }\n ]\n },\n {\n \"token\": \"?\",\n \"logprob\": -0.0008108172,\n \"bytes\": [63],\n \"top_logprobs\": [\n {\n \"token\": \"?\",\n \"logprob\": -0.0008108172,\n \"bytes\": [63]\n },\n {\n \"token\": \"?\\n\",\n \"logprob\": -7.184561,\n \"bytes\": [63, 10]\n }\n ]\n }\n ]\n },\n \"finish_reason\": \"stop\"\n }\n ],\n \"usage\": {\n \"prompt_tokens\": 9,\n \"completion_tokens\": 9,\n \"total_tokens\": 18,\n \"completion_tokens_details\": {\n \"reasoning_tokens\": 0,\n \"accepted_prediction_tokens\": 0,\n \"rejected_prediction_tokens\": 0\n }\n },\n \"system_fingerprint\": null\n}\n"}]}}},"/chat/completions/{completion_id}":{"get":{"operationId":"getChatCompletion","tags":["Chat"],"summary":"Get a stored chat completion. Only Chat Completions that have been created\nwith the `store` parameter set to `true` will be returned.\n","parameters":[{"in":"path","name":"completion_id","required":true,"schema":{"type":"string"},"description":"The ID of the chat completion to retrieve."}],"responses":{"200":{"description":"A chat completion","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateChatCompletionResponse"}}}}},"x-oaiMeta":{"name":"Get chat completion","group":"chat","examples":{"request":{"curl":"curl https://api.openai.com/v1/chat/completions/chatcmpl-abc123 \\\n -H \"Authorization: Bearer $OPENAI_API_KEY\" \\\n -H \"Content-Type: application/json\"\n","python":"import os\nfrom openai import OpenAI\n\nclient = OpenAI(\n api_key=os.environ.get(\"OPENAI_API_KEY\"), # This is the default and can be omitted\n)\nchat_completion = client.chat.completions.retrieve(\n \"completion_id\",\n)\nprint(chat_completion.id)","node.js":"import OpenAI from 'openai';\n\nconst client = new OpenAI({\n apiKey: process.env['OPENAI_API_KEY'], // This is the default and can be omitted\n});\n\nconst chatCompletion = await client.chat.completions.retrieve('completion_id');\n\nconsole.log(chatCompletion.id);","go":"package main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\n\t\"github.com/openai/openai-go\"\n\t\"github.com/openai/openai-go/option\"\n)\n\nfunc main() {\n\tclient := openai.NewClient(\n\t\toption.WithAPIKey(\"My API Key\"),\n\t)\n\tchatCompletion, err := client.Chat.Completions.Get(context.TODO(), \"completion_id\")\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf(\"%+v\\n\", chatCompletion.ID)\n}\n","java":"package com.openai.example;\n\nimport com.openai.client.OpenAIClient;\nimport com.openai.client.okhttp.OpenAIOkHttpClient;\nimport com.openai.models.chat.completions.ChatCompletion;\nimport com.openai.models.chat.completions.ChatCompletionRetrieveParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n OpenAIClient client = OpenAIOkHttpClient.fromEnv();\n\n ChatCompletion chatCompletion = client.chat().completions().retrieve(\"completion_id\");\n }\n}","ruby":"require \"openai\"\n\nopenai = OpenAI::Client.new(api_key: \"My API Key\")\n\nchat_completion = openai.chat.completions.retrieve(\"completion_id\")\n\nputs(chat_completion)"},"response":"{\n \"object\": \"chat.completion\",\n \"id\": \"chatcmpl-abc123\",\n \"model\": \"gpt-4o-2024-08-06\",\n \"created\": 1738960610,\n \"request_id\": \"req_ded8ab984ec4bf840f37566c1011c417\",\n \"tool_choice\": null,\n \"usage\": {\n \"total_tokens\": 31,\n \"completion_tokens\": 18,\n \"prompt_tokens\": 13\n },\n \"seed\": 4944116822809979520,\n \"top_p\": 1.0,\n \"temperature\": 1.0,\n \"presence_penalty\": 0.0,\n \"frequency_penalty\": 0.0,\n \"system_fingerprint\": \"fp_50cad350e4\",\n \"input_user\": null,\n \"service_tier\": \"default\",\n \"tools\": null,\n \"metadata\": {},\n \"choices\": [\n {\n \"index\": 0,\n \"message\": {\n \"content\": \"Mind of circuits hum, \\nLearning patterns in silence— \\nFuture's quiet spark.\",\n \"role\": \"assistant\",\n \"tool_calls\": null,\n \"function_call\": null\n },\n \"finish_reason\": \"stop\",\n \"logprobs\": null\n }\n ],\n \"response_format\": null\n}\n"}}},"post":{"operationId":"updateChatCompletion","tags":["Chat"],"summary":"Modify a stored chat completion. Only Chat Completions that have been\ncreated with the `store` parameter set to `true` can be modified. Currently,\nthe only supported modification is to update the `metadata` field.\n","parameters":[{"in":"path","name":"completion_id","required":true,"schema":{"type":"string"},"description":"The ID of the chat completion to update."}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["metadata"],"properties":{"metadata":{"$ref":"#/components/schemas/Metadata"}}}}}},"responses":{"200":{"description":"A chat completion","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateChatCompletionResponse"}}}}},"x-oaiMeta":{"name":"Update chat completion","group":"chat","examples":{"request":{"curl":"curl -X POST https://api.openai.com/v1/chat/completions/chat_abc123 \\\n -H \"Authorization: Bearer $OPENAI_API_KEY\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"metadata\": {\"foo\": \"bar\"}}'\n","python":"import os\nfrom openai import OpenAI\n\nclient = OpenAI(\n api_key=os.environ.get(\"OPENAI_API_KEY\"), # This is the default and can be omitted\n)\nchat_completion = client.chat.completions.update(\n completion_id=\"completion_id\",\n metadata={\n \"foo\": \"string\"\n },\n)\nprint(chat_completion.id)","node.js":"import OpenAI from 'openai';\n\nconst client = new OpenAI({\n apiKey: process.env['OPENAI_API_KEY'], // This is the default and can be omitted\n});\n\nconst chatCompletion = await client.chat.completions.update('completion_id', {\n metadata: { foo: 'string' },\n});\n\nconsole.log(chatCompletion.id);","go":"package main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\n\t\"github.com/openai/openai-go\"\n\t\"github.com/openai/openai-go/option\"\n\t\"github.com/openai/openai-go/shared\"\n)\n\nfunc main() {\n\tclient := openai.NewClient(\n\t\toption.WithAPIKey(\"My API Key\"),\n\t)\n\tchatCompletion, err := client.Chat.Completions.Update(\n\t\tcontext.TODO(),\n\t\t\"completion_id\",\n\t\topenai.ChatCompletionUpdateParams{\n\t\t\tMetadata: shared.Metadata{\n\t\t\t\t\"foo\": \"string\",\n\t\t\t},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf(\"%+v\\n\", chatCompletion.ID)\n}\n","java":"package com.openai.example;\n\nimport com.openai.client.OpenAIClient;\nimport com.openai.client.okhttp.OpenAIOkHttpClient;\nimport com.openai.core.JsonValue;\nimport com.openai.models.chat.completions.ChatCompletion;\nimport com.openai.models.chat.completions.ChatCompletionUpdateParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n OpenAIClient client = OpenAIOkHttpClient.fromEnv();\n\n ChatCompletionUpdateParams params = ChatCompletionUpdateParams.builder()\n .completionId(\"completion_id\")\n .metadata(ChatCompletionUpdateParams.Metadata.builder()\n .putAdditionalProperty(\"foo\", JsonValue.from(\"string\"))\n .build())\n .build();\n ChatCompletion chatCompletion = client.chat().completions().update(params);\n }\n}","ruby":"require \"openai\"\n\nopenai = OpenAI::Client.new(api_key: \"My API Key\")\n\nchat_completion = openai.chat.completions.update(\"completion_id\", metadata: {foo: \"string\"})\n\nputs(chat_completion)"},"response":"{\n \"object\": \"chat.completion\",\n \"id\": \"chatcmpl-AyPNinnUqUDYo9SAdA52NobMflmj2\",\n \"model\": \"gpt-4o-2024-08-06\",\n \"created\": 1738960610,\n \"request_id\": \"req_ded8ab984ec4bf840f37566c1011c417\",\n \"tool_choice\": null,\n \"usage\": {\n \"total_tokens\": 31,\n \"completion_tokens\": 18,\n \"prompt_tokens\": 13\n },\n \"seed\": 4944116822809979520,\n \"top_p\": 1.0,\n \"temperature\": 1.0,\n \"presence_penalty\": 0.0,\n \"frequency_penalty\": 0.0,\n \"system_fingerprint\": \"fp_50cad350e4\",\n \"input_user\": null,\n \"service_tier\": \"default\",\n \"tools\": null,\n \"metadata\": {\n \"foo\": \"bar\"\n },\n \"choices\": [\n {\n \"index\": 0,\n \"message\": {\n \"content\": \"Mind of circuits hum, \\nLearning patterns in silence— \\nFuture's quiet spark.\",\n \"role\": \"assistant\",\n \"tool_calls\": null,\n \"function_call\": null\n },\n \"finish_reason\": \"stop\",\n \"logprobs\": null\n }\n ],\n \"response_format\": null\n}\n"}}},"delete":{"operationId":"deleteChatCompletion","tags":["Chat"],"summary":"Delete a stored chat completion. Only Chat Completions that have been\ncreated with the `store` parameter set to `true` can be deleted.\n","parameters":[{"in":"path","name":"completion_id","required":true,"schema":{"type":"string"},"description":"The ID of the chat completion to delete."}],"responses":{"200":{"description":"The chat completion was deleted successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChatCompletionDeleted"}}}}},"x-oaiMeta":{"name":"Delete chat completion","group":"chat","examples":{"request":{"curl":"curl -X DELETE https://api.openai.com/v1/chat/completions/chat_abc123 \\\n -H \"Authorization: Bearer $OPENAI_API_KEY\" \\\n -H \"Content-Type: application/json\"\n","python":"import os\nfrom openai import OpenAI\n\nclient = OpenAI(\n api_key=os.environ.get(\"OPENAI_API_KEY\"), # This is the default and can be omitted\n)\nchat_completion_deleted = client.chat.completions.delete(\n \"completion_id\",\n)\nprint(chat_completion_deleted.id)","node.js":"import OpenAI from 'openai';\n\nconst client = new OpenAI({\n apiKey: process.env['OPENAI_API_KEY'], // This is the default and can be omitted\n});\n\nconst chatCompletionDeleted = await client.chat.completions.delete('completion_id');\n\nconsole.log(chatCompletionDeleted.id);","go":"package main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\n\t\"github.com/openai/openai-go\"\n\t\"github.com/openai/openai-go/option\"\n)\n\nfunc main() {\n\tclient := openai.NewClient(\n\t\toption.WithAPIKey(\"My API Key\"),\n\t)\n\tchatCompletionDeleted, err := client.Chat.Completions.Delete(context.TODO(), \"completion_id\")\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf(\"%+v\\n\", chatCompletionDeleted.ID)\n}\n","java":"package com.openai.example;\n\nimport com.openai.client.OpenAIClient;\nimport com.openai.client.okhttp.OpenAIOkHttpClient;\nimport com.openai.models.chat.completions.ChatCompletionDeleteParams;\nimport com.openai.models.chat.completions.ChatCompletionDeleted;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n OpenAIClient client = OpenAIOkHttpClient.fromEnv();\n\n ChatCompletionDeleted chatCompletionDeleted = client.chat().completions().delete(\"completion_id\");\n }\n}","ruby":"require \"openai\"\n\nopenai = OpenAI::Client.new(api_key: \"My API Key\")\n\nchat_completion_deleted = openai.chat.completions.delete(\"completion_id\")\n\nputs(chat_completion_deleted)"},"response":"{\n \"object\": \"chat.completion.deleted\",\n \"id\": \"chatcmpl-AyPNinnUqUDYo9SAdA52NobMflmj2\",\n \"deleted\": true\n}\n"}}}},"/chat/completions/{completion_id}/messages":{"get":{"operationId":"getChatCompletionMessages","tags":["Chat"],"summary":"Get the messages in a stored chat completion. Only Chat Completions that\nhave been created with the `store` parameter set to `true` will be\nreturned.\n","parameters":[{"in":"path","name":"completion_id","required":true,"schema":{"type":"string"},"description":"The ID of the chat completion to retrieve messages from."},{"name":"after","in":"query","description":"Identifier for the last message from the previous pagination request.","required":false,"schema":{"type":"string"}},{"name":"limit","in":"query","description":"Number of messages to retrieve.","required":false,"schema":{"type":"integer","default":20}},{"name":"order","in":"query","description":"Sort order for messages by timestamp. Use `asc` for ascending order or `desc` for descending order. Defaults to `asc`.","required":false,"schema":{"type":"string","enum":["asc","desc"],"default":"asc"}}],"responses":{"200":{"description":"A list of messages","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChatCompletionMessageList"}}}}},"x-oaiMeta":{"name":"Get chat messages","group":"chat","examples":{"request":{"curl":"curl https://api.openai.com/v1/chat/completions/chat_abc123/messages \\\n -H \"Authorization: Bearer $OPENAI_API_KEY\" \\\n -H \"Content-Type: application/json\"\n","python":"import os\nfrom openai import OpenAI\n\nclient = OpenAI(\n api_key=os.environ.get(\"OPENAI_API_KEY\"), # This is the default and can be omitted\n)\npage = client.chat.completions.messages.list(\n completion_id=\"completion_id\",\n)\npage = page.data[0]\nprint(page)","node.js":"import OpenAI from 'openai';\n\nconst client = new OpenAI({\n apiKey: process.env['OPENAI_API_KEY'], // This is the default and can be omitted\n});\n\n// Automatically fetches more pages as needed.\nfor await (const chatCompletionStoreMessage of client.chat.completions.messages.list(\n 'completion_id',\n)) {\n console.log(chatCompletionStoreMessage);\n}","go":"package main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\n\t\"github.com/openai/openai-go\"\n\t\"github.com/openai/openai-go/option\"\n)\n\nfunc main() {\n\tclient := openai.NewClient(\n\t\toption.WithAPIKey(\"My API Key\"),\n\t)\n\tpage, err := client.Chat.Completions.Messages.List(\n\t\tcontext.TODO(),\n\t\t\"completion_id\",\n\t\topenai.ChatCompletionMessageListParams{},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf(\"%+v\\n\", page)\n}\n","java":"package com.openai.example;\n\nimport com.openai.client.OpenAIClient;\nimport com.openai.client.okhttp.OpenAIOkHttpClient;\nimport com.openai.models.chat.completions.messages.MessageListPage;\nimport com.openai.models.chat.completions.messages.MessageListParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n OpenAIClient client = OpenAIOkHttpClient.fromEnv();\n\n MessageListPage page = client.chat().completions().messages().list(\"completion_id\");\n }\n}","ruby":"require \"openai\"\n\nopenai = OpenAI::Client.new(api_key: \"My API Key\")\n\npage = openai.chat.completions.messages.list(\"completion_id\")\n\nputs(page)"},"response":"{\n \"object\": \"list\",\n \"data\": [\n {\n \"id\": \"chatcmpl-AyPNinnUqUDYo9SAdA52NobMflmj2-0\",\n \"role\": \"user\",\n \"content\": \"write a haiku about ai\",\n \"name\": null,\n \"content_parts\": null\n }\n ],\n \"first_id\": \"chatcmpl-AyPNinnUqUDYo9SAdA52NobMflmj2-0\",\n \"last_id\": \"chatcmpl-AyPNinnUqUDYo9SAdA52NobMflmj2-0\",\n \"has_more\": false\n}\n"}}}},"/completions":{"post":{"operationId":"createCompletion","tags":["Completions"],"summary":"Creates a completion for the provided prompt and parameters.\n\nReturns a completion object, or a sequence of completion objects if the request is streamed.\n","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateCompletionRequest"}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateCompletionResponse"}}}}},"x-oaiMeta":{"name":"Create completion","group":"completions","legacy":true,"examples":[{"title":"No streaming","request":{"curl":"curl https://api.openai.com/v1/completions \\\n -H \"Content-Type: application/json\" \\\n -H \"Authorization: Bearer $OPENAI_API_KEY\" \\\n -d '{\n \"model\": \"VAR_completion_model_id\",\n \"prompt\": \"Say this is a test\",\n \"max_tokens\": 7,\n \"temperature\": 0\n }'\n","python":"import os\nfrom openai import OpenAI\n\nclient = OpenAI(\n api_key=os.environ.get(\"OPENAI_API_KEY\"), # This is the default and can be omitted\n)\nfor completion in client.completions.create(\n model=\"gpt-3.5-turbo-instruct\",\n prompt=\"This is a test.\",\n):\n print(completion)","javascript":"import OpenAI from \"openai\";\n\nconst openai = new OpenAI();\n\nasync function main() {\n const completion = await openai.completions.create({\n model: \"VAR_completion_model_id\",\n prompt: \"Say this is a test.\",\n max_tokens: 7,\n temperature: 0,\n });\n\n console.log(completion);\n}\nmain();","node.js":"import OpenAI from 'openai';\n\nconst client = new OpenAI({\n apiKey: process.env['OPENAI_API_KEY'], // This is the default and can be omitted\n});\n\nconst completion = await client.completions.create({\n model: 'gpt-3.5-turbo-instruct',\n prompt: 'This is a test.',\n});\n\nconsole.log(completion);","go":"package main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\n\t\"github.com/openai/openai-go\"\n\t\"github.com/openai/openai-go/option\"\n)\n\nfunc main() {\n\tclient := openai.NewClient(\n\t\toption.WithAPIKey(\"My API Key\"),\n\t)\n\tcompletion, err := client.Completions.New(context.TODO(), openai.CompletionNewParams{\n\t\tModel: openai.CompletionNewParamsModelGPT3_5TurboInstruct,\n\t\tPrompt: openai.CompletionNewParamsPromptUnion{\n\t\t\tOfString: openai.String(\"This is a test.\"),\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf(\"%+v\\n\", completion)\n}\n","java":"package com.openai.example;\n\nimport com.openai.client.OpenAIClient;\nimport com.openai.client.okhttp.OpenAIOkHttpClient;\nimport com.openai.models.completions.Completion;\nimport com.openai.models.completions.CompletionCreateParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n OpenAIClient client = OpenAIOkHttpClient.fromEnv();\n\n CompletionCreateParams params = CompletionCreateParams.builder()\n .model(CompletionCreateParams.Model.GPT_3_5_TURBO_INSTRUCT)\n .prompt(\"This is a test.\")\n .build();\n Completion completion = client.completions().create(params);\n }\n}","ruby":"require \"openai\"\n\nopenai = OpenAI::Client.new(api_key: \"My API Key\")\n\ncompletion = openai.completions.create(model: :\"gpt-3.5-turbo-instruct\", prompt: \"This is a test.\")\n\nputs(completion)"},"response":"{\n \"id\": \"cmpl-uqkvlQyYK7bGYrRHQ0eXlWi7\",\n \"object\": \"text_completion\",\n \"created\": 1589478378,\n \"model\": \"VAR_completion_model_id\",\n \"system_fingerprint\": \"fp_44709d6fcb\",\n \"choices\": [\n {\n \"text\": \"\\n\\nThis is indeed a test\",\n \"index\": 0,\n \"logprobs\": null,\n \"finish_reason\": \"length\"\n }\n ],\n \"usage\": {\n \"prompt_tokens\": 5,\n \"completion_tokens\": 7,\n \"total_tokens\": 12\n }\n}\n"},{"title":"Streaming","request":{"curl":"curl https://api.openai.com/v1/completions \\\n -H \"Content-Type: application/json\" \\\n -H \"Authorization: Bearer $OPENAI_API_KEY\" \\\n -d '{\n \"model\": \"VAR_completion_model_id\",\n \"prompt\": \"Say this is a test\",\n \"max_tokens\": 7,\n \"temperature\": 0,\n \"stream\": true\n }'\n","python":"import os\nfrom openai import OpenAI\n\nclient = OpenAI(\n api_key=os.environ.get(\"OPENAI_API_KEY\"), # This is the default and can be omitted\n)\nfor completion in client.completions.create(\n model=\"gpt-3.5-turbo-instruct\",\n prompt=\"This is a test.\",\n):\n print(completion)","javascript":"import OpenAI from \"openai\";\n\nconst openai = new OpenAI();\n\nasync function main() {\n const stream = await openai.completions.create({\n model: \"VAR_completion_model_id\",\n prompt: \"Say this is a test.\",\n stream: true,\n });\n\n for await (const chunk of stream) {\n console.log(chunk.choices[0].text)\n }\n}\nmain();","node.js":"import OpenAI from 'openai';\n\nconst client = new OpenAI({\n apiKey: process.env['OPENAI_API_KEY'], // This is the default and can be omitted\n});\n\nconst completion = await client.completions.create({\n model: 'gpt-3.5-turbo-instruct',\n prompt: 'This is a test.',\n});\n\nconsole.log(completion);","go":"package main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\n\t\"github.com/openai/openai-go\"\n\t\"github.com/openai/openai-go/option\"\n)\n\nfunc main() {\n\tclient := openai.NewClient(\n\t\toption.WithAPIKey(\"My API Key\"),\n\t)\n\tcompletion, err := client.Completions.New(context.TODO(), openai.CompletionNewParams{\n\t\tModel: openai.CompletionNewParamsModelGPT3_5TurboInstruct,\n\t\tPrompt: openai.CompletionNewParamsPromptUnion{\n\t\t\tOfString: openai.String(\"This is a test.\"),\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf(\"%+v\\n\", completion)\n}\n","java":"package com.openai.example;\n\nimport com.openai.client.OpenAIClient;\nimport com.openai.client.okhttp.OpenAIOkHttpClient;\nimport com.openai.models.completions.Completion;\nimport com.openai.models.completions.CompletionCreateParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n OpenAIClient client = OpenAIOkHttpClient.fromEnv();\n\n CompletionCreateParams params = CompletionCreateParams.builder()\n .model(CompletionCreateParams.Model.GPT_3_5_TURBO_INSTRUCT)\n .prompt(\"This is a test.\")\n .build();\n Completion completion = client.completions().create(params);\n }\n}","ruby":"require \"openai\"\n\nopenai = OpenAI::Client.new(api_key: \"My API Key\")\n\ncompletion = openai.completions.create(model: :\"gpt-3.5-turbo-instruct\", prompt: \"This is a test.\")\n\nputs(completion)"},"response":"{\n \"id\": \"cmpl-7iA7iJjj8V2zOkCGvWF2hAkDWBQZe\",\n \"object\": \"text_completion\",\n \"created\": 1690759702,\n \"choices\": [\n {\n \"text\": \"This\",\n \"index\": 0,\n \"logprobs\": null,\n \"finish_reason\": null\n }\n ],\n \"model\": \"gpt-3.5-turbo-instruct\"\n \"system_fingerprint\": \"fp_44709d6fcb\",\n}\n"}]}}},"/containers":{"get":{"summary":"List Containers","description":"Lists containers.","operationId":"ListContainers","parameters":[{"name":"limit","in":"query","description":"A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.\n","required":false,"schema":{"type":"integer","default":20}},{"name":"order","in":"query","description":"Sort order by the `created_at` timestamp of the objects. `asc` for ascending order and `desc` for descending order.\n","schema":{"type":"string","default":"desc","enum":["asc","desc"]}},{"name":"after","in":"query","description":"A cursor for use in pagination. `after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list.\n","schema":{"type":"string"}},{"name":"name","in":"query","description":"Filter results by container name.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContainerListResource"}}}}},"x-oaiMeta":{"name":"List containers","group":"containers","path":"get","examples":{"request":{"curl":"curl https://api.openai.com/v1/containers \\\n -H \"Authorization: Bearer $OPENAI_API_KEY\"\n","node.js":"import OpenAI from 'openai';\n\nconst client = new OpenAI({\n apiKey: process.env['OPENAI_API_KEY'], // This is the default and can be omitted\n});\n\n// Automatically fetches more pages as needed.\nfor await (const containerListResponse of client.containers.list()) {\n console.log(containerListResponse.id);\n}","python":"import os\nfrom openai import OpenAI\n\nclient = OpenAI(\n api_key=os.environ.get(\"OPENAI_API_KEY\"), # This is the default and can be omitted\n)\npage = client.containers.list()\npage = page.data[0]\nprint(page.id)","go":"package main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\n\t\"github.com/openai/openai-go\"\n\t\"github.com/openai/openai-go/option\"\n)\n\nfunc main() {\n\tclient := openai.NewClient(\n\t\toption.WithAPIKey(\"My API Key\"),\n\t)\n\tpage, err := client.Containers.List(context.TODO(), openai.ContainerListParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf(\"%+v\\n\", page)\n}\n","java":"package com.openai.example;\n\nimport com.openai.client.OpenAIClient;\nimport com.openai.client.okhttp.OpenAIOkHttpClient;\nimport com.openai.models.containers.ContainerListPage;\nimport com.openai.models.containers.ContainerListParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n OpenAIClient client = OpenAIOkHttpClient.fromEnv();\n\n ContainerListPage page = client.containers().list();\n }\n}","ruby":"require \"openai\"\n\nopenai = OpenAI::Client.new(api_key: \"My API Key\")\n\npage = openai.containers.list\n\nputs(page)"},"response":"{\n \"object\": \"list\",\n \"data\": [\n {\n \"id\": \"cntr_682dfebaacac8198bbfe9c2474fb6f4a085685cbe3cb5863\",\n \"object\": \"container\",\n \"created_at\": 1747844794,\n \"status\": \"running\",\n \"expires_after\": {\n \"anchor\": \"last_active_at\",\n \"minutes\": 20\n },\n \"last_active_at\": 1747844794,\n \"memory_limit\": \"4g\",\n \"name\": \"My Container\"\n }\n ],\n \"first_id\": \"container_123\",\n \"last_id\": \"container_123\",\n \"has_more\": false\n}\n"}}},"post":{"summary":"Create Container","description":"Creates a container.","operationId":"CreateContainer","parameters":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateContainerBody"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContainerResource"}}}}},"x-oaiMeta":{"name":"Create container","group":"containers","path":"post","examples":{"request":{"curl":"curl https://api.openai.com/v1/containers \\\n -H \"Authorization: Bearer $OPENAI_API_KEY\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"name\": \"My Container\",\n \"memory_limit\": \"4g\",\n \"skills\": [\n {\n \"type\": \"skill_reference\",\n \"skill_id\": \"skill_4db6f1a2c9e73508b41f9da06e2c7b5f\"\n },\n {\n \"type\": \"skill_reference\",\n \"skill_id\": \"openai-spreadsheets\",\n \"version\": \"latest\"\n }\n ],\n \"network_policy\": {\n \"type\": \"allowlist\",\n \"allowed_domains\": [\"api.buildkite.com\"]\n }\n }'\n","node.js":"import OpenAI from 'openai';\n\nconst client = new OpenAI({\n apiKey: process.env['OPENAI_API_KEY'], // This is the default and can be omitted\n});\n\nconst container = await client.containers.create({ name: 'name' });\n\nconsole.log(container.id);","python":"import os\nfrom openai import OpenAI\n\nclient = OpenAI(\n api_key=os.environ.get(\"OPENAI_API_KEY\"), # This is the default and can be omitted\n)\ncontainer = client.containers.create(\n name=\"name\",\n)\nprint(container.id)","go":"package main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\n\t\"github.com/openai/openai-go\"\n\t\"github.com/openai/openai-go/option\"\n)\n\nfunc main() {\n\tclient := openai.NewClient(\n\t\toption.WithAPIKey(\"My API Key\"),\n\t)\n\tcontainer, err := client.Containers.New(context.TODO(), openai.ContainerNewParams{\n\t\tName: \"name\",\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf(\"%+v\\n\", container.ID)\n}\n","java":"package com.openai.example;\n\nimport com.openai.client.OpenAIClient;\nimport com.openai.client.okhttp.OpenAIOkHttpClient;\nimport com.openai.models.containers.ContainerCreateParams;\nimport com.openai.models.containers.ContainerCreateResponse;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n OpenAIClient client = OpenAIOkHttpClient.fromEnv();\n\n ContainerCreateParams params = ContainerCreateParams.builder()\n .name(\"name\")\n .build();\n ContainerCreateResponse container = client.containers().create(params);\n }\n}","ruby":"require \"openai\"\n\nopenai = OpenAI::Client.new(api_key: \"My API Key\")\n\ncontainer = openai.containers.create(name: \"name\")\n\nputs(container)"},"response":"{\n \"id\": \"cntr_682e30645a488191b6363a0cbefc0f0a025ec61b66250591\",\n \"object\": \"container\",\n \"created_at\": 1747857508,\n \"status\": \"running\",\n \"expires_after\": {\n \"anchor\": \"last_active_at\",\n \"minutes\": 20\n },\n \"last_active_at\": 1747857508,\n \"network_policy\": {\n \"type\": \"allowlist\",\n \"allowed_domains\": [\"api.buildkite.com\"]\n },\n \"memory_limit\": \"4g\",\n \"name\": \"My Container\"\n}\n"}}}},"/containers/{container_id}":{"get":{"summary":"Retrieve Container","description":"Retrieves a container.","operationId":"RetrieveContainer","parameters":[{"name":"container_id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContainerResource"}}}}},"x-oaiMeta":{"name":"Retrieve container","group":"containers","path":"get","examples":{"request":{"curl":"curl https://api.openai.com/v1/containers/cntr_682dfebaacac8198bbfe9c2474fb6f4a085685cbe3cb5863 \\\n -H \"Authorization: Bearer $OPENAI_API_KEY\"\n","node.js":"import OpenAI from 'openai';\n\nconst client = new OpenAI({\n apiKey: process.env['OPENAI_API_KEY'], // This is the default and can be omitted\n});\n\nconst container = await client.containers.retrieve('container_id');\n\nconsole.log(container.id);","python":"import os\nfrom openai import OpenAI\n\nclient = OpenAI(\n api_key=os.environ.get(\"OPENAI_API_KEY\"), # This is the default and can be omitted\n)\ncontainer = client.containers.retrieve(\n \"container_id\",\n)\nprint(container.id)","go":"package main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\n\t\"github.com/openai/openai-go\"\n\t\"github.com/openai/openai-go/option\"\n)\n\nfunc main() {\n\tclient := openai.NewClient(\n\t\toption.WithAPIKey(\"My API Key\"),\n\t)\n\tcontainer, err := client.Containers.Get(context.TODO(), \"container_id\")\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf(\"%+v\\n\", container.ID)\n}\n","java":"package com.openai.example;\n\nimport com.openai.client.OpenAIClient;\nimport com.openai.client.okhttp.OpenAIOkHttpClient;\nimport com.openai.models.containers.ContainerRetrieveParams;\nimport com.openai.models.containers.ContainerRetrieveResponse;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n OpenAIClient client = OpenAIOkHttpClient.fromEnv();\n\n ContainerRetrieveResponse container = client.containers().retrieve(\"container_id\");\n }\n}","ruby":"require \"openai\"\n\nopenai = OpenAI::Client.new(api_key: \"My API Key\")\n\ncontainer = openai.containers.retrieve(\"container_id\")\n\nputs(container)"},"response":"{\n \"id\": \"cntr_682dfebaacac8198bbfe9c2474fb6f4a085685cbe3cb5863\",\n \"object\": \"container\",\n \"created_at\": 1747844794,\n \"status\": \"running\",\n \"expires_after\": {\n \"anchor\": \"last_active_at\",\n \"minutes\": 20\n },\n \"last_active_at\": 1747844794,\n \"memory_limit\": \"4g\",\n \"name\": \"My Container\"\n}\n"}}},"delete":{"operationId":"DeleteContainer","summary":"Delete Container","description":"Delete a container.","parameters":[{"name":"container_id","in":"path","description":"The ID of the container to delete.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK"}},"x-oaiMeta":{"name":"Delete a container","group":"containers","path":"delete","examples":{"request":{"curl":"curl -X DELETE https://api.openai.com/v1/containers/cntr_682dfebaacac8198bbfe9c2474fb6f4a085685cbe3cb5863 \\\n -H \"Authorization: Bearer $OPENAI_API_KEY\"\n","node.js":"import OpenAI from 'openai';\n\nconst client = new OpenAI({\n apiKey: process.env['OPENAI_API_KEY'], // This is the default and can be omitted\n});\n\nawait client.containers.delete('container_id');","python":"import os\nfrom openai import OpenAI\n\nclient = OpenAI(\n api_key=os.environ.get(\"OPENAI_API_KEY\"), # This is the default and can be omitted\n)\nclient.containers.delete(\n \"container_id\",\n)","go":"package main\n\nimport (\n\t\"context\"\n\n\t\"github.com/openai/openai-go\"\n\t\"github.com/openai/openai-go/option\"\n)\n\nfunc main() {\n\tclient := openai.NewClient(\n\t\toption.WithAPIKey(\"My API Key\"),\n\t)\n\terr := client.Containers.Delete(context.TODO(), \"container_id\")\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n","java":"package com.openai.example;\n\nimport com.openai.client.OpenAIClient;\nimport com.openai.client.okhttp.OpenAIOkHttpClient;\nimport com.openai.models.containers.ContainerDeleteParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n OpenAIClient client = OpenAIOkHttpClient.fromEnv();\n\n client.containers().delete(\"container_id\");\n }\n}","ruby":"require \"openai\"\n\nopenai = OpenAI::Client.new(api_key: \"My API Key\")\n\nresult = openai.containers.delete(\"container_id\")\n\nputs(result)"},"response":"{\n \"id\": \"cntr_682dfebaacac8198bbfe9c2474fb6f4a085685cbe3cb5863\",\n \"object\": \"container.deleted\",\n \"deleted\": true\n}\n"}}}},"/containers/{container_id}/files":{"post":{"summary":"Create a Container File\n\nYou can send either a multipart/form-data request with the raw file content, or a JSON request with a file ID.\n","description":"Creates a container file.\n","operationId":"CreateContainerFile","parameters":[{"name":"container_id","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateContainerFileBody"}},"multipart/form-data":{"schema":{"$ref":"#/components/schemas/CreateContainerFileBody"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContainerFileResource"}}}}},"x-oaiMeta":{"name":"Create container file","group":"containers","path":"post","examples":{"request":{"curl":"curl https://api.openai.com/v1/containers/cntr_682e0e7318108198aa783fd921ff305e08e78805b9fdbb04/files \\\n -H \"Authorization: Bearer $OPENAI_API_KEY\" \\\n -F file=\"@example.txt\"\n","node.js":"import fs from 'fs';\nimport OpenAI from 'openai';\n\nconst client = new OpenAI({\n apiKey: process.env['OPENAI_API_KEY'], // This is the default and can be omitted\n});\n\nconst file = await client.containers.files.create('container_id');\n\nconsole.log(file.id);","python":"import os\nfrom openai import OpenAI\n\nclient = OpenAI(\n api_key=os.environ.get(\"OPENAI_API_KEY\"), # This is the default and can be omitted\n)\nfile = client.containers.files.create(\n container_id=\"container_id\",\n)\nprint(file.id)","go":"package main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\n\t\"github.com/openai/openai-go\"\n\t\"github.com/openai/openai-go/option\"\n)\n\nfunc main() {\n\tclient := openai.NewClient(\n\t\toption.WithAPIKey(\"My API Key\"),\n\t)\n\tfile, err := client.Containers.Files.New(\n\t\tcontext.TODO(),\n\t\t\"container_id\",\n\t\topenai.ContainerFileNewParams{},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf(\"%+v\\n\", file.ID)\n}\n","java":"package com.openai.example;\n\nimport com.openai.client.OpenAIClient;\nimport com.openai.client.okhttp.OpenAIOkHttpClient;\nimport com.openai.models.containers.files.FileCreateParams;\nimport com.openai.models.containers.files.FileCreateResponse;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n OpenAIClient client = OpenAIOkHttpClient.fromEnv();\n\n FileCreateResponse file = client.containers().files().create(\"container_id\");\n }\n}","ruby":"require \"openai\"\n\nopenai = OpenAI::Client.new(api_key: \"My API Key\")\n\nfile = openai.containers.files.create(\"container_id\")\n\nputs(file)"},"response":"{\n \"id\": \"cfile_682e0e8a43c88191a7978f477a09bdf5\",\n \"object\": \"container.file\",\n \"created_at\": 1747848842,\n \"bytes\": 880,\n \"container_id\": \"cntr_682e0e7318108198aa783fd921ff305e08e78805b9fdbb04\",\n \"path\": \"/mnt/data/88e12fa445d32636f190a0b33daed6cb-tsconfig.json\",\n \"source\": \"user\"\n}\n"}}},"get":{"summary":"List Container files","description":"Lists container files.","operationId":"ListContainerFiles","parameters":[{"name":"container_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"limit","in":"query","description":"A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.\n","required":false,"schema":{"type":"integer","default":20}},{"name":"order","in":"query","description":"Sort order by the `created_at` timestamp of the objects. `asc` for ascending order and `desc` for descending order.\n","schema":{"type":"string","default":"desc","enum":["asc","desc"]}},{"name":"after","in":"query","description":"A cursor for use in pagination. `after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list.\n","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContainerFileListResource"}}}}},"x-oaiMeta":{"name":"List container files","group":"containers","path":"get","examples":{"request":{"curl":"curl https://api.openai.com/v1/containers/cntr_682e0e7318108198aa783fd921ff305e08e78805b9fdbb04/files \\\n -H \"Authorization: Bearer $OPENAI_API_KEY\"\n","node.js":"import OpenAI from 'openai';\n\nconst client = new OpenAI({\n apiKey: process.env['OPENAI_API_KEY'], // This is the default and can be omitted\n});\n\n// Automatically fetches more pages as needed.\nfor await (const fileListResponse of client.containers.files.list('container_id')) {\n console.log(fileListResponse.id);\n}","python":"import os\nfrom openai import OpenAI\n\nclient = OpenAI(\n api_key=os.environ.get(\"OPENAI_API_KEY\"), # This is the default and can be omitted\n)\npage = client.containers.files.list(\n container_id=\"container_id\",\n)\npage = page.data[0]\nprint(page.id)","go":"package main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\n\t\"github.com/openai/openai-go\"\n\t\"github.com/openai/openai-go/option\"\n)\n\nfunc main() {\n\tclient := openai.NewClient(\n\t\toption.WithAPIKey(\"My API Key\"),\n\t)\n\tpage, err := client.Containers.Files.List(\n\t\tcontext.TODO(),\n\t\t\"container_id\",\n\t\topenai.ContainerFileListParams{},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf(\"%+v\\n\", page)\n}\n","java":"package com.openai.example;\n\nimport com.openai.client.OpenAIClient;\nimport com.openai.client.okhttp.OpenAIOkHttpClient;\nimport com.openai.models.containers.files.FileListPage;\nimport com.openai.models.containers.files.FileListParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n OpenAIClient client = OpenAIOkHttpClient.fromEnv();\n\n FileListPage page = client.containers().files().list(\"container_id\");\n }\n}","ruby":"require \"openai\"\n\nopenai = OpenAI::Client.new(api_key: \"My API Key\")\n\npage = openai.containers.files.list(\"container_id\")\n\nputs(page)"},"response":"{\n \"object\": \"list\",\n \"data\": [\n {\n \"id\": \"cfile_682e0e8a43c88191a7978f477a09bdf5\",\n \"object\": \"container.file\",\n \"created_at\": 1747848842,\n \"bytes\": 880,\n \"container_id\": \"cntr_682e0e7318108198aa783fd921ff305e08e78805b9fdbb04\",\n \"path\": \"/mnt/data/88e12fa445d32636f190a0b33daed6cb-tsconfig.json\",\n \"source\": \"user\"\n }\n ],\n \"first_id\": \"cfile_682e0e8a43c88191a7978f477a09bdf5\",\n \"has_more\": false,\n \"last_id\": \"cfile_682e0e8a43c88191a7978f477a09bdf5\"\n}\n"}}}},"/containers/{container_id}/files/{file_id}":{"get":{"summary":"Retrieve Container File","description":"Retrieves a container file.","operationId":"RetrieveContainerFile","parameters":[{"name":"container_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"file_id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContainerFileResource"}}}}},"x-oaiMeta":{"name":"Retrieve container file","group":"containers","path":"get","examples":{"request":{"curl":"curl https://api.openai.com/v1/containers/container_123/files/file_456 \\\n -H \"Authorization: Bearer $OPENAI_API_KEY\"\n","node.js":"import OpenAI from 'openai';\n\nconst client = new OpenAI({\n apiKey: process.env['OPENAI_API_KEY'], // This is the default and can be omitted\n});\n\nconst file = await client.containers.files.retrieve('file_id', { container_id: 'container_id' });\n\nconsole.log(file.id);","python":"import os\nfrom openai import OpenAI\n\nclient = OpenAI(\n api_key=os.environ.get(\"OPENAI_API_KEY\"), # This is the default and can be omitted\n)\nfile = client.containers.files.retrieve(\n file_id=\"file_id\",\n container_id=\"container_id\",\n)\nprint(file.id)","go":"package main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\n\t\"github.com/openai/openai-go\"\n\t\"github.com/openai/openai-go/option\"\n)\n\nfunc main() {\n\tclient := openai.NewClient(\n\t\toption.WithAPIKey(\"My API Key\"),\n\t)\n\tfile, err := client.Containers.Files.Get(\n\t\tcontext.TODO(),\n\t\t\"container_id\",\n\t\t\"file_id\",\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf(\"%+v\\n\", file.ID)\n}\n","java":"package com.openai.example;\n\nimport com.openai.client.OpenAIClient;\nimport com.openai.client.okhttp.OpenAIOkHttpClient;\nimport com.openai.models.containers.files.FileRetrieveParams;\nimport com.openai.models.containers.files.FileRetrieveResponse;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n OpenAIClient client = OpenAIOkHttpClient.fromEnv();\n\n FileRetrieveParams params = FileRetrieveParams.builder()\n .containerId(\"container_id\")\n .fileId(\"file_id\")\n .build();\n FileRetrieveResponse file = client.containers().files().retrieve(params);\n }\n}","ruby":"require \"openai\"\n\nopenai = OpenAI::Client.new(api_key: \"My API Key\")\n\nfile = openai.containers.files.retrieve(\"file_id\", container_id: \"container_id\")\n\nputs(file)"},"response":"{\n \"id\": \"cfile_682e0e8a43c88191a7978f477a09bdf5\",\n \"object\": \"container.file\",\n \"created_at\": 1747848842,\n \"bytes\": 880,\n \"container_id\": \"cntr_682e0e7318108198aa783fd921ff305e08e78805b9fdbb04\",\n \"path\": \"/mnt/data/88e12fa445d32636f190a0b33daed6cb-tsconfig.json\",\n \"source\": \"user\"\n}\n"}}},"delete":{"operationId":"DeleteContainerFile","summary":"Delete Container File","description":"Delete a container file.","parameters":[{"name":"container_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"file_id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK"}},"x-oaiMeta":{"name":"Delete a container file","group":"containers","path":"delete","examples":{"request":{"curl":"curl -X DELETE https://api.openai.com/v1/containers/cntr_682dfebaacac8198bbfe9c2474fb6f4a085685cbe3cb5863/files/cfile_682e0e8a43c88191a7978f477a09bdf5 \\\n -H \"Authorization: Bearer $OPENAI_API_KEY\"\n","node.js":"import OpenAI from 'openai';\n\nconst client = new OpenAI({\n apiKey: process.env['OPENAI_API_KEY'], // This is the default and can be omitted\n});\n\nawait client.containers.files.delete('file_id', { container_id: 'container_id' });","python":"import os\nfrom openai import OpenAI\n\nclient = OpenAI(\n api_key=os.environ.get(\"OPENAI_API_KEY\"), # This is the default and can be omitted\n)\nclient.containers.files.delete(\n file_id=\"file_id\",\n container_id=\"container_id\",\n)","go":"package main\n\nimport (\n\t\"context\"\n\n\t\"github.com/openai/openai-go\"\n\t\"github.com/openai/openai-go/option\"\n)\n\nfunc main() {\n\tclient := openai.NewClient(\n\t\toption.WithAPIKey(\"My API Key\"),\n\t)\n\terr := client.Containers.Files.Delete(\n\t\tcontext.TODO(),\n\t\t\"container_id\",\n\t\t\"file_id\",\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n","java":"package com.openai.example;\n\nimport com.openai.client.OpenAIClient;\nimport com.openai.client.okhttp.OpenAIOkHttpClient;\nimport com.openai.models.containers.files.FileDeleteParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n OpenAIClient client = OpenAIOkHttpClient.fromEnv();\n\n FileDeleteParams params = FileDeleteParams.builder()\n .containerId(\"container_id\")\n .fileId(\"file_id\")\n .build();\n client.containers().files().delete(params);\n }\n}","ruby":"require \"openai\"\n\nopenai = OpenAI::Client.new(api_key: \"My API Key\")\n\nresult = openai.containers.files.delete(\"file_id\", container_id: \"container_id\")\n\nputs(result)"},"response":"{\n \"id\": \"cfile_682e0e8a43c88191a7978f477a09bdf5\",\n \"object\": \"container.file.deleted\",\n \"deleted\": true\n}\n"}}}},"/containers/{container_id}/files/{file_id}/content":{"get":{"summary":"Retrieve Container File Content","description":"Retrieves a container file content.","operationId":"RetrieveContainerFileContent","parameters":[{"name":"container_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"file_id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"}},"x-oaiMeta":{"name":"Retrieve container file content","group":"containers","path":"get","examples":{"request":{"curl":"curl https://api.openai.com/v1/containers/container_123/files/cfile_456/content \\\n -H \"Authorization: Bearer $OPENAI_API_KEY\"\n","node.js":"import OpenAI from 'openai';\n\nconst client = new OpenAI({\n apiKey: process.env['OPENAI_API_KEY'], // This is the default and can be omitted\n});\n\nconst content = await client.containers.files.content.retrieve('file_id', {\n container_id: 'container_id',\n});\n\nconsole.log(content);\n\nconst data = await content.blob();\nconsole.log(data);","python":"import os\nfrom openai import OpenAI\n\nclient = OpenAI(\n api_key=os.environ.get(\"OPENAI_API_KEY\"), # This is the default and can be omitted\n)\ncontent = client.containers.files.content.retrieve(\n file_id=\"file_id\",\n container_id=\"container_id\",\n)\nprint(content)\ndata = content.read()\nprint(data)","go":"package main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\n\t\"github.com/openai/openai-go\"\n\t\"github.com/openai/openai-go/option\"\n)\n\nfunc main() {\n\tclient := openai.NewClient(\n\t\toption.WithAPIKey(\"My API Key\"),\n\t)\n\tcontent, err := client.Containers.Files.Content.Get(\n\t\tcontext.TODO(),\n\t\t\"container_id\",\n\t\t\"file_id\",\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf(\"%+v\\n\", content)\n}\n","java":"package com.openai.example;\n\nimport com.openai.client.OpenAIClient;\nimport com.openai.client.okhttp.OpenAIOkHttpClient;\nimport com.openai.core.http.HttpResponse;\nimport com.openai.models.containers.files.content.ContentRetrieveParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n OpenAIClient client = OpenAIOkHttpClient.fromEnv();\n\n ContentRetrieveParams params = ContentRetrieveParams.builder()\n .containerId(\"container_id\")\n .fileId(\"file_id\")\n .build();\n HttpResponse content = client.containers().files().content().retrieve(params);\n }\n}","ruby":"require \"openai\"\n\nopenai = OpenAI::Client.new(api_key: \"My API Key\")\n\ncontent = openai.containers.files.content.retrieve(\"file_id\", container_id: \"container_id\")\n\nputs(content)"},"response":"<binary content of the file>\n"}}}},"/conversations/{conversation_id}/items":{"post":{"operationId":"createConversationItems","tags":["Conversations"],"summary":"Create items in a conversation with the given ID.","parameters":[{"in":"path","name":"conversation_id","required":true,"schema":{"type":"string","example":"conv_123"},"description":"The ID of the conversation to add the item to."},{"name":"include","in":"query","required":false,"schema":{"type":"array","items":{"$ref":"#/components/schemas/IncludeEnum"}},"description":"Additional fields to include in the response. See the `include`\nparameter for [listing Conversation items above](/docs/api-reference/conversations/list-items#conversations_list_items-include) for more information.\n"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"items":{"type":"array","description":"The items to add to the conversation. You may add up to 20 items at a time.\n","items":{"$ref":"#/components/schemas/InputItem"},"maxItems":20}},"required":["items"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConversationItemList"}}}}},"x-oaiMeta":{"name":"Create items","group":"conversations","path":"create-item","examples":{"request":{"curl":"curl https://api.openai.com/v1/conversations/conv_123/items \\\n -H \"Content-Type: application/json\" \\\n -H \"Authorization: Bearer $OPENAI_API_KEY\" \\\n -d '{\n \"items\": [\n {\n \"type\": \"message\",\n \"role\": \"user\",\n \"content\": [\n {\"type\": \"input_text\", \"text\": \"Hello!\"}\n ]\n },\n {\n \"type\": \"message\",\n \"role\": \"user\",\n \"content\": [\n {\"type\": \"input_text\", \"text\": \"How are you?\"}\n ]\n }\n ]\n }'\n","javascript":"import OpenAI from \"openai\";\nconst client = new OpenAI();\n\nconst items = await client.conversations.items.create(\n \"conv_123\",\n {\n items: [\n {\n type: \"message\",\n role: \"user\",\n content: [{ type: \"input_text\", text: \"Hello!\" }],\n },\n {\n type: \"message\",\n role: \"user\",\n content: [{ type: \"input_text\", text: \"How are you?\" }],\n },\n ],\n }\n);\nconsole.log(items.data);\n","python":"import os\nfrom openai import OpenAI\n\nclient = OpenAI(\n api_key=os.environ.get(\"OPENAI_API_KEY\"), # This is the default and can be omitted\n)\nconversation_item_list = client.conversations.items.create(\n conversation_id=\"conv_123\",\n items=[{\n \"content\": \"string\",\n \"role\": \"user\",\n \"type\": \"message\",\n }],\n)\nprint(conversation_item_list.first_id)","csharp":"using System;\nusing System.Collections.Generic;\nusing OpenAI.Conversations;\n\nOpenAIConversationClient client = new(\n apiKey: Environment.GetEnvironmentVariable(\"OPENAI_API_KEY\")\n);\n\nConversationItemList created = client.ConversationItems.Create(\n conversationId: \"conv_123\",\n new CreateConversationItemsOptions\n {\n Items = new List<ConversationItem>\n {\n new ConversationMessage\n {\n Role = \"user\",\n Content =\n {\n new ConversationInputText { Text = \"Hello!\" }\n }\n },\n new ConversationMessage\n {\n Role = \"user\",\n Content =\n {\n new ConversationInputText { Text = \"How are you?\" }\n }\n }\n }\n }\n);\nConsole.WriteLine(created.Data.Count);\n","node.js":"import OpenAI from 'openai';\n\nconst client = new OpenAI({\n apiKey: process.env['OPENAI_API_KEY'], // This is the default and can be omitted\n});\n\nconst conversationItemList = await client.conversations.items.create('conv_123', {\n items: [\n {\n content: 'string',\n role: 'user',\n type: 'message',\n },\n ],\n});\n\nconsole.log(conversationItemList.first_id);","go":"package main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\n\t\"github.com/openai/openai-go\"\n\t\"github.com/openai/openai-go/conversations\"\n\t\"github.com/openai/openai-go/option\"\n\t\"github.com/openai/openai-go/responses\"\n)\n\nfunc main() {\n\tclient := openai.NewClient(\n\t\toption.WithAPIKey(\"My API Key\"),\n\t)\n\tconversationItemList, err := client.Conversations.Items.New(\n\t\tcontext.TODO(),\n\t\t\"conv_123\",\n\t\tconversations.ItemNewParams{\n\t\t\tItems: []responses.ResponseInputItemUnionParam{{\n\t\t\t\tOfMessage: &responses.EasyInputMessageParam{\n\t\t\t\t\tContent: responses.EasyInputMessageContentUnionParam{\n\t\t\t\t\t\tOfString: openai.String(\"string\"),\n\t\t\t\t\t},\n\t\t\t\t\tRole: responses.EasyInputMessageRoleUser,\n\t\t\t\t\tType: responses.EasyInputMessageTypeMessage,\n\t\t\t\t},\n\t\t\t}},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf(\"%+v\\n\", conversationItemList.FirstID)\n}\n","java":"package com.openai.example;\n\nimport com.openai.client.OpenAIClient;\nimport com.openai.client.okhttp.OpenAIOkHttpClient;\nimport com.openai.models.conversations.items.ConversationItemList;\nimport com.openai.models.conversations.items.ItemCreateParams;\nimport com.openai.models.responses.EasyInputMessage;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n OpenAIClient client = OpenAIOkHttpClient.fromEnv();\n\n ItemCreateParams params = ItemCreateParams.builder()\n .conversationId(\"conv_123\")\n .addItem(EasyInputMessage.builder()\n .content(\"string\")\n .role(EasyInputMessage.Role.USER)\n .type(EasyInputMessage.Type.MESSAGE)\n .build())\n .build();\n ConversationItemList conversationItemList = client.conversations().items().create(params);\n }\n}","ruby":"require \"openai\"\n\nopenai = OpenAI::Client.new(api_key: \"My API Key\")\n\nconversation_item_list = openai.conversations.items.create(\"conv_123\", items: [{content: \"string\", role: :user, type: :message}])\n\nputs(conversation_item_list)"},"response":"{\n \"object\": \"list\",\n \"data\": [\n {\n \"type\": \"message\",\n \"id\": \"msg_abc\",\n \"status\": \"completed\",\n \"role\": \"user\",\n \"content\": [\n {\"type\": \"input_text\", \"text\": \"Hello!\"}\n ]\n },\n {\n \"type\": \"message\",\n \"id\": \"msg_def\",\n \"status\": \"completed\",\n \"role\": \"user\",\n \"content\": [\n {\"type\": \"input_text\", \"text\": \"How are you?\"}\n ]\n }\n ],\n \"first_id\": \"msg_abc\",\n \"last_id\": \"msg_def\",\n \"has_more\": false\n}\n"}}},"get":{"operationId":"listConversationItems","tags":["Conversations"],"summary":"List all items for a conversation with the given ID.","parameters":[{"in":"path","name":"conversation_id","required":true,"schema":{"type":"string","example":"conv_123"},"description":"The ID of the conversation to list items for."},{"name":"limit","in":"query","description":"A limit on the number of objects to be returned. Limit can range between\n1 and 100, and the default is 20.\n","required":false,"schema":{"type":"integer","default":20}},{"in":"query","name":"order","schema":{"type":"string","enum":["asc","desc"]},"description":"The order to return the input items in. Default is `desc`.\n- `asc`: Return the input items in ascending order.\n- `desc`: Return the input items in descending order.\n"},{"in":"query","name":"after","schema":{"type":"string"},"description":"An item ID to list items after, used in pagination.\n"},{"name":"include","in":"query","required":false,"schema":{"type":"array","items":{"$ref":"#/components/schemas/IncludeEnum"}},"description":"Specify additional output data to include in the model response. Currently supported values are:\n- `web_search_call.action.sources`: Include the sources of the web search tool call.\n- `code_interpreter_call.outputs`: Includes the outputs of python code execution in code interpreter tool call items.\n- `computer_call_output.output.image_url`: Include image urls from the computer call output.\n- `file_search_call.results`: Include the search results of the file search tool call.\n- `message.input_image.image_url`: Include image urls from the input message.\n- `message.output_text.logprobs`: Include logprobs with assistant messages.\n- `reasoning.encrypted_content`: Includes an encrypted version of reasoning tokens in reasoning item outputs. This enables reasoning items to be used in multi-turn conversations when using the Responses API statelessly (like when the `store` parameter is set to `false`, or when an organization is enrolled in the zero data retention program)."}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConversationItemList"}}}}},"x-oaiMeta":{"name":"List items","group":"conversations","path":"list-items","examples":{"request":{"curl":"curl \"https://api.openai.com/v1/conversations/conv_123/items?limit=10\" \\\n -H \"Authorization: Bearer $OPENAI_API_KEY\"\n","javascript":"import OpenAI from \"openai\";\nconst client = new OpenAI();\n\nconst items = await client.conversations.items.list(\"conv_123\", { limit: 10 });\nconsole.log(items.data);\n","python":"import os\nfrom openai import OpenAI\n\nclient = OpenAI(\n api_key=os.environ.get(\"OPENAI_API_KEY\"), # This is the default and can be omitted\n)\npage = client.conversations.items.list(\n conversation_id=\"conv_123\",\n)\npage = page.data[0]\nprint(page)","csharp":"using System;\nusing OpenAI.Conversations;\n\nOpenAIConversationClient client = new(\n apiKey: Environment.GetEnvironmentVariable(\"OPENAI_API_KEY\")\n);\n\nConversationItemList items = client.ConversationItems.List(\n conversationId: \"conv_123\",\n new ListConversationItemsOptions { Limit = 10 }\n);\nConsole.WriteLine(items.Data.Count);\n","node.js":"import OpenAI from 'openai';\n\nconst client = new OpenAI({\n apiKey: process.env['OPENAI_API_KEY'], // This is the default and can be omitted\n});\n\n// Automatically fetches more pages as needed.\nfor await (const conversationItem of client.conversations.items.list('conv_123')) {\n console.log(conversationItem);\n}","go":"package main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\n\t\"github.com/openai/openai-go\"\n\t\"github.com/openai/openai-go/conversations\"\n\t\"github.com/openai/openai-go/option\"\n)\n\nfunc main() {\n\tclient := openai.NewClient(\n\t\toption.WithAPIKey(\"My API Key\"),\n\t)\n\tpage, err := client.Conversations.Items.List(\n\t\tcontext.TODO(),\n\t\t\"conv_123\",\n\t\tconversations.ItemListParams{},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf(\"%+v\\n\", page)\n}\n","java":"package com.openai.example;\n\nimport com.openai.client.OpenAIClient;\nimport com.openai.client.okhttp.OpenAIOkHttpClient;\nimport com.openai.models.conversations.items.ItemListPage;\nimport com.openai.models.conversations.items.ItemListParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n OpenAIClient client = OpenAIOkHttpClient.fromEnv();\n\n ItemListPage page = client.conversations().items().list(\"conv_123\");\n }\n}","ruby":"require \"openai\"\n\nopenai = OpenAI::Client.new(api_key: \"My API Key\")\n\npage = openai.conversations.items.list(\"conv_123\")\n\nputs(page)"},"response":"{\n \"object\": \"list\",\n \"data\": [\n {\n \"type\": \"message\",\n \"id\": \"msg_abc\",\n \"status\": \"completed\",\n \"role\": \"user\",\n \"content\": [\n {\"type\": \"input_text\", \"text\": \"Hello!\"}\n ]\n }\n ],\n \"first_id\": \"msg_abc\",\n \"last_id\": \"msg_abc\",\n \"has_more\": false\n}\n"}}}},"/conversations/{conversation_id}/items/{item_id}":{"get":{"operationId":"getConversationItem","tags":["Conversations"],"summary":"Get a single item from a conversation with the given IDs.","parameters":[{"in":"path","name":"conversation_id","required":true,"schema":{"type":"string","example":"conv_123"},"description":"The ID of the conversation that contains the item."},{"in":"path","name":"item_id","required":true,"schema":{"type":"string","example":"msg_abc"},"description":"The ID of the item to retrieve."},{"name":"include","in":"query","required":false,"schema":{"type":"array","items":{"$ref":"#/components/schemas/IncludeEnum"}},"description":"Additional fields to include in the response. See the `include`\nparameter for [listing Conversation items above](/docs/api-reference/conversations/list-items#conversations_list_items-include) for more information.\n"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConversationItem"}}}}},"x-oaiMeta":{"name":"Retrieve an item","group":"conversations","path":"get-item","examples":{"request":{"curl":"curl https://api.openai.com/v1/conversations/conv_123/items/msg_abc \\\n -H \"Authorization: Bearer $OPENAI_API_KEY\"\n","javascript":"import OpenAI from \"openai\";\nconst client = new OpenAI();\n\nconst item = await client.conversations.items.retrieve(\n \"conv_123\",\n \"msg_abc\"\n);\nconsole.log(item);\n","python":"import os\nfrom openai import OpenAI\n\nclient = OpenAI(\n api_key=os.environ.get(\"OPENAI_API_KEY\"), # This is the default and can be omitted\n)\nconversation_item = client.conversations.items.retrieve(\n item_id=\"msg_abc\",\n conversation_id=\"conv_123\",\n)\nprint(conversation_item)","csharp":"using System;\nusing OpenAI.Conversations;\n\nOpenAIConversationClient client = new(\n apiKey: Environment.GetEnvironmentVariable(\"OPENAI_API_KEY\")\n);\n\nConversationItem item = client.ConversationItems.Get(\n conversationId: \"conv_123\",\n itemId: \"msg_abc\"\n);\nConsole.WriteLine(item.Id);\n","node.js":"import OpenAI from 'openai';\n\nconst client = new OpenAI({\n apiKey: process.env['OPENAI_API_KEY'], // This is the default and can be omitted\n});\n\nconst conversationItem = await client.conversations.items.retrieve('msg_abc', {\n conversation_id: 'conv_123',\n});\n\nconsole.log(conversationItem);","go":"package main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\n\t\"github.com/openai/openai-go\"\n\t\"github.com/openai/openai-go/conversations\"\n\t\"github.com/openai/openai-go/option\"\n)\n\nfunc main() {\n\tclient := openai.NewClient(\n\t\toption.WithAPIKey(\"My API Key\"),\n\t)\n\tconversationItem, err := client.Conversations.Items.Get(\n\t\tcontext.TODO(),\n\t\t\"conv_123\",\n\t\t\"msg_abc\",\n\t\tconversations.ItemGetParams{},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf(\"%+v\\n\", conversationItem)\n}\n","java":"package com.openai.example;\n\nimport com.openai.client.OpenAIClient;\nimport com.openai.client.okhttp.OpenAIOkHttpClient;\nimport com.openai.models.conversations.items.ConversationItem;\nimport com.openai.models.conversations.items.ItemRetrieveParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n OpenAIClient client = OpenAIOkHttpClient.fromEnv();\n\n ItemRetrieveParams params = ItemRetrieveParams.builder()\n .conversationId(\"conv_123\")\n .itemId(\"msg_abc\")\n .build();\n ConversationItem conversationItem = client.conversations().items().retrieve(params);\n }\n}","ruby":"require \"openai\"\n\nopenai = OpenAI::Client.new(api_key: \"My API Key\")\n\nconversation_item = openai.conversations.items.retrieve(\"msg_abc\", conversation_id: \"conv_123\")\n\nputs(conversation_item)"},"response":"{\n \"type\": \"message\",\n \"id\": \"msg_abc\",\n \"status\": \"completed\",\n \"role\": \"user\",\n \"content\": [\n {\"type\": \"input_text\", \"text\": \"Hello!\"}\n ]\n}\n"}}},"delete":{"operationId":"deleteConversationItem","tags":["Conversations"],"summary":"Delete an item from a conversation with the given IDs.","parameters":[{"in":"path","name":"conversation_id","required":true,"schema":{"type":"string","example":"conv_123"},"description":"The ID of the conversation that contains the item."},{"in":"path","name":"item_id","required":true,"schema":{"type":"string","example":"msg_abc"},"description":"The ID of the item to delete."}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConversationResource"}}}}},"x-oaiMeta":{"name":"Delete an item","group":"conversations","path":"delete-item","examples":{"request":{"curl":"curl -X DELETE https://api.openai.com/v1/conversations/conv_123/items/msg_abc \\\n -H \"Authorization: Bearer $OPENAI_API_KEY\"\n","javascript":"import OpenAI from \"openai\";\nconst client = new OpenAI();\n\nconst conversation = await client.conversations.items.delete(\n \"conv_123\",\n \"msg_abc\"\n);\nconsole.log(conversation);\n","python":"import os\nfrom openai import OpenAI\n\nclient = OpenAI(\n api_key=os.environ.get(\"OPENAI_API_KEY\"), # This is the default and can be omitted\n)\nconversation = client.conversations.items.delete(\n item_id=\"msg_abc\",\n conversation_id=\"conv_123\",\n)\nprint(conversation.id)","csharp":"using System;\nusing OpenAI.Conversations;\n\nOpenAIConversationClient client = new(\n apiKey: Environment.GetEnvironmentVariable(\"OPENAI_API_KEY\")\n);\n\nConversation conversation = client.ConversationItems.Delete(\n conversationId: \"conv_123\",\n itemId: \"msg_abc\"\n);\nConsole.WriteLine(conversation.Id);\n","node.js":"import OpenAI from 'openai';\n\nconst client = new OpenAI({\n apiKey: process.env['OPENAI_API_KEY'], // This is the default and can be omitted\n});\n\nconst conversation = await client.conversations.items.delete('msg_abc', {\n conversation_id: 'conv_123',\n});\n\nconsole.log(conversation.id);","go":"package main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\n\t\"github.com/openai/openai-go\"\n\t\"github.com/openai/openai-go/option\"\n)\n\nfunc main() {\n\tclient := openai.NewClient(\n\t\toption.WithAPIKey(\"My API Key\"),\n\t)\n\tconversation, err := client.Conversations.Items.Delete(\n\t\tcontext.TODO(),\n\t\t\"conv_123\",\n\t\t\"msg_abc\",\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf(\"%+v\\n\", conversation.ID)\n}\n","java":"package com.openai.example;\n\nimport com.openai.client.OpenAIClient;\nimport com.openai.client.okhttp.OpenAIOkHttpClient;\nimport com.openai.models.conversations.Conversation;\nimport com.openai.models.conversations.items.ItemDeleteParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n OpenAIClient client = OpenAIOkHttpClient.fromEnv();\n\n ItemDeleteParams params = ItemDeleteParams.builder()\n .conversationId(\"conv_123\")\n .itemId(\"msg_abc\")\n .build();\n Conversation conversation = client.conversations().items().delete(params);\n }\n}","ruby":"require \"openai\"\n\nopenai = OpenAI::Client.new(api_key: \"My API Key\")\n\nconversation = openai.conversations.items.delete(\"msg_abc\", conversation_id: \"conv_123\")\n\nputs(conversation)"},"response":"{\n \"id\": \"conv_123\",\n \"object\": \"conversation\",\n \"created_at\": 1741900000,\n \"metadata\": {\"topic\": \"demo\"}\n}\n"}}}},"/embeddings":{"post":{"operationId":"createEmbedding","tags":["Embeddings"],"summary":"Creates an embedding vector representing the input text.","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateEmbeddingRequest"}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateEmbeddingResponse"}}}}},"x-oaiMeta":{"name":"Create embeddings","group":"embeddings","examples":{"request":{"curl":"curl https://api.openai.com/v1/embeddings \\\n -H \"Authorization: Bearer $OPENAI_API_KEY\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"input\": \"The food was delicious and the waiter...\",\n \"model\": \"text-embedding-ada-002\",\n \"encoding_format\": \"float\"\n }'\n","python":"import os\nfrom openai import OpenAI\n\nclient = OpenAI(\n api_key=os.environ.get(\"OPENAI_API_KEY\"), # This is the default and can be omitted\n)\ncreate_embedding_response = client.embeddings.create(\n input=\"The quick brown fox jumped over the lazy dog\",\n model=\"text-embedding-3-small\",\n)\nprint(create_embedding_response.data)","javascript":"import OpenAI from \"openai\";\n\nconst openai = new OpenAI();\n\nasync function main() {\n const embedding = await openai.embeddings.create({\n model: \"text-embedding-ada-002\",\n input: \"The quick brown fox jumped over the lazy dog\",\n encoding_format: \"float\",\n });\n\n console.log(embedding);\n}\n\nmain();\n","csharp":"using System;\n\nusing OpenAI.Embeddings;\n\nEmbeddingClient client = new(\n model: \"text-embedding-3-small\",\n apiKey: Environment.GetEnvironmentVariable(\"OPENAI_API_KEY\")\n);\n\nOpenAIEmbedding embedding = client.GenerateEmbedding(input: \"The quick brown fox jumped over the lazy dog\");\nReadOnlyMemory<float> vector = embedding.ToFloats();\n\nfor (int i = 0; i < vector.Length; i++)\n{\n Console.WriteLine($\" [{i,4}] = {vector.Span[i]}\");\n}\n","node.js":"import OpenAI from 'openai';\n\nconst client = new OpenAI({\n apiKey: process.env['OPENAI_API_KEY'], // This is the default and can be omitted\n});\n\nconst createEmbeddingResponse = await client.embeddings.create({\n input: 'The quick brown fox jumped over the lazy dog',\n model: 'text-embedding-3-small',\n});\n\nconsole.log(createEmbeddingResponse.data);","go":"package main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\n\t\"github.com/openai/openai-go\"\n\t\"github.com/openai/openai-go/option\"\n)\n\nfunc main() {\n\tclient := openai.NewClient(\n\t\toption.WithAPIKey(\"My API Key\"),\n\t)\n\tcreateEmbeddingResponse, err := client.Embeddings.New(context.TODO(), openai.EmbeddingNewParams{\n\t\tInput: openai.EmbeddingNewParamsInputUnion{\n\t\t\tOfString: openai.String(\"The quick brown fox jumped over the lazy dog\"),\n\t\t},\n\t\tModel: openai.EmbeddingModelTextEmbedding3Small,\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf(\"%+v\\n\", createEmbeddingResponse.Data)\n}\n","java":"package com.openai.example;\n\nimport com.openai.client.OpenAIClient;\nimport com.openai.client.okhttp.OpenAIOkHttpClient;\nimport com.openai.models.embeddings.CreateEmbeddingResponse;\nimport com.openai.models.embeddings.EmbeddingCreateParams;\nimport com.openai.models.embeddings.EmbeddingModel;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n OpenAIClient client = OpenAIOkHttpClient.fromEnv();\n\n EmbeddingCreateParams params = EmbeddingCreateParams.builder()\n .input(\"The quick brown fox jumped over the lazy dog\")\n .model(EmbeddingModel.TEXT_EMBEDDING_3_SMALL)\n .build();\n CreateEmbeddingResponse createEmbeddingResponse = client.embeddings().create(params);\n }\n}","ruby":"require \"openai\"\n\nopenai = OpenAI::Client.new(api_key: \"My API Key\")\n\ncreate_embedding_response = openai.embeddings.create(\n input: \"The quick brown fox jumped over the lazy dog\",\n model: :\"text-embedding-3-small\"\n)\n\nputs(create_embedding_response)"},"response":"{\n \"object\": \"list\",\n \"data\": [\n {\n \"object\": \"embedding\",\n \"embedding\": [\n 0.0023064255,\n -0.009327292,\n .... (1536 floats total for ada-002)\n -0.0028842222,\n ],\n \"index\": 0\n }\n ],\n \"model\": \"text-embedding-ada-002\",\n \"usage\": {\n \"prompt_tokens\": 8,\n \"total_tokens\": 8\n }\n}\n"}}}},"/evals":{"get":{"operationId":"listEvals","tags":["Evals"],"summary":"List evaluations for a project.\n","parameters":[{"name":"after","in":"query","description":"Identifier for the last eval from the previous pagination request.","required":false,"schema":{"type":"string"}},{"name":"limit","in":"query","description":"Number of evals to retrieve.","required":false,"schema":{"type":"integer","default":20}},{"name":"order","in":"query","description":"Sort order for evals by timestamp. Use `asc` for ascending order or `desc` for descending order.","required":false,"schema":{"type":"string","enum":["asc","desc"],"default":"asc"}},{"name":"order_by","in":"query","description":"Evals can be ordered by creation time or last updated time. Use\n`created_at` for creation time or `updated_at` for last updated time.\n","required":false,"schema":{"type":"string","enum":["created_at","updated_at"],"default":"created_at"}}],"responses":{"200":{"description":"A list of evals","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EvalList"}}}}},"x-oaiMeta":{"name":"List evals","group":"evals","path":"list","examples":{"request":{"curl":"curl https://api.openai.com/v1/evals?limit=1 \\\n -H \"Authorization: Bearer $OPENAI_API_KEY\" \\\n -H \"Content-Type: application/json\"\n","python":"import os\nfrom openai import OpenAI\n\nclient = OpenAI(\n api_key=os.environ.get(\"OPENAI_API_KEY\"), # This is the default and can be omitted\n)\npage = client.evals.list()\npage = page.data[0]\nprint(page.id)","javascript":"import OpenAI from \"openai\";\n\nconst openai = new OpenAI();\n\nconst evals = await openai.evals.list({ limit: 1 });\nconsole.log(evals);\n","node.js":"import OpenAI from 'openai';\n\nconst client = new OpenAI({\n apiKey: process.env['OPENAI_API_KEY'], // This is the default and can be omitted\n});\n\n// Automatically fetches more pages as needed.\nfor await (const evalListResponse of client.evals.list()) {\n console.log(evalListResponse.id);\n}","java":"package com.openai.example;\n\nimport com.openai.client.OpenAIClient;\nimport com.openai.client.okhttp.OpenAIOkHttpClient;\nimport com.openai.models.evals.EvalListPage;\nimport com.openai.models.evals.EvalListParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n OpenAIClient client = OpenAIOkHttpClient.fromEnv();\n\n EvalListPage page = client.evals().list();\n }\n}","ruby":"require \"openai\"\n\nopenai = OpenAI::Client.new(api_key: \"My API Key\")\n\npage = openai.evals.list\n\nputs(page)"},"response":"{\n \"object\": \"list\",\n \"data\": [\n {\n \"id\": \"eval_67abd54d9b0081909a86353f6fb9317a\",\n \"object\": \"eval\",\n \"data_source_config\": {\n \"type\": \"stored_completions\",\n \"metadata\": {\n \"usecase\": \"push_notifications_summarizer\"\n },\n \"schema\": {\n \"type\": \"object\",\n \"properties\": {\n \"item\": {\n \"type\": \"object\"\n },\n \"sample\": {\n \"type\": \"object\"\n }\n },\n \"required\": [\n \"item\",\n \"sample\"\n ]\n }\n },\n \"testing_criteria\": [\n {\n \"name\": \"Push Notification Summary Grader\",\n \"id\": \"Push Notification Summary Grader-9b876f24-4762-4be9-aff4-db7a9b31c673\",\n \"type\": \"label_model\",\n \"model\": \"o3-mini\",\n \"input\": [\n {\n \"type\": \"message\",\n \"role\": \"developer\",\n \"content\": {\n \"type\": \"input_text\",\n \"text\": \"\\nLabel the following push notification summary as either correct or incorrect.\\nThe push notification and the summary will be provided below.\\nA good push notificiation summary is concise and snappy.\\nIf it is good, then label it as correct, if not, then incorrect.\\n\"\n }\n },\n {\n \"type\": \"message\",\n \"role\": \"user\",\n \"content\": {\n \"type\": \"input_text\",\n \"text\": \"\\nPush notifications: {{item.input}}\\nSummary: {{sample.output_text}}\\n\"\n }\n }\n ],\n \"passing_labels\": [\n \"correct\"\n ],\n \"labels\": [\n \"correct\",\n \"incorrect\"\n ],\n \"sampling_params\": null\n }\n ],\n \"name\": \"Push Notification Summary Grader\",\n \"created_at\": 1739314509,\n \"metadata\": {\n \"description\": \"A stored completions eval for push notification summaries\"\n }\n }\n ],\n \"first_id\": \"eval_67abd54d9b0081909a86353f6fb9317a\",\n \"last_id\": \"eval_67aa884cf6688190b58f657d4441c8b7\",\n \"has_more\": true\n}\n"}}},"post":{"operationId":"createEval","tags":["Evals"],"summary":"Create the structure of an evaluation that can be used to test a model's performance.\nAn evaluation is a set of testing criteria and the config for a data source, which dictates the schema of the data used in the evaluation. After creating an evaluation, you can run it on different models and model parameters. We support several types of graders and datasources.\nFor more information, see the [Evals guide](/docs/guides/evals).\n","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateEvalRequest"}}}},"responses":{"201":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Eval"}}}}},"x-oaiMeta":{"name":"Create eval","group":"evals","path":"post","examples":{"request":{"curl":"curl https://api.openai.com/v1/evals \\\n -H \"Authorization: Bearer $OPENAI_API_KEY\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"name\": \"Sentiment\",\n \"data_source_config\": {\n \"type\": \"stored_completions\",\n \"metadata\": {\n \"usecase\": \"chatbot\"\n }\n },\n \"testing_criteria\": [\n {\n \"type\": \"label_model\",\n \"model\": \"o3-mini\",\n \"input\": [\n {\n \"role\": \"developer\",\n \"content\": \"Classify the sentiment of the following statement as one of 'positive', 'neutral', or 'negative'\"\n },\n {\n \"role\": \"user\",\n \"content\": \"Statement: {{item.input}}\"\n }\n ],\n \"passing_labels\": [\n \"positive\"\n ],\n \"labels\": [\n \"positive\",\n \"neutral\",\n \"negative\"\n ],\n \"name\": \"Example label grader\"\n }\n ]\n }'\n","python":"import os\nfrom openai import OpenAI\n\nclient = OpenAI(\n api_key=os.environ.get(\"OPENAI_API_KEY\"), # This is the default and can be omitted\n)\neval = client.evals.create(\n data_source_config={\n \"item_schema\": {\n \"foo\": \"bar\"\n },\n \"type\": \"custom\",\n },\n testing_criteria=[{\n \"input\": [{\n \"content\": \"content\",\n \"role\": \"role\",\n }],\n \"labels\": [\"string\"],\n \"model\": \"model\",\n \"name\": \"name\",\n \"passing_labels\": [\"string\"],\n \"type\": \"label_model\",\n }],\n)\nprint(eval.id)","javascript":"import OpenAI from \"openai\";\n\nconst openai = new OpenAI();\n\nconst evalObj = await openai.evals.create({\n name: \"Sentiment\",\n data_source_config: {\n type: \"stored_completions\",\n metadata: { usecase: \"chatbot\" }\n },\n testing_criteria: [\n {\n type: \"label_model\",\n model: \"o3-mini\",\n input: [\n { role: \"developer\", content: \"Classify the sentiment of the following statement as one of 'positive', 'neutral', or 'negative'\" },\n { role: \"user\", content: \"Statement: {{item.input}}\" }\n ],\n passing_labels: [\"positive\"],\n labels: [\"positive\", \"neutral\", \"negative\"],\n name: \"Example label grader\"\n }\n ]\n});\nconsole.log(evalObj);\n","node.js":"import OpenAI from 'openai';\n\nconst client = new OpenAI({\n apiKey: process.env['OPENAI_API_KEY'], // This is the default and can be omitted\n});\n\nconst _eval = await client.evals.create({\n data_source_config: {\n item_schema: { foo: 'bar' },\n type: 'custom',\n },\n testing_criteria: [\n {\n input: [{ content: 'content', role: 'role' }],\n labels: ['string'],\n model: 'model',\n name: 'name',\n passing_labels: ['string'],\n type: 'label_model',\n },\n ],\n});\n\nconsole.log(_eval.id);","java":"package com.openai.example;\n\nimport com.openai.client.OpenAIClient;\nimport com.openai.client.okhttp.OpenAIOkHttpClient;\nimport com.openai.core.JsonValue;\nimport com.openai.models.evals.EvalCreateParams;\nimport com.openai.models.evals.EvalCreateResponse;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n OpenAIClient client = OpenAIOkHttpClient.fromEnv();\n\n EvalCreateParams params = EvalCreateParams.builder()\n .customDataSourceConfig(EvalCreateParams.DataSourceConfig.Custom.ItemSchema.builder()\n .putAdditionalProperty(\"foo\", JsonValue.from(\"bar\"))\n .build())\n .addTestingCriterion(EvalCreateParams.TestingCriterion.LabelModel.builder()\n .addInput(EvalCreateParams.TestingCriterion.LabelModel.Input.SimpleInputMessage.builder()\n .content(\"content\")\n .role(\"role\")\n .build())\n .addLabel(\"string\")\n .model(\"model\")\n .name(\"name\")\n .addPassingLabel(\"string\")\n .build())\n .build();\n EvalCreateResponse eval = client.evals().create(params);\n }\n}","ruby":"require \"openai\"\n\nopenai = OpenAI::Client.new(api_key: \"My API Key\")\n\neval_ = openai.evals.create(\n data_source_config: {item_schema: {foo: \"bar\"}, type: :custom},\n testing_criteria: [\n {\n input: [{content: \"content\", role: \"role\"}],\n labels: [\"string\"],\n model: \"model\",\n name: \"name\",\n passing_labels: [\"string\"],\n type: :label_model\n }\n ]\n)\n\nputs(eval_)"},"response":"{\n \"object\": \"eval\",\n \"id\": \"eval_67b7fa9a81a88190ab4aa417e397ea21\",\n \"data_source_config\": {\n \"type\": \"stored_completions\",\n \"metadata\": {\n \"usecase\": \"chatbot\"\n },\n \"schema\": {\n \"type\": \"object\",\n \"properties\": {\n \"item\": {\n \"type\": \"object\"\n },\n \"sample\": {\n \"type\": \"object\"\n }\n },\n \"required\": [\n \"item\",\n \"sample\"\n ]\n },\n \"testing_criteria\": [\n {\n \"name\": \"Example label grader\",\n \"type\": \"label_model\",\n \"model\": \"o3-mini\",\n \"input\": [\n {\n \"type\": \"message\",\n \"role\": \"developer\",\n \"content\": {\n \"type\": \"input_text\",\n \"text\": \"Classify the sentiment of the following statement as one of positive, neutral, or negative\"\n }\n },\n {\n \"type\": \"message\",\n \"role\": \"user\",\n \"content\": {\n \"type\": \"input_text\",\n \"text\": \"Statement: {{item.input}}\"\n }\n }\n ],\n \"passing_labels\": [\n \"positive\"\n ],\n \"labels\": [\n \"positive\",\n \"neutral\",\n \"negative\"\n ]\n }\n ],\n \"name\": \"Sentiment\",\n \"created_at\": 1740110490,\n \"metadata\": {\n \"description\": \"An eval for sentiment analysis\"\n }\n}\n"}}}},"/evals/{eval_id}":{"get":{"operationId":"getEval","tags":["Evals"],"summary":"Get an evaluation by ID.\n","parameters":[{"name":"eval_id","in":"path","required":true,"schema":{"type":"string"},"description":"The ID of the evaluation to retrieve."}],"responses":{"200":{"description":"The evaluation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Eval"}}}}},"x-oaiMeta":{"name":"Get an eval","group":"evals","path":"get","examples":{"request":{"curl":"curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a \\\n -H \"Authorization: Bearer $OPENAI_API_KEY\" \\\n -H \"Content-Type: application/json\"\n","python":"import os\nfrom openai import OpenAI\n\nclient = OpenAI(\n api_key=os.environ.get(\"OPENAI_API_KEY\"), # This is the default and can be omitted\n)\neval = client.evals.retrieve(\n \"eval_id\",\n)\nprint(eval.id)","javascript":"import OpenAI from \"openai\";\n\nconst openai = new OpenAI();\n\nconst evalObj = await openai.evals.retrieve(\"eval_67abd54d9b0081909a86353f6fb9317a\");\nconsole.log(evalObj);\n","node.js":"import OpenAI from 'openai';\n\nconst client = new OpenAI({\n apiKey: process.env['OPENAI_API_KEY'], // This is the default and can be omitted\n});\n\nconst _eval = await client.evals.retrieve('eval_id');\n\nconsole.log(_eval.id);","java":"package com.openai.example;\n\nimport com.openai.client.OpenAIClient;\nimport com.openai.client.okhttp.OpenAIOkHttpClient;\nimport com.openai.models.evals.EvalRetrieveParams;\nimport com.openai.models.evals.EvalRetrieveResponse;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n OpenAIClient client = OpenAIOkHttpClient.fromEnv();\n\n EvalRetrieveResponse eval = client.evals().retrieve(\"eval_id\");\n }\n}","ruby":"require \"openai\"\n\nopenai = OpenAI::Client.new(api_key: \"My API Key\")\n\neval_ = openai.evals.retrieve(\"eval_id\")\n\nputs(eval_)"},"response":"{\n \"object\": \"eval\",\n \"id\": \"eval_67abd54d9b0081909a86353f6fb9317a\",\n \"data_source_config\": {\n \"type\": \"custom\",\n \"schema\": {\n \"type\": \"object\",\n \"properties\": {\n \"item\": {\n \"type\": \"object\",\n \"properties\": {\n \"input\": {\n \"type\": \"string\"\n },\n \"ground_truth\": {\n \"type\": \"string\"\n }\n },\n \"required\": [\n \"input\",\n \"ground_truth\"\n ]\n }\n },\n \"required\": [\n \"item\"\n ]\n }\n },\n \"testing_criteria\": [\n {\n \"name\": \"String check\",\n \"id\": \"String check-2eaf2d8d-d649-4335-8148-9535a7ca73c2\",\n \"type\": \"string_check\",\n \"input\": \"{{item.input}}\",\n \"reference\": \"{{item.ground_truth}}\",\n \"operation\": \"eq\"\n }\n ],\n \"name\": \"External Data Eval\",\n \"created_at\": 1739314509,\n \"metadata\": {},\n}\n"}}},"post":{"operationId":"updateEval","tags":["Evals"],"summary":"Update certain properties of an evaluation.\n","parameters":[{"name":"eval_id","in":"path","required":true,"schema":{"type":"string"},"description":"The ID of the evaluation to update."}],"requestBody":{"description":"Request to update an evaluation","required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"Rename the evaluation."},"metadata":{"$ref":"#/components/schemas/Metadata"}}}}}},"responses":{"200":{"description":"The updated evaluation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Eval"}}}}},"x-oaiMeta":{"name":"Update an eval","group":"evals","path":"update","examples":{"request":{"curl":"curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a \\\n -H \"Authorization: Bearer $OPENAI_API_KEY\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"name\": \"Updated Eval\", \"metadata\": {\"description\": \"Updated description\"}}'\n","python":"import os\nfrom openai import OpenAI\n\nclient = OpenAI(\n api_key=os.environ.get(\"OPENAI_API_KEY\"), # This is the default and can be omitted\n)\neval = client.evals.update(\n eval_id=\"eval_id\",\n)\nprint(eval.id)","javascript":"import OpenAI from \"openai\";\n\nconst openai = new OpenAI();\n\nconst updatedEval = await openai.evals.update(\n \"eval_67abd54d9b0081909a86353f6fb9317a\",\n {\n name: \"Updated Eval\",\n metadata: { description: \"Updated description\" }\n }\n);\nconsole.log(updatedEval);\n","node.js":"import OpenAI from 'openai';\n\nconst client = new OpenAI({\n apiKey: process.env['OPENAI_API_KEY'], // This is the default and can be omitted\n});\n\nconst _eval = await client.evals.update('eval_id');\n\nconsole.log(_eval.id);","java":"package com.openai.example;\n\nimport com.openai.client.OpenAIClient;\nimport com.openai.client.okhttp.OpenAIOkHttpClient;\nimport com.openai.models.evals.EvalUpdateParams;\nimport com.openai.models.evals.EvalUpdateResponse;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n OpenAIClient client = OpenAIOkHttpClient.fromEnv();\n\n EvalUpdateResponse eval = client.evals().update(\"eval_id\");\n }\n}","ruby":"require \"openai\"\n\nopenai = OpenAI::Client.new(api_key: \"My API Key\")\n\neval_ = openai.evals.update(\"eval_id\")\n\nputs(eval_)"},"response":"{\n \"object\": \"eval\",\n \"id\": \"eval_67abd54d9b0081909a86353f6fb9317a\",\n \"data_source_config\": {\n \"type\": \"custom\",\n \"schema\": {\n \"type\": \"object\",\n \"properties\": {\n \"item\": {\n \"type\": \"object\",\n \"properties\": {\n \"input\": {\n \"type\": \"string\"\n },\n \"ground_truth\": {\n \"type\": \"string\"\n }\n },\n \"required\": [\n \"input\",\n \"ground_truth\"\n ]\n }\n },\n \"required\": [\n \"item\"\n ]\n }\n },\n \"testing_criteria\": [\n {\n \"name\": \"String check\",\n \"id\": \"String check-2eaf2d8d-d649-4335-8148-9535a7ca73c2\",\n \"type\": \"string_check\",\n \"input\": \"{{item.input}}\",\n \"reference\": \"{{item.ground_truth}}\",\n \"operation\": \"eq\"\n }\n ],\n \"name\": \"Updated Eval\",\n \"created_at\": 1739314509,\n \"metadata\": {\"description\": \"Updated description\"},\n}\n"}}},"delete":{"operationId":"deleteEval","tags":["Evals"],"summary":"Delete an evaluation.\n","parameters":[{"name":"eval_id","in":"path","required":true,"schema":{"type":"string"},"description":"The ID of the evaluation to delete."}],"responses":{"200":{"description":"Successfully deleted the evaluation.","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","example":"eval.deleted"},"deleted":{"type":"boolean","example":true},"eval_id":{"type":"string","example":"eval_abc123"}},"required":["object","deleted","eval_id"]}}}},"404":{"description":"Evaluation not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-oaiMeta":{"name":"Delete an eval","group":"evals","examples":{"request":{"curl":"curl https://api.openai.com/v1/evals/eval_abc123 \\\n -X DELETE \\\n -H \"Authorization: Bearer $OPENAI_API_KEY\"\n","python":"import os\nfrom openai import OpenAI\n\nclient = OpenAI(\n api_key=os.environ.get(\"OPENAI_API_KEY\"), # This is the default and can be omitted\n)\neval = client.evals.delete(\n \"eval_id\",\n)\nprint(eval.eval_id)","javascript":"import OpenAI from \"openai\";\n\nconst openai = new OpenAI();\n\nconst deleted = await openai.evals.delete(\"eval_abc123\");\nconsole.log(deleted);\n","node.js":"import OpenAI from 'openai';\n\nconst client = new OpenAI({\n apiKey: process.env['OPENAI_API_KEY'], // This is the default and can be omitted\n});\n\nconst _eval = await client.evals.delete('eval_id');\n\nconsole.log(_eval.eval_id);","java":"package com.openai.example;\n\nimport com.openai.client.OpenAIClient;\nimport com.openai.client.okhttp.OpenAIOkHttpClient;\nimport com.openai.models.evals.EvalDeleteParams;\nimport com.openai.models.evals.EvalDeleteResponse;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n OpenAIClient client = OpenAIOkHttpClient.fromEnv();\n\n EvalDeleteResponse eval = client.evals().delete(\"eval_id\");\n }\n}","ruby":"require \"openai\"\n\nopenai = OpenAI::Client.new(api_key: \"My API Key\")\n\neval_ = openai.evals.delete(\"eval_id\")\n\nputs(eval_)"},"response":"{\n \"object\": \"eval.deleted\",\n \"deleted\": true,\n \"eval_id\": \"eval_abc123\"\n}\n"}}}},"/evals/{eval_id}/runs":{"get":{"operationId":"getEvalRuns","tags":["Evals"],"summary":"Get a list of runs for an evaluation.\n","parameters":[{"name":"eval_id","in":"path","required":true,"schema":{"type":"string"},"description":"The ID of the evaluation to retrieve runs for."},{"name":"after","in":"query","description":"Identifier for the last run from the previous pagination request.","required":false,"schema":{"type":"string"}},{"name":"limit","in":"query","description":"Number of runs to retrieve.","required":false,"schema":{"type":"integer","default":20}},{"name":"order","in":"query","description":"Sort order for runs by timestamp. Use `asc` for ascending order or `desc` for descending order. Defaults to `asc`.","required":false,"schema":{"type":"string","enum":["asc","desc"],"default":"asc"}},{"name":"status","in":"query","description":"Filter runs by status. One of `queued` | `in_progress` | `failed` | `completed` | `canceled`.","required":false,"schema":{"type":"string","enum":["queued","in_progress","completed","canceled","failed"]}}],"responses":{"200":{"description":"A list of runs for the evaluation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EvalRunList"}}}}},"x-oaiMeta":{"name":"Get eval runs","group":"evals","path":"get-runs","examples":{"request":{"curl":"curl https://api.openai.com/v1/evals/egroup_67abd54d9b0081909a86353f6fb9317a/runs \\\n -H \"Authorization: Bearer $OPENAI_API_KEY\" \\\n -H \"Content-Type: application/json\"\n","python":"import os\nfrom openai import OpenAI\n\nclient = OpenAI(\n api_key=os.environ.get(\"OPENAI_API_KEY\"), # This is the default and can be omitted\n)\npage = client.evals.runs.list(\n eval_id=\"eval_id\",\n)\npage = page.data[0]\nprint(page.id)","javascript":"import OpenAI from \"openai\";\n\nconst openai = new OpenAI();\n\nconst runs = await openai.evals.runs.list(\"egroup_67abd54d9b0081909a86353f6fb9317a\");\nconsole.log(runs);\n","node.js":"import OpenAI from 'openai';\n\nconst client = new OpenAI({\n apiKey: process.env['OPENAI_API_KEY'], // This is the default and can be omitted\n});\n\n// Automatically fetches more pages as needed.\nfor await (const runListResponse of client.evals.runs.list('eval_id')) {\n console.log(runListResponse.id);\n}","java":"package com.openai.example;\n\nimport com.openai.client.OpenAIClient;\nimport com.openai.client.okhttp.OpenAIOkHttpClient;\nimport com.openai.models.evals.runs.RunListPage;\nimport com.openai.models.evals.runs.RunListParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n OpenAIClient client = OpenAIOkHttpClient.fromEnv();\n\n RunListPage page = client.evals().runs().list(\"eval_id\");\n }\n}","ruby":"require \"openai\"\n\nopenai = OpenAI::Client.new(api_key: \"My API Key\")\n\npage = openai.evals.runs.list(\"eval_id\")\n\nputs(page)"},"response":"{\n \"object\": \"list\",\n \"data\": [\n {\n \"object\": \"eval.run\",\n \"id\": \"evalrun_67e0c7d31560819090d60c0780591042\",\n \"eval_id\": \"eval_67e0c726d560819083f19a957c4c640b\",\n \"report_url\": \"https://platform.openai.com/evaluations/eval_67e0c726d560819083f19a957c4c640b\",\n \"status\": \"completed\",\n \"model\": \"o3-mini\",\n \"name\": \"bulk_with_negative_examples_o3-mini\",\n \"created_at\": 1742784467,\n \"result_counts\": {\n \"total\": 1,\n \"errored\": 0,\n \"failed\": 0,\n \"passed\": 1\n },\n \"per_model_usage\": [\n {\n \"model_name\": \"o3-mini\",\n \"invocation_count\": 1,\n \"prompt_tokens\": 563,\n \"completion_tokens\": 874,\n \"total_tokens\": 1437,\n \"cached_tokens\": 0\n }\n ],\n \"per_testing_criteria_results\": [\n {\n \"testing_criteria\": \"Push Notification Summary Grader-1808cd0b-eeec-4e0b-a519-337e79f4f5d1\",\n \"passed\": 1,\n \"failed\": 0\n }\n ],\n \"data_source\": {\n \"type\": \"completions\",\n \"source\": {\n \"type\": \"file_content\",\n \"content\": [\n {\n \"item\": {\n \"notifications\": \"\\n- New message from Sarah: \\\"Can you call me later?\\\"\\n- Your package has been delivered!\\n- Flash sale: 20% off electronics for the next 2 hours!\\n\"\n }\n }\n ]\n },\n \"input_messages\": {\n \"type\": \"template\",\n \"template\": [\n {\n \"type\": \"message\",\n \"role\": \"developer\",\n \"content\": {\n \"type\": \"input_text\",\n \"text\": \"\\n\\n\\n\\nYou are a helpful assistant that takes in an array of push notifications and returns a collapsed summary of them.\\nThe push notification will be provided as follows:\\n<push_notifications>\\n...notificationlist...\\n</push_notifications>\\n\\nYou should return just the summary and nothing else.\\n\\n\\nYou should return a summary that is concise and snappy.\\n\\n\\nHere is an example of a good summary:\\n<push_notifications>\\n- Traffic alert: Accident reported on Main Street.- Package out for delivery: Expected by 5 PM.- New friend suggestion: Connect with Emma.\\n</push_notifications>\\n<summary>\\nTraffic alert, package expected by 5pm, suggestion for new friend (Emily).\\n</summary>\\n\\n\\nHere is an example of a bad summary:\\n<push_notifications>\\n- Traffic alert: Accident reported on Main Street.- Package out for delivery: Expected by 5 PM.- New friend suggestion: Connect with Emma.\\n</push_notifications>\\n<summary>\\nTraffic alert reported on main street. You have a package that will arrive by 5pm, Emily is a new friend suggested for you.\\n</summary>\\n\"\n }\n },\n {\n \"type\": \"message\",\n \"role\": \"user\",\n \"content\": {\n \"type\": \"input_text\",\n \"text\": \"<push_notifications>{{item.notifications}}</push_notifications>\"\n }\n }\n ]\n },\n \"model\": \"o3-mini\",\n \"sampling_params\": null\n },\n \"error\": null,\n \"metadata\": {}\n }\n ],\n \"first_id\": \"evalrun_67e0c7d31560819090d60c0780591042\",\n \"last_id\": \"evalrun_67e0c7d31560819090d60c0780591042\",\n \"has_more\": true\n}\n"}}},"post":{"operationId":"createEvalRun","tags":["Evals"],"summary":"Kicks off a new run for a given evaluation, specifying the data source, and what model configuration to use to test. The datasource will be validated against the schema specified in the config of the evaluation.\n","parameters":[{"in":"path","name":"eval_id","required":true,"schema":{"type":"string"},"description":"The ID of the evaluation to create a run for."}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateEvalRunRequest"}}}},"responses":{"201":{"description":"Successfully created a run for the evaluation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EvalRun"}}}},"400":{"description":"Bad request (for example, missing eval object)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-oaiMeta":{"name":"Create eval run","group":"evals","examples":{"request":{"curl":"curl https://api.openai.com/v1/evals/eval_67e579652b548190aaa83ada4b125f47/runs \\\n -X POST \\\n -H \"Authorization: Bearer $OPENAI_API_KEY\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"name\":\"gpt-4o-mini\",\"data_source\":{\"type\":\"completions\",\"input_messages\":{\"type\":\"template\",\"template\":[{\"role\":\"developer\",\"content\":\"Categorize a given news headline into one of the following topics: Technology, Markets, World, Business, or Sports.\\n\\n# Steps\\n\\n1. Analyze the content of the news headline to understand its primary focus.\\n2. Extract the subject matter, identifying any key indicators or keywords.\\n3. Use the identified indicators to determine the most suitable category out of the five options: Technology, Markets, World, Business, or Sports.\\n4. Ensure only one category is selected per headline.\\n\\n# Output Format\\n\\nRespond with the chosen category as a single word. For instance: \\\"Technology\\\", \\\"Markets\\\", \\\"World\\\", \\\"Business\\\", or \\\"Sports\\\".\\n\\n# Examples\\n\\n**Input**: \\\"Apple Unveils New iPhone Model, Featuring Advanced AI Features\\\" \\n**Output**: \\\"Technology\\\"\\n\\n**Input**: \\\"Global Stocks Mixed as Investors Await Central Bank Decisions\\\" \\n**Output**: \\\"Markets\\\"\\n\\n**Input**: \\\"War in Ukraine: Latest Updates on Negotiation Status\\\" \\n**Output**: \\\"World\\\"\\n\\n**Input**: \\\"Microsoft in Talks to Acquire Gaming Company for $2 Billion\\\" \\n**Output**: \\\"Business\\\"\\n\\n**Input**: \\\"Manchester United Secures Win in Premier League Football Match\\\" \\n**Output**: \\\"Sports\\\" \\n\\n# Notes\\n\\n- If the headline appears to fit into more than one category, choose the most dominant theme.\\n- Keywords or phrases such as \\\"stocks\\\", \\\"company acquisition\\\", \\\"match\\\", or technological brands can be good indicators for classification.\\n\"} , {\"role\":\"user\",\"content\":\"{{item.input}}\"}]} ,\"sampling_params\":{\"temperature\":1,\"max_completions_tokens\":2048,\"top_p\":1,\"seed\":42},\"model\":\"gpt-4o-mini\",\"source\":{\"type\":\"file_content\",\"content\":[{\"item\":{\"input\":\"Tech Company Launches Advanced Artificial Intelligence Platform\",\"ground_truth\":\"Technology\"}}]}}'\n","python":"import os\nfrom openai import OpenAI\n\nclient = OpenAI(\n api_key=os.environ.get(\"OPENAI_API_KEY\"), # This is the default and can be omitted\n)\nrun = client.evals.runs.create(\n eval_id=\"eval_id\",\n data_source={\n \"source\": {\n \"content\": [{\n \"item\": {\n \"foo\": \"bar\"\n }\n }],\n \"type\": \"file_content\",\n },\n \"type\": \"jsonl\",\n },\n)\nprint(run.id)","javascript":"import OpenAI from \"openai\";\n\nconst openai = new OpenAI();\n\nconst run = await openai.evals.runs.create(\n \"eval_67e579652b548190aaa83ada4b125f47\",\n {\n name: \"gpt-4o-mini\",\n data_source: {\n type: \"completions\",\n input_messages: {\n type: \"template\",\n template: [\n {\n role: \"developer\",\n content: \"Categorize a given news headline into one of the following topics: Technology, Markets, World, Business, or Sports.\\n\\n# Steps\\n\\n1. Analyze the content of the news headline to understand its primary focus.\\n2. Extract the subject matter, identifying any key indicators or keywords.\\n3. Use the identified indicators to determine the most suitable category out of the five options: Technology, Markets, World, Business, or Sports.\\n4. Ensure only one category is selected per headline.\\n\\n# Output Format\\n\\nRespond with the chosen category as a single word. For instance: \\\"Technology\\\", \\\"Markets\\\", \\\"World\\\", \\\"Business\\\", or \\\"Sports\\\".\\n\\n# Examples\\n\\n**Input**: \\\"Apple Unveils New iPhone Model, Featuring Advanced AI Features\\\" \\n**Output**: \\\"Technology\\\"\\n\\n**Input**: \\\"Global Stocks Mixed as Investors Await Central Bank Decisions\\\" \\n**Output**: \\\"Markets\\\"\\n\\n**Input**: \\\"War in Ukraine: Latest Updates on Negotiation Status\\\" \\n**Output**: \\\"World\\\"\\n\\n**Input**: \\\"Microsoft in Talks to Acquire Gaming Company for $2 Billion\\\" \\n**Output**: \\\"Business\\\"\\n\\n**Input**: \\\"Manchester United Secures Win in Premier League Football Match\\\" \\n**Output**: \\\"Sports\\\" \\n\\n# Notes\\n\\n- If the headline appears to fit into more than one category, choose the most dominant theme.\\n- Keywords or phrases such as \\\"stocks\\\", \\\"company acquisition\\\", \\\"match\\\", or technological brands can be good indicators for classification.\\n\"\n },\n {\n role: \"user\",\n content: \"{{item.input}}\"\n }\n ]\n },\n sampling_params: {\n temperature: 1,\n max_completions_tokens: 2048,\n top_p: 1,\n seed: 42\n },\n model: \"gpt-4o-mini\",\n source: {\n type: \"file_content\",\n content: [\n {\n item: {\n input: \"Tech Company Launches Advanced Artificial Intelligence Platform\",\n ground_truth: \"Technology\"\n }\n }\n ]\n }\n }\n }\n);\nconsole.log(run);\n","node.js":"import OpenAI from 'openai';\n\nconst client = new OpenAI({\n apiKey: process.env['OPENAI_API_KEY'], // This is the default and can be omitted\n});\n\nconst run = await client.evals.runs.create('eval_id', {\n data_source: {\n source: { content: [{ item: { foo: 'bar' } }], type: 'file_content' },\n type: 'jsonl',\n },\n});\n\nconsole.log(run.id);","java":"package com.openai.example;\n\nimport com.openai.client.OpenAIClient;\nimport com.openai.client.okhttp.OpenAIOkHttpClient;\nimport com.openai.core.JsonValue;\nimport com.openai.models.evals.runs.CreateEvalJsonlRunDataSource;\nimport com.openai.models.evals.runs.RunCreateParams;\nimport com.openai.models.evals.runs.RunCreateResponse;\nimport java.util.List;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n OpenAIClient client = OpenAIOkHttpClient.fromEnv();\n\n RunCreateParams params = RunCreateParams.builder()\n .evalId(\"eval_id\")\n .dataSource(CreateEvalJsonlRunDataSource.builder()\n .fileContentSource(List.of(CreateEvalJsonlRunDataSource.Source.FileContent.Content.builder()\n .item(CreateEvalJsonlRunDataSource.Source.FileContent.Content.Item.builder()\n .putAdditionalProperty(\"foo\", JsonValue.from(\"bar\"))\n .build())\n .build()))\n .build())\n .build();\n RunCreateResponse run = client.evals().runs().create(params);\n }\n}","ruby":"require \"openai\"\n\nopenai = OpenAI::Client.new(api_key: \"My API Key\")\n\nrun = openai.evals.runs.create(\n \"eval_id\",\n data_source: {source: {content: [{item: {foo: \"bar\"}}], type: :file_content}, type: :jsonl}\n)\n\nputs(run)"},"response":"{\n \"object\": \"eval.run\",\n \"id\": \"evalrun_67e57965b480819094274e3a32235e4c\",\n \"eval_id\": \"eval_67e579652b548190aaa83ada4b125f47\",\n \"report_url\": \"https://platform.openai.com/evaluations/eval_67e579652b548190aaa83ada4b125f47&run_id=evalrun_67e57965b480819094274e3a32235e4c\",\n \"status\": \"queued\",\n \"model\": \"gpt-4o-mini\",\n \"name\": \"gpt-4o-mini\",\n \"created_at\": 1743092069,\n \"result_counts\": {\n \"total\": 0,\n \"errored\": 0,\n \"failed\": 0,\n \"passed\": 0\n },\n \"per_model_usage\": null,\n \"per_testing_criteria_results\": null,\n \"data_source\": {\n \"type\": \"completions\",\n \"source\": {\n \"type\": \"file_content\",\n \"content\": [\n {\n \"item\": {\n \"input\": \"Tech Company Launches Advanced Artificial Intelligence Platform\",\n \"ground_truth\": \"Technology\"\n }\n }\n ]\n },\n \"input_messages\": {\n \"type\": \"template\",\n \"template\": [\n {\n \"type\": \"message\",\n \"role\": \"developer\",\n \"content\": {\n \"type\": \"input_text\",\n \"text\": \"Categorize a given news headline into one of the following topics: Technology, Markets, World, Business, or Sports.\\n\\n# Steps\\n\\n1. Analyze the content of the news headline to understand its primary focus.\\n2. Extract the subject matter, identifying any key indicators or keywords.\\n3. Use the identified indicators to determine the most suitable category out of the five options: Technology, Markets, World, Business, or Sports.\\n4. Ensure only one category is selected per headline.\\n\\n# Output Format\\n\\nRespond with the chosen category as a single word. For instance: \\\"Technology\\\", \\\"Markets\\\", \\\"World\\\", \\\"Business\\\", or \\\"Sports\\\".\\n\\n# Examples\\n\\n**Input**: \\\"Apple Unveils New iPhone Model, Featuring Advanced AI Features\\\" \\n**Output**: \\\"Technology\\\"\\n\\n**Input**: \\\"Global Stocks Mixed as Investors Await Central Bank Decisions\\\" \\n**Output**: \\\"Markets\\\"\\n\\n**Input**: \\\"War in Ukraine: Latest Updates on Negotiation Status\\\" \\n**Output**: \\\"World\\\"\\n\\n**Input**: \\\"Microsoft in Talks to Acquire Gaming Company for $2 Billion\\\" \\n**Output**: \\\"Business\\\"\\n\\n**Input**: \\\"Manchester United Secures Win in Premier League Football Match\\\" \\n**Output**: \\\"Sports\\\" \\n\\n# Notes\\n\\n- If the headline appears to fit into more than one category, choose the most dominant theme.\\n- Keywords or phrases such as \\\"stocks\\\", \\\"company acquisition\\\", \\\"match\\\", or technological brands can be good indicators for classification.\\n\"\n }\n },\n {\n \"type\": \"message\",\n \"role\": \"user\",\n \"content\": {\n \"type\": \"input_text\",\n \"text\": \"{{item.input}}\"\n }\n }\n ]\n },\n \"model\": \"gpt-4o-mini\",\n \"sampling_params\": {\n \"seed\": 42,\n \"temperature\": 1.0,\n \"top_p\": 1.0,\n \"max_completions_tokens\": 2048\n }\n },\n \"error\": null,\n \"metadata\": {}\n}\n"}}}},"/evals/{eval_id}/runs/{run_id}":{"get":{"operationId":"getEvalRun","tags":["Evals"],"summary":"Get an evaluation run by ID.\n","parameters":[{"name":"eval_id","in":"path","required":true,"schema":{"type":"string"},"description":"The ID of the evaluation to retrieve runs for."},{"name":"run_id","in":"path","required":true,"schema":{"type":"string"},"description":"The ID of the run to retrieve."}],"responses":{"200":{"description":"The evaluation run","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EvalRun"}}}}},"x-oaiMeta":{"name":"Get an eval run","group":"evals","path":"get","examples":{"request":{"curl":"curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/evalrun_67abd54d60ec8190832b46859da808f7 \\\n -H \"Authorization: Bearer $OPENAI_API_KEY\" \\\n -H \"Content-Type: application/json\"\n","python":"import os\nfrom openai import OpenAI\n\nclient = OpenAI(\n api_key=os.environ.get(\"OPENAI_API_KEY\"), # This is the default and can be omitted\n)\nrun = client.evals.runs.retrieve(\n run_id=\"run_id\",\n eval_id=\"eval_id\",\n)\nprint(run.id)","javascript":"import OpenAI from \"openai\";\n\nconst openai = new OpenAI();\n\nconst run = await openai.evals.runs.retrieve(\n \"evalrun_67abd54d60ec8190832b46859da808f7\",\n { eval_id: \"eval_67abd54d9b0081909a86353f6fb9317a\" }\n);\nconsole.log(run);\n","node.js":"import OpenAI from 'openai';\n\nconst client = new OpenAI({\n apiKey: process.env['OPENAI_API_KEY'], // This is the default and can be omitted\n});\n\nconst run = await client.evals.runs.retrieve('run_id', { eval_id: 'eval_id' });\n\nconsole.log(run.id);","java":"package com.openai.example;\n\nimport com.openai.client.OpenAIClient;\nimport com.openai.client.okhttp.OpenAIOkHttpClient;\nimport com.openai.models.evals.runs.RunRetrieveParams;\nimport com.openai.models.evals.runs.RunRetrieveResponse;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n OpenAIClient client = OpenAIOkHttpClient.fromEnv();\n\n RunRetrieveParams params = RunRetrieveParams.builder()\n .evalId(\"eval_id\")\n .runId(\"run_id\")\n .build();\n RunRetrieveResponse run = client.evals().runs().retrieve(params);\n }\n}","ruby":"require \"openai\"\n\nopenai = OpenAI::Client.new(api_key: \"My API Key\")\n\nrun = openai.evals.runs.retrieve(\"run_id\", eval_id: \"eval_id\")\n\nputs(run)"},"response":"{\n \"object\": \"eval.run\",\n \"id\": \"evalrun_67abd54d60ec8190832b46859da808f7\",\n \"eval_id\": \"eval_67abd54d9b0081909a86353f6fb9317a\",\n \"report_url\": \"https://platform.openai.com/evaluations/eval_67abd54d9b0081909a86353f6fb9317a?run_id=evalrun_67abd54d60ec8190832b46859da808f7\",\n \"status\": \"queued\",\n \"model\": \"gpt-4o-mini\",\n \"name\": \"gpt-4o-mini\",\n \"created_at\": 1743092069,\n \"result_counts\": {\n \"total\": 0,\n \"errored\": 0,\n \"failed\": 0,\n \"passed\": 0\n },\n \"per_model_usage\": null,\n \"per_testing_criteria_results\": null,\n \"data_source\": {\n \"type\": \"completions\",\n \"source\": {\n \"type\": \"file_content\",\n \"content\": [\n {\n \"item\": {\n \"input\": \"Tech Company Launches Advanced Artificial Intelligence Platform\",\n \"ground_truth\": \"Technology\"\n }\n },\n {\n \"item\": {\n \"input\": \"Central Bank Increases Interest Rates Amid Inflation Concerns\",\n \"ground_truth\": \"Markets\"\n }\n },\n {\n \"item\": {\n \"input\": \"International Summit Addresses Climate Change Strategies\",\n \"ground_truth\": \"World\"\n }\n },\n {\n \"item\": {\n \"input\": \"Major Retailer Reports Record-Breaking Holiday Sales\",\n \"ground_truth\": \"Business\"\n }\n },\n {\n \"item\": {\n \"input\": \"National Team Qualifies for World Championship Finals\",\n \"ground_truth\": \"Sports\"\n }\n },\n {\n \"item\": {\n \"input\": \"Stock Markets Rally After Positive Economic Data Released\",\n \"ground_truth\": \"Markets\"\n }\n },\n {\n \"item\": {\n \"input\": \"Global Manufacturer Announces Merger with Competitor\",\n \"ground_truth\": \"Business\"\n }\n },\n {\n \"item\": {\n \"input\": \"Breakthrough in Renewable Energy Technology Unveiled\",\n \"ground_truth\": \"Technology\"\n }\n },\n {\n \"item\": {\n \"input\": \"World Leaders Sign Historic Climate Agreement\",\n \"ground_truth\": \"World\"\n }\n },\n {\n \"item\": {\n \"input\": \"Professional Athlete Sets New Record in Championship Event\",\n \"ground_truth\": \"Sports\"\n }\n },\n {\n \"item\": {\n \"input\": \"Financial Institutions Adapt to New Regulatory Requirements\",\n \"ground_truth\": \"Business\"\n }\n },\n {\n \"item\": {\n \"input\": \"Tech Conference Showcases Advances in Artificial Intelligence\",\n \"ground_truth\": \"Technology\"\n }\n },\n {\n \"item\": {\n \"input\": \"Global Markets Respond to Oil Price Fluctuations\",\n \"ground_truth\": \"Markets\"\n }\n },\n {\n \"item\": {\n \"input\": \"International Cooperation Strengthened Through New Treaty\",\n \"ground_truth\": \"World\"\n }\n },\n {\n \"item\": {\n \"input\": \"Sports League Announces Revised Schedule for Upcoming Season\",\n \"ground_truth\": \"Sports\"\n }\n }\n ]\n },\n \"input_messages\": {\n \"type\": \"template\",\n \"template\": [\n {\n \"type\": \"message\",\n \"role\": \"developer\",\n \"content\": {\n \"type\": \"input_text\",\n \"text\": \"Categorize a given news headline into one of the following topics: Technology, Markets, World, Business, or Sports.\\n\\n# Steps\\n\\n1. Analyze the content of the news headline to understand its primary focus.\\n2. Extract the subject matter, identifying any key indicators or keywords.\\n3. Use the identified indicators to determine the most suitable category out of the five options: Technology, Markets, World, Business, or Sports.\\n4. Ensure only one category is selected per headline.\\n\\n# Output Format\\n\\nRespond with the chosen category as a single word. For instance: \\\"Technology\\\", \\\"Markets\\\", \\\"World\\\", \\\"Business\\\", or \\\"Sports\\\".\\n\\n# Examples\\n\\n**Input**: \\\"Apple Unveils New iPhone Model, Featuring Advanced AI Features\\\" \\n**Output**: \\\"Technology\\\"\\n\\n**Input**: \\\"Global Stocks Mixed as Investors Await Central Bank Decisions\\\" \\n**Output**: \\\"Markets\\\"\\n\\n**Input**: \\\"War in Ukraine: Latest Updates on Negotiation Status\\\" \\n**Output**: \\\"World\\\"\\n\\n**Input**: \\\"Microsoft in Talks to Acquire Gaming Company for $2 Billion\\\" \\n**Output**: \\\"Business\\\"\\n\\n**Input**: \\\"Manchester United Secures Win in Premier League Football Match\\\" \\n**Output**: \\\"Sports\\\" \\n\\n# Notes\\n\\n- If the headline appears to fit into more than one category, choose the most dominant theme.\\n- Keywords or phrases such as \\\"stocks\\\", \\\"company acquisition\\\", \\\"match\\\", or technological brands can be good indicators for classification.\\n\"\n }\n },\n {\n \"type\": \"message\",\n \"role\": \"user\",\n \"content\": {\n \"type\": \"input_text\",\n \"text\": \"{{item.input}}\"\n }\n }\n ]\n },\n \"model\": \"gpt-4o-mini\",\n \"sampling_params\": {\n \"seed\": 42,\n \"temperature\": 1.0,\n \"top_p\": 1.0,\n \"max_completions_tokens\": 2048\n }\n },\n \"error\": null,\n \"metadata\": {}\n}\n"}}},"post":{"operationId":"cancelEvalRun","tags":["Evals"],"summary":"Cancel an ongoing evaluation run.\n","parameters":[{"name":"eval_id","in":"path","required":true,"schema":{"type":"string"},"description":"The ID of the evaluation whose run you want to cancel."},{"name":"run_id","in":"path","required":true,"schema":{"type":"string"},"description":"The ID of the run to cancel."}],"responses":{"200":{"description":"The canceled eval run object","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EvalRun"}}}}},"x-oaiMeta":{"name":"Cancel eval run","group":"evals","path":"post","examples":{"request":{"curl":"curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/evalrun_67abd54d60ec8190832b46859da808f7/cancel \\\n -X POST \\\n -H \"Authorization: Bearer $OPENAI_API_KEY\" \\\n -H \"Content-Type: application/json\"\n","python":"import os\nfrom openai import OpenAI\n\nclient = OpenAI(\n api_key=os.environ.get(\"OPENAI_API_KEY\"), # This is the default and can be omitted\n)\nresponse = client.evals.runs.cancel(\n run_id=\"run_id\",\n eval_id=\"eval_id\",\n)\nprint(response.id)","javascript":"import OpenAI from \"openai\";\n\nconst openai = new OpenAI();\n\nconst canceledRun = await openai.evals.runs.cancel(\n \"evalrun_67abd54d60ec8190832b46859da808f7\",\n { eval_id: \"eval_67abd54d9b0081909a86353f6fb9317a\" }\n);\nconsole.log(canceledRun);\n","node.js":"import OpenAI from 'openai';\n\nconst client = new OpenAI({\n apiKey: process.env['OPENAI_API_KEY'], // This is the default and can be omitted\n});\n\nconst response = await client.evals.runs.cancel('run_id', { eval_id: 'eval_id' });\n\nconsole.log(response.id);","java":"package com.openai.example;\n\nimport com.openai.client.OpenAIClient;\nimport com.openai.client.okhttp.OpenAIOkHttpClient;\nimport com.openai.models.evals.runs.RunCancelParams;\nimport com.openai.models.evals.runs.RunCancelResponse;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n OpenAIClient client = OpenAIOkHttpClient.fromEnv();\n\n RunCancelParams params = RunCancelParams.builder()\n .evalId(\"eval_id\")\n .runId(\"run_id\")\n .build();\n RunCancelResponse response = client.evals().runs().cancel(params);\n }\n}","ruby":"require \"openai\"\n\nopenai = OpenAI::Client.new(api_key: \"My API Key\")\n\nresponse = openai.evals.runs.cancel(\"run_id\", eval_id: \"eval_id\")\n\nputs(response)"},"response":"{\n \"object\": \"eval.run\",\n \"id\": \"evalrun_67abd54d60ec8190832b46859da808f7\",\n \"eval_id\": \"eval_67abd54d9b0081909a86353f6fb9317a\",\n \"report_url\": \"https://platform.openai.com/evaluations/eval_67abd54d9b0081909a86353f6fb9317a?run_id=evalrun_67abd54d60ec8190832b46859da808f7\",\n \"status\": \"canceled\",\n \"model\": \"gpt-4o-mini\",\n \"name\": \"gpt-4o-mini\",\n \"created_at\": 1743092069,\n \"result_counts\": {\n \"total\": 0,\n \"errored\": 0,\n \"failed\": 0,\n \"passed\": 0\n },\n \"per_model_usage\": null,\n \"per_testing_criteria_results\": null,\n \"data_source\": {\n \"type\": \"completions\",\n \"source\": {\n \"type\": \"file_content\",\n \"content\": [\n {\n \"item\": {\n \"input\": \"Tech Company Launches Advanced Artificial Intelligence Platform\",\n \"ground_truth\": \"Technology\"\n }\n },\n {\n \"item\": {\n \"input\": \"Central Bank Increases Interest Rates Amid Inflation Concerns\",\n \"ground_truth\": \"Markets\"\n }\n },\n {\n \"item\": {\n \"input\": \"International Summit Addresses Climate Change Strategies\",\n \"ground_truth\": \"World\"\n }\n },\n {\n \"item\": {\n \"input\": \"Major Retailer Reports Record-Breaking Holiday Sales\",\n \"ground_truth\": \"Business\"\n }\n },\n {\n \"item\": {\n \"input\": \"National Team Qualifies for World Championship Finals\",\n \"ground_truth\": \"Sports\"\n }\n },\n {\n \"item\": {\n \"input\": \"Stock Markets Rally After Positive Economic Data Released\",\n \"ground_truth\": \"Markets\"\n }\n },\n {\n \"item\": {\n \"input\": \"Global Manufacturer Announces Merger with Competitor\",\n \"ground_truth\": \"Business\"\n }\n },\n {\n \"item\": {\n \"input\": \"Breakthrough in Renewable Energy Technology Unveiled\",\n \"ground_truth\": \"Technology\"\n }\n },\n {\n \"item\": {\n \"input\": \"World Leaders Sign Historic Climate Agreement\",\n \"ground_truth\": \"World\"\n }\n },\n {\n \"item\": {\n \"input\": \"Professional Athlete Sets New Record in Championship Event\",\n \"ground_truth\": \"Sports\"\n }\n },\n {\n \"item\": {\n \"input\": \"Financial Institutions Adapt to New Regulatory Requirements\",\n \"ground_truth\": \"Business\"\n }\n },\n {\n \"item\": {\n \"input\": \"Tech Conference Showcases Advances in Artificial Intelligence\",\n \"ground_truth\": \"Technology\"\n }\n },\n {\n \"item\": {\n \"input\": \"Global Markets Respond to Oil Price Fluctuations\",\n \"ground_truth\": \"Markets\"\n }\n },\n {\n \"item\": {\n \"input\": \"International Cooperation Strengthened Through New Treaty\",\n \"ground_truth\": \"World\"\n }\n },\n {\n \"item\": {\n \"input\": \"Sports League Announces Revised Schedule for Upcoming Season\",\n \"ground_truth\": \"Sports\"\n }\n }\n ]\n },\n \"input_messages\": {\n \"type\": \"template\",\n \"template\": [\n {\n \"type\": \"message\",\n \"role\": \"developer\",\n \"content\": {\n \"type\": \"input_text\",\n \"text\": \"Categorize a given news headline into one of the following topics: Technology, Markets, World, Business, or Sports.\\n\\n# Steps\\n\\n1. Analyze the content of the news headline to understand its primary focus.\\n2. Extract the subject matter, identifying any key indicators or keywords.\\n3. Use the identified indicators to determine the most suitable category out of the five options: Technology, Markets, World, Business, or Sports.\\n4. Ensure only one category is selected per headline.\\n\\n# Output Format\\n\\nRespond with the chosen category as a single word. For instance: \\\"Technology\\\", \\\"Markets\\\", \\\"World\\\", \\\"Business\\\", or \\\"Sports\\\".\\n\\n# Examples\\n\\n**Input**: \\\"Apple Unveils New iPhone Model, Featuring Advanced AI Features\\\" \\n**Output**: \\\"Technology\\\"\\n\\n**Input**: \\\"Global Stocks Mixed as Investors Await Central Bank Decisions\\\" \\n**Output**: \\\"Markets\\\"\\n\\n**Input**: \\\"War in Ukraine: Latest Updates on Negotiation Status\\\" \\n**Output**: \\\"World\\\"\\n\\n**Input**: \\\"Microsoft in Talks to Acquire Gaming Company for $2 Billion\\\" \\n**Output**: \\\"Business\\\"\\n\\n**Input**: \\\"Manchester United Secures Win in Premier League Football Match\\\" \\n**Output**: \\\"Sports\\\" \\n\\n# Notes\\n\\n- If the headline appears to fit into more than one category, choose the most dominant theme.\\n- Keywords or phrases such as \\\"stocks\\\", \\\"company acquisition\\\", \\\"match\\\", or technological brands can be good indicators for classification.\\n\"\n }\n },\n {\n \"type\": \"message\",\n \"role\": \"user\",\n \"content\": {\n \"type\": \"input_text\",\n \"text\": \"{{item.input}}\"\n }\n }\n ]\n },\n \"model\": \"gpt-4o-mini\",\n \"sampling_params\": {\n \"seed\": 42,\n \"temperature\": 1.0,\n \"top_p\": 1.0,\n \"max_completions_tokens\": 2048\n }\n },\n \"error\": null,\n \"metadata\": {}\n}\n"}}},"delete":{"operationId":"deleteEvalRun","tags":["Evals"],"summary":"Delete an eval run.\n","parameters":[{"name":"eval_id","in":"path","required":true,"schema":{"type":"string"},"description":"The ID of the evaluation to delete the run from."},{"name":"run_id","in":"path","required":true,"schema":{"type":"string"},"description":"The ID of the run to delete."}],"responses":{"200":{"description":"Successfully deleted the eval run","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","example":"eval.run.deleted"},"deleted":{"type":"boolean","example":true},"run_id":{"type":"string","example":"evalrun_677469f564d48190807532a852da3afb"}}}}}},"404":{"description":"Run not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-oaiMeta":{"name":"Delete eval run","group":"evals","path":"delete","examples":{"request":{"curl":"curl https://api.openai.com/v1/evals/eval_123abc/runs/evalrun_abc456 \\\n -X DELETE \\\n -H \"Authorization: Bearer $OPENAI_API_KEY\" \\\n -H \"Content-Type: application/json\"\n","python":"import os\nfrom openai import OpenAI\n\nclient = OpenAI(\n api_key=os.environ.get(\"OPENAI_API_KEY\"), # This is the default and can be omitted\n)\nrun = client.evals.runs.delete(\n run_id=\"run_id\",\n eval_id=\"eval_id\",\n)\nprint(run.run_id)","javascript":"import OpenAI from \"openai\";\n\nconst openai = new OpenAI();\n\nconst deleted = await openai.evals.runs.delete(\n \"eval_123abc\",\n \"evalrun_abc456\"\n);\nconsole.log(deleted);\n","node.js":"import OpenAI from 'openai';\n\nconst client = new OpenAI({\n apiKey: process.env['OPENAI_API_KEY'], // This is the default and can be omitted\n});\n\nconst run = await client.evals.runs.delete('run_id', { eval_id: 'eval_id' });\n\nconsole.log(run.run_id);","java":"package com.openai.example;\n\nimport com.openai.client.OpenAIClient;\nimport com.openai.client.okhttp.OpenAIOkHttpClient;\nimport com.openai.models.evals.runs.RunDeleteParams;\nimport com.openai.models.evals.runs.RunDeleteResponse;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n OpenAIClient client = OpenAIOkHttpClient.fromEnv();\n\n RunDeleteParams params = RunDeleteParams.builder()\n .evalId(\"eval_id\")\n .runId(\"run_id\")\n .build();\n RunDeleteResponse run = client.evals().runs().delete(params);\n }\n}","ruby":"require \"openai\"\n\nopenai = OpenAI::Client.new(api_key: \"My API Key\")\n\nrun = openai.evals.runs.delete(\"run_id\", eval_id: \"eval_id\")\n\nputs(run)"},"response":"{\n \"object\": \"eval.run.deleted\",\n \"deleted\": true,\n \"run_id\": \"evalrun_abc456\"\n}\n"}}}},"/evals/{eval_id}/runs/{run_id}/output_items":{"get":{"operationId":"getEvalRunOutputItems","tags":["Evals"],"summary":"Get a list of output items for an evaluation run.\n","parameters":[{"name":"eval_id","in":"path","required":true,"schema":{"type":"string"},"description":"The ID of the evaluation to retrieve runs for."},{"name":"run_id","in":"path","required":true,"schema":{"type":"string"},"description":"The ID of the run to retrieve output items for."},{"name":"after","in":"query","description":"Identifier for the last output item from the previous pagination request.","required":false,"schema":{"type":"string"}},{"name":"limit","in":"query","description":"Number of output items to retrieve.","required":false,"schema":{"type":"integer","default":20}},{"name":"status","in":"query","description":"Filter output items by status. Use `failed` to filter by failed output\nitems or `pass` to filter by passed output items.\n","required":false,"schema":{"type":"string","enum":["fail","pass"]}},{"name":"order","in":"query","description":"Sort order for output items by timestamp. Use `asc` for ascending order or `desc` for descending order. Defaults to `asc`.","required":false,"schema":{"type":"string","enum":["asc","desc"],"default":"asc"}}],"responses":{"200":{"description":"A list of output items for the evaluation run","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EvalRunOutputItemList"}}}}},"x-oaiMeta":{"name":"Get eval run output items","group":"evals","path":"get","examples":{"request":{"curl":"curl https://api.openai.com/v1/evals/egroup_67abd54d9b0081909a86353f6fb9317a/runs/erun_67abd54d60ec8190832b46859da808f7/output_items \\\n -H \"Authorization: Bearer $OPENAI_API_KEY\" \\\n -H \"Content-Type: application/json\"\n","python":"import os\nfrom openai import OpenAI\n\nclient = OpenAI(\n api_key=os.environ.get(\"OPENAI_API_KEY\"), # This is the default and can be omitted\n)\npage = client.evals.runs.output_items.list(\n run_id=\"run_id\",\n eval_id=\"eval_id\",\n)\npage = page.data[0]\nprint(page.id)","javascript":"import OpenAI from \"openai\";\n\nconst openai = new OpenAI();\n\nconst outputItems = await openai.evals.runs.outputItems.list(\n \"egroup_67abd54d9b0081909a86353f6fb9317a\",\n \"erun_67abd54d60ec8190832b46859da808f7\"\n);\nconsole.log(outputItems);\n","node.js":"import OpenAI from 'openai';\n\nconst client = new OpenAI({\n apiKey: process.env['OPENAI_API_KEY'], // This is the default and can be omitted\n});\n\n// Automatically fetches more pages as needed.\nfor await (const outputItemListResponse of client.evals.runs.outputItems.list('run_id', {\n eval_id: 'eval_id',\n})) {\n console.log(outputItemListResponse.id);\n}","java":"package com.openai.example;\n\nimport com.openai.client.OpenAIClient;\nimport com.openai.client.okhttp.OpenAIOkHttpClient;\nimport com.openai.models.evals.runs.outputitems.OutputItemListPage;\nimport com.openai.models.evals.runs.outputitems.OutputItemListParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n OpenAIClient client = OpenAIOkHttpClient.fromEnv();\n\n OutputItemListParams params = OutputItemListParams.builder()\n .evalId(\"eval_id\")\n .runId(\"run_id\")\n .build();\n OutputItemListPage page = client.evals().runs().outputItems().list(params);\n }\n}","ruby":"require \"openai\"\n\nopenai = OpenAI::Client.new(api_key: \"My API Key\")\n\npage = openai.evals.runs.output_items.list(\"run_id\", eval_id: \"eval_id\")\n\nputs(page)"},"response":"{\n \"object\": \"list\",\n \"data\": [\n {\n \"object\": \"eval.run.output_item\",\n \"id\": \"outputitem_67e5796c28e081909917bf79f6e6214d\",\n \"created_at\": 1743092076,\n \"run_id\": \"evalrun_67abd54d60ec8190832b46859da808f7\",\n \"eval_id\": \"eval_67abd54d9b0081909a86353f6fb9317a\",\n \"status\": \"pass\",\n \"datasource_item_id\": 5,\n \"datasource_item\": {\n \"input\": \"Stock Markets Rally After Positive Economic Data Released\",\n \"ground_truth\": \"Markets\"\n },\n \"results\": [\n {\n \"name\": \"String check-a2486074-d803-4445-b431-ad2262e85d47\",\n \"sample\": null,\n \"passed\": true,\n \"score\": 1.0\n }\n ],\n \"sample\": {\n \"input\": [\n {\n \"role\": \"developer\",\n \"content\": \"Categorize a given news headline into one of the following topics: Technology, Markets, World, Business, or Sports.\\n\\n# Steps\\n\\n1. Analyze the content of the news headline to understand its primary focus.\\n2. Extract the subject matter, identifying any key indicators or keywords.\\n3. Use the identified indicators to determine the most suitable category out of the five options: Technology, Markets, World, Business, or Sports.\\n4. Ensure only one category is selected per headline.\\n\\n# Output Format\\n\\nRespond with the chosen category as a single word. For instance: \\\"Technology\\\", \\\"Markets\\\", \\\"World\\\", \\\"Business\\\", or \\\"Sports\\\".\\n\\n# Examples\\n\\n**Input**: \\\"Apple Unveils New iPhone Model, Featuring Advanced AI Features\\\" \\n**Output**: \\\"Technology\\\"\\n\\n**Input**: \\\"Global Stocks Mixed as Investors Await Central Bank Decisions\\\" \\n**Output**: \\\"Markets\\\"\\n\\n**Input**: \\\"War in Ukraine: Latest Updates on Negotiation Status\\\" \\n**Output**: \\\"World\\\"\\n\\n**Input**: \\\"Microsoft in Talks to Acquire Gaming Company for $2 Billion\\\" \\n**Output**: \\\"Business\\\"\\n\\n**Input**: \\\"Manchester United Secures Win in Premier League Football Match\\\" \\n**Output**: \\\"Sports\\\" \\n\\n# Notes\\n\\n- If the headline appears to fit into more than one category, choose the most dominant theme.\\n- Keywords or phrases such as \\\"stocks\\\", \\\"company acquisition\\\", \\\"match\\\", or technological brands can be good indicators for classification.\\n\",\n \"tool_call_id\": null,\n \"tool_calls\": null,\n \"function_call\": null\n },\n {\n \"role\": \"user\",\n \"content\": \"Stock Markets Rally After Positive Economic Data Released\",\n \"tool_call_id\": null,\n \"tool_calls\": null,\n \"function_call\": null\n }\n ],\n \"output\": [\n {\n \"role\": \"assistant\",\n \"content\": \"Markets\",\n \"tool_call_id\": null,\n \"tool_calls\": null,\n \"function_call\": null\n }\n ],\n \"finish_reason\": \"stop\",\n \"model\": \"gpt-4o-mini-2024-07-18\",\n \"usage\": {\n \"total_tokens\": 325,\n \"completion_tokens\": 2,\n \"prompt_tokens\": 323,\n \"cached_tokens\": 0\n },\n \"error\": null,\n \"temperature\": 1.0,\n \"max_completion_tokens\": 2048,\n \"top_p\": 1.0,\n \"seed\": 42\n }\n }\n ],\n \"first_id\": \"outputitem_67e5796c28e081909917bf79f6e6214d\",\n \"last_id\": \"outputitem_67e5796c28e081909917bf79f6e6214d\",\n \"has_more\": true\n}\n"}}}},"/evals/{eval_id}/runs/{run_id}/output_items/{output_item_id}":{"get":{"operationId":"getEvalRunOutputItem","tags":["Evals"],"summary":"Get an evaluation run output item by ID.\n","parameters":[{"name":"eval_id","in":"path","required":true,"schema":{"type":"string"},"description":"The ID of the evaluation to retrieve runs for."},{"name":"run_id","in":"path","required":true,"schema":{"type":"string"},"description":"The ID of the run to retrieve."},{"name":"output_item_id","in":"path","required":true,"schema":{"type":"string"},"description":"The ID of the output item to retrieve."}],"responses":{"200":{"description":"The evaluation run output item","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EvalRunOutputItem"}}}}},"x-oaiMeta":{"name":"Get an output item of an eval run","group":"evals","path":"get","examples":{"request":{"curl":"curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a/runs/evalrun_67abd54d60ec8190832b46859da808f7/output_items/outputitem_67abd55eb6548190bb580745d5644a33 \\\n -H \"Authorization: Bearer $OPENAI_API_KEY\" \\\n -H \"Content-Type: application/json\"\n","python":"import os\nfrom openai import OpenAI\n\nclient = OpenAI(\n api_key=os.environ.get(\"OPENAI_API_KEY\"), # This is the default and can be omitted\n)\noutput_item = client.evals.runs.output_items.retrieve(\n output_item_id=\"output_item_id\",\n eval_id=\"eval_id\",\n run_id=\"run_id\",\n)\nprint(output_item.id)","javascript":"import OpenAI from \"openai\";\n\nconst openai = new OpenAI();\n\nconst outputItem = await openai.evals.runs.outputItems.retrieve(\n \"outputitem_67abd55eb6548190bb580745d5644a33\",\n {\n eval_id: \"eval_67abd54d9b0081909a86353f6fb9317a\",\n run_id: \"evalrun_67abd54d60ec8190832b46859da808f7\",\n }\n);\nconsole.log(outputItem);\n","node.js":"import OpenAI from 'openai';\n\nconst client = new OpenAI({\n apiKey: process.env['OPENAI_API_KEY'], // This is the default and can be omitted\n});\n\nconst outputItem = await client.evals.runs.outputItems.retrieve('output_item_id', {\n eval_id: 'eval_id',\n run_id: 'run_id',\n});\n\nconsole.log(outputItem.id);","java":"package com.openai.example;\n\nimport com.openai.client.OpenAIClient;\nimport com.openai.client.okhttp.OpenAIOkHttpClient;\nimport com.openai.models.evals.runs.outputitems.OutputItemRetrieveParams;\nimport com.openai.models.evals.runs.outputitems.OutputItemRetrieveResponse;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n OpenAIClient client = OpenAIOkHttpClient.fromEnv();\n\n OutputItemRetrieveParams params = OutputItemRetrieveParams.builder()\n .evalId(\"eval_id\")\n .runId(\"run_id\")\n .outputItemId(\"output_item_id\")\n .build();\n OutputItemRetrieveResponse outputItem = client.evals().runs().outputItems().retrieve(params);\n }\n}","ruby":"require \"openai\"\n\nopenai = OpenAI::Client.new(api_key: \"My API Key\")\n\noutput_item = openai.evals.runs.output_items.retrieve(\"output_item_id\", eval_id: \"eval_id\", run_id: \"run_id\")\n\nputs(output_item)"},"response":"{\n \"object\": \"eval.run.output_item\",\n \"id\": \"outputitem_67e5796c28e081909917bf79f6e6214d\",\n \"created_at\": 1743092076,\n \"run_id\": \"evalrun_67abd54d60ec8190832b46859da808f7\",\n \"eval_id\": \"eval_67abd54d9b0081909a86353f6fb9317a\",\n \"status\": \"pass\",\n \"datasource_item_id\": 5,\n \"datasource_item\": {\n \"input\": \"Stock Markets Rally After Positive Economic Data Released\",\n \"ground_truth\": \"Markets\"\n },\n \"results\": [\n {\n \"name\": \"String check-a2486074-d803-4445-b431-ad2262e85d47\",\n \"sample\": null,\n \"passed\": true,\n \"score\": 1.0\n }\n ],\n \"sample\": {\n \"input\": [\n {\n \"role\": \"developer\",\n \"content\": \"Categorize a given news headline into one of the following topics: Technology, Markets, World, Business, or Sports.\\n\\n# Steps\\n\\n1. Analyze the content of the news headline to understand its primary focus.\\n2. Extract the subject matter, identifying any key indicators or keywords.\\n3. Use the identified indicators to determine the most suitable category out of the five options: Technology, Markets, World, Business, or Sports.\\n4. Ensure only one category is selected per headline.\\n\\n# Output Format\\n\\nRespond with the chosen category as a single word. For instance: \\\"Technology\\\", \\\"Markets\\\", \\\"World\\\", \\\"Business\\\", or \\\"Sports\\\".\\n\\n# Examples\\n\\n**Input**: \\\"Apple Unveils New iPhone Model, Featuring Advanced AI Features\\\" \\n**Output**: \\\"Technology\\\"\\n\\n**Input**: \\\"Global Stocks Mixed as Investors Await Central Bank Decisions\\\" \\n**Output**: \\\"Markets\\\"\\n\\n**Input**: \\\"War in Ukraine: Latest Updates on Negotiation Status\\\" \\n**Output**: \\\"World\\\"\\n\\n**Input**: \\\"Microsoft in Talks to Acquire Gaming Company for $2 Billion\\\" \\n**Output**: \\\"Business\\\"\\n\\n**Input**: \\\"Manchester United Secures Win in Premier League Football Match\\\" \\n**Output**: \\\"Sports\\\" \\n\\n# Notes\\n\\n- If the headline appears to fit into more than one category, choose the most dominant theme.\\n- Keywords or phrases such as \\\"stocks\\\", \\\"company acquisition\\\", \\\"match\\\", or technological brands can be good indicators for classification.\\n\",\n \"tool_call_id\": null,\n \"tool_calls\": null,\n \"function_call\": null\n },\n {\n \"role\": \"user\",\n \"content\": \"Stock Markets Rally After Positive Economic Data Released\",\n \"tool_call_id\": null,\n \"tool_calls\": null,\n \"function_call\": null\n }\n ],\n \"output\": [\n {\n \"role\": \"assistant\",\n \"content\": \"Markets\",\n \"tool_call_id\": null,\n \"tool_calls\": null,\n \"function_call\": null\n }\n ],\n \"finish_reason\": \"stop\",\n \"model\": \"gpt-4o-mini-2024-07-18\",\n \"usage\": {\n \"total_tokens\": 325,\n \"completion_tokens\": 2,\n \"prompt_tokens\": 323,\n \"cached_tokens\": 0\n },\n \"error\": null,\n \"temperature\": 1.0,\n \"max_completion_tokens\": 2048,\n \"top_p\": 1.0,\n \"seed\": 42\n }\n}\n"}}}},"/files":{"get":{"operationId":"listFiles","tags":["Files"],"summary":"Returns a list of files.","parameters":[{"in":"query","name":"purpose","required":false,"schema":{"type":"string"},"description":"Only return files with the given purpose."},{"name":"limit","in":"query","description":"A limit on the number of objects to be returned. Limit can range between 1 and 10,000, and the default is 10,000.\n","required":false,"schema":{"type":"integer","default":10000}},{"name":"order","in":"query","description":"Sort order by the `created_at` timestamp of the objects. `asc` for ascending order and `desc` for descending order.\n","schema":{"type":"string","default":"desc","enum":["asc","desc"]}},{"name":"after","in":"query","description":"A cursor for use in pagination. `after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list.\n","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListFilesResponse"}}}}},"x-oaiMeta":{"name":"List files","group":"files","examples":{"request":{"curl":"curl https://api.openai.com/v1/files \\\n -H \"Authorization: Bearer $OPENAI_API_KEY\"\n","python":"import os\nfrom openai import OpenAI\n\nclient = OpenAI(\n api_key=os.environ.get(\"OPENAI_API_KEY\"), # This is the default and can be omitted\n)\npage = client.files.list()\npage = page.data[0]\nprint(page)","javascript":"import OpenAI from \"openai\";\n\nconst openai = new OpenAI();\n\nasync function main() {\n const list = await openai.files.list();\n\n for await (const file of list) {\n console.log(file);\n }\n}\n\nmain();","node.js":"import OpenAI from 'openai';\n\nconst client = new OpenAI({\n apiKey: process.env['OPENAI_API_KEY'], // This is the default and can be omitted\n});\n\n// Automatically fetches more pages as needed.\nfor await (const fileObject of client.files.list()) {\n console.log(fileObject);\n}","go":"package main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\n\t\"github.com/openai/openai-go\"\n\t\"github.com/openai/openai-go/option\"\n)\n\nfunc main() {\n\tclient := openai.NewClient(\n\t\toption.WithAPIKey(\"My API Key\"),\n\t)\n\tpage, err := client.Files.List(context.TODO(), openai.FileListParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf(\"%+v\\n\", page)\n}\n","java":"package com.openai.example;\n\nimport com.openai.client.OpenAIClient;\nimport com.openai.client.okhttp.OpenAIOkHttpClient;\nimport com.openai.models.files.FileListPage;\nimport com.openai.models.files.FileListParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n OpenAIClient client = OpenAIOkHttpClient.fromEnv();\n\n FileListPage page = client.files().list();\n }\n}","ruby":"require \"openai\"\n\nopenai = OpenAI::Client.new(api_key: \"My API Key\")\n\npage = openai.files.list\n\nputs(page)"},"response":"{\n \"object\": \"list\",\n \"data\": [\n {\n \"id\": \"file-abc123\",\n \"object\": \"file\",\n \"bytes\": 175,\n \"created_at\": 1613677385,\n \"expires_at\": 1677614202,\n \"filename\": \"salesOverview.pdf\",\n \"purpose\": \"assistants\",\n },\n {\n \"id\": \"file-abc456\",\n \"object\": \"file\",\n \"bytes\": 140,\n \"created_at\": 1613779121,\n \"expires_at\": 1677614202,\n \"filename\": \"puppy.jsonl\",\n \"purpose\": \"fine-tune\",\n }\n ],\n \"first_id\": \"file-abc123\",\n \"last_id\": \"file-abc456\",\n \"has_more\": false\n}\n"}}},"post":{"operationId":"createFile","tags":["Files"],"summary":"Upload a file that can be used across various endpoints. Individual files\ncan be up to 512 MB, and each project can store up to 2.5 TB of files in\ntotal. There is no organization-wide storage limit. Uploads to this\nendpoint are rate-limited to 1,000 requests per minute per authenticated\nuser.\n\n- The Assistants API supports files up to 2 million tokens and of specific\n file types. See the [Assistants Tools guide](/docs/assistants/tools) for\n details.\n- The Fine-tuning API only supports `.jsonl` files. The input also has\n certain required formats for fine-tuning\n [chat](/docs/api-reference/fine-tuning/chat-input) or\n [completions](/docs/api-reference/fine-tuning/completions-input) models.\n- The Batch API only supports `.jsonl` files up to 200 MB in size. The input\n also has a specific required\n [format](/docs/api-reference/batch/request-input).\n- For Retrieval or `file_search` ingestion, upload files here first. If\n you need to attach multiple uploaded files to the same vector store, use\n [`/vector_stores/{vector_store_id}/file_batches`](/docs/api-reference/vector-stores-file-batches/createBatch)\n instead of attaching them one by one. Vector store attachment has separate\n limits from file upload, including 2,000 attached files per minute per\n organization.\n\nPlease [contact us](https://help.openai.com/) if you need to increase these\nstorage limits.\n","requestBody":{"required":true,"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/CreateFileRequest"}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenAIFile"}}}}},"x-oaiMeta":{"name":"Upload file","group":"files","description":"Uploads a file for later use across OpenAI APIs. Uploads to this endpoint are rate-limited to 1,000 requests per minute per authenticated user. For Retrieval or `file_search` ingestion, upload files here first. If you need to attach multiple uploaded files to the same vector store, use vector store file batches instead of attaching them one by one.\n","examples":{"request":{"curl":"curl https://api.openai.com/v1/files \\\n -H \"Authorization: Bearer $OPENAI_API_KEY\" \\\n -F purpose=\"fine-tune\" \\\n -F file=\"@mydata.jsonl\"\n -F expires_after[anchor]=\"created_at\"\n -F expires_after[seconds]=2592000\n","python":"import os\nfrom openai import OpenAI\n\nclient = OpenAI(\n api_key=os.environ.get(\"OPENAI_API_KEY\"), # This is the default and can be omitted\n)\nfile_object = client.files.create(\n file=b\"Example data\",\n purpose=\"assistants\",\n)\nprint(file_object.id)","javascript":"import fs from \"fs\";\nimport OpenAI from \"openai\";\n\nconst openai = new OpenAI();\n\nasync function main() {\n const file = await openai.files.create({\n file: fs.createReadStream(\"mydata.jsonl\"),\n purpose: \"fine-tune\",\n expires_after: {\n anchor: \"created_at\",\n seconds: 2592000\n }\n });\n\n console.log(file);\n}\n\nmain();","node.js":"import fs from 'fs';\nimport OpenAI from 'openai';\n\nconst client = new OpenAI({\n apiKey: process.env['OPENAI_API_KEY'], // This is the default and can be omitted\n});\n\nconst fileObject = await client.files.create({\n file: fs.createReadStream('fine-tune.jsonl'),\n purpose: 'assistants',\n});\n\nconsole.log(fileObject.id);","go":"package main\n\nimport (\n\t\"bytes\"\n\t\"context\"\n\t\"fmt\"\n\t\"io\"\n\n\t\"github.com/openai/openai-go\"\n\t\"github.com/openai/openai-go/option\"\n)\n\nfunc main() {\n\tclient := openai.NewClient(\n\t\toption.WithAPIKey(\"My API Key\"),\n\t)\n\tfileObject, err := client.Files.New(context.TODO(), openai.FileNewParams{\n\t\tFile: io.Reader(bytes.NewBuffer([]byte(\"Example data\"))),\n\t\tPurpose: openai.FilePurposeAssistants,\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf(\"%+v\\n\", fileObject.ID)\n}\n","java":"package com.openai.example;\n\nimport com.openai.client.OpenAIClient;\nimport com.openai.client.okhttp.OpenAIOkHttpClient;\nimport com.openai.models.files.FileCreateParams;\nimport com.openai.models.files.FileObject;\nimport com.openai.models.files.FilePurpose;\nimport java.io.ByteArrayInputStream;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n OpenAIClient client = OpenAIOkHttpClient.fromEnv();\n\n FileCreateParams params = FileCreateParams.builder()\n .file(new ByteArrayInputStream(\"Example data\".getBytes()))\n .purpose(FilePurpose.ASSISTANTS)\n .build();\n FileObject fileObject = client.files().create(params);\n }\n}","ruby":"require \"openai\"\n\nopenai = OpenAI::Client.new(api_key: \"My API Key\")\n\nfile_object = openai.files.create(file: StringIO.new(\"Example data\"), purpose: :assistants)\n\nputs(file_object)"},"response":"{\n \"id\": \"file-abc123\",\n \"object\": \"file\",\n \"bytes\": 120000,\n \"created_at\": 1677610602,\n \"expires_at\": 1677614202,\n \"filename\": \"mydata.jsonl\",\n \"purpose\": \"fine-tune\",\n}\n"}}}},"/files/{file_id}":{"delete":{"operationId":"deleteFile","tags":["Files"],"summary":"Delete a file and remove it from all vector stores.","parameters":[{"in":"path","name":"file_id","required":true,"schema":{"type":"string"},"description":"The ID of the file to use for this request."}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteFileResponse"}}}}},"x-oaiMeta":{"name":"Delete file","group":"files","examples":{"request":{"curl":"curl https://api.openai.com/v1/files/file-abc123 \\\n -X DELETE \\\n -H \"Authorization: Bearer $OPENAI_API_KEY\"\n","python":"import os\nfrom openai import OpenAI\n\nclient = OpenAI(\n api_key=os.environ.get(\"OPENAI_API_KEY\"), # This is the default and can be omitted\n)\nfile_deleted = client.files.delete(\n \"file_id\",\n)\nprint(file_deleted.id)","javascript":"import OpenAI from \"openai\";\n\nconst openai = new OpenAI();\n\nasync function main() {\n const file = await openai.files.delete(\"file-abc123\");\n\n console.log(file);\n}\n\nmain();","node.js":"import OpenAI from 'openai';\n\nconst client = new OpenAI({\n apiKey: process.env['OPENAI_API_KEY'], // This is the default and can be omitted\n});\n\nconst fileDeleted = await client.files.delete('file_id');\n\nconsole.log(fileDeleted.id);","go":"package main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\n\t\"github.com/openai/openai-go\"\n\t\"github.com/openai/openai-go/option\"\n)\n\nfunc main() {\n\tclient := openai.NewClient(\n\t\toption.WithAPIKey(\"My API Key\"),\n\t)\n\tfileDeleted, err := client.Files.Delete(context.TODO(), \"file_id\")\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf(\"%+v\\n\", fileDeleted.ID)\n}\n","java":"package com.openai.example;\n\nimport com.openai.client.OpenAIClient;\nimport com.openai.client.okhttp.OpenAIOkHttpClient;\nimport com.openai.models.files.FileDeleteParams;\nimport com.openai.models.files.FileDeleted;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n OpenAIClient client = OpenAIOkHttpClient.fromEnv();\n\n FileDeleted fileDeleted = client.files().delete(\"file_id\");\n }\n}","ruby":"require \"openai\"\n\nopenai = OpenAI::Client.new(api_key: \"My API Key\")\n\nfile_deleted = openai.files.delete(\"file_id\")\n\nputs(file_deleted)"},"response":"{\n \"id\": \"file-abc123\",\n \"object\": \"file\",\n \"deleted\": true\n}\n"}}},"get":{"operationId":"retrieveFile","tags":["Files"],"summary":"Returns information about a specific file.","parameters":[{"in":"path","name":"file_id","required":true,"schema":{"type":"string"},"description":"The ID of the file to use for this request."}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenAIFile"}}}}},"x-oaiMeta":{"name":"Retrieve file","group":"files","examples":{"request":{"curl":"curl https://api.openai.com/v1/files/file-abc123 \\\n -H \"Authorization: Bearer $OPENAI_API_KEY\"\n","python":"import os\nfrom openai import OpenAI\n\nclient = OpenAI(\n api_key=os.environ.get(\"OPENAI_API_KEY\"), # This is the default and can be omitted\n)\nfile_object = client.files.retrieve(\n \"file_id\",\n)\nprint(file_object.id)","javascript":"import OpenAI from \"openai\";\n\nconst openai = new OpenAI();\n\nasync function main() {\n const file = await openai.files.retrieve(\"file-abc123\");\n\n console.log(file);\n}\n\nmain();","node.js":"import OpenAI from 'openai';\n\nconst client = new OpenAI({\n apiKey: process.env['OPENAI_API_KEY'], // This is the default and can be omitted\n});\n\nconst fileObject = await client.files.retrieve('file_id');\n\nconsole.log(fileObject.id);","go":"package main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\n\t\"github.com/openai/openai-go\"\n\t\"github.com/openai/openai-go/option\"\n)\n\nfunc main() {\n\tclient := openai.NewClient(\n\t\toption.WithAPIKey(\"My API Key\"),\n\t)\n\tfileObject, err := client.Files.Get(context.TODO(), \"file_id\")\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf(\"%+v\\n\", fileObject.ID)\n}\n","java":"package com.openai.example;\n\nimport com.openai.client.OpenAIClient;\nimport com.openai.client.okhttp.OpenAIOkHttpClient;\nimport com.openai.models.files.FileObject;\nimport com.openai.models.files.FileRetrieveParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n OpenAIClient client = OpenAIOkHttpClient.fromEnv();\n\n FileObject fileObject = client.files().retrieve(\"file_id\");\n }\n}","ruby":"require \"openai\"\n\nopenai = OpenAI::Client.new(api_key: \"My API Key\")\n\nfile_object = openai.files.retrieve(\"file_id\")\n\nputs(file_object)"},"response":"{\n \"id\": \"file-abc123\",\n \"object\": \"file\",\n \"bytes\": 120000,\n \"created_at\": 1677610602,\n \"expires_at\": 1677614202,\n \"filename\": \"mydata.jsonl\",\n \"purpose\": \"fine-tune\",\n}\n"}}}},"/files/{file_id}/content":{"get":{"operationId":"downloadFile","tags":["Files"],"summary":"Returns the contents of the specified file.","parameters":[{"in":"path","name":"file_id","required":true,"schema":{"type":"string"},"description":"The ID of the file to use for this request."}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"string"}}}}},"x-oaiMeta":{"name":"Retrieve file content","group":"files","examples":{"request":{"curl":"curl https://api.openai.com/v1/files/file-abc123/content \\\n -H \"Authorization: Bearer $OPENAI_API_KEY\" > file.jsonl\n","python":"import os\nfrom openai import OpenAI\n\nclient = OpenAI(\n api_key=os.environ.get(\"OPENAI_API_KEY\"), # This is the default and can be omitted\n)\nresponse = client.files.content(\n \"file_id\",\n)\nprint(response)\ncontent = response.read()\nprint(content)","javascript":"import OpenAI from \"openai\";\n\nconst openai = new OpenAI();\n\nasync function main() {\n const file = await openai.files.content(\"file-abc123\");\n\n console.log(file);\n}\n\nmain();\n","node.js":"import OpenAI from 'openai';\n\nconst client = new OpenAI({\n apiKey: process.env['OPENAI_API_KEY'], // This is the default and can be omitted\n});\n\nconst response = await client.files.content('file_id');\n\nconsole.log(response);\n\nconst content = await response.blob();\nconsole.log(content);","go":"package main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\n\t\"github.com/openai/openai-go\"\n\t\"github.com/openai/openai-go/option\"\n)\n\nfunc main() {\n\tclient := openai.NewClient(\n\t\toption.WithAPIKey(\"My API Key\"),\n\t)\n\tresponse, err := client.Files.Content(context.TODO(), \"file_id\")\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf(\"%+v\\n\", response)\n}\n","java":"package com.openai.example;\n\nimport com.openai.client.OpenAIClient;\nimport com.openai.client.okhttp.OpenAIOkHttpClient;\nimport com.openai.core.http.HttpResponse;\nimport com.openai.models.files.FileContentParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n OpenAIClient client = OpenAIOkHttpClient.fromEnv();\n\n HttpResponse response = client.files().content(\"file_id\");\n }\n}","ruby":"require \"openai\"\n\nopenai = OpenAI::Client.new(api_key: \"My API Key\")\n\nresponse = openai.files.content(\"file_id\")\n\nputs(response)"},"response":""}}}},"/fine_tuning/alpha/graders/run":{"post":{"operationId":"runGrader","tags":["Fine-tuning"],"summary":"Run a grader.\n","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunGraderRequest"}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunGraderResponse"}}}}},"x-oaiMeta":{"name":"Run grader","beta":true,"group":"graders","examples":[{"title":"Score text alignment","request":{"curl":"curl -X POST https://api.openai.com/v1/fine_tuning/alpha/graders/run \\\n -H \"Content-Type: application/json\" \\\n -H \"Authorization: Bearer $OPENAI_API_KEY\" \\\n -d '{\n \"grader\": {\n \"type\": \"score_model\",\n \"name\": \"Example score model grader\",\n \"input\": [\n {\n \"role\": \"user\",\n \"content\": [\n {\n \"type\": \"input_text\",\n \"text\": \"Score how close the reference answer is to the model answer on a 0-1 scale. Return only the score.\\n\\nReference answer: {{item.reference_answer}}\\n\\nModel answer: {{sample.output_text}}\"\n }\n ]\n }\n ],\n \"model\": \"gpt-5-mini\",\n \"sampling_params\": {\n \"temperature\": 1,\n \"top_p\": 1,\n \"seed\": 42\n }\n },\n \"item\": {\n \"reference_answer\": \"fuzzy wuzzy was a bear\"\n },\n \"model_sample\": \"fuzzy wuzzy was a bear\"\n }'\n","python":"import os\nfrom openai import OpenAI\n\nclient = OpenAI(\n api_key=os.environ.get(\"OPENAI_API_KEY\"), # This is the default and can be omitted\n)\nresponse = client.fine_tuning.alpha.graders.run(\n grader={\n \"input\": \"input\",\n \"name\": \"name\",\n \"operation\": \"eq\",\n \"reference\": \"reference\",\n \"type\": \"string_check\",\n },\n model_sample=\"model_sample\",\n)\nprint(response.metadata)","javascript":"import OpenAI from \"openai\";\n\nconst openai = new OpenAI();\n\nconst result = await openai.fineTuning.alpha.graders.run({\n grader: {\n type: \"score_model\",\n name: \"Example score model grader\",\n input: [\n {\n role: \"user\",\n content: [\n {\n type: \"input_text\",\n text: \"Score how close the reference answer is to the model answer on a 0-1 scale. Return only the score.\\n\\nReference answer: {{item.reference_answer}}\\n\\nModel answer: {{sample.output_text}}\",\n },\n ],\n },\n ],\n model: \"gpt-5-mini\",\n sampling_params: { temperature: 1, top_p: 1, seed: 42 },\n },\n item: { reference_answer: \"fuzzy wuzzy was a bear\" },\n model_sample: \"fuzzy wuzzy was a bear\",\n});\nconsole.log(result);\n","node.js":"import OpenAI from 'openai';\n\nconst client = new OpenAI({\n apiKey: process.env['OPENAI_API_KEY'], // This is the default and can be omitted\n});\n\nconst response = await client.fineTuning.alpha.graders.run({\n grader: {\n input: 'input',\n name: 'name',\n operation: 'eq',\n reference: 'reference',\n type: 'string_check',\n },\n model_sample: 'model_sample',\n});\n\nconsole.log(response.metadata);","go":"package main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\n\t\"github.com/openai/openai-go\"\n\t\"github.com/openai/openai-go/option\"\n)\n\nfunc main() {\n\tclient := openai.NewClient(\n\t\toption.WithAPIKey(\"My API Key\"),\n\t)\n\tresponse, err := client.FineTuning.Alpha.Graders.Run(context.TODO(), openai.FineTuningAlphaGraderRunParams{\n\t\tGrader: openai.FineTuningAlphaGraderRunParamsGraderUnion{\n\t\t\tOfStringCheck: &openai.StringCheckGraderParam{\n\t\t\t\tInput: \"input\",\n\t\t\t\tName: \"name\",\n\t\t\t\tOperation: openai.StringCheckGraderOperationEq,\n\t\t\t\tReference: \"reference\",\n\t\t\t},\n\t\t},\n\t\tModelSample: \"model_sample\",\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf(\"%+v\\n\", response.Metadata)\n}\n","java":"package com.openai.example;\n\nimport com.openai.client.OpenAIClient;\nimport com.openai.client.okhttp.OpenAIOkHttpClient;\nimport com.openai.models.finetuning.alpha.graders.GraderRunParams;\nimport com.openai.models.finetuning.alpha.graders.GraderRunResponse;\nimport com.openai.models.graders.gradermodels.StringCheckGrader;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n OpenAIClient client = OpenAIOkHttpClient.fromEnv();\n\n GraderRunParams params = GraderRunParams.builder()\n .grader(StringCheckGrader.builder()\n .input(\"input\")\n .name(\"name\")\n .operation(StringCheckGrader.Operation.EQ)\n .reference(\"reference\")\n .build())\n .modelSample(\"model_sample\")\n .build();\n GraderRunResponse response = client.fineTuning().alpha().graders().run(params);\n }\n}","ruby":"require \"openai\"\n\nopenai = OpenAI::Client.new(api_key: \"My API Key\")\n\nresponse = openai.fine_tuning.alpha.graders.run(\n grader: {input: \"input\", name: \"name\", operation: :eq, reference: \"reference\", type: :string_check},\n model_sample: \"model_sample\"\n)\n\nputs(response)"},"response":"{\n \"reward\": 1.0,\n \"metadata\": {\n \"name\": \"Example score model grader\",\n \"type\": \"score_model\",\n \"errors\": {\n \"formula_parse_error\": false,\n \"sample_parse_error\": false,\n \"truncated_observation_error\": false,\n \"unresponsive_reward_error\": false,\n \"invalid_variable_error\": false,\n \"other_error\": false,\n \"python_grader_server_error\": false,\n \"python_grader_server_error_type\": null,\n \"python_grader_runtime_error\": false,\n \"python_grader_runtime_error_details\": null,\n \"model_grader_server_error\": false,\n \"model_grader_refusal_error\": false,\n \"model_grader_parse_error\": false,\n \"model_grader_server_error_details\": null\n },\n \"execution_time\": 4.365238428115845,\n \"scores\": {},\n \"token_usage\": {\n \"prompt_tokens\": 190,\n \"total_tokens\": 324,\n \"completion_tokens\": 134,\n \"cached_tokens\": 0\n },\n \"sampled_model_name\": \"gpt-4o-2024-08-06\"\n },\n \"sub_rewards\": {},\n \"model_grader_token_usage_per_model\": {\n \"gpt-4o-2024-08-06\": {\n \"prompt_tokens\": 190,\n \"total_tokens\": 324,\n \"completion_tokens\": 134,\n \"cached_tokens\": 0\n }\n }\n}\n"},{"title":"Score an image caption","request":{"curl":"curl -X POST https://api.openai.com/v1/fine_tuning/alpha/graders/run \\\n -H \"Content-Type: application/json\" \\\n -H \"Authorization: Bearer $OPENAI_API_KEY\" \\\n -d '{\n \"grader\": {\n \"type\": \"score_model\",\n \"name\": \"Image caption grader\",\n \"input\": [\n {\n \"role\": \"user\",\n \"content\": [\n {\n \"type\": \"input_text\",\n \"text\": \"Score how well the provided caption matches the image on a 0-1 scale. Only return the score.\\n\\nCaption: {{sample.output_text}}\"\n },\n {\n \"type\": \"input_image\",\n \"image_url\": \"https://example.com/dog-catching-ball.png\",\n \"file_id\": null,\n \"detail\": \"high\"\n }\n ]\n }\n ],\n \"model\": \"gpt-5-mini\",\n \"sampling_params\": {\n \"temperature\": 0.2\n }\n },\n \"item\": {\n \"expected_caption\": \"A golden retriever jumps to catch a tennis ball\"\n },\n \"model_sample\": \"A dog leaps to grab a tennis ball mid-air\"\n }'\n","node.js":"import OpenAI from 'openai';\n\nconst client = new OpenAI({\n apiKey: process.env['OPENAI_API_KEY'], // This is the default and can be omitted\n});\n\nconst response = await client.fineTuning.alpha.graders.run({\n grader: {\n input: 'input',\n name: 'name',\n operation: 'eq',\n reference: 'reference',\n type: 'string_check',\n },\n model_sample: 'model_sample',\n});\n\nconsole.log(response.metadata);","python":"import os\nfrom openai import OpenAI\n\nclient = OpenAI(\n api_key=os.environ.get(\"OPENAI_API_KEY\"), # This is the default and can be omitted\n)\nresponse = client.fine_tuning.alpha.graders.run(\n grader={\n \"input\": \"input\",\n \"name\": \"name\",\n \"operation\": \"eq\",\n \"reference\": \"reference\",\n \"type\": \"string_check\",\n },\n model_sample=\"model_sample\",\n)\nprint(response.metadata)","go":"package main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\n\t\"github.com/openai/openai-go\"\n\t\"github.com/openai/openai-go/option\"\n)\n\nfunc main() {\n\tclient := openai.NewClient(\n\t\toption.WithAPIKey(\"My API Key\"),\n\t)\n\tresponse, err := client.FineTuning.Alpha.Graders.Run(context.TODO(), openai.FineTuningAlphaGraderRunParams{\n\t\tGrader: openai.FineTuningAlphaGraderRunParamsGraderUnion{\n\t\t\tOfStringCheck: &openai.StringCheckGraderParam{\n\t\t\t\tInput: \"input\",\n\t\t\t\tName: \"name\",\n\t\t\t\tOperation: openai.StringCheckGraderOperationEq,\n\t\t\t\tReference: \"reference\",\n\t\t\t},\n\t\t},\n\t\tModelSample: \"model_sample\",\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf(\"%+v\\n\", response.Metadata)\n}\n","java":"package com.openai.example;\n\nimport com.openai.client.OpenAIClient;\nimport com.openai.client.okhttp.OpenAIOkHttpClient;\nimport com.openai.models.finetuning.alpha.graders.GraderRunParams;\nimport com.openai.models.finetuning.alpha.graders.GraderRunResponse;\nimport com.openai.models.graders.gradermodels.StringCheckGrader;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n OpenAIClient client = OpenAIOkHttpClient.fromEnv();\n\n GraderRunParams params = GraderRunParams.builder()\n .grader(StringCheckGrader.builder()\n .input(\"input\")\n .name(\"name\")\n .operation(StringCheckGrader.Operation.EQ)\n .reference(\"reference\")\n .build())\n .modelSample(\"model_sample\")\n .build();\n GraderRunResponse response = client.fineTuning().alpha().graders().run(params);\n }\n}","ruby":"require \"openai\"\n\nopenai = OpenAI::Client.new(api_key: \"My API Key\")\n\nresponse = openai.fine_tuning.alpha.graders.run(\n grader: {input: \"input\", name: \"name\", operation: :eq, reference: \"reference\", type: :string_check},\n model_sample: \"model_sample\"\n)\n\nputs(response)"}},{"title":"Score an audio response","request":{"curl":"curl -X POST https://api.openai.com/v1/fine_tuning/alpha/graders/run \\\n -H \"Content-Type: application/json\" \\\n -H \"Authorization: Bearer $OPENAI_API_KEY\" \\\n -d '{\n \"grader\": {\n \"type\": \"score_model\",\n \"name\": \"Audio clarity grader\",\n \"input\": [\n {\n \"role\": \"user\",\n \"content\": [\n {\n \"type\": \"input_text\",\n \"text\": \"Listen to the clip and return a confidence score from 0 to 1 that the speaker said: {{item.target_phrase}}\"\n },\n {\n \"type\": \"input_audio\",\n \"input_audio\": {\n \"data\": \"{{item.audio_clip_b64}}\",\n \"format\": \"mp3\"\n }\n }\n ]\n }\n ],\n \"model\": \"gpt-audio\",\n \"sampling_params\": {\n \"temperature\": 0.2,\n \"top_p\": 1,\n \"seed\": 123\n }\n },\n \"item\": {\n \"target_phrase\": \"Please deliver the package on Tuesday\",\n \"audio_clip_b64\": \"<base64-encoded mp3>\"\n },\n \"model_sample\": \"Please deliver the package on Tuesday\"\n }'\n","node.js":"import OpenAI from 'openai';\n\nconst client = new OpenAI({\n apiKey: process.env['OPENAI_API_KEY'], // This is the default and can be omitted\n});\n\nconst response = await client.fineTuning.alpha.graders.run({\n grader: {\n input: 'input',\n name: 'name',\n operation: 'eq',\n reference: 'reference',\n type: 'string_check',\n },\n model_sample: 'model_sample',\n});\n\nconsole.log(response.metadata);","python":"import os\nfrom openai import OpenAI\n\nclient = OpenAI(\n api_key=os.environ.get(\"OPENAI_API_KEY\"), # This is the default and can be omitted\n)\nresponse = client.fine_tuning.alpha.graders.run(\n grader={\n \"input\": \"input\",\n \"name\": \"name\",\n \"operation\": \"eq\",\n \"reference\": \"reference\",\n \"type\": \"string_check\",\n },\n model_sample=\"model_sample\",\n)\nprint(response.metadata)","go":"package main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\n\t\"github.com/openai/openai-go\"\n\t\"github.com/openai/openai-go/option\"\n)\n\nfunc main() {\n\tclient := openai.NewClient(\n\t\toption.WithAPIKey(\"My API Key\"),\n\t)\n\tresponse, err := client.FineTuning.Alpha.Graders.Run(context.TODO(), openai.FineTuningAlphaGraderRunParams{\n\t\tGrader: openai.FineTuningAlphaGraderRunParamsGraderUnion{\n\t\t\tOfStringCheck: &openai.StringCheckGraderParam{\n\t\t\t\tInput: \"input\",\n\t\t\t\tName: \"name\",\n\t\t\t\tOperation: openai.StringCheckGraderOperationEq,\n\t\t\t\tReference: \"reference\",\n\t\t\t},\n\t\t},\n\t\tModelSample: \"model_sample\",\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf(\"%+v\\n\", response.Metadata)\n}\n","java":"package com.openai.example;\n\nimport com.openai.client.OpenAIClient;\nimport com.openai.client.okhttp.OpenAIOkHttpClient;\nimport com.openai.models.finetuning.alpha.graders.GraderRunParams;\nimport com.openai.models.finetuning.alpha.graders.GraderRunResponse;\nimport com.openai.models.graders.gradermodels.StringCheckGrader;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n OpenAIClient client = OpenAIOkHttpClient.fromEnv();\n\n GraderRunParams params = GraderRunParams.builder()\n .grader(StringCheckGrader.builder()\n .input(\"input\")\n .name(\"name\")\n .operation(StringCheckGrader.Operation.EQ)\n .reference(\"reference\")\n .build())\n .modelSample(\"model_sample\")\n .build();\n GraderRunResponse response = client.fineTuning().alpha().graders().run(params);\n }\n}","ruby":"require \"openai\"\n\nopenai = OpenAI::Client.new(api_key: \"My API Key\")\n\nresponse = openai.fine_tuning.alpha.graders.run(\n grader: {input: \"input\", name: \"name\", operation: :eq, reference: \"reference\", type: :string_check},\n model_sample: \"model_sample\"\n)\n\nputs(response)"}}]}}},"/fine_tuning/alpha/graders/validate":{"post":{"operationId":"validateGrader","tags":["Fine-tuning"],"summary":"Validate a grader.\n","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidateGraderRequest"}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidateGraderResponse"}}}}},"x-oaiMeta":{"name":"Validate grader","beta":true,"group":"graders","examples":{"request":{"curl":"curl https://api.openai.com/v1/fine_tuning/alpha/graders/validate \\\n -H \"Authorization: Bearer $OPENAI_API_KEY\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"grader\": {\n \"type\": \"string_check\",\n \"name\": \"Example string check grader\",\n \"input\": \"{{sample.output_text}}\",\n \"reference\": \"{{item.label}}\",\n \"operation\": \"eq\"\n }\n }'\n","node.js":"import OpenAI from 'openai';\n\nconst client = new OpenAI({\n apiKey: process.env['OPENAI_API_KEY'], // This is the default and can be omitted\n});\n\nconst response = await client.fineTuning.alpha.graders.validate({\n grader: {\n input: 'input',\n name: 'name',\n operation: 'eq',\n reference: 'reference',\n type: 'string_check',\n },\n});\n\nconsole.log(response.grader);","python":"import os\nfrom openai import OpenAI\n\nclient = OpenAI(\n api_key=os.environ.get(\"OPENAI_API_KEY\"), # This is the default and can be omitted\n)\nresponse = client.fine_tuning.alpha.graders.validate(\n grader={\n \"input\": \"input\",\n \"name\": \"name\",\n \"operation\": \"eq\",\n \"reference\": \"reference\",\n \"type\": \"string_check\",\n },\n)\nprint(response.grader)","go":"package main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\n\t\"github.com/openai/openai-go\"\n\t\"github.com/openai/openai-go/option\"\n)\n\nfunc main() {\n\tclient := openai.NewClient(\n\t\toption.WithAPIKey(\"My API Key\"),\n\t)\n\tresponse, err := client.FineTuning.Alpha.Graders.Validate(context.TODO(), openai.FineTuningAlphaGraderValidateParams{\n\t\tGrader: openai.FineTuningAlphaGraderValidateParamsGraderUnion{\n\t\t\tOfStringCheckGrader: &openai.StringCheckGraderParam{\n\t\t\t\tInput: \"input\",\n\t\t\t\tName: \"name\",\n\t\t\t\tOperation: openai.StringCheckGraderOperationEq,\n\t\t\t\tReference: \"reference\",\n\t\t\t},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf(\"%+v\\n\", response.Grader)\n}\n","java":"package com.openai.example;\n\nimport com.openai.client.OpenAIClient;\nimport com.openai.client.okhttp.OpenAIOkHttpClient;\nimport com.openai.models.finetuning.alpha.graders.GraderValidateParams;\nimport com.openai.models.finetuning.alpha.graders.GraderValidateResponse;\nimport com.openai.models.graders.gradermodels.StringCheckGrader;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n OpenAIClient client = OpenAIOkHttpClient.fromEnv();\n\n GraderValidateParams params = GraderValidateParams.builder()\n .grader(StringCheckGrader.builder()\n .input(\"input\")\n .name(\"name\")\n .operation(StringCheckGrader.Operation.EQ)\n .reference(\"reference\")\n .build())\n .build();\n GraderValidateResponse response = client.fineTuning().alpha().graders().validate(params);\n }\n}","ruby":"require \"openai\"\n\nopenai = OpenAI::Client.new(api_key: \"My API Key\")\n\nresponse = openai.fine_tuning.alpha.graders.validate(\n grader: {input: \"input\", name: \"name\", operation: :eq, reference: \"reference\", type: :string_check}\n)\n\nputs(response)"},"response":"{\n \"grader\": {\n \"type\": \"string_check\",\n \"name\": \"Example string check grader\",\n \"input\": \"{{sample.output_text}}\",\n \"reference\": \"{{item.label}}\",\n \"operation\": \"eq\"\n }\n}\n"}}}},"/fine_tuning/checkpoints/{fine_tuned_model_checkpoint}/permissions":{"get":{"operationId":"listFineTuningCheckpointPermissions","tags":["Fine-tuning"],"summary":"**NOTE:** This endpoint requires an [admin API key](../admin-api-keys).\n\nOrganization owners can use this endpoint to view all permissions for a fine-tuned model checkpoint.\n","parameters":[{"in":"path","name":"fine_tuned_model_checkpoint","required":true,"schema":{"type":"string","example":"ft-AF1WoRqd3aJAHsqc9NY7iL8F"},"description":"The ID of the fine-tuned model checkpoint to get permissions for.\n"},{"name":"project_id","in":"query","description":"The ID of the project to get permissions for.","required":false,"schema":{"type":"string"}},{"name":"after","in":"query","description":"Identifier for the last permission ID from the previous pagination request.","required":false,"schema":{"type":"string"}},{"name":"limit","in":"query","description":"Number of permissions to retrieve.","required":false,"schema":{"type":"integer","default":10}},{"name":"order","in":"query","description":"The order in which to retrieve permissions.","required":false,"schema":{"type":"string","enum":["ascending","descending"],"default":"descending"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListFineTuningCheckpointPermissionResponse"}}}}},"x-oaiMeta":{"name":"List checkpoint permissions","group":"fine-tuning","examples":{"request":{"curl":"curl https://api.openai.com/v1/fine_tuning/checkpoints/ft:gpt-4o-mini-2024-07-18:org:weather:B7R9VjQd/permissions \\\n -H \"Authorization: Bearer $OPENAI_API_KEY\"\n","node.js":"import OpenAI from 'openai';\n\nconst client = new OpenAI({\n apiKey: process.env['OPENAI_API_KEY'], // This is the default and can be omitted\n});\n\nconst permission = await client.fineTuning.checkpoints.permissions.retrieve(\n 'ft-AF1WoRqd3aJAHsqc9NY7iL8F',\n);\n\nconsole.log(permission.first_id);","python":"import os\nfrom openai import OpenAI\n\nclient = OpenAI(\n api_key=os.environ.get(\"OPENAI_API_KEY\"), # This is the default and can be omitted\n)\npermission = client.fine_tuning.checkpoints.permissions.retrieve(\n fine_tuned_model_checkpoint=\"ft-AF1WoRqd3aJAHsqc9NY7iL8F\",\n)\nprint(permission.first_id)","go":"package main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\n\t\"github.com/openai/openai-go\"\n\t\"github.com/openai/openai-go/option\"\n)\n\nfunc main() {\n\tclient := openai.NewClient(\n\t\toption.WithAPIKey(\"My API Key\"),\n\t)\n\tpermission, err := client.FineTuning.Checkpoints.Permissions.Get(\n\t\tcontext.TODO(),\n\t\t\"ft-AF1WoRqd3aJAHsqc9NY7iL8F\",\n\t\topenai.FineTuningCheckpointPermissionGetParams{},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf(\"%+v\\n\", permission.FirstID)\n}\n","java":"package com.openai.example;\n\nimport com.openai.client.OpenAIClient;\nimport com.openai.client.okhttp.OpenAIOkHttpClient;\nimport com.openai.models.finetuning.checkpoints.permissions.PermissionRetrieveParams;\nimport com.openai.models.finetuning.checkpoints.permissions.PermissionRetrieveResponse;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n OpenAIClient client = OpenAIOkHttpClient.fromEnv();\n\n PermissionRetrieveResponse permission = client.fineTuning().checkpoints().permissions().retrieve(\"ft-AF1WoRqd3aJAHsqc9NY7iL8F\");\n }\n}","ruby":"require \"openai\"\n\nopenai = OpenAI::Client.new(api_key: \"My API Key\")\n\npermission = openai.fine_tuning.checkpoints.permissions.retrieve(\"ft-AF1WoRqd3aJAHsqc9NY7iL8F\")\n\nputs(permission)"},"response":"{\n \"object\": \"list\",\n \"data\": [\n {\n \"object\": \"checkpoint.permission\",\n \"id\": \"cp_zc4Q7MP6XxulcVzj4MZdwsAB\",\n \"created_at\": 1721764867,\n \"project_id\": \"proj_abGMw1llN8IrBb6SvvY5A1iH\"\n },\n {\n \"object\": \"checkpoint.permission\",\n \"id\": \"cp_enQCFmOTGj3syEpYVhBRLTSy\",\n \"created_at\": 1721764800,\n \"project_id\": \"proj_iqGMw1llN8IrBb6SvvY5A1oF\"\n },\n ],\n \"first_id\": \"cp_zc4Q7MP6XxulcVzj4MZdwsAB\",\n \"last_id\": \"cp_enQCFmOTGj3syEpYVhBRLTSy\",\n \"has_more\": false\n}\n"}}},"post":{"operationId":"createFineTuningCheckpointPermission","tags":["Fine-tuning"],"summary":"**NOTE:** Calling this endpoint requires an [admin API key](../admin-api-keys).\n\nThis enables organization owners to share fine-tuned models with other projects in their organization.\n","parameters":[{"in":"path","name":"fine_tuned_model_checkpoint","required":true,"schema":{"type":"string","example":"ft:gpt-4o-mini-2024-07-18:org:weather:B7R9VjQd"},"description":"The ID of the fine-tuned model checkpoint to create a permission for.\n"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateFineTuningCheckpointPermissionRequest"}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListFineTuningCheckpointPermissionResponse"}}}}},"x-oaiMeta":{"name":"Create checkpoint permissions","group":"fine-tuning","examples":{"request":{"curl":"curl https://api.openai.com/v1/fine_tuning/checkpoints/ft:gpt-4o-mini-2024-07-18:org:weather:B7R9VjQd/permissions \\\n -H \"Authorization: Bearer $OPENAI_API_KEY\"\n -d '{\"project_ids\": [\"proj_abGMw1llN8IrBb6SvvY5A1iH\"]}'\n","node.js":"import OpenAI from 'openai';\n\nconst client = new OpenAI({\n apiKey: process.env['OPENAI_API_KEY'], // This is the default and can be omitted\n});\n\n// Automatically fetches more pages as needed.\nfor await (const permissionCreateResponse of client.fineTuning.checkpoints.permissions.create(\n 'ft:gpt-4o-mini-2024-07-18:org:weather:B7R9VjQd',\n { project_ids: ['string'] },\n)) {\n console.log(permissionCreateResponse.id);\n}","python":"import os\nfrom openai import OpenAI\n\nclient = OpenAI(\n api_key=os.environ.get(\"OPENAI_API_KEY\"), # This is the default and can be omitted\n)\npage = client.fine_tuning.checkpoints.permissions.create(\n fine_tuned_model_checkpoint=\"ft:gpt-4o-mini-2024-07-18:org:weather:B7R9VjQd\",\n project_ids=[\"string\"],\n)\npage = page.data[0]\nprint(page.id)","go":"package main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\n\t\"github.com/openai/openai-go\"\n\t\"github.com/openai/openai-go/option\"\n)\n\nfunc main() {\n\tclient := openai.NewClient(\n\t\toption.WithAPIKey(\"My API Key\"),\n\t)\n\tpage, err := client.FineTuning.Checkpoints.Permissions.New(\n\t\tcontext.TODO(),\n\t\t\"ft:gpt-4o-mini-2024-07-18:org:weather:B7R9VjQd\",\n\t\topenai.FineTuningCheckpointPermissionNewParams{\n\t\t\tProjectIDs: []string{\"string\"},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf(\"%+v\\n\", page)\n}\n","java":"package com.openai.example;\n\nimport com.openai.client.OpenAIClient;\nimport com.openai.client.okhttp.OpenAIOkHttpClient;\nimport com.openai.models.finetuning.checkpoints.permissions.PermissionCreatePage;\nimport com.openai.models.finetuning.checkpoints.permissions.PermissionCreateParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n OpenAIClient client = OpenAIOkHttpClient.fromEnv();\n\n PermissionCreateParams params = PermissionCreateParams.builder()\n .fineTunedModelCheckpoint(\"ft:gpt-4o-mini-2024-07-18:org:weather:B7R9VjQd\")\n .addProjectId(\"string\")\n .build();\n PermissionCreatePage page = client.fineTuning().checkpoints().permissions().create(params);\n }\n}","ruby":"require \"openai\"\n\nopenai = OpenAI::Client.new(api_key: \"My API Key\")\n\npage = openai.fine_tuning.checkpoints.permissions.create(\n \"ft:gpt-4o-mini-2024-07-18:org:weather:B7R9VjQd\",\n project_ids: [\"string\"]\n)\n\nputs(page)"},"response":"{\n \"object\": \"list\",\n \"data\": [\n {\n \"object\": \"checkpoint.permission\",\n \"id\": \"cp_zc4Q7MP6XxulcVzj4MZdwsAB\",\n \"created_at\": 1721764867,\n \"project_id\": \"proj_abGMw1llN8IrBb6SvvY5A1iH\"\n }\n ],\n \"first_id\": \"cp_zc4Q7MP6XxulcVzj4MZdwsAB\",\n \"last_id\": \"cp_zc4Q7MP6XxulcVzj4MZdwsAB\",\n \"has_more\": false\n}\n"}}}},"/fine_tuning/checkpoints/{fine_tuned_model_checkpoint}/permissions/{permission_id}":{"delete":{"operationId":"deleteFineTuningCheckpointPermission","tags":["Fine-tuning"],"summary":"**NOTE:** This endpoint requires an [admin API key](../admin-api-keys).\n\nOrganization owners can use this endpoint to delete a permission for a fine-tuned model checkpoint.\n","parameters":[{"in":"path","name":"fine_tuned_model_checkpoint","required":true,"schema":{"type":"string","example":"ft:gpt-4o-mini-2024-07-18:org:weather:B7R9VjQd"},"description":"The ID of the fine-tuned model checkpoint to delete a permission for.\n"},{"in":"path","name":"permission_id","required":true,"schema":{"type":"string","example":"cp_zc4Q7MP6XxulcVzj4MZdwsAB"},"description":"The ID of the fine-tuned model checkpoint permission to delete.\n"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteFineTuningCheckpointPermissionResponse"}}}}},"x-oaiMeta":{"name":"Delete checkpoint permission","group":"fine-tuning","examples":{"request":{"curl":"curl https://api.openai.com/v1/fine_tuning/checkpoints/ft:gpt-4o-mini-2024-07-18:org:weather:B7R9VjQd/permissions/cp_zc4Q7MP6XxulcVzj4MZdwsAB \\\n -H \"Authorization: Bearer $OPENAI_API_KEY\"\n","node.js":"import OpenAI from 'openai';\n\nconst client = new OpenAI({\n apiKey: process.env['OPENAI_API_KEY'], // This is the default and can be omitted\n});\n\nconst permission = await client.fineTuning.checkpoints.permissions.delete(\n 'cp_zc4Q7MP6XxulcVzj4MZdwsAB',\n { fine_tuned_model_checkpoint: 'ft:gpt-4o-mini-2024-07-18:org:weather:B7R9VjQd' },\n);\n\nconsole.log(permission.id);","python":"import os\nfrom openai import OpenAI\n\nclient = OpenAI(\n api_key=os.environ.get(\"OPENAI_API_KEY\"), # This is the default and can be omitted\n)\npermission = client.fine_tuning.checkpoints.permissions.delete(\n permission_id=\"cp_zc4Q7MP6XxulcVzj4MZdwsAB\",\n fine_tuned_model_checkpoint=\"ft:gpt-4o-mini-2024-07-18:org:weather:B7R9VjQd\",\n)\nprint(permission.id)","go":"package main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\n\t\"github.com/openai/openai-go\"\n\t\"github.com/openai/openai-go/option\"\n)\n\nfunc main() {\n\tclient := openai.NewClient(\n\t\toption.WithAPIKey(\"My API Key\"),\n\t)\n\tpermission, err := client.FineTuning.Checkpoints.Permissions.Delete(\n\t\tcontext.TODO(),\n\t\t\"ft:gpt-4o-mini-2024-07-18:org:weather:B7R9VjQd\",\n\t\t\"cp_zc4Q7MP6XxulcVzj4MZdwsAB\",\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf(\"%+v\\n\", permission.ID)\n}\n","java":"package com.openai.example;\n\nimport com.openai.client.OpenAIClient;\nimport com.openai.client.okhttp.OpenAIOkHttpClient;\nimport com.openai.models.finetuning.checkpoints.permissions.PermissionDeleteParams;\nimport com.openai.models.finetuning.checkpoints.permissions.PermissionDeleteResponse;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n OpenAIClient client = OpenAIOkHttpClient.fromEnv();\n\n PermissionDeleteParams params = PermissionDeleteParams.builder()\n .fineTunedModelCheckpoint(\"ft:gpt-4o-mini-2024-07-18:org:weather:B7R9VjQd\")\n .permissionId(\"cp_zc4Q7MP6XxulcVzj4MZdwsAB\")\n .build();\n PermissionDeleteResponse permission = client.fineTuning().checkpoints().permissions().delete(params);\n }\n}","ruby":"require \"openai\"\n\nopenai = OpenAI::Client.new(api_key: \"My API Key\")\n\npermission = openai.fine_tuning.checkpoints.permissions.delete(\n \"cp_zc4Q7MP6XxulcVzj4MZdwsAB\",\n fine_tuned_model_checkpoint: \"ft:gpt-4o-mini-2024-07-18:org:weather:B7R9VjQd\"\n)\n\nputs(permission)"},"response":"{\n \"object\": \"checkpoint.permission\",\n \"id\": \"cp_zc4Q7MP6XxulcVzj4MZdwsAB\",\n \"deleted\": true\n}\n"}}}},"/fine_tuning/jobs":{"post":{"operationId":"createFineTuningJob","tags":["Fine-tuning"],"summary":"Creates a fine-tuning job which begins the process of creating a new model from a given dataset.\n\nResponse includes details of the enqueued job including job status and the name of the fine-tuned models once complete.\n\n[Learn more about fine-tuning](/docs/guides/model-optimization)\n","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateFineTuningJobRequest"}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FineTuningJob"}}}}},"x-oaiMeta":{"name":"Create fine-tuning job","group":"fine-tuning","examples":[{"title":"Default","request":{"curl":"curl https://api.openai.com/v1/fine_tuning/jobs \\\n -H \"Content-Type: application/json\" \\\n -H \"Authorization: Bearer $OPENAI_API_KEY\" \\\n -d '{\n \"training_file\": \"file-BK7bzQj3FfZFXr7DbL6xJwfo\",\n \"model\": \"gpt-4o-mini\"\n }'\n","python":"import os\nfrom openai import OpenAI\n\nclient = OpenAI(\n api_key=os.environ.get(\"OPENAI_API_KEY\"), # This is the default and can be omitted\n)\nfine_tuning_job = client.fine_tuning.jobs.create(\n model=\"gpt-4o-mini\",\n training_file=\"file-abc123\",\n)\nprint(fine_tuning_job.id)","javascript":"import OpenAI from \"openai\";\n\nconst openai = new OpenAI();\n\nasync function main() {\n const fineTune = await openai.fineTuning.jobs.create({\n training_file: \"file-abc123\"\n });\n\n console.log(fineTune);\n}\n\nmain();\n","node.js":"import OpenAI from 'openai';\n\nconst client = new OpenAI({\n apiKey: process.env['OPENAI_API_KEY'], // This is the default and can be omitted\n});\n\nconst fineTuningJob = await client.fineTuning.jobs.create({\n model: 'gpt-4o-mini',\n training_file: 'file-abc123',\n});\n\nconsole.log(fineTuningJob.id);","go":"package main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\n\t\"github.com/openai/openai-go\"\n\t\"github.com/openai/openai-go/option\"\n)\n\nfunc main() {\n\tclient := openai.NewClient(\n\t\toption.WithAPIKey(\"My API Key\"),\n\t)\n\tfineTuningJob, err := client.FineTuning.Jobs.New(context.TODO(), openai.FineTuningJobNewParams{\n\t\tModel: openai.FineTuningJobNewParamsModelGPT4oMini,\n\t\tTrainingFile: \"file-abc123\",\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf(\"%+v\\n\", fineTuningJob.ID)\n}\n","java":"package com.openai.example;\n\nimport com.openai.client.OpenAIClient;\nimport com.openai.client.okhttp.OpenAIOkHttpClient;\nimport com.openai.models.finetuning.jobs.FineTuningJob;\nimport com.openai.models.finetuning.jobs.JobCreateParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n OpenAIClient client = OpenAIOkHttpClient.fromEnv();\n\n JobCreateParams params = JobCreateParams.builder()\n .model(JobCreateParams.Model.GPT_4O_MINI)\n .trainingFile(\"file-abc123\")\n .build();\n FineTuningJob fineTuningJob = client.fineTuning().jobs().create(params);\n }\n}","ruby":"require \"openai\"\n\nopenai = OpenAI::Client.new(api_key: \"My API Key\")\n\nfine_tuning_job = openai.fine_tuning.jobs.create(model: :\"gpt-4o-mini\", training_file: \"file-abc123\")\n\nputs(fine_tuning_job)"},"response":"{\n \"object\": \"fine_tuning.job\",\n \"id\": \"ftjob-abc123\",\n \"model\": \"gpt-4o-mini-2024-07-18\",\n \"created_at\": 1721764800,\n \"fine_tuned_model\": null,\n \"organization_id\": \"org-123\",\n \"result_files\": [],\n \"status\": \"queued\",\n \"validation_file\": null,\n \"training_file\": \"file-abc123\",\n \"method\": {\n \"type\": \"supervised\",\n \"supervised\": {\n \"hyperparameters\": {\n \"batch_size\": \"auto\",\n \"learning_rate_multiplier\": \"auto\",\n \"n_epochs\": \"auto\",\n }\n }\n },\n \"metadata\": null\n}\n"},{"title":"Epochs","request":{"curl":"curl https://api.openai.com/v1/fine_tuning/jobs \\\n -H \"Content-Type: application/json\" \\\n -H \"Authorization: Bearer $OPENAI_API_KEY\" \\\n -d '{\n \"training_file\": \"file-abc123\",\n \"model\": \"gpt-4o-mini\",\n \"method\": {\n \"type\": \"supervised\",\n \"supervised\": {\n \"hyperparameters\": {\n \"n_epochs\": 2\n }\n }\n }\n }'\n","python":"import os\nfrom openai import OpenAI\n\nclient = OpenAI(\n api_key=os.environ.get(\"OPENAI_API_KEY\"), # This is the default and can be omitted\n)\nfine_tuning_job = client.fine_tuning.jobs.create(\n model=\"gpt-4o-mini\",\n training_file=\"file-abc123\",\n)\nprint(fine_tuning_job.id)","javascript":"import OpenAI from \"openai\";\nimport { SupervisedMethod, SupervisedHyperparameters } from \"openai/resources/fine-tuning/methods\";\n\nconst openai = new OpenAI();\n\nasync function main() {\n const fineTune = await openai.fineTuning.jobs.create({\n training_file: \"file-abc123\",\n model: \"gpt-4o-mini\",\n method: {\n type: \"supervised\",\n supervised: {\n hyperparameters: {\n n_epochs: 2\n }\n }\n }\n });\n\n console.log(fineTune);\n}\n\nmain();\n","node.js":"import OpenAI from 'openai';\n\nconst client = new OpenAI({\n apiKey: process.env['OPENAI_API_KEY'], // This is the default and can be omitted\n});\n\nconst fineTuningJob = await client.fineTuning.jobs.create({\n model: 'gpt-4o-mini',\n training_file: 'file-abc123',\n});\n\nconsole.log(fineTuningJob.id);","go":"package main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\n\t\"github.com/openai/openai-go\"\n\t\"github.com/openai/openai-go/option\"\n)\n\nfunc main() {\n\tclient := openai.NewClient(\n\t\toption.WithAPIKey(\"My API Key\"),\n\t)\n\tfineTuningJob, err := client.FineTuning.Jobs.New(context.TODO(), openai.FineTuningJobNewParams{\n\t\tModel: openai.FineTuningJobNewParamsModelGPT4oMini,\n\t\tTrainingFile: \"file-abc123\",\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf(\"%+v\\n\", fineTuningJob.ID)\n}\n","java":"package com.openai.example;\n\nimport com.openai.client.OpenAIClient;\nimport com.openai.client.okhttp.OpenAIOkHttpClient;\nimport com.openai.models.finetuning.jobs.FineTuningJob;\nimport com.openai.models.finetuning.jobs.JobCreateParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n OpenAIClient client = OpenAIOkHttpClient.fromEnv();\n\n JobCreateParams params = JobCreateParams.builder()\n .model(JobCreateParams.Model.GPT_4O_MINI)\n .trainingFile(\"file-abc123\")\n .build();\n FineTuningJob fineTuningJob = client.fineTuning().jobs().create(params);\n }\n}","ruby":"require \"openai\"\n\nopenai = OpenAI::Client.new(api_key: \"My API Key\")\n\nfine_tuning_job = openai.fine_tuning.jobs.create(model: :\"gpt-4o-mini\", training_file: \"file-abc123\")\n\nputs(fine_tuning_job)"},"response":"{\n \"object\": \"fine_tuning.job\",\n \"id\": \"ftjob-abc123\",\n \"model\": \"gpt-4o-mini\",\n \"created_at\": 1721764800,\n \"fine_tuned_model\": null,\n \"organization_id\": \"org-123\",\n \"result_files\": [],\n \"status\": \"queued\",\n \"validation_file\": null,\n \"training_file\": \"file-abc123\",\n \"hyperparameters\": {\n \"batch_size\": \"auto\",\n \"learning_rate_multiplier\": \"auto\",\n \"n_epochs\": 2\n },\n \"method\": {\n \"type\": \"supervised\",\n \"supervised\": {\n \"hyperparameters\": {\n \"batch_size\": \"auto\",\n \"learning_rate_multiplier\": \"auto\",\n \"n_epochs\": 2\n }\n }\n },\n \"metadata\": null,\n \"error\": {\n \"code\": null,\n \"message\": null,\n \"param\": null\n },\n \"finished_at\": null,\n \"seed\": 683058546,\n \"trained_tokens\": null,\n \"estimated_finish\": null,\n \"integrations\": [],\n \"user_provided_suffix\": null,\n \"usage_metrics\": null,\n \"shared_with_openai\": false\n}\n"},{"title":"DPO","request":{"curl":"curl https://api.openai.com/v1/fine_tuning/jobs \\\n -H \"Content-Type: application/json\" \\\n -H \"Authorization: Bearer $OPENAI_API_KEY\" \\\n -d '{\n \"training_file\": \"file-abc123\",\n \"validation_file\": \"file-abc123\",\n \"model\": \"gpt-4o-mini\",\n \"method\": {\n \"type\": \"dpo\",\n \"dpo\": {\n \"hyperparameters\": {\n \"beta\": 0.1\n }\n }\n }\n }'\n","python":"import os\nfrom openai import OpenAI\n\nclient = OpenAI(\n api_key=os.environ.get(\"OPENAI_API_KEY\"), # This is the default and can be omitted\n)\nfine_tuning_job = client.fine_tuning.jobs.create(\n model=\"gpt-4o-mini\",\n training_file=\"file-abc123\",\n)\nprint(fine_tuning_job.id)","node.js":"import OpenAI from 'openai';\n\nconst client = new OpenAI({\n apiKey: process.env['OPENAI_API_KEY'], // This is the default and can be omitted\n});\n\nconst fineTuningJob = await client.fineTuning.jobs.create({\n model: 'gpt-4o-mini',\n training_file: 'file-abc123',\n});\n\nconsole.log(fineTuningJob.id);","go":"package main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\n\t\"github.com/openai/openai-go\"\n\t\"github.com/openai/openai-go/option\"\n)\n\nfunc main() {\n\tclient := openai.NewClient(\n\t\toption.WithAPIKey(\"My API Key\"),\n\t)\n\tfineTuningJob, err := client.FineTuning.Jobs.New(context.TODO(), openai.FineTuningJobNewParams{\n\t\tModel: openai.FineTuningJobNewParamsModelGPT4oMini,\n\t\tTrainingFile: \"file-abc123\",\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf(\"%+v\\n\", fineTuningJob.ID)\n}\n","java":"package com.openai.example;\n\nimport com.openai.client.OpenAIClient;\nimport com.openai.client.okhttp.OpenAIOkHttpClient;\nimport com.openai.models.finetuning.jobs.FineTuningJob;\nimport com.openai.models.finetuning.jobs.JobCreateParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n OpenAIClient client = OpenAIOkHttpClient.fromEnv();\n\n JobCreateParams params = JobCreateParams.builder()\n .model(JobCreateParams.Model.GPT_4O_MINI)\n .trainingFile(\"file-abc123\")\n .build();\n FineTuningJob fineTuningJob = client.fineTuning().jobs().create(params);\n }\n}","ruby":"require \"openai\"\n\nopenai = OpenAI::Client.new(api_key: \"My API Key\")\n\nfine_tuning_job = openai.fine_tuning.jobs.create(model: :\"gpt-4o-mini\", training_file: \"file-abc123\")\n\nputs(fine_tuning_job)"},"response":"{\n \"object\": \"fine_tuning.job\",\n \"id\": \"ftjob-abc\",\n \"model\": \"gpt-4o-mini\",\n \"created_at\": 1746130590,\n \"fine_tuned_model\": null,\n \"organization_id\": \"org-abc\",\n \"result_files\": [],\n \"status\": \"queued\",\n \"validation_file\": \"file-123\",\n \"training_file\": \"file-abc\",\n \"method\": {\n \"type\": \"dpo\",\n \"dpo\": {\n \"hyperparameters\": {\n \"beta\": 0.1,\n \"batch_size\": \"auto\",\n \"learning_rate_multiplier\": \"auto\",\n \"n_epochs\": \"auto\"\n }\n }\n },\n \"metadata\": null,\n \"error\": {\n \"code\": null,\n \"message\": null,\n \"param\": null\n },\n \"finished_at\": null,\n \"hyperparameters\": null,\n \"seed\": 1036326793,\n \"estimated_finish\": null,\n \"integrations\": [],\n \"user_provided_suffix\": null,\n \"usage_metrics\": null,\n \"shared_with_openai\": false\n}\n"},{"title":"Reinforcement","request":{"curl":"curl https://api.openai.com/v1/fine_tuning/jobs \\\n -H \"Content-Type: application/json\" \\\n -H \"Authorization: Bearer $OPENAI_API_KEY\" \\\n -d '{\n \"training_file\": \"file-abc\",\n \"validation_file\": \"file-123\",\n \"model\": \"o4-mini\",\n \"method\": {\n \"type\": \"reinforcement\",\n \"reinforcement\": {\n \"grader\": {\n \"type\": \"string_check\",\n \"name\": \"Example string check grader\",\n \"input\": \"{{sample.output_text}}\",\n \"reference\": \"{{item.label}}\",\n \"operation\": \"eq\"\n },\n \"hyperparameters\": {\n \"reasoning_effort\": \"medium\"\n }\n }\n }\n }'\n","python":"import os\nfrom openai import OpenAI\n\nclient = OpenAI(\n api_key=os.environ.get(\"OPENAI_API_KEY\"), # This is the default and can be omitted\n)\nfine_tuning_job = client.fine_tuning.jobs.create(\n model=\"gpt-4o-mini\",\n training_file=\"file-abc123\",\n)\nprint(fine_tuning_job.id)","node.js":"import OpenAI from 'openai';\n\nconst client = new OpenAI({\n apiKey: process.env['OPENAI_API_KEY'], // This is the default and can be omitted\n});\n\nconst fineTuningJob = await client.fineTuning.jobs.create({\n model: 'gpt-4o-mini',\n training_file: 'file-abc123',\n});\n\nconsole.log(fineTuningJob.id);","go":"package main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\n\t\"github.com/openai/openai-go\"\n\t\"github.com/openai/openai-go/option\"\n)\n\nfunc main() {\n\tclient := openai.NewClient(\n\t\toption.WithAPIKey(\"My API Key\"),\n\t)\n\tfineTuningJob, err := client.FineTuning.Jobs.New(context.TODO(), openai.FineTuningJobNewParams{\n\t\tModel: openai.FineTuningJobNewParamsModelGPT4oMini,\n\t\tTrainingFile: \"file-abc123\",\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf(\"%+v\\n\", fineTuningJob.ID)\n}\n","java":"package com.openai.example;\n\nimport com.openai.client.OpenAIClient;\nimport com.openai.client.okhttp.OpenAIOkHttpClient;\nimport com.openai.models.finetuning.jobs.FineTuningJob;\nimport com.openai.models.finetuning.jobs.JobCreateParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n OpenAIClient client = OpenAIOkHttpClient.fromEnv();\n\n JobCreateParams params = JobCreateParams.builder()\n .model(JobCreateParams.Model.GPT_4O_MINI)\n .trainingFile(\"file-abc123\")\n .build();\n FineTuningJob fineTuningJob = client.fineTuning().jobs().create(params);\n }\n}","ruby":"require \"openai\"\n\nopenai = OpenAI::Client.new(api_key: \"My API Key\")\n\nfine_tuning_job = openai.fine_tuning.jobs.create(model: :\"gpt-4o-mini\", training_file: \"file-abc123\")\n\nputs(fine_tuning_job)"},"response":"{\n \"object\": \"fine_tuning.job\",\n \"id\": \"ftjob-abc123\",\n \"model\": \"o4-mini\",\n \"created_at\": 1721764800,\n \"finished_at\": null,\n \"fine_tuned_model\": null,\n \"organization_id\": \"org-123\",\n \"result_files\": [],\n \"status\": \"validating_files\",\n \"validation_file\": \"file-123\",\n \"training_file\": \"file-abc\",\n \"trained_tokens\": null,\n \"error\": {},\n \"user_provided_suffix\": null,\n \"seed\": 950189191,\n \"estimated_finish\": null,\n \"integrations\": [],\n \"method\": {\n \"type\": \"reinforcement\",\n \"reinforcement\": {\n \"hyperparameters\": {\n \"batch_size\": \"auto\",\n \"learning_rate_multiplier\": \"auto\",\n \"n_epochs\": \"auto\",\n \"eval_interval\": \"auto\",\n \"eval_samples\": \"auto\",\n \"compute_multiplier\": \"auto\",\n \"reasoning_effort\": \"medium\"\n },\n \"grader\": {\n \"type\": \"string_check\",\n \"name\": \"Example string check grader\",\n \"input\": \"{{sample.output_text}}\",\n \"reference\": \"{{item.label}}\",\n \"operation\": \"eq\"\n },\n \"response_format\": null\n }\n },\n \"metadata\": null,\n \"usage_metrics\": null,\n \"shared_with_openai\": false\n}\n \n"},{"title":"Validation file","request":{"curl":"curl https://api.openai.com/v1/fine_tuning/jobs \\\n -H \"Content-Type: application/json\" \\\n -H \"Authorization: Bearer $OPENAI_API_KEY\" \\\n -d '{\n \"training_file\": \"file-abc123\",\n \"validation_file\": \"file-abc123\",\n \"model\": \"gpt-4o-mini\"\n }'\n","python":"import os\nfrom openai import OpenAI\n\nclient = OpenAI(\n api_key=os.environ.get(\"OPENAI_API_KEY\"), # This is the default and can be omitted\n)\nfine_tuning_job = client.fine_tuning.jobs.create(\n model=\"gpt-4o-mini\",\n training_file=\"file-abc123\",\n)\nprint(fine_tuning_job.id)","javascript":"import OpenAI from \"openai\";\n\nconst openai = new OpenAI();\n\nasync function main() {\n const fineTune = await openai.fineTuning.jobs.create({\n training_file: \"file-abc123\",\n validation_file: \"file-abc123\"\n });\n\n console.log(fineTune);\n}\n\nmain();\n","node.js":"import OpenAI from 'openai';\n\nconst client = new OpenAI({\n apiKey: process.env['OPENAI_API_KEY'], // This is the default and can be omitted\n});\n\nconst fineTuningJob = await client.fineTuning.jobs.create({\n model: 'gpt-4o-mini',\n training_file: 'file-abc123',\n});\n\nconsole.log(fineTuningJob.id);","go":"package main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\n\t\"github.com/openai/openai-go\"\n\t\"github.com/openai/openai-go/option\"\n)\n\nfunc main() {\n\tclient := openai.NewClient(\n\t\toption.WithAPIKey(\"My API Key\"),\n\t)\n\tfineTuningJob, err := client.FineTuning.Jobs.New(context.TODO(), openai.FineTuningJobNewParams{\n\t\tModel: openai.FineTuningJobNewParamsModelGPT4oMini,\n\t\tTrainingFile: \"file-abc123\",\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf(\"%+v\\n\", fineTuningJob.ID)\n}\n","java":"package com.openai.example;\n\nimport com.openai.client.OpenAIClient;\nimport com.openai.client.okhttp.OpenAIOkHttpClient;\nimport com.openai.models.finetuning.jobs.FineTuningJob;\nimport com.openai.models.finetuning.jobs.JobCreateParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n OpenAIClient client = OpenAIOkHttpClient.fromEnv();\n\n JobCreateParams params = JobCreateParams.builder()\n .model(JobCreateParams.Model.GPT_4O_MINI)\n .trainingFile(\"file-abc123\")\n .build();\n FineTuningJob fineTuningJob = client.fineTuning().jobs().create(params);\n }\n}","ruby":"require \"openai\"\n\nopenai = OpenAI::Client.new(api_key: \"My API Key\")\n\nfine_tuning_job = openai.fine_tuning.jobs.create(model: :\"gpt-4o-mini\", training_file: \"file-abc123\")\n\nputs(fine_tuning_job)"},"response":"{\n \"object\": \"fine_tuning.job\",\n \"id\": \"ftjob-abc123\",\n \"model\": \"gpt-4o-mini-2024-07-18\",\n \"created_at\": 1721764800,\n \"fine_tuned_model\": null,\n \"organization_id\": \"org-123\",\n \"result_files\": [],\n \"status\": \"queued\",\n \"validation_file\": \"file-abc123\",\n \"training_file\": \"file-abc123\",\n \"method\": {\n \"type\": \"supervised\",\n \"supervised\": {\n \"hyperparameters\": {\n \"batch_size\": \"auto\",\n \"learning_rate_multiplier\": \"auto\",\n \"n_epochs\": \"auto\",\n }\n }\n },\n \"metadata\": null\n}\n"},{"title":"W&B Integration","request":{"curl":"curl https://api.openai.com/v1/fine_tuning/jobs \\\n -H \"Content-Type: application/json\" \\\n -H \"Authorization: Bearer $OPENAI_API_KEY\" \\\n -d '{\n \"training_file\": \"file-abc123\",\n \"validation_file\": \"file-abc123\",\n \"model\": \"gpt-4o-mini\",\n \"integrations\": [\n {\n \"type\": \"wandb\",\n \"wandb\": {\n \"project\": \"my-wandb-project\",\n \"name\": \"ft-run-display-name\"\n \"tags\": [\n \"first-experiment\", \"v2\"\n ]\n }\n }\n ]\n }'\n","node.js":"import OpenAI from 'openai';\n\nconst client = new OpenAI({\n apiKey: process.env['OPENAI_API_KEY'], // This is the default and can be omitted\n});\n\nconst fineTuningJob = await client.fineTuning.jobs.create({\n model: 'gpt-4o-mini',\n training_file: 'file-abc123',\n});\n\nconsole.log(fineTuningJob.id);","python":"import os\nfrom openai import OpenAI\n\nclient = OpenAI(\n api_key=os.environ.get(\"OPENAI_API_KEY\"), # This is the default and can be omitted\n)\nfine_tuning_job = client.fine_tuning.jobs.create(\n model=\"gpt-4o-mini\",\n training_file=\"file-abc123\",\n)\nprint(fine_tuning_job.id)","go":"package main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\n\t\"github.com/openai/openai-go\"\n\t\"github.com/openai/openai-go/option\"\n)\n\nfunc main() {\n\tclient := openai.NewClient(\n\t\toption.WithAPIKey(\"My API Key\"),\n\t)\n\tfineTuningJob, err := client.FineTuning.Jobs.New(context.TODO(), openai.FineTuningJobNewParams{\n\t\tModel: openai.FineTuningJobNewParamsModelGPT4oMini,\n\t\tTrainingFile: \"file-abc123\",\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf(\"%+v\\n\", fineTuningJob.ID)\n}\n","java":"package com.openai.example;\n\nimport com.openai.client.OpenAIClient;\nimport com.openai.client.okhttp.OpenAIOkHttpClient;\nimport com.openai.models.finetuning.jobs.FineTuningJob;\nimport com.openai.models.finetuning.jobs.JobCreateParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n OpenAIClient client = OpenAIOkHttpClient.fromEnv();\n\n JobCreateParams params = JobCreateParams.builder()\n .model(JobCreateParams.Model.GPT_4O_MINI)\n .trainingFile(\"file-abc123\")\n .build();\n FineTuningJob fineTuningJob = client.fineTuning().jobs().create(params);\n }\n}","ruby":"require \"openai\"\n\nopenai = OpenAI::Client.new(api_key: \"My API Key\")\n\nfine_tuning_job = openai.fine_tuning.jobs.create(model: :\"gpt-4o-mini\", training_file: \"file-abc123\")\n\nputs(fine_tuning_job)"},"response":"{\n \"object\": \"fine_tuning.job\",\n \"id\": \"ftjob-abc123\",\n \"model\": \"gpt-4o-mini-2024-07-18\",\n \"created_at\": 1721764800,\n \"fine_tuned_model\": null,\n \"organization_id\": \"org-123\",\n \"result_files\": [],\n \"status\": \"queued\",\n \"validation_file\": \"file-abc123\",\n \"training_file\": \"file-abc123\",\n \"integrations\": [\n {\n \"type\": \"wandb\",\n \"wandb\": {\n \"project\": \"my-wandb-project\",\n \"entity\": None,\n \"run_id\": \"ftjob-abc123\"\n }\n }\n ],\n \"method\": {\n \"type\": \"supervised\",\n \"supervised\": {\n \"hyperparameters\": {\n \"batch_size\": \"auto\",\n \"learning_rate_multiplier\": \"auto\",\n \"n_epochs\": \"auto\",\n }\n }\n },\n \"metadata\": null\n}\n"}]}},"get":{"operationId":"listPaginatedFineTuningJobs","tags":["Fine-tuning"],"summary":"List your organization's fine-tuning jobs\n","parameters":[{"name":"after","in":"query","description":"Identifier for the last job from the previous pagination request.","required":false,"schema":{"type":"string"}},{"name":"limit","in":"query","description":"Number of fine-tuning jobs to retrieve.","required":false,"schema":{"type":"integer","default":20}},{"in":"query","name":"metadata","required":false,"schema":{"type":"object","nullable":true,"additionalProperties":{"type":"string"}},"style":"deepObject","explode":true,"description":"Optional metadata filter. To filter, use the syntax `metadata[k]=v`. Alternatively, set `metadata=null` to indicate no metadata.\n"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListPaginatedFineTuningJobsResponse"}}}}},"x-oaiMeta":{"name":"List fine-tuning jobs","group":"fine-tuning","examples":{"request":{"curl":"curl https://api.openai.com/v1/fine_tuning/jobs?limit=2&metadata[key]=value \\\n -H \"Authorization: Bearer $OPENAI_API_KEY\"\n","python":"import os\nfrom openai import OpenAI\n\nclient = OpenAI(\n api_key=os.environ.get(\"OPENAI_API_KEY\"), # This is the default and can be omitted\n)\npage = client.fine_tuning.jobs.list()\npage = page.data[0]\nprint(page.id)","javascript":"import OpenAI from \"openai\";\n\nconst openai = new OpenAI();\n\nasync function main() {\n const list = await openai.fineTuning.jobs.list();\n\n for await (const fineTune of list) {\n console.log(fineTune);\n }\n}\n\nmain();","node.js":"import OpenAI from 'openai';\n\nconst client = new OpenAI({\n apiKey: process.env['OPENAI_API_KEY'], // This is the default and can be omitted\n});\n\n// Automatically fetches more pages as needed.\nfor await (const fineTuningJob of client.fineTuning.jobs.list()) {\n console.log(fineTuningJob.id);\n}","go":"package main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\n\t\"github.com/openai/openai-go\"\n\t\"github.com/openai/openai-go/option\"\n)\n\nfunc main() {\n\tclient := openai.NewClient(\n\t\toption.WithAPIKey(\"My API Key\"),\n\t)\n\tpage, err := client.FineTuning.Jobs.List(context.TODO(), openai.FineTuningJobListParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf(\"%+v\\n\", page)\n}\n","java":"package com.openai.example;\n\nimport com.openai.client.OpenAIClient;\nimport com.openai.client.okhttp.OpenAIOkHttpClient;\nimport com.openai.models.finetuning.jobs.JobListPage;\nimport com.openai.models.finetuning.jobs.JobListParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n OpenAIClient client = OpenAIOkHttpClient.fromEnv();\n\n JobListPage page = client.fineTuning().jobs().list();\n }\n}","ruby":"require \"openai\"\n\nopenai = OpenAI::Client.new(api_key: \"My API Key\")\n\npage = openai.fine_tuning.jobs.list\n\nputs(page)"},"response":"{\n \"object\": \"list\",\n \"data\": [\n {\n \"object\": \"fine_tuning.job\",\n \"id\": \"ftjob-abc123\",\n \"model\": \"gpt-4o-mini-2024-07-18\",\n \"created_at\": 1721764800,\n \"fine_tuned_model\": null,\n \"organization_id\": \"org-123\",\n \"result_files\": [],\n \"status\": \"queued\",\n \"validation_file\": null,\n \"training_file\": \"file-abc123\",\n \"metadata\": {\n \"key\": \"value\"\n }\n },\n { ... },\n { ... }\n ], \"has_more\": true\n}\n"}}}},"/fine_tuning/jobs/{fine_tuning_job_id}":{"get":{"operationId":"retrieveFineTuningJob","tags":["Fine-tuning"],"summary":"Get info about a fine-tuning job.\n\n[Learn more about fine-tuning](/docs/guides/model-optimization)\n","parameters":[{"in":"path","name":"fine_tuning_job_id","required":true,"schema":{"type":"string","example":"ft-AF1WoRqd3aJAHsqc9NY7iL8F"},"description":"The ID of the fine-tuning job.\n"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FineTuningJob"}}}}},"x-oaiMeta":{"name":"Retrieve fine-tuning job","group":"fine-tuning","examples":{"request":{"curl":"curl https://api.openai.com/v1/fine_tuning/jobs/ft-AF1WoRqd3aJAHsqc9NY7iL8F \\\n -H \"Authorization: Bearer $OPENAI_API_KEY\"\n","python":"import os\nfrom openai import OpenAI\n\nclient = OpenAI(\n api_key=os.environ.get(\"OPENAI_API_KEY\"), # This is the default and can be omitted\n)\nfine_tuning_job = client.fine_tuning.jobs.retrieve(\n \"ft-AF1WoRqd3aJAHsqc9NY7iL8F\",\n)\nprint(fine_tuning_job.id)","javascript":"import OpenAI from \"openai\";\n\nconst openai = new OpenAI();\n\nasync function main() {\n const fineTune = await openai.fineTuning.jobs.retrieve(\"ftjob-abc123\");\n\n console.log(fineTune);\n}\n\nmain();\n","node.js":"import OpenAI from 'openai';\n\nconst client = new OpenAI({\n apiKey: process.env['OPENAI_API_KEY'], // This is the default and can be omitted\n});\n\nconst fineTuningJob = await client.fineTuning.jobs.retrieve('ft-AF1WoRqd3aJAHsqc9NY7iL8F');\n\nconsole.log(fineTuningJob.id);","go":"package main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\n\t\"github.com/openai/openai-go\"\n\t\"github.com/openai/openai-go/option\"\n)\n\nfunc main() {\n\tclient := openai.NewClient(\n\t\toption.WithAPIKey(\"My API Key\"),\n\t)\n\tfineTuningJob, err := client.FineTuning.Jobs.Get(context.TODO(), \"ft-AF1WoRqd3aJAHsqc9NY7iL8F\")\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf(\"%+v\\n\", fineTuningJob.ID)\n}\n","java":"package com.openai.example;\n\nimport com.openai.client.OpenAIClient;\nimport com.openai.client.okhttp.OpenAIOkHttpClient;\nimport com.openai.models.finetuning.jobs.FineTuningJob;\nimport com.openai.models.finetuning.jobs.JobRetrieveParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n OpenAIClient client = OpenAIOkHttpClient.fromEnv();\n\n FineTuningJob fineTuningJob = client.fineTuning().jobs().retrieve(\"ft-AF1WoRqd3aJAHsqc9NY7iL8F\");\n }\n}","ruby":"require \"openai\"\n\nopenai = OpenAI::Client.new(api_key: \"My API Key\")\n\nfine_tuning_job = openai.fine_tuning.jobs.retrieve(\"ft-AF1WoRqd3aJAHsqc9NY7iL8F\")\n\nputs(fine_tuning_job)"},"response":"{\n \"object\": \"fine_tuning.job\",\n \"id\": \"ftjob-abc123\",\n \"model\": \"davinci-002\",\n \"created_at\": 1692661014,\n \"finished_at\": 1692661190,\n \"fine_tuned_model\": \"ft:davinci-002:my-org:custom_suffix:7q8mpxmy\",\n \"organization_id\": \"org-123\",\n \"result_files\": [\n \"file-abc123\"\n ],\n \"status\": \"succeeded\",\n \"validation_file\": null,\n \"training_file\": \"file-abc123\",\n \"hyperparameters\": {\n \"n_epochs\": 4,\n \"batch_size\": 1,\n \"learning_rate_multiplier\": 1.0\n },\n \"trained_tokens\": 5768,\n \"integrations\": [],\n \"seed\": 0,\n \"estimated_finish\": 0,\n \"method\": {\n \"type\": \"supervised\",\n \"supervised\": {\n \"hyperparameters\": {\n \"n_epochs\": 4,\n \"batch_size\": 1,\n \"learning_rate_multiplier\": 1.0\n }\n }\n }\n}\n"}}}},"/fine_tuning/jobs/{fine_tuning_job_id}/cancel":{"post":{"operationId":"cancelFineTuningJob","tags":["Fine-tuning"],"summary":"Immediately cancel a fine-tune job.\n","parameters":[{"in":"path","name":"fine_tuning_job_id","required":true,"schema":{"type":"string","example":"ft-AF1WoRqd3aJAHsqc9NY7iL8F"},"description":"The ID of the fine-tuning job to cancel.\n"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FineTuningJob"}}}}},"x-oaiMeta":{"name":"Cancel fine-tuning","group":"fine-tuning","examples":{"request":{"curl":"curl -X POST https://api.openai.com/v1/fine_tuning/jobs/ftjob-abc123/cancel \\\n -H \"Authorization: Bearer $OPENAI_API_KEY\"\n","python":"import os\nfrom openai import OpenAI\n\nclient = OpenAI(\n api_key=os.environ.get(\"OPENAI_API_KEY\"), # This is the default and can be omitted\n)\nfine_tuning_job = client.fine_tuning.jobs.cancel(\n \"ft-AF1WoRqd3aJAHsqc9NY7iL8F\",\n)\nprint(fine_tuning_job.id)","javascript":"import OpenAI from \"openai\";\n\nconst openai = new OpenAI();\n\nasync function main() {\n const fineTune = await openai.fineTuning.jobs.cancel(\"ftjob-abc123\");\n\n console.log(fineTune);\n}\nmain();","node.js":"import OpenAI from 'openai';\n\nconst client = new OpenAI({\n apiKey: process.env['OPENAI_API_KEY'], // This is the default and can be omitted\n});\n\nconst fineTuningJob = await client.fineTuning.jobs.cancel('ft-AF1WoRqd3aJAHsqc9NY7iL8F');\n\nconsole.log(fineTuningJob.id);","go":"package main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\n\t\"github.com/openai/openai-go\"\n\t\"github.com/openai/openai-go/option\"\n)\n\nfunc main() {\n\tclient := openai.NewClient(\n\t\toption.WithAPIKey(\"My API Key\"),\n\t)\n\tfineTuningJob, err := client.FineTuning.Jobs.Cancel(context.TODO(), \"ft-AF1WoRqd3aJAHsqc9NY7iL8F\")\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf(\"%+v\\n\", fineTuningJob.ID)\n}\n","java":"package com.openai.example;\n\nimport com.openai.client.OpenAIClient;\nimport com.openai.client.okhttp.OpenAIOkHttpClient;\nimport com.openai.models.finetuning.jobs.FineTuningJob;\nimport com.openai.models.finetuning.jobs.JobCancelParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n OpenAIClient client = OpenAIOkHttpClient.fromEnv();\n\n FineTuningJob fineTuningJob = client.fineTuning().jobs().cancel(\"ft-AF1WoRqd3aJAHsqc9NY7iL8F\");\n }\n}","ruby":"require \"openai\"\n\nopenai = OpenAI::Client.new(api_key: \"My API Key\")\n\nfine_tuning_job = openai.fine_tuning.jobs.cancel(\"ft-AF1WoRqd3aJAHsqc9NY7iL8F\")\n\nputs(fine_tuning_job)"},"response":"{\n \"object\": \"fine_tuning.job\",\n \"id\": \"ftjob-abc123\",\n \"model\": \"gpt-4o-mini-2024-07-18\",\n \"created_at\": 1721764800,\n \"fine_tuned_model\": null,\n \"organization_id\": \"org-123\",\n \"result_files\": [],\n \"status\": \"cancelled\",\n \"validation_file\": \"file-abc123\",\n \"training_file\": \"file-abc123\"\n}\n"}}}},"/fine_tuning/jobs/{fine_tuning_job_id}/checkpoints":{"get":{"operationId":"listFineTuningJobCheckpoints","tags":["Fine-tuning"],"summary":"List checkpoints for a fine-tuning job.\n","parameters":[{"in":"path","name":"fine_tuning_job_id","required":true,"schema":{"type":"string","example":"ft-AF1WoRqd3aJAHsqc9NY7iL8F"},"description":"The ID of the fine-tuning job to get checkpoints for.\n"},{"name":"after","in":"query","description":"Identifier for the last checkpoint ID from the previous pagination request.","required":false,"schema":{"type":"string"}},{"name":"limit","in":"query","description":"Number of checkpoints to retrieve.","required":false,"schema":{"type":"integer","default":10}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListFineTuningJobCheckpointsResponse"}}}}},"x-oaiMeta":{"name":"List fine-tuning checkpoints","group":"fine-tuning","examples":{"request":{"curl":"curl https://api.openai.com/v1/fine_tuning/jobs/ftjob-abc123/checkpoints \\\n -H \"Authorization: Bearer $OPENAI_API_KEY\"\n","node.js":"import OpenAI from 'openai';\n\nconst client = new OpenAI({\n apiKey: process.env['OPENAI_API_KEY'], // This is the default and can be omitted\n});\n\n// Automatically fetches more pages as needed.\nfor await (const fineTuningJobCheckpoint of client.fineTuning.jobs.checkpoints.list(\n 'ft-AF1WoRqd3aJAHsqc9NY7iL8F',\n)) {\n console.log(fineTuningJobCheckpoint.id);\n}","python":"import os\nfrom openai import OpenAI\n\nclient = OpenAI(\n api_key=os.environ.get(\"OPENAI_API_KEY\"), # This is the default and can be omitted\n)\npage = client.fine_tuning.jobs.checkpoints.list(\n fine_tuning_job_id=\"ft-AF1WoRqd3aJAHsqc9NY7iL8F\",\n)\npage = page.data[0]\nprint(page.id)","go":"package main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\n\t\"github.com/openai/openai-go\"\n\t\"github.com/openai/openai-go/option\"\n)\n\nfunc main() {\n\tclient := openai.NewClient(\n\t\toption.WithAPIKey(\"My API Key\"),\n\t)\n\tpage, err := client.FineTuning.Jobs.Checkpoints.List(\n\t\tcontext.TODO(),\n\t\t\"ft-AF1WoRqd3aJAHsqc9NY7iL8F\",\n\t\topenai.FineTuningJobCheckpointListParams{},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf(\"%+v\\n\", page)\n}\n","java":"package com.openai.example;\n\nimport com.openai.client.OpenAIClient;\nimport com.openai.client.okhttp.OpenAIOkHttpClient;\nimport com.openai.models.finetuning.jobs.checkpoints.CheckpointListPage;\nimport com.openai.models.finetuning.jobs.checkpoints.CheckpointListParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n OpenAIClient client = OpenAIOkHttpClient.fromEnv();\n\n CheckpointListPage page = client.fineTuning().jobs().checkpoints().list(\"ft-AF1WoRqd3aJAHsqc9NY7iL8F\");\n }\n}","ruby":"require \"openai\"\n\nopenai = OpenAI::Client.new(api_key: \"My API Key\")\n\npage = openai.fine_tuning.jobs.checkpoints.list(\"ft-AF1WoRqd3aJAHsqc9NY7iL8F\")\n\nputs(page)"},"response":"{\n \"object\": \"list\",\n \"data\": [\n {\n \"object\": \"fine_tuning.job.checkpoint\",\n \"id\": \"ftckpt_zc4Q7MP6XxulcVzj4MZdwsAB\",\n \"created_at\": 1721764867,\n \"fine_tuned_model_checkpoint\": \"ft:gpt-4o-mini-2024-07-18:my-org:custom-suffix:96olL566:ckpt-step-2000\",\n \"metrics\": {\n \"full_valid_loss\": 0.134,\n \"full_valid_mean_token_accuracy\": 0.874\n },\n \"fine_tuning_job_id\": \"ftjob-abc123\",\n \"step_number\": 2000\n },\n {\n \"object\": \"fine_tuning.job.checkpoint\",\n \"id\": \"ftckpt_enQCFmOTGj3syEpYVhBRLTSy\",\n \"created_at\": 1721764800,\n \"fine_tuned_model_checkpoint\": \"ft:gpt-4o-mini-2024-07-18:my-org:custom-suffix:7q8mpxmy:ckpt-step-1000\",\n \"metrics\": {\n \"full_valid_loss\": 0.167,\n \"full_valid_mean_token_accuracy\": 0.781\n },\n \"fine_tuning_job_id\": \"ftjob-abc123\",\n \"step_number\": 1000\n }\n ],\n \"first_id\": \"ftckpt_zc4Q7MP6XxulcVzj4MZdwsAB\",\n \"last_id\": \"ftckpt_enQCFmOTGj3syEpYVhBRLTSy\",\n \"has_more\": true\n}\n"}}}},"/fine_tuning/jobs/{fine_tuning_job_id}/events":{"get":{"operationId":"listFineTuningEvents","tags":["Fine-tuning"],"summary":"Get status updates for a fine-tuning job.\n","parameters":[{"in":"path","name":"fine_tuning_job_id","required":true,"schema":{"type":"string","example":"ft-AF1WoRqd3aJAHsqc9NY7iL8F"},"description":"The ID of the fine-tuning job to get events for.\n"},{"name":"after","in":"query","description":"Identifier for the last event from the previous pagination request.","required":false,"schema":{"type":"string"}},{"name":"limit","in":"query","description":"Number of events to retrieve.","required":false,"schema":{"type":"integer","default":20}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListFineTuningJobEventsResponse"}}}}},"x-oaiMeta":{"name":"List fine-tuning events","group":"fine-tuning","examples":{"request":{"curl":"curl https://api.openai.com/v1/fine_tuning/jobs/ftjob-abc123/events \\\n -H \"Authorization: Bearer $OPENAI_API_KEY\"\n","python":"import os\nfrom openai import OpenAI\n\nclient = OpenAI(\n api_key=os.environ.get(\"OPENAI_API_KEY\"), # This is the default and can be omitted\n)\npage = client.fine_tuning.jobs.list_events(\n fine_tuning_job_id=\"ft-AF1WoRqd3aJAHsqc9NY7iL8F\",\n)\npage = page.data[0]\nprint(page.id)","javascript":"import OpenAI from \"openai\";\n\nconst openai = new OpenAI();\n\nasync function main() {\n const list = await openai.fineTuning.list_events(id=\"ftjob-abc123\", limit=2);\n\n for await (const fineTune of list) {\n console.log(fineTune);\n }\n}\n\nmain();","node.js":"import OpenAI from 'openai';\n\nconst client = new OpenAI({\n apiKey: process.env['OPENAI_API_KEY'], // This is the default and can be omitted\n});\n\n// Automatically fetches more pages as needed.\nfor await (const fineTuningJobEvent of client.fineTuning.jobs.listEvents(\n 'ft-AF1WoRqd3aJAHsqc9NY7iL8F',\n)) {\n console.log(fineTuningJobEvent.id);\n}","go":"package main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\n\t\"github.com/openai/openai-go\"\n\t\"github.com/openai/openai-go/option\"\n)\n\nfunc main() {\n\tclient := openai.NewClient(\n\t\toption.WithAPIKey(\"My API Key\"),\n\t)\n\tpage, err := client.FineTuning.Jobs.ListEvents(\n\t\tcontext.TODO(),\n\t\t\"ft-AF1WoRqd3aJAHsqc9NY7iL8F\",\n\t\topenai.FineTuningJobListEventsParams{},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf(\"%+v\\n\", page)\n}\n","java":"package com.openai.example;\n\nimport com.openai.client.OpenAIClient;\nimport com.openai.client.okhttp.OpenAIOkHttpClient;\nimport com.openai.models.finetuning.jobs.JobListEventsPage;\nimport com.openai.models.finetuning.jobs.JobListEventsParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n OpenAIClient client = OpenAIOkHttpClient.fromEnv();\n\n JobListEventsPage page = client.fineTuning().jobs().listEvents(\"ft-AF1WoRqd3aJAHsqc9NY7iL8F\");\n }\n}","ruby":"require \"openai\"\n\nopenai = OpenAI::Client.new(api_key: \"My API Key\")\n\npage = openai.fine_tuning.jobs.list_events(\"ft-AF1WoRqd3aJAHsqc9NY7iL8F\")\n\nputs(page)"},"response":"{\n \"object\": \"list\",\n \"data\": [\n {\n \"object\": \"fine_tuning.job.event\",\n \"id\": \"ft-event-ddTJfwuMVpfLXseO0Am0Gqjm\",\n \"created_at\": 1721764800,\n \"level\": \"info\",\n \"message\": \"Fine tuning job successfully completed\",\n \"data\": null,\n \"type\": \"message\"\n },\n {\n \"object\": \"fine_tuning.job.event\",\n \"id\": \"ft-event-tyiGuB72evQncpH87xe505Sv\",\n \"created_at\": 1721764800,\n \"level\": \"info\",\n \"message\": \"New fine-tuned model created: ft:gpt-4o-mini:openai::7p4lURel\",\n \"data\": null,\n \"type\": \"message\"\n }\n ],\n \"has_more\": true\n}\n"}}}},"/fine_tuning/jobs/{fine_tuning_job_id}/pause":{"post":{"operationId":"pauseFineTuningJob","tags":["Fine-tuning"],"summary":"Pause a fine-tune job.\n","parameters":[{"in":"path","name":"fine_tuning_job_id","required":true,"schema":{"type":"string","example":"ft-AF1WoRqd3aJAHsqc9NY7iL8F"},"description":"The ID of the fine-tuning job to pause.\n"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FineTuningJob"}}}}},"x-oaiMeta":{"name":"Pause fine-tuning","group":"fine-tuning","examples":{"request":{"curl":"curl -X POST https://api.openai.com/v1/fine_tuning/jobs/ftjob-abc123/pause \\\n -H \"Authorization: Bearer $OPENAI_API_KEY\"\n","python":"import os\nfrom openai import OpenAI\n\nclient = OpenAI(\n api_key=os.environ.get(\"OPENAI_API_KEY\"), # This is the default and can be omitted\n)\nfine_tuning_job = client.fine_tuning.jobs.pause(\n \"ft-AF1WoRqd3aJAHsqc9NY7iL8F\",\n)\nprint(fine_tuning_job.id)","javascript":"import OpenAI from \"openai\";\n\nconst openai = new OpenAI();\n\nasync function main() {\n const fineTune = await openai.fineTuning.jobs.pause(\"ftjob-abc123\");\n\n console.log(fineTune);\n}\nmain();","node.js":"import OpenAI from 'openai';\n\nconst client = new OpenAI({\n apiKey: process.env['OPENAI_API_KEY'], // This is the default and can be omitted\n});\n\nconst fineTuningJob = await client.fineTuning.jobs.pause('ft-AF1WoRqd3aJAHsqc9NY7iL8F');\n\nconsole.log(fineTuningJob.id);","go":"package main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\n\t\"github.com/openai/openai-go\"\n\t\"github.com/openai/openai-go/option\"\n)\n\nfunc main() {\n\tclient := openai.NewClient(\n\t\toption.WithAPIKey(\"My API Key\"),\n\t)\n\tfineTuningJob, err := client.FineTuning.Jobs.Pause(context.TODO(), \"ft-AF1WoRqd3aJAHsqc9NY7iL8F\")\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf(\"%+v\\n\", fineTuningJob.ID)\n}\n","java":"package com.openai.example;\n\nimport com.openai.client.OpenAIClient;\nimport com.openai.client.okhttp.OpenAIOkHttpClient;\nimport com.openai.models.finetuning.jobs.FineTuningJob;\nimport com.openai.models.finetuning.jobs.JobPauseParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n OpenAIClient client = OpenAIOkHttpClient.fromEnv();\n\n FineTuningJob fineTuningJob = client.fineTuning().jobs().pause(\"ft-AF1WoRqd3aJAHsqc9NY7iL8F\");\n }\n}","ruby":"require \"openai\"\n\nopenai = OpenAI::Client.new(api_key: \"My API Key\")\n\nfine_tuning_job = openai.fine_tuning.jobs.pause(\"ft-AF1WoRqd3aJAHsqc9NY7iL8F\")\n\nputs(fine_tuning_job)"},"response":"{\n \"object\": \"fine_tuning.job\",\n \"id\": \"ftjob-abc123\",\n \"model\": \"gpt-4o-mini-2024-07-18\",\n \"created_at\": 1721764800,\n \"fine_tuned_model\": null,\n \"organization_id\": \"org-123\",\n \"result_files\": [],\n \"status\": \"paused\",\n \"validation_file\": \"file-abc123\",\n \"training_file\": \"file-abc123\"\n}\n"}}}},"/fine_tuning/jobs/{fine_tuning_job_id}/resume":{"post":{"operationId":"resumeFineTuningJob","tags":["Fine-tuning"],"summary":"Resume a fine-tune job.\n","parameters":[{"in":"path","name":"fine_tuning_job_id","required":true,"schema":{"type":"string","example":"ft-AF1WoRqd3aJAHsqc9NY7iL8F"},"description":"The ID of the fine-tuning job to resume.\n"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FineTuningJob"}}}}},"x-oaiMeta":{"name":"Resume fine-tuning","group":"fine-tuning","examples":{"request":{"curl":"curl -X POST https://api.openai.com/v1/fine_tuning/jobs/ftjob-abc123/resume \\\n -H \"Authorization: Bearer $OPENAI_API_KEY\"\n","python":"import os\nfrom openai import OpenAI\n\nclient = OpenAI(\n api_key=os.environ.get(\"OPENAI_API_KEY\"), # This is the default and can be omitted\n)\nfine_tuning_job = client.fine_tuning.jobs.resume(\n \"ft-AF1WoRqd3aJAHsqc9NY7iL8F\",\n)\nprint(fine_tuning_job.id)","javascript":"import OpenAI from \"openai\";\n\nconst openai = new OpenAI();\n\nasync function main() {\n const fineTune = await openai.fineTuning.jobs.resume(\"ftjob-abc123\");\n\n console.log(fineTune);\n}\nmain();","node.js":"import OpenAI from 'openai';\n\nconst client = new OpenAI({\n apiKey: process.env['OPENAI_API_KEY'], // This is the default and can be omitted\n});\n\nconst fineTuningJob = await client.fineTuning.jobs.resume('ft-AF1WoRqd3aJAHsqc9NY7iL8F');\n\nconsole.log(fineTuningJob.id);","go":"package main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\n\t\"github.com/openai/openai-go\"\n\t\"github.com/openai/openai-go/option\"\n)\n\nfunc main() {\n\tclient := openai.NewClient(\n\t\toption.WithAPIKey(\"My API Key\"),\n\t)\n\tfineTuningJob, err := client.FineTuning.Jobs.Resume(context.TODO(), \"ft-AF1WoRqd3aJAHsqc9NY7iL8F\")\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf(\"%+v\\n\", fineTuningJob.ID)\n}\n","java":"package com.openai.example;\n\nimport com.openai.client.OpenAIClient;\nimport com.openai.client.okhttp.OpenAIOkHttpClient;\nimport com.openai.models.finetuning.jobs.FineTuningJob;\nimport com.openai.models.finetuning.jobs.JobResumeParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n OpenAIClient client = OpenAIOkHttpClient.fromEnv();\n\n FineTuningJob fineTuningJob = client.fineTuning().jobs().resume(\"ft-AF1WoRqd3aJAHsqc9NY7iL8F\");\n }\n}","ruby":"require \"openai\"\n\nopenai = OpenAI::Client.new(api_key: \"My API Key\")\n\nfine_tuning_job = openai.fine_tuning.jobs.resume(\"ft-AF1WoRqd3aJAHsqc9NY7iL8F\")\n\nputs(fine_tuning_job)"},"response":"{\n \"object\": \"fine_tuning.job\",\n \"id\": \"ftjob-abc123\",\n \"model\": \"gpt-4o-mini-2024-07-18\",\n \"created_at\": 1721764800,\n \"fine_tuned_model\": null,\n \"organization_id\": \"org-123\",\n \"result_files\": [],\n \"status\": \"queued\",\n \"validation_file\": \"file-abc123\",\n \"training_file\": \"file-abc123\"\n}\n"}}}},"/images/edits":{"post":{"operationId":"createImageEdit","tags":["Images"],"summary":"Creates an edited or extended image given one or more source images and a prompt. This endpoint supports GPT Image models (`gpt-image-1.5`, `gpt-image-1`, `gpt-image-1-mini`, and `chatgpt-image-latest`) and `dall-e-2`.","description":"You can call this endpoint with either:\n\n- `multipart/form-data`: use binary uploads via `image` (and optional `mask`).\n- `application/json`: use `images` (and optional `mask`) as references with either `image_url` or `file_id`.\n\nNote that JSON requests use `images` (array) instead of the multipart `image` field.\n","requestBody":{"required":true,"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/CreateImageEditRequest"},"examples":{"multipart_edit":{"summary":"Multipart form upload (binary image + prompt)","value":{"model":"gpt-image-1.5","prompt":"Add a watercolor effect to this image","image":"<binary image file>","size":"1024x1024","quality":"high"}}}},"application/json":{"schema":{"$ref":"#/components/schemas/EditImageBodyJsonParam"},"examples":{"json_with_url":{"summary":"JSON request with image URL","value":{"model":"gpt-image-1.5","prompt":"Add a watercolor effect to this image","images":[{"image_url":"https://example.com/source-image.png"}],"size":"1024x1024","quality":"high"}},"json_with_file_id":{"summary":"JSON request with uploaded file id","value":{"model":"gpt-image-1.5","prompt":"Replace the background with a snowy mountain scene","images":[{"file_id":"file-abc123"}],"mask":{"file_id":"file-mask123"},"output_format":"png","output_compression":100}}}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ImagesResponse"}},"text/event-stream":{"schema":{"$ref":"#/components/schemas/ImageEditStreamEvent"}}}}},"x-oaiMeta":{"name":"Create image edit","group":"images","examples":[{"title":"Edit image","request":{"curl":"curl -s -D >(grep -i x-request-id >&2) \\\n -o >(jq -r '.data[0].b64_json' | base64 --decode > gift-basket.png) \\\n -X POST \"https://api.openai.com/v1/images/edits\" \\\n -H \"Authorization: Bearer $OPENAI_API_KEY\" \\\n -F \"model=gpt-image-1.5\" \\\n -F \"image[]=@body-lotion.png\" \\\n -F \"image[]=@bath-bomb.png\" \\\n -F \"image[]=@incense-kit.png\" \\\n -F \"image[]=@soap.png\" \\\n -F 'prompt=Create a lovely gift basket with these four items in it'\n","python":"import os\nfrom openai import OpenAI\n\nclient = OpenAI(\n api_key=os.environ.get(\"OPENAI_API_KEY\"), # This is the default and can be omitted\n)\nfor image in client.images.edit(\n image=b\"Example data\",\n prompt=\"A cute baby sea otter wearing a beret\",\n):\n print(image)","javascript":"import fs from \"fs\";\nimport OpenAI, { toFile } from \"openai\";\n\nconst client = new OpenAI();\n\nconst imageFiles = [\n \"bath-bomb.png\",\n \"body-lotion.png\",\n \"incense-kit.png\",\n \"soap.png\",\n];\n\nconst images = await Promise.all(\n imageFiles.map(async (file) =>\n await toFile(fs.createReadStream(file), null, {\n type: \"image/png\",\n })\n ),\n);\n\nconst rsp = await client.images.edit({\n model: \"gpt-image-1.5\",\n image: images,\n prompt: \"Create a lovely gift basket with these four items in it\",\n});\n\n// Save the image to a file\nconst image_base64 = rsp.data[0].b64_json;\nconst image_bytes = Buffer.from(image_base64, \"base64\");\nfs.writeFileSync(\"basket.png\", image_bytes);\n","node.js":"import fs from 'fs';\nimport OpenAI from 'openai';\n\nconst client = new OpenAI({\n apiKey: process.env['OPENAI_API_KEY'], // This is the default and can be omitted\n});\n\nconst imagesResponse = await client.images.edit({\n image: fs.createReadStream('path/to/file'),\n prompt: 'A cute baby sea otter wearing a beret',\n});\n\nconsole.log(imagesResponse);","go":"package main\n\nimport (\n\t\"bytes\"\n\t\"context\"\n\t\"fmt\"\n\t\"io\"\n\n\t\"github.com/openai/openai-go\"\n\t\"github.com/openai/openai-go/option\"\n)\n\nfunc main() {\n\tclient := openai.NewClient(\n\t\toption.WithAPIKey(\"My API Key\"),\n\t)\n\timagesResponse, err := client.Images.Edit(context.TODO(), openai.ImageEditParams{\n\t\tImage: openai.ImageEditParamsImageUnion{\n\t\t\tOfFile: io.Reader(bytes.NewBuffer([]byte(\"Example data\"))),\n\t\t},\n\t\tPrompt: \"A cute baby sea otter wearing a beret\",\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf(\"%+v\\n\", imagesResponse)\n}\n","java":"package com.openai.example;\n\nimport com.openai.client.OpenAIClient;\nimport com.openai.client.okhttp.OpenAIOkHttpClient;\nimport com.openai.models.images.ImageEditParams;\nimport com.openai.models.images.ImagesResponse;\nimport java.io.ByteArrayInputStream;\nimport java.io.InputStream;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n OpenAIClient client = OpenAIOkHttpClient.fromEnv();\n\n ImageEditParams params = ImageEditParams.builder()\n .image(new ByteArrayInputStream(\"Example data\".getBytes()))\n .prompt(\"A cute baby sea otter wearing a beret\")\n .build();\n ImagesResponse imagesResponse = client.images().edit(params);\n }\n}","ruby":"require \"openai\"\n\nopenai = OpenAI::Client.new(api_key: \"My API Key\")\n\nimages_response = openai.images.edit(image: StringIO.new(\"Example data\"), prompt: \"A cute baby sea otter wearing a beret\")\n\nputs(images_response)"}},{"title":"Streaming","request":{"curl":"curl -s -N -X POST \"https://api.openai.com/v1/images/edits\" \\\n -H \"Authorization: Bearer $OPENAI_API_KEY\" \\\n -F \"model=gpt-image-1.5\" \\\n -F \"image[]=@body-lotion.png\" \\\n -F \"image[]=@bath-bomb.png\" \\\n -F \"image[]=@incense-kit.png\" \\\n -F \"image[]=@soap.png\" \\\n -F 'prompt=Create a lovely gift basket with these four items in it' \\\n -F \"stream=true\"\n","python":"import os\nfrom openai import OpenAI\n\nclient = OpenAI(\n api_key=os.environ.get(\"OPENAI_API_KEY\"), # This is the default and can be omitted\n)\nfor image in client.images.edit(\n image=b\"Example data\",\n prompt=\"A cute baby sea otter wearing a beret\",\n):\n print(image)","javascript":"import fs from \"fs\";\nimport OpenAI, { toFile } from \"openai\";\n\nconst client = new OpenAI();\n\nconst imageFiles = [\n \"bath-bomb.png\",\n \"body-lotion.png\",\n \"incense-kit.png\",\n \"soap.png\",\n];\n\nconst images = await Promise.all(\n imageFiles.map(async (file) =>\n await toFile(fs.createReadStream(file), null, {\n type: \"image/png\",\n })\n ),\n);\n\nconst stream = await client.images.edit({\n model: \"gpt-image-1.5\",\n image: images,\n prompt: \"Create a lovely gift basket with these four items in it\",\n stream: true,\n});\n\nfor await (const event of stream) {\n console.log(event);\n}\n","node.js":"import fs from 'fs';\nimport OpenAI from 'openai';\n\nconst client = new OpenAI({\n apiKey: process.env['OPENAI_API_KEY'], // This is the default and can be omitted\n});\n\nconst imagesResponse = await client.images.edit({\n image: fs.createReadStream('path/to/file'),\n prompt: 'A cute baby sea otter wearing a beret',\n});\n\nconsole.log(imagesResponse);","go":"package main\n\nimport (\n\t\"bytes\"\n\t\"context\"\n\t\"fmt\"\n\t\"io\"\n\n\t\"github.com/openai/openai-go\"\n\t\"github.com/openai/openai-go/option\"\n)\n\nfunc main() {\n\tclient := openai.NewClient(\n\t\toption.WithAPIKey(\"My API Key\"),\n\t)\n\timagesResponse, err := client.Images.Edit(context.TODO(), openai.ImageEditParams{\n\t\tImage: openai.ImageEditParamsImageUnion{\n\t\t\tOfFile: io.Reader(bytes.NewBuffer([]byte(\"Example data\"))),\n\t\t},\n\t\tPrompt: \"A cute baby sea otter wearing a beret\",\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf(\"%+v\\n\", imagesResponse)\n}\n","java":"package com.openai.example;\n\nimport com.openai.client.OpenAIClient;\nimport com.openai.client.okhttp.OpenAIOkHttpClient;\nimport com.openai.models.images.ImageEditParams;\nimport com.openai.models.images.ImagesResponse;\nimport java.io.ByteArrayInputStream;\nimport java.io.InputStream;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n OpenAIClient client = OpenAIOkHttpClient.fromEnv();\n\n ImageEditParams params = ImageEditParams.builder()\n .image(new ByteArrayInputStream(\"Example data\".getBytes()))\n .prompt(\"A cute baby sea otter wearing a beret\")\n .build();\n ImagesResponse imagesResponse = client.images().edit(params);\n }\n}","ruby":"require \"openai\"\n\nopenai = OpenAI::Client.new(api_key: \"My API Key\")\n\nimages_response = openai.images.edit(image: StringIO.new(\"Example data\"), prompt: \"A cute baby sea otter wearing a beret\")\n\nputs(images_response)"},"response":"event: image_edit.partial_image\ndata: {\"type\":\"image_edit.partial_image\",\"b64_json\":\"...\",\"partial_image_index\":0}\n\nevent: image_edit.completed\ndata: {\"type\":\"image_edit.completed\",\"b64_json\":\"...\",\"usage\":{\"total_tokens\":100,\"input_tokens\":50,\"output_tokens\":50,\"input_tokens_details\":{\"text_tokens\":10,\"image_tokens\":40}}}\n"}]}}},"/images/generations":{"post":{"operationId":"createImage","tags":["Images"],"summary":"Creates an image given a prompt. [Learn more](/docs/guides/images).\n","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateImageRequest"}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ImagesResponse"}},"text/event-stream":{"schema":{"$ref":"#/components/schemas/ImageGenStreamEvent"}}}}},"x-oaiMeta":{"name":"Create image","group":"images","examples":[{"title":"Generate image","request":{"curl":"curl https://api.openai.com/v1/images/generations \\\n -H \"Content-Type: application/json\" \\\n -H \"Authorization: Bearer $OPENAI_API_KEY\" \\\n -d '{\n \"model\": \"gpt-image-1.5\",\n \"prompt\": \"A cute baby sea otter\",\n \"n\": 1,\n \"size\": \"1024x1024\"\n }'\n","python":"import os\nfrom openai import OpenAI\n\nclient = OpenAI(\n api_key=os.environ.get(\"OPENAI_API_KEY\"), # This is the default and can be omitted\n)\nfor image in client.images.generate(\n prompt=\"A cute baby sea otter\",\n):\n print(image)","javascript":"import OpenAI from \"openai\";\nimport { writeFile } from \"fs/promises\";\n\nconst client = new OpenAI();\n\nconst img = await client.images.generate({\n model: \"gpt-image-1.5\",\n prompt: \"A cute baby sea otter\",\n n: 1,\n size: \"1024x1024\"\n});\n\nconst imageBuffer = Buffer.from(img.data[0].b64_json, \"base64\");\nawait writeFile(\"output.png\", imageBuffer);\n","node.js":"import OpenAI from 'openai';\n\nconst client = new OpenAI({\n apiKey: process.env['OPENAI_API_KEY'], // This is the default and can be omitted\n});\n\nconst imagesResponse = await client.images.generate({ prompt: 'A cute baby sea otter' });\n\nconsole.log(imagesResponse);","go":"package main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\n\t\"github.com/openai/openai-go\"\n\t\"github.com/openai/openai-go/option\"\n)\n\nfunc main() {\n\tclient := openai.NewClient(\n\t\toption.WithAPIKey(\"My API Key\"),\n\t)\n\timagesResponse, err := client.Images.Generate(context.TODO(), openai.ImageGenerateParams{\n\t\tPrompt: \"A cute baby sea otter\",\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf(\"%+v\\n\", imagesResponse)\n}\n","java":"package com.openai.example;\n\nimport com.openai.client.OpenAIClient;\nimport com.openai.client.okhttp.OpenAIOkHttpClient;\nimport com.openai.models.images.ImageGenerateParams;\nimport com.openai.models.images.ImagesResponse;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n OpenAIClient client = OpenAIOkHttpClient.fromEnv();\n\n ImageGenerateParams params = ImageGenerateParams.builder()\n .prompt(\"A cute baby sea otter\")\n .build();\n ImagesResponse imagesResponse = client.images().generate(params);\n }\n}","ruby":"require \"openai\"\n\nopenai = OpenAI::Client.new(api_key: \"My API Key\")\n\nimages_response = openai.images.generate(prompt: \"A cute baby sea otter\")\n\nputs(images_response)"},"response":"{\n \"created\": 1713833628,\n \"data\": [\n {\n \"b64_json\": \"...\"\n }\n ],\n \"usage\": {\n \"total_tokens\": 100,\n \"input_tokens\": 50,\n \"output_tokens\": 50,\n \"input_tokens_details\": {\n \"text_tokens\": 10,\n \"image_tokens\": 40\n }\n }\n}\n"},{"title":"Streaming","request":{"curl":"curl https://api.openai.com/v1/images/generations \\\n -H \"Content-Type: application/json\" \\\n -H \"Authorization: Bearer $OPENAI_API_KEY\" \\\n -d '{\n \"model\": \"gpt-image-1.5\",\n \"prompt\": \"A cute baby sea otter\",\n \"n\": 1,\n \"size\": \"1024x1024\",\n \"stream\": true\n }' \\\n --no-buffer\n","python":"import os\nfrom openai import OpenAI\n\nclient = OpenAI(\n api_key=os.environ.get(\"OPENAI_API_KEY\"), # This is the default and can be omitted\n)\nfor image in client.images.generate(\n prompt=\"A cute baby sea otter\",\n):\n print(image)","javascript":"import OpenAI from \"openai\";\n\nconst client = new OpenAI();\n\nconst stream = await client.images.generate({\n model: \"gpt-image-1.5\",\n prompt: \"A cute baby sea otter\",\n n: 1,\n size: \"1024x1024\",\n stream: true,\n});\n\nfor await (const event of stream) {\n console.log(event);\n}\n","node.js":"import OpenAI from 'openai';\n\nconst client = new OpenAI({\n apiKey: process.env['OPENAI_API_KEY'], // This is the default and can be omitted\n});\n\nconst imagesResponse = await client.images.generate({ prompt: 'A cute baby sea otter' });\n\nconsole.log(imagesResponse);","go":"package main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\n\t\"github.com/openai/openai-go\"\n\t\"github.com/openai/openai-go/option\"\n)\n\nfunc main() {\n\tclient := openai.NewClient(\n\t\toption.WithAPIKey(\"My API Key\"),\n\t)\n\timagesResponse, err := client.Images.Generate(context.TODO(), openai.ImageGenerateParams{\n\t\tPrompt: \"A cute baby sea otter\",\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf(\"%+v\\n\", imagesResponse)\n}\n","java":"package com.openai.example;\n\nimport com.openai.client.OpenAIClient;\nimport com.openai.client.okhttp.OpenAIOkHttpClient;\nimport com.openai.models.images.ImageGenerateParams;\nimport com.openai.models.images.ImagesResponse;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n OpenAIClient client = OpenAIOkHttpClient.fromEnv();\n\n ImageGenerateParams params = ImageGenerateParams.builder()\n .prompt(\"A cute baby sea otter\")\n .build();\n ImagesResponse imagesResponse = client.images().generate(params);\n }\n}","ruby":"require \"openai\"\n\nopenai = OpenAI::Client.new(api_key: \"My API Key\")\n\nimages_response = openai.images.generate(prompt: \"A cute baby sea otter\")\n\nputs(images_response)"},"response":"event: image_generation.partial_image\ndata: {\"type\":\"image_generation.partial_image\",\"b64_json\":\"...\",\"partial_image_index\":0}\n\nevent: image_generation.completed\ndata: {\"type\":\"image_generation.completed\",\"b64_json\":\"...\",\"usage\":{\"total_tokens\":100,\"input_tokens\":50,\"output_tokens\":50,\"input_tokens_details\":{\"text_tokens\":10,\"image_tokens\":40}}}\n"}]}}},"/images/variations":{"post":{"operationId":"createImageVariation","tags":["Images"],"summary":"Creates a variation of a given image. This endpoint only supports `dall-e-2`.","requestBody":{"required":true,"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/CreateImageVariationRequest"}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ImagesResponse"}}}}},"x-oaiMeta":{"name":"Create image variation","group":"images","examples":{"request":{"curl":"curl https://api.openai.com/v1/images/variations \\\n -H \"Authorization: Bearer $OPENAI_API_KEY\" \\\n -F image=\"@otter.png\" \\\n -F n=2 \\\n -F size=\"1024x1024\"\n","python":"import os\nfrom openai import OpenAI\n\nclient = OpenAI(\n api_key=os.environ.get(\"OPENAI_API_KEY\"), # This is the default and can be omitted\n)\nimages_response = client.images.create_variation(\n image=b\"Example data\",\n)\nprint(images_response.created)","javascript":"import fs from \"fs\";\nimport OpenAI from \"openai\";\n\nconst openai = new OpenAI();\n\nasync function main() {\n const image = await openai.images.createVariation({\n image: fs.createReadStream(\"otter.png\"),\n });\n\n console.log(image.data);\n}\nmain();","csharp":"using System;\n\nusing OpenAI.Images;\n\nImageClient client = new(\n model: \"dall-e-2\",\n apiKey: Environment.GetEnvironmentVariable(\"OPENAI_API_KEY\")\n);\n\nGeneratedImage image = client.GenerateImageVariation(imageFilePath: \"otter.png\");\n\nConsole.WriteLine(image.ImageUri);\n","node.js":"import fs from 'fs';\nimport OpenAI from 'openai';\n\nconst client = new OpenAI({\n apiKey: process.env['OPENAI_API_KEY'], // This is the default and can be omitted\n});\n\nconst imagesResponse = await client.images.createVariation({\n image: fs.createReadStream('otter.png'),\n});\n\nconsole.log(imagesResponse.created);","go":"package main\n\nimport (\n\t\"bytes\"\n\t\"context\"\n\t\"fmt\"\n\t\"io\"\n\n\t\"github.com/openai/openai-go\"\n\t\"github.com/openai/openai-go/option\"\n)\n\nfunc main() {\n\tclient := openai.NewClient(\n\t\toption.WithAPIKey(\"My API Key\"),\n\t)\n\timagesResponse, err := client.Images.NewVariation(context.TODO(), openai.ImageNewVariationParams{\n\t\tImage: io.Reader(bytes.NewBuffer([]byte(\"Example data\"))),\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf(\"%+v\\n\", imagesResponse.Created)\n}\n","java":"package com.openai.example;\n\nimport com.openai.client.OpenAIClient;\nimport com.openai.client.okhttp.OpenAIOkHttpClient;\nimport com.openai.models.images.ImageCreateVariationParams;\nimport com.openai.models.images.ImagesResponse;\nimport java.io.ByteArrayInputStream;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n OpenAIClient client = OpenAIOkHttpClient.fromEnv();\n\n ImageCreateVariationParams params = ImageCreateVariationParams.builder()\n .image(new ByteArrayInputStream(\"Example data\".getBytes()))\n .build();\n ImagesResponse imagesResponse = client.images().createVariation(params);\n }\n}","ruby":"require \"openai\"\n\nopenai = OpenAI::Client.new(api_key: \"My API Key\")\n\nimages_response = openai.images.create_variation(image: StringIO.new(\"Example data\"))\n\nputs(images_response)"},"response":"{\n \"created\": 1589478378,\n \"data\": [\n {\n \"url\": \"https://...\"\n },\n {\n \"url\": \"https://...\"\n }\n ]\n}\n"}}}},"/models":{"get":{"operationId":"listModels","tags":["Models"],"summary":"Lists the currently available models, and provides basic information about each one such as the owner and availability.","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListModelsResponse"}}}}},"x-oaiMeta":{"name":"List models","group":"models","examples":{"request":{"curl":"curl https://api.openai.com/v1/models \\\n -H \"Authorization: Bearer $OPENAI_API_KEY\"\n","python":"import os\nfrom openai import OpenAI\n\nclient = OpenAI(\n api_key=os.environ.get(\"OPENAI_API_KEY\"), # This is the default and can be omitted\n)\npage = client.models.list()\npage = page.data[0]\nprint(page.id)","javascript":"import OpenAI from \"openai\";\n\nconst openai = new OpenAI();\n\nasync function main() {\n const list = await openai.models.list();\n\n for await (const model of list) {\n console.log(model);\n }\n}\nmain();","csharp":"using System;\n\nusing OpenAI.Models;\n\nOpenAIModelClient client = new(\n apiKey: Environment.GetEnvironmentVariable(\"OPENAI_API_KEY\")\n);\n\nforeach (var model in client.GetModels().Value)\n{\n Console.WriteLine(model.Id);\n}\n","node.js":"import OpenAI from 'openai';\n\nconst client = new OpenAI({\n apiKey: process.env['OPENAI_API_KEY'], // This is the default and can be omitted\n});\n\n// Automatically fetches more pages as needed.\nfor await (const model of client.models.list()) {\n console.log(model.id);\n}","go":"package main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\n\t\"github.com/openai/openai-go\"\n\t\"github.com/openai/openai-go/option\"\n)\n\nfunc main() {\n\tclient := openai.NewClient(\n\t\toption.WithAPIKey(\"My API Key\"),\n\t)\n\tpage, err := client.Models.List(context.TODO())\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf(\"%+v\\n\", page)\n}\n","java":"package com.openai.example;\n\nimport com.openai.client.OpenAIClient;\nimport com.openai.client.okhttp.OpenAIOkHttpClient;\nimport com.openai.models.models.ModelListPage;\nimport com.openai.models.models.ModelListParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n OpenAIClient client = OpenAIOkHttpClient.fromEnv();\n\n ModelListPage page = client.models().list();\n }\n}","ruby":"require \"openai\"\n\nopenai = OpenAI::Client.new(api_key: \"My API Key\")\n\npage = openai.models.list\n\nputs(page)"},"response":"{\n \"object\": \"list\",\n \"data\": [\n {\n \"id\": \"model-id-0\",\n \"object\": \"model\",\n \"created\": 1686935002,\n \"owned_by\": \"organization-owner\"\n },\n {\n \"id\": \"model-id-1\",\n \"object\": \"model\",\n \"created\": 1686935002,\n \"owned_by\": \"organization-owner\",\n },\n {\n \"id\": \"model-id-2\",\n \"object\": \"model\",\n \"created\": 1686935002,\n \"owned_by\": \"openai\"\n },\n ]\n}\n"}}}},"/models/{model}":{"get":{"operationId":"retrieveModel","tags":["Models"],"summary":"Retrieves a model instance, providing basic information about the model such as the owner and permissioning.","parameters":[{"in":"path","name":"model","required":true,"schema":{"type":"string","example":"gpt-4o-mini"},"description":"The ID of the model to use for this request"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Model"}}}}},"x-oaiMeta":{"name":"Retrieve model","group":"models","examples":{"request":{"curl":"curl https://api.openai.com/v1/models/VAR_chat_model_id \\\n -H \"Authorization: Bearer $OPENAI_API_KEY\"\n","python":"import os\nfrom openai import OpenAI\n\nclient = OpenAI(\n api_key=os.environ.get(\"OPENAI_API_KEY\"), # This is the default and can be omitted\n)\nmodel = client.models.retrieve(\n \"gpt-4o-mini\",\n)\nprint(model.id)","javascript":"import OpenAI from \"openai\";\n\nconst openai = new OpenAI();\n\nasync function main() {\n const model = await openai.models.retrieve(\"VAR_chat_model_id\");\n\n console.log(model);\n}\n\nmain();","csharp":"using System;\nusing System.ClientModel;\n\nusing OpenAI.Models;\n\n OpenAIModelClient client = new(\n apiKey: Environment.GetEnvironmentVariable(\"OPENAI_API_KEY\")\n);\n\nClientResult<OpenAIModel> model = client.GetModel(\"babbage-002\");\nConsole.WriteLine(model.Value.Id);\n","node.js":"import OpenAI from 'openai';\n\nconst client = new OpenAI({\n apiKey: process.env['OPENAI_API_KEY'], // This is the default and can be omitted\n});\n\nconst model = await client.models.retrieve('gpt-4o-mini');\n\nconsole.log(model.id);","go":"package main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\n\t\"github.com/openai/openai-go\"\n\t\"github.com/openai/openai-go/option\"\n)\n\nfunc main() {\n\tclient := openai.NewClient(\n\t\toption.WithAPIKey(\"My API Key\"),\n\t)\n\tmodel, err := client.Models.Get(context.TODO(), \"gpt-4o-mini\")\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf(\"%+v\\n\", model.ID)\n}\n","java":"package com.openai.example;\n\nimport com.openai.client.OpenAIClient;\nimport com.openai.client.okhttp.OpenAIOkHttpClient;\nimport com.openai.models.models.Model;\nimport com.openai.models.models.ModelRetrieveParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n OpenAIClient client = OpenAIOkHttpClient.fromEnv();\n\n Model model = client.models().retrieve(\"gpt-4o-mini\");\n }\n}","ruby":"require \"openai\"\n\nopenai = OpenAI::Client.new(api_key: \"My API Key\")\n\nmodel = openai.models.retrieve(\"gpt-4o-mini\")\n\nputs(model)"},"response":"{\n \"id\": \"VAR_chat_model_id\",\n \"object\": \"model\",\n \"created\": 1686935002,\n \"owned_by\": \"openai\"\n}\n"}}},"delete":{"operationId":"deleteModel","tags":["Models"],"summary":"Delete a fine-tuned model. You must have the Owner role in your organization to delete a model.","parameters":[{"in":"path","name":"model","required":true,"schema":{"type":"string","example":"ft:gpt-4o-mini:acemeco:suffix:abc123"},"description":"The model to delete"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteModelResponse"}}}}},"x-oaiMeta":{"name":"Delete a fine-tuned model","group":"models","examples":{"request":{"curl":"curl https://api.openai.com/v1/models/ft:gpt-4o-mini:acemeco:suffix:abc123 \\\n -X DELETE \\\n -H \"Authorization: Bearer $OPENAI_API_KEY\"\n","python":"import os\nfrom openai import OpenAI\n\nclient = OpenAI(\n api_key=os.environ.get(\"OPENAI_API_KEY\"), # This is the default and can be omitted\n)\nmodel_deleted = client.models.delete(\n \"ft:gpt-4o-mini:acemeco:suffix:abc123\",\n)\nprint(model_deleted.id)","javascript":"import OpenAI from \"openai\";\n\nconst openai = new OpenAI();\n\nasync function main() {\n const model = await openai.models.delete(\"ft:gpt-4o-mini:acemeco:suffix:abc123\");\n \n console.log(model);\n}\nmain();","csharp":"using System;\nusing System.ClientModel;\n\nusing OpenAI.Models;\n\nOpenAIModelClient client = new(\n apiKey: Environment.GetEnvironmentVariable(\"OPENAI_API_KEY\")\n);\n\nClientResult success = client.DeleteModel(\"ft:gpt-4o-mini:acemeco:suffix:abc123\");\nConsole.WriteLine(success);\n","node.js":"import OpenAI from 'openai';\n\nconst client = new OpenAI({\n apiKey: process.env['OPENAI_API_KEY'], // This is the default and can be omitted\n});\n\nconst modelDeleted = await client.models.delete('ft:gpt-4o-mini:acemeco:suffix:abc123');\n\nconsole.log(modelDeleted.id);","go":"package main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\n\t\"github.com/openai/openai-go\"\n\t\"github.com/openai/openai-go/option\"\n)\n\nfunc main() {\n\tclient := openai.NewClient(\n\t\toption.WithAPIKey(\"My API Key\"),\n\t)\n\tmodelDeleted, err := client.Models.Delete(context.TODO(), \"ft:gpt-4o-mini:acemeco:suffix:abc123\")\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf(\"%+v\\n\", modelDeleted.ID)\n}\n","java":"package com.openai.example;\n\nimport com.openai.client.OpenAIClient;\nimport com.openai.client.okhttp.OpenAIOkHttpClient;\nimport com.openai.models.models.ModelDeleteParams;\nimport com.openai.models.models.ModelDeleted;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n OpenAIClient client = OpenAIOkHttpClient.fromEnv();\n\n ModelDeleted modelDeleted = client.models().delete(\"ft:gpt-4o-mini:acemeco:suffix:abc123\");\n }\n}","ruby":"require \"openai\"\n\nopenai = OpenAI::Client.new(api_key: \"My API Key\")\n\nmodel_deleted = openai.models.delete(\"ft:gpt-4o-mini:acemeco:suffix:abc123\")\n\nputs(model_deleted)"},"response":"{\n \"id\": \"ft:gpt-4o-mini:acemeco:suffix:abc123\",\n \"object\": \"model\",\n \"deleted\": true\n}\n"}}}},"/moderations":{"post":{"operationId":"createModeration","tags":["Moderations"],"summary":"Classifies if text and/or image inputs are potentially harmful. Learn\nmore in the [moderation guide](/docs/guides/moderation).\n","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateModerationRequest"}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateModerationResponse"}}}}},"x-oaiMeta":{"name":"Create moderation","group":"moderations","examples":[{"title":"Single string","request":{"curl":"curl https://api.openai.com/v1/moderations \\\n -H \"Content-Type: application/json\" \\\n -H \"Authorization: Bearer $OPENAI_API_KEY\" \\\n -d '{\n \"input\": \"I want to kill them.\"\n }'\n","python":"import os\nfrom openai import OpenAI\n\nclient = OpenAI(\n api_key=os.environ.get(\"OPENAI_API_KEY\"), # This is the default and can be omitted\n)\nmoderation = client.moderations.create(\n input=\"I want to kill them.\",\n)\nprint(moderation.id)","javascript":"import OpenAI from \"openai\";\n\nconst openai = new OpenAI();\n\nasync function main() {\n const moderation = await openai.moderations.create({ input: \"I want to kill them.\" });\n\n console.log(moderation);\n}\nmain();\n","csharp":"using System;\nusing System.ClientModel;\n\nusing OpenAI.Moderations;\n\nModerationClient client = new(\n model: \"omni-moderation-latest\",\n apiKey: Environment.GetEnvironmentVariable(\"OPENAI_API_KEY\")\n);\n\nClientResult<ModerationResult> moderation = client.ClassifyText(\"I want to kill them.\");\n","node.js":"import OpenAI from 'openai';\n\nconst client = new OpenAI({\n apiKey: process.env['OPENAI_API_KEY'], // This is the default and can be omitted\n});\n\nconst moderation = await client.moderations.create({ input: 'I want to kill them.' });\n\nconsole.log(moderation.id);","go":"package main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\n\t\"github.com/openai/openai-go\"\n\t\"github.com/openai/openai-go/option\"\n)\n\nfunc main() {\n\tclient := openai.NewClient(\n\t\toption.WithAPIKey(\"My API Key\"),\n\t)\n\tmoderation, err := client.Moderations.New(context.TODO(), openai.ModerationNewParams{\n\t\tInput: openai.ModerationNewParamsInputUnion{\n\t\t\tOfString: openai.String(\"I want to kill them.\"),\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf(\"%+v\\n\", moderation.ID)\n}\n","java":"package com.openai.example;\n\nimport com.openai.client.OpenAIClient;\nimport com.openai.client.okhttp.OpenAIOkHttpClient;\nimport com.openai.models.moderations.ModerationCreateParams;\nimport com.openai.models.moderations.ModerationCreateResponse;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n OpenAIClient client = OpenAIOkHttpClient.fromEnv();\n\n ModerationCreateParams params = ModerationCreateParams.builder()\n .input(\"I want to kill them.\")\n .build();\n ModerationCreateResponse moderation = client.moderations().create(params);\n }\n}","ruby":"require \"openai\"\n\nopenai = OpenAI::Client.new(api_key: \"My API Key\")\n\nmoderation = openai.moderations.create(input: \"I want to kill them.\")\n\nputs(moderation)"},"response":"{\n \"id\": \"modr-AB8CjOTu2jiq12hp1AQPfeqFWaORR\",\n \"model\": \"text-moderation-007\",\n \"results\": [\n {\n \"flagged\": true,\n \"categories\": {\n \"sexual\": false,\n \"hate\": false,\n \"harassment\": true,\n \"self-harm\": false,\n \"sexual/minors\": false,\n \"hate/threatening\": false,\n \"violence/graphic\": false,\n \"self-harm/intent\": false,\n \"self-harm/instructions\": false,\n \"harassment/threatening\": true,\n \"violence\": true\n },\n \"category_scores\": {\n \"sexual\": 0.000011726012417057063,\n \"hate\": 0.22706663608551025,\n \"harassment\": 0.5215635299682617,\n \"self-harm\": 2.227119921371923e-6,\n \"sexual/minors\": 7.107352217872176e-8,\n \"hate/threatening\": 0.023547329008579254,\n \"violence/graphic\": 0.00003391829886822961,\n \"self-harm/intent\": 1.646940972932498e-6,\n \"self-harm/instructions\": 1.1198755256458526e-9,\n \"harassment/threatening\": 0.5694745779037476,\n \"violence\": 0.9971134662628174\n }\n }\n ]\n}\n"},{"title":"Image and text","request":{"curl":"curl https://api.openai.com/v1/moderations \\\n -X POST \\\n -H \"Content-Type: application/json\" \\\n -H \"Authorization: Bearer $OPENAI_API_KEY\" \\\n -d '{\n \"model\": \"omni-moderation-latest\",\n \"input\": [\n { \"type\": \"text\", \"text\": \"...text to classify goes here...\" },\n {\n \"type\": \"image_url\",\n \"image_url\": {\n \"url\": \"https://example.com/image.png\"\n }\n }\n ]\n }'\n","python":"import os\nfrom openai import OpenAI\n\nclient = OpenAI(\n api_key=os.environ.get(\"OPENAI_API_KEY\"), # This is the default and can be omitted\n)\nmoderation = client.moderations.create(\n input=\"I want to kill them.\",\n)\nprint(moderation.id)","javascript":"import OpenAI from \"openai\";\nconst openai = new OpenAI();\n\nconst moderation = await openai.moderations.create({\n model: \"omni-moderation-latest\",\n input: [\n { type: \"text\", text: \"...text to classify goes here...\" },\n {\n type: \"image_url\",\n image_url: {\n url: \"https://example.com/image.png\"\n // can also use base64 encoded image URLs\n // url: \"data:image/jpeg;base64,abcdefg...\"\n }\n }\n ],\n});\n\nconsole.log(moderation);\n","node.js":"import OpenAI from 'openai';\n\nconst client = new OpenAI({\n apiKey: process.env['OPENAI_API_KEY'], // This is the default and can be omitted\n});\n\nconst moderation = await client.moderations.create({ input: 'I want to kill them.' });\n\nconsole.log(moderation.id);","go":"package main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\n\t\"github.com/openai/openai-go\"\n\t\"github.com/openai/openai-go/option\"\n)\n\nfunc main() {\n\tclient := openai.NewClient(\n\t\toption.WithAPIKey(\"My API Key\"),\n\t)\n\tmoderation, err := client.Moderations.New(context.TODO(), openai.ModerationNewParams{\n\t\tInput: openai.ModerationNewParamsInputUnion{\n\t\t\tOfString: openai.String(\"I want to kill them.\"),\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf(\"%+v\\n\", moderation.ID)\n}\n","java":"package com.openai.example;\n\nimport com.openai.client.OpenAIClient;\nimport com.openai.client.okhttp.OpenAIOkHttpClient;\nimport com.openai.models.moderations.ModerationCreateParams;\nimport com.openai.models.moderations.ModerationCreateResponse;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n OpenAIClient client = OpenAIOkHttpClient.fromEnv();\n\n ModerationCreateParams params = ModerationCreateParams.builder()\n .input(\"I want to kill them.\")\n .build();\n ModerationCreateResponse moderation = client.moderations().create(params);\n }\n}","ruby":"require \"openai\"\n\nopenai = OpenAI::Client.new(api_key: \"My API Key\")\n\nmoderation = openai.moderations.create(input: \"I want to kill them.\")\n\nputs(moderation)"},"response":"{\n \"id\": \"modr-0d9740456c391e43c445bf0f010940c7\",\n \"model\": \"omni-moderation-latest\",\n \"results\": [\n {\n \"flagged\": true,\n \"categories\": {\n \"harassment\": true,\n \"harassment/threatening\": true,\n \"sexual\": false,\n \"hate\": false,\n \"hate/threatening\": false,\n \"illicit\": false,\n \"illicit/violent\": false,\n \"self-harm/intent\": false,\n \"self-harm/instructions\": false,\n \"self-harm\": false,\n \"sexual/minors\": false,\n \"violence\": true,\n \"violence/graphic\": true\n },\n \"category_scores\": {\n \"harassment\": 0.8189693396524255,\n \"harassment/threatening\": 0.804985420696006,\n \"sexual\": 1.573112165348997e-6,\n \"hate\": 0.007562942636942845,\n \"hate/threatening\": 0.004208854591835476,\n \"illicit\": 0.030535955153511665,\n \"illicit/violent\": 0.008925306722380033,\n \"self-harm/intent\": 0.00023023930975076432,\n \"self-harm/instructions\": 0.0002293869201073356,\n \"self-harm\": 0.012598046106750154,\n \"sexual/minors\": 2.212566909570261e-8,\n \"violence\": 0.9999992735124786,\n \"violence/graphic\": 0.843064871157054\n },\n \"category_applied_input_types\": {\n \"harassment\": [\n \"text\"\n ],\n \"harassment/threatening\": [\n \"text\"\n ],\n \"sexual\": [\n \"text\",\n \"image\"\n ],\n \"hate\": [\n \"text\"\n ],\n \"hate/threatening\": [\n \"text\"\n ],\n \"illicit\": [\n \"text\"\n ],\n \"illicit/violent\": [\n \"text\"\n ],\n \"self-harm/intent\": [\n \"text\",\n \"image\"\n ],\n \"self-harm/instructions\": [\n \"text\",\n \"image\"\n ],\n \"self-harm\": [\n \"text\",\n \"image\"\n ],\n \"sexual/minors\": [\n \"text\"\n ],\n \"violence\": [\n \"text\",\n \"image\"\n ],\n \"violence/graphic\": [\n \"text\",\n \"image\"\n ]\n }\n }\n ]\n}\n"}]}}},"/organization/admin_api_keys":{"get":{"summary":"List organization API keys","operationId":"admin-api-keys-list","description":"Retrieve a paginated list of organization admin API keys.","parameters":[{"in":"query","name":"after","required":false,"schema":{"type":"string","nullable":true,"description":"Return keys with IDs that come after this ID in the pagination order."}},{"in":"query","name":"order","required":false,"schema":{"type":"string","enum":["asc","desc"],"default":"asc","description":"Order results by creation time, ascending or descending."}},{"in":"query","name":"limit","required":false,"schema":{"type":"integer","default":20,"description":"Maximum number of keys to return."}}],"responses":{"200":{"description":"A list of organization API keys.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiKeyList"}}}}},"x-oaiMeta":{"name":"List all organization and project API keys.","group":"administration","examples":{"request":{"curl":"curl https://api.openai.com/v1/organization/admin_api_keys?after=key_abc&limit=20 \\\n -H \"Authorization: Bearer $OPENAI_ADMIN_KEY\" \\\n -H \"Content-Type: application/json\"\n"},"response":"{\n \"object\": \"list\",\n \"data\": [\n {\n \"object\": \"organization.admin_api_key\",\n \"id\": \"key_abc\",\n \"name\": \"Main Admin Key\",\n \"redacted_value\": \"sk-admin...def\",\n \"created_at\": 1711471533,\n \"last_used_at\": 1711471534,\n \"owner\": {\n \"type\": \"service_account\",\n \"object\": \"organization.service_account\",\n \"id\": \"sa_456\",\n \"name\": \"My Service Account\",\n \"created_at\": 1711471533,\n \"role\": \"member\"\n }\n }\n ],\n \"first_id\": \"key_abc\",\n \"last_id\": \"key_abc\",\n \"has_more\": false\n}\n"}}},"post":{"summary":"Create an organization admin API key","operationId":"admin-api-keys-create","description":"Create a new admin-level API key for the organization.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"New Admin Key"}}}}}},"responses":{"200":{"description":"The newly created admin API key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdminApiKey"}}}}},"x-oaiMeta":{"name":"Create admin API key","group":"administration","examples":{"request":{"curl":"curl -X POST https://api.openai.com/v1/organization/admin_api_keys \\\n -H \"Authorization: Bearer $OPENAI_ADMIN_KEY\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"name\": \"New Admin Key\"\n }'\n"},"response":"{\n \"object\": \"organization.admin_api_key\",\n \"id\": \"key_xyz\",\n \"name\": \"New Admin Key\",\n \"redacted_value\": \"sk-admin...xyz\",\n \"created_at\": 1711471533,\n \"last_used_at\": 1711471534,\n \"owner\": {\n \"type\": \"user\",\n \"object\": \"organization.user\",\n \"id\": \"user_123\",\n \"name\": \"John Doe\",\n \"created_at\": 1711471533,\n \"role\": \"owner\"\n },\n \"value\": \"sk-admin-1234abcd\"\n}\n"}}}},"/organization/admin_api_keys/{key_id}":{"get":{"summary":"Retrieve a single organization API key","operationId":"admin-api-keys-get","description":"Get details for a specific organization API key by its ID.","parameters":[{"in":"path","name":"key_id","required":true,"schema":{"type":"string","description":"The ID of the API key."}}],"responses":{"200":{"description":"Details of the requested API key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdminApiKey"}}}}},"x-oaiMeta":{"name":"Retrieve admin API key","group":"administration","examples":{"request":{"curl":"curl https://api.openai.com/v1/organization/admin_api_keys/key_abc \\\n -H \"Authorization: Bearer $OPENAI_ADMIN_KEY\" \\\n -H \"Content-Type: application/json\"\n"},"response":"{\n \"object\": \"organization.admin_api_key\",\n \"id\": \"key_abc\",\n \"name\": \"Main Admin Key\",\n \"redacted_value\": \"sk-admin...xyz\",\n \"created_at\": 1711471533,\n \"last_used_at\": 1711471534,\n \"owner\": {\n \"type\": \"user\",\n \"object\": \"organization.user\",\n \"id\": \"user_123\",\n \"name\": \"John Doe\",\n \"created_at\": 1711471533,\n \"role\": \"owner\"\n }\n}\n"}}},"delete":{"summary":"Delete an organization admin API key","operationId":"admin-api-keys-delete","description":"Delete the specified admin API key.","parameters":[{"in":"path","name":"key_id","required":true,"schema":{"type":"string","description":"The ID of the API key to be deleted."}}],"responses":{"200":{"description":"Confirmation that the API key was deleted.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","example":"key_abc"},"object":{"type":"string","example":"organization.admin_api_key.deleted"},"deleted":{"type":"boolean","example":true}}}}}}},"x-oaiMeta":{"name":"Delete admin API key","group":"administration","examples":{"request":{"curl":"curl -X DELETE https://api.openai.com/v1/organization/admin_api_keys/key_abc \\\n -H \"Authorization: Bearer $OPENAI_ADMIN_KEY\" \\\n -H \"Content-Type: application/json\"\n"},"response":"{\n \"id\": \"key_abc\",\n \"object\": \"organization.admin_api_key.deleted\",\n \"deleted\": true\n}\n"}}}},"/organization/audit_logs":{"get":{"summary":"List user actions and configuration changes within this organization.","operationId":"list-audit-logs","tags":["Audit Logs"],"parameters":[{"name":"effective_at","in":"query","description":"Return only events whose `effective_at` (Unix seconds) is in this range.","required":false,"schema":{"type":"object","properties":{"gt":{"type":"integer","description":"Return only events whose `effective_at` (Unix seconds) is greater than this value."},"gte":{"type":"integer","description":"Return only events whose `effective_at` (Unix seconds) is greater than or equal to this value."},"lt":{"type":"integer","description":"Return only events whose `effective_at` (Unix seconds) is less than this value."},"lte":{"type":"integer","description":"Return only events whose `effective_at` (Unix seconds) is less than or equal to this value."}}}},{"name":"project_ids[]","in":"query","description":"Return only events for these projects.","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"event_types[]","in":"query","description":"Return only events with a `type` in one of these values. For example, `project.created`. For all options, see the documentation for the [audit log object](/docs/api-reference/audit-logs/object).","required":false,"schema":{"type":"array","items":{"$ref":"#/components/schemas/AuditLogEventType"}}},{"name":"actor_ids[]","in":"query","description":"Return only events performed by these actors. Can be a user ID, a service account ID, or an api key tracking ID.","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"actor_emails[]","in":"query","description":"Return only events performed by users with these emails.","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"resource_ids[]","in":"query","description":"Return only events performed on these targets. For example, a project ID updated.","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"limit","in":"query","description":"A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.\n","required":false,"schema":{"type":"integer","default":20}},{"name":"after","in":"query","description":"A cursor for use in pagination. `after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list.\n","schema":{"type":"string"}},{"name":"before","in":"query","description":"A cursor for use in pagination. `before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_foo, your subsequent call can include before=obj_foo in order to fetch the previous page of the list.\n","schema":{"type":"string"}}],"responses":{"200":{"description":"Audit logs listed successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListAuditLogsResponse"}}}}},"x-oaiMeta":{"name":"List audit logs","group":"audit-logs","examples":{"request":{"curl":"curl https://api.openai.com/v1/organization/audit_logs \\\n-H \"Authorization: Bearer $OPENAI_ADMIN_KEY\" \\\n-H \"Content-Type: application/json\"\n"},"response":"{\n \"object\": \"list\",\n \"data\": [\n {\n \"id\": \"audit_log-xxx_yyyymmdd\",\n \"type\": \"project.archived\",\n \"effective_at\": 1722461446,\n \"actor\": {\n \"type\": \"api_key\",\n \"api_key\": {\n \"type\": \"user\",\n \"user\": {\n \"id\": \"user-xxx\",\n \"email\": \"user@example.com\"\n }\n }\n },\n \"project.archived\": {\n \"id\": \"proj_abc\"\n },\n },\n {\n \"id\": \"audit_log-yyy__20240101\",\n \"type\": \"api_key.updated\",\n \"effective_at\": 1720804190,\n \"actor\": {\n \"type\": \"session\",\n \"session\": {\n \"user\": {\n \"id\": \"user-xxx\",\n \"email\": \"user@example.com\"\n },\n \"ip_address\": \"127.0.0.1\",\n \"user_agent\": \"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/91.0.4472.124 Safari/537.36\",\n \"ja3\": \"a497151ce4338a12c4418c44d375173e\",\n \"ja4\": \"q13d0313h3_55b375c5d22e_c7319ce65786\",\n \"ip_address_details\": {\n \"country\": \"US\",\n \"city\": \"San Francisco\",\n \"region\": \"California\",\n \"region_code\": \"CA\",\n \"asn\": \"1234\",\n \"latitude\": \"37.77490\",\n \"longitude\": \"-122.41940\"\n }\n }\n },\n \"api_key.updated\": {\n \"id\": \"key_xxxx\",\n \"data\": {\n \"scopes\": [\"resource_2.operation_2\"]\n }\n },\n }\n ],\n \"first_id\": \"audit_log-xxx__20240101\",\n \"last_id\": \"audit_log_yyy__20240101\",\n \"has_more\": true\n}\n"}}}},"/organization/certificates":{"get":{"summary":"List uploaded certificates for this organization.","operationId":"listOrganizationCertificates","tags":["Certificates"],"parameters":[{"name":"limit","in":"query","description":"A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.\n","required":false,"schema":{"type":"integer","default":20}},{"name":"after","in":"query","description":"A cursor for use in pagination. `after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list.\n","required":false,"schema":{"type":"string"}},{"name":"order","in":"query","description":"Sort order by the `created_at` timestamp of the objects. `asc` for ascending order and `desc` for descending order.\n","schema":{"type":"string","default":"desc","enum":["asc","desc"]}}],"responses":{"200":{"description":"Certificates listed successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListCertificatesResponse"}}}}},"x-oaiMeta":{"name":"List organization certificates","group":"administration","examples":{"request":{"curl":"curl https://api.openai.com/v1/organization/certificates \\\n-H \"Authorization: Bearer $OPENAI_ADMIN_KEY\"\n"},"response":"{\n \"object\": \"list\",\n \"data\": [\n {\n \"object\": \"organization.certificate\",\n \"id\": \"cert_abc\",\n \"name\": \"My Example Certificate\",\n \"active\": true,\n \"created_at\": 1234567,\n \"certificate_details\": {\n \"valid_at\": 12345667,\n \"expires_at\": 12345678\n }\n },\n ],\n \"first_id\": \"cert_abc\",\n \"last_id\": \"cert_abc\",\n \"has_more\": false\n}\n"}}},"post":{"summary":"Upload a certificate to the organization. This does **not** automatically activate the certificate.\n\nOrganizations can upload up to 50 certificates.\n","operationId":"uploadCertificate","tags":["Certificates"],"requestBody":{"description":"The certificate upload payload.","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UploadCertificateRequest"}}}},"responses":{"200":{"description":"Certificate uploaded successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Certificate"}}}}},"x-oaiMeta":{"name":"Upload certificate","group":"administration","examples":{"request":{"curl":"curl -X POST https://api.openai.com/v1/organization/certificates \\\n-H \"Authorization: Bearer $OPENAI_ADMIN_KEY\" \\\n-H \"Content-Type: application/json\" \\\n-d '{\n \"name\": \"My Example Certificate\",\n \"certificate\": \"-----BEGIN CERTIFICATE-----\\\\nMIIDeT...\\\\n-----END CERTIFICATE-----\"\n}'\n"},"response":"{\n \"object\": \"certificate\",\n \"id\": \"cert_abc\",\n \"name\": \"My Example Certificate\",\n \"created_at\": 1234567,\n \"certificate_details\": {\n \"valid_at\": 12345667,\n \"expires_at\": 12345678\n }\n}\n"}}}},"/organization/certificates/activate":{"post":{"summary":"Activate certificates at the organization level.\n\nYou can atomically and idempotently activate up to 10 certificates at a time.\n","operationId":"activateOrganizationCertificates","tags":["Certificates"],"requestBody":{"description":"The certificate activation payload.","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ToggleCertificatesRequest"}}}},"responses":{"200":{"description":"Certificates activated successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListCertificatesResponse"}}}}},"x-oaiMeta":{"name":"Activate certificates for organization","group":"administration","examples":{"request":{"curl":"curl https://api.openai.com/v1/organization/certificates/activate \\\n-H \"Authorization: Bearer $OPENAI_ADMIN_KEY\" \\\n-H \"Content-Type: application/json\" \\\n-d '{\n \"data\": [\"cert_abc\", \"cert_def\"]\n}'\n"},"response":"{\n \"object\": \"organization.certificate.activation\",\n \"data\": [\n {\n \"object\": \"organization.certificate\",\n \"id\": \"cert_abc\",\n \"name\": \"My Example Certificate\",\n \"active\": true,\n \"created_at\": 1234567,\n \"certificate_details\": {\n \"valid_at\": 12345667,\n \"expires_at\": 12345678\n }\n },\n {\n \"object\": \"organization.certificate\",\n \"id\": \"cert_def\",\n \"name\": \"My Example Certificate 2\",\n \"active\": true,\n \"created_at\": 1234567,\n \"certificate_details\": {\n \"valid_at\": 12345667,\n \"expires_at\": 12345678\n }\n },\n ],\n}\n"}}}},"/organization/certificates/deactivate":{"post":{"summary":"Deactivate certificates at the organization level.\n\nYou can atomically and idempotently deactivate up to 10 certificates at a time.\n","operationId":"deactivateOrganizationCertificates","tags":["Certificates"],"requestBody":{"description":"The certificate deactivation payload.","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ToggleCertificatesRequest"}}}},"responses":{"200":{"description":"Certificates deactivated successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListCertificatesResponse"}}}}},"x-oaiMeta":{"name":"Deactivate certificates for organization","group":"administration","examples":{"request":{"curl":"curl https://api.openai.com/v1/organization/certificates/deactivate \\\n-H \"Authorization: Bearer $OPENAI_ADMIN_KEY\" \\\n-H \"Content-Type: application/json\" \\\n-d '{\n \"data\": [\"cert_abc\", \"cert_def\"]\n}'\n"},"response":"{\n \"object\": \"organization.certificate.deactivation\",\n \"data\": [\n {\n \"object\": \"organization.certificate\",\n \"id\": \"cert_abc\",\n \"name\": \"My Example Certificate\",\n \"active\": false,\n \"created_at\": 1234567,\n \"certificate_details\": {\n \"valid_at\": 12345667,\n \"expires_at\": 12345678\n }\n },\n {\n \"object\": \"organization.certificate\",\n \"id\": \"cert_def\",\n \"name\": \"My Example Certificate 2\",\n \"active\": false,\n \"created_at\": 1234567,\n \"certificate_details\": {\n \"valid_at\": 12345667,\n \"expires_at\": 12345678\n }\n },\n ],\n}\n"}}}},"/organization/certificates/{certificate_id}":{"get":{"summary":"Get a certificate that has been uploaded to the organization.\n\nYou can get a certificate regardless of whether it is active or not.\n","operationId":"getCertificate","tags":["Certificates"],"parameters":[{"name":"certificate_id","in":"path","description":"Unique ID of the certificate to retrieve.","required":true,"schema":{"type":"string"}},{"name":"include","in":"query","description":"A list of additional fields to include in the response. Currently the only supported value is `content` to fetch the PEM content of the certificate.","required":false,"schema":{"type":"array","items":{"type":"string","enum":["content"]}}}],"responses":{"200":{"description":"Certificate retrieved successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Certificate"}}}}},"x-oaiMeta":{"name":"Get certificate","group":"administration","examples":{"request":{"curl":"curl \"https://api.openai.com/v1/organization/certificates/cert_abc?include[]=content\" \\\n-H \"Authorization: Bearer $OPENAI_ADMIN_KEY\"\n"},"response":"{\n \"object\": \"certificate\",\n \"id\": \"cert_abc\",\n \"name\": \"My Example Certificate\",\n \"created_at\": 1234567,\n \"certificate_details\": {\n \"valid_at\": 1234567,\n \"expires_at\": 12345678,\n \"content\": \"-----BEGIN CERTIFICATE-----MIIDeT...-----END CERTIFICATE-----\"\n }\n}\n"}}},"post":{"summary":"Modify a certificate. Note that only the name can be modified.\n","operationId":"modifyCertificate","tags":["Certificates"],"parameters":[{"name":"certificate_id","in":"path","description":"Unique ID of the certificate to modify.","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"The certificate modification payload.","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModifyCertificateRequest"}}}},"responses":{"200":{"description":"Certificate modified successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Certificate"}}}}},"x-oaiMeta":{"name":"Modify certificate","group":"administration","examples":{"request":{"curl":"curl -X POST https://api.openai.com/v1/organization/certificates/cert_abc \\\n-H \"Authorization: Bearer $OPENAI_ADMIN_KEY\" \\\n-H \"Content-Type: application/json\" \\\n-d '{\n \"name\": \"Renamed Certificate\"\n}'\n"},"response":"{\n \"object\": \"certificate\",\n \"id\": \"cert_abc\",\n \"name\": \"Renamed Certificate\",\n \"created_at\": 1234567,\n \"certificate_details\": {\n \"valid_at\": 12345667,\n \"expires_at\": 12345678\n }\n}\n"}}},"delete":{"summary":"Delete a certificate from the organization.\n\nThe certificate must be inactive for the organization and all projects.\n","operationId":"deleteCertificate","tags":["Certificates"],"parameters":[{"name":"certificate_id","in":"path","description":"Unique ID of the certificate to delete.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Certificate deleted successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteCertificateResponse"}}}}},"x-oaiMeta":{"name":"Delete certificate","group":"administration","examples":{"request":{"curl":"curl -X DELETE https://api.openai.com/v1/organization/certificates/cert_abc \\\n-H \"Authorization: Bearer $OPENAI_ADMIN_KEY\"\n"},"response":"{\n \"object\": \"certificate.deleted\",\n \"id\": \"cert_abc\"\n}\n"}}}},"/organization/costs":{"get":{"summary":"Get costs details for the organization.","operationId":"usage-costs","tags":["Usage"],"parameters":[{"name":"start_time","in":"query","description":"Start time (Unix seconds) of the query time range, inclusive.","required":true,"schema":{"type":"integer"}},{"name":"end_time","in":"query","description":"End time (Unix seconds) of the query time range, exclusive.","required":false,"schema":{"type":"integer"}},{"name":"bucket_width","in":"query","description":"Width of each time bucket in response. Currently only `1d` is supported, default to `1d`.","required":false,"schema":{"type":"string","enum":["1d"],"default":"1d"}},{"name":"project_ids","in":"query","description":"Return only costs for these projects.","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"group_by","in":"query","description":"Group the costs by the specified fields. Support fields include `project_id`, `line_item` and any combination of them.","required":false,"schema":{"type":"array","items":{"type":"string","enum":["project_id","line_item"]}}},{"name":"limit","in":"query","description":"A limit on the number of buckets to be returned. Limit can range between 1 and 180, and the default is 7.\n","required":false,"schema":{"type":"integer","default":7}},{"name":"page","in":"query","description":"A cursor for use in pagination. Corresponding to the `next_page` field from the previous response.","schema":{"type":"string"}}],"responses":{"200":{"description":"Costs data retrieved successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UsageResponse"}}}}},"x-oaiMeta":{"name":"Costs","group":"usage-costs","examples":{"request":{"curl":"curl \"https://api.openai.com/v1/organization/costs?start_time=1730419200&limit=1\" \\\n-H \"Authorization: Bearer $OPENAI_ADMIN_KEY\" \\\n-H \"Content-Type: application/json\"\n"},"response":"{\n \"object\": \"page\",\n \"data\": [\n {\n \"object\": \"bucket\",\n \"start_time\": 1730419200,\n \"end_time\": 1730505600,\n \"results\": [\n {\n \"object\": \"organization.costs.result\",\n \"amount\": {\n \"value\": 0.06,\n \"currency\": \"usd\"\n },\n \"line_item\": null,\n \"project_id\": null\n }\n ]\n }\n ],\n \"has_more\": false,\n \"next_page\": null\n}\n"}}}},"/organization/groups":{"get":{"summary":"Lists all groups in the organization.","operationId":"list-groups","tags":["Groups"],"parameters":[{"name":"limit","in":"query","description":"A limit on the number of groups to be returned. Limit can range between 0 and 1000, and the default is 100.\n","required":false,"schema":{"type":"integer","minimum":0,"maximum":1000,"default":100}},{"name":"after","in":"query","description":"A cursor for use in pagination. `after` is a group ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with group_abc, your subsequent call can include `after=group_abc` in order to fetch the next page of the list.\n","required":false,"schema":{"type":"string"}},{"name":"order","in":"query","description":"Specifies the sort order of the returned groups.","required":false,"schema":{"type":"string","enum":["asc","desc"],"default":"asc"}}],"responses":{"200":{"description":"Groups listed successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GroupListResource"}}}}},"x-oaiMeta":{"name":"List groups","group":"administration","examples":{"request":{"curl":"curl https://api.openai.com/v1/organization/groups?limit=20&order=asc \\\n -H \"Authorization: Bearer $OPENAI_ADMIN_KEY\" \\\n -H \"Content-Type: application/json\"\n"},"response":"{\n \"object\": \"list\",\n \"data\": [\n {\n \"object\": \"group\",\n \"id\": \"group_01J1F8ABCDXYZ\",\n \"name\": \"Support Team\",\n \"created_at\": 1711471533,\n \"is_scim_managed\": false\n }\n ],\n \"has_more\": false,\n \"next\": null\n}\n"}}},"post":{"summary":"Creates a new group in the organization.","operationId":"create-group","tags":["Groups"],"requestBody":{"description":"Parameters for the group you want to create.","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateGroupBody"}}}},"responses":{"200":{"description":"Group created successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GroupResponse"}}}}},"x-oaiMeta":{"name":"Create group","group":"administration","examples":{"request":{"curl":"curl -X POST https://api.openai.com/v1/organization/groups \\\n -H \"Authorization: Bearer $OPENAI_ADMIN_KEY\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"name\": \"Support Team\"\n }'\n"},"response":"{\n \"object\": \"group\",\n \"id\": \"group_01J1F8ABCDXYZ\",\n \"name\": \"Support Team\",\n \"created_at\": 1711471533,\n \"is_scim_managed\": false\n}\n"}}}},"/organization/groups/{group_id}":{"post":{"summary":"Updates a group's information.","operationId":"update-group","tags":["Groups"],"parameters":[{"name":"group_id","in":"path","description":"The ID of the group to update.","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"New attributes to set on the group.","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateGroupBody"}}}},"responses":{"200":{"description":"Group updated successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GroupResourceWithSuccess"}}}}},"x-oaiMeta":{"name":"Update group","group":"administration","examples":{"request":{"curl":"curl -X POST https://api.openai.com/v1/organization/groups/group_01J1F8ABCDXYZ \\\n -H \"Authorization: Bearer $OPENAI_ADMIN_KEY\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"name\": \"Escalations\"\n }'\n"},"response":"{\n \"id\": \"group_01J1F8ABCDXYZ\",\n \"name\": \"Escalations\",\n \"created_at\": 1711471533,\n \"is_scim_managed\": false\n}\n"}}},"delete":{"summary":"Deletes a group from the organization.","operationId":"delete-group","tags":["Groups"],"parameters":[{"name":"group_id","in":"path","description":"The ID of the group to delete.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Group deleted successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GroupDeletedResource"}}}}},"x-oaiMeta":{"name":"Delete group","group":"administration","examples":{"request":{"curl":"curl -X DELETE https://api.openai.com/v1/organization/groups/group_01J1F8ABCDXYZ \\\n -H \"Authorization: Bearer $OPENAI_ADMIN_KEY\" \\\n -H \"Content-Type: application/json\"\n"},"response":"{\n \"object\": \"group.deleted\",\n \"id\": \"group_01J1F8ABCDXYZ\",\n \"deleted\": true\n}\n"}}}},"/organization/groups/{group_id}/roles":{"get":{"summary":"Lists the organization roles assigned to a group within the organization.","operationId":"list-group-role-assignments","tags":["Group organization role assignments"],"parameters":[{"name":"group_id","in":"path","description":"The ID of the group whose organization role assignments you want to list.","required":true,"schema":{"type":"string"}},{"name":"limit","in":"query","description":"A limit on the number of organization role assignments to return.","required":false,"schema":{"type":"integer","minimum":0,"maximum":1000}},{"name":"after","in":"query","description":"Cursor for pagination. Provide the value from the previous response's `next` field to continue listing organization roles.","required":false,"schema":{"type":"string"}},{"name":"order","in":"query","description":"Sort order for the returned organization roles.","required":false,"schema":{"type":"string","enum":["asc","desc"]}}],"responses":{"200":{"description":"Group organization role assignments listed successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RoleListResource"}}}}},"x-oaiMeta":{"name":"List group organization role assignments","group":"administration","examples":{"request":{"curl":"curl https://api.openai.com/v1/organization/groups/group_01J1F8ABCDXYZ/roles \\\n -H \"Authorization: Bearer $OPENAI_ADMIN_KEY\" \\\n -H \"Content-Type: application/json\"\n"},"response":"{\n \"object\": \"list\",\n \"data\": [\n {\n \"id\": \"role_01J1F8ROLE01\",\n \"name\": \"API Group Manager\",\n \"permissions\": [\n \"api.groups.read\",\n \"api.groups.write\"\n ],\n \"resource_type\": \"api.organization\",\n \"predefined_role\": false,\n \"description\": \"Allows managing organization groups\",\n \"created_at\": 1711471533,\n \"updated_at\": 1711472599,\n \"created_by\": \"user_abc123\",\n \"created_by_user_obj\": {\n \"id\": \"user_abc123\",\n \"name\": \"Ada Lovelace\",\n \"email\": \"ada@example.com\"\n },\n \"metadata\": {}\n }\n ],\n \"has_more\": false,\n \"next\": null\n}\n"}}},"post":{"summary":"Assigns an organization role to a group within the organization.","operationId":"assign-group-role","tags":["Group organization role assignments"],"parameters":[{"name":"group_id","in":"path","description":"The ID of the group that should receive the organization role.","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Identifies the organization role to assign to the group.","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicAssignOrganizationGroupRoleBody"}}}},"responses":{"200":{"description":"Organization role assigned to the group successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GroupRoleAssignment"}}}}},"x-oaiMeta":{"name":"Assign organization role to group","group":"administration","examples":{"request":{"curl":"curl -X POST https://api.openai.com/v1/organization/groups/group_01J1F8ABCDXYZ/roles \\\n -H \"Authorization: Bearer $OPENAI_ADMIN_KEY\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"role_id\": \"role_01J1F8ROLE01\"\n }'\n"},"response":"{\n \"object\": \"group.role\",\n \"group\": {\n \"object\": \"group\",\n \"id\": \"group_01J1F8ABCDXYZ\",\n \"name\": \"Support Team\",\n \"created_at\": 1711471533,\n \"scim_managed\": false\n },\n \"role\": {\n \"object\": \"role\",\n \"id\": \"role_01J1F8ROLE01\",\n \"name\": \"API Group Manager\",\n \"description\": \"Allows managing organization groups\",\n \"permissions\": [\n \"api.groups.read\",\n \"api.groups.write\"\n ],\n \"resource_type\": \"api.organization\",\n \"predefined_role\": false\n }\n}\n"}}}},"/organization/groups/{group_id}/roles/{role_id}":{"delete":{"summary":"Unassigns an organization role from a group within the organization.","operationId":"unassign-group-role","tags":["Group organization role assignments"],"parameters":[{"name":"group_id","in":"path","description":"The ID of the group to modify.","required":true,"schema":{"type":"string"}},{"name":"role_id","in":"path","description":"The ID of the organization role to remove from the group.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Organization role unassigned from the group successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeletedRoleAssignmentResource"}}}}},"x-oaiMeta":{"name":"Unassign organization role from group","group":"administration","examples":{"request":{"curl":"curl -X DELETE https://api.openai.com/v1/organization/groups/group_01J1F8ABCDXYZ/roles/role_01J1F8ROLE01 \\\n -H \"Authorization: Bearer $OPENAI_ADMIN_KEY\" \\\n -H \"Content-Type: application/json\"\n"},"response":"{\n \"object\": \"group.role.deleted\",\n \"deleted\": true\n}\n"}}}},"/organization/groups/{group_id}/users":{"get":{"summary":"Lists the users assigned to a group.","operationId":"list-group-users","tags":["Group users"],"parameters":[{"name":"group_id","in":"path","description":"The ID of the group to inspect.","required":true,"schema":{"type":"string"}},{"name":"limit","in":"query","description":"A limit on the number of users to be returned. Limit can range between 0 and 1000, and the default is 100.\n","required":false,"schema":{"type":"integer","minimum":0,"maximum":1000,"default":100}},{"name":"after","in":"query","description":"A cursor for use in pagination. Provide the ID of the last user from the previous list response to retrieve the next page.\n","required":false,"schema":{"type":"string"}},{"name":"order","in":"query","description":"Specifies the sort order of users in the list.","required":false,"schema":{"type":"string","enum":["asc","desc"],"default":"desc"}}],"responses":{"200":{"description":"Group users listed successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserListResource"}}}}},"x-oaiMeta":{"name":"List group users","group":"administration","examples":{"request":{"curl":"curl https://api.openai.com/v1/organization/groups/group_01J1F8ABCDXYZ/users?limit=20 \\\n -H \"Authorization: Bearer $OPENAI_ADMIN_KEY\" \\\n -H \"Content-Type: application/json\"\n"},"response":"{\n \"object\": \"list\",\n \"data\": [\n {\n \"object\": \"organization.user\",\n \"id\": \"user_abc123\",\n \"name\": \"Ada Lovelace\",\n \"email\": \"ada@example.com\",\n \"role\": \"owner\",\n \"added_at\": 1711471533\n }\n ],\n \"has_more\": false,\n \"next\": null\n}\n"}}},"post":{"summary":"Adds a user to a group.","operationId":"add-group-user","tags":["Group users"],"parameters":[{"name":"group_id","in":"path","description":"The ID of the group to update.","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Identifies the user that should be added to the group.","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateGroupUserBody"}}}},"responses":{"200":{"description":"User added to the group successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GroupUserAssignment"}}}}},"x-oaiMeta":{"name":"Add group user","group":"administration","examples":{"request":{"curl":"curl -X POST https://api.openai.com/v1/organization/groups/group_01J1F8ABCDXYZ/users \\\n -H \"Authorization: Bearer $OPENAI_ADMIN_KEY\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"user_id\": \"user_abc123\"\n }'\n"},"response":"{\n \"object\": \"group.user\",\n \"user_id\": \"user_abc123\",\n \"group_id\": \"group_01J1F8ABCDXYZ\"\n}\n"}}}},"/organization/groups/{group_id}/users/{user_id}":{"delete":{"summary":"Removes a user from a group.","operationId":"remove-group-user","tags":["Group users"],"parameters":[{"name":"group_id","in":"path","description":"The ID of the group to update.","required":true,"schema":{"type":"string"}},{"name":"user_id","in":"path","description":"The ID of the user to remove from the group.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"User removed from the group successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GroupUserDeletedResource"}}}}},"x-oaiMeta":{"name":"Remove group user","group":"administration","examples":{"request":{"curl":"curl -X DELETE https://api.openai.com/v1/organization/groups/group_01J1F8ABCDXYZ/users/user_abc123 \\\n -H \"Authorization: Bearer $OPENAI_ADMIN_KEY\" \\\n -H \"Content-Type: application/json\"\n"},"response":"{\n \"object\": \"group.user.deleted\",\n \"deleted\": true\n}\n"}}}},"/organization/invites":{"get":{"summary":"Returns a list of invites in the organization.","operationId":"list-invites","tags":["Invites"],"parameters":[{"name":"limit","in":"query","description":"A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.\n","required":false,"schema":{"type":"integer","default":20}},{"name":"after","in":"query","description":"A cursor for use in pagination. `after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list.\n","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Invites listed successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InviteListResponse"}}}}},"x-oaiMeta":{"name":"List invites","group":"administration","examples":{"request":{"curl":"curl https://api.openai.com/v1/organization/invites?after=invite-abc&limit=20 \\\n -H \"Authorization: Bearer $OPENAI_ADMIN_KEY\" \\\n -H \"Content-Type: application/json\"\n"},"response":"{\n \"object\": \"list\",\n \"data\": [\n {\n \"object\": \"organization.invite\",\n \"id\": \"invite-abc\",\n \"email\": \"user@example.com\",\n \"role\": \"owner\",\n \"status\": \"accepted\",\n \"invited_at\": 1711471533,\n \"expires_at\": 1711471533,\n \"accepted_at\": 1711471533\n }\n ],\n \"first_id\": \"invite-abc\",\n \"last_id\": \"invite-abc\",\n \"has_more\": false\n}\n"}}},"post":{"summary":"Create an invite for a user to the organization. The invite must be accepted by the user before they have access to the organization.","operationId":"inviteUser","tags":["Invites"],"requestBody":{"description":"The invite request payload.","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InviteRequest"}}}},"responses":{"200":{"description":"User invited successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Invite"}}}}},"x-oaiMeta":{"name":"Create invite","group":"administration","examples":{"request":{"curl":"curl -X POST https://api.openai.com/v1/organization/invites \\\n -H \"Authorization: Bearer $OPENAI_ADMIN_KEY\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"email\": \"anotheruser@example.com\",\n \"role\": \"reader\",\n \"projects\": [\n {\n \"id\": \"project-xyz\",\n \"role\": \"member\"\n },\n {\n \"id\": \"project-abc\",\n \"role\": \"owner\"\n }\n ]\n }'\n"},"response":"{\n \"object\": \"organization.invite\",\n \"id\": \"invite-def\",\n \"email\": \"anotheruser@example.com\",\n \"role\": \"reader\",\n \"status\": \"pending\",\n \"invited_at\": 1711471533,\n \"expires_at\": 1711471533,\n \"accepted_at\": null,\n \"projects\": [\n {\n \"id\": \"project-xyz\",\n \"role\": \"member\"\n },\n {\n \"id\": \"project-abc\",\n \"role\": \"owner\"\n }\n ]\n}\n"}}}},"/organization/invites/{invite_id}":{"get":{"summary":"Retrieves an invite.","operationId":"retrieve-invite","tags":["Invites"],"parameters":[{"in":"path","name":"invite_id","required":true,"schema":{"type":"string"},"description":"The ID of the invite to retrieve."}],"responses":{"200":{"description":"Invite retrieved successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Invite"}}}}},"x-oaiMeta":{"name":"Retrieve invite","group":"administration","examples":{"request":{"curl":"curl https://api.openai.com/v1/organization/invites/invite-abc \\\n -H \"Authorization: Bearer $OPENAI_ADMIN_KEY\" \\\n -H \"Content-Type: application/json\"\n"},"response":"{\n \"object\": \"organization.invite\",\n \"id\": \"invite-abc\",\n \"email\": \"user@example.com\",\n \"role\": \"owner\",\n \"status\": \"accepted\",\n \"invited_at\": 1711471533,\n \"expires_at\": 1711471533,\n \"accepted_at\": 1711471533\n}\n"}}},"delete":{"summary":"Delete an invite. If the invite has already been accepted, it cannot be deleted.","operationId":"delete-invite","tags":["Invites"],"parameters":[{"in":"path","name":"invite_id","required":true,"schema":{"type":"string"},"description":"The ID of the invite to delete."}],"responses":{"200":{"description":"Invite deleted successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InviteDeleteResponse"}}}}},"x-oaiMeta":{"name":"Delete invite","group":"administration","examples":{"request":{"curl":"curl -X DELETE https://api.openai.com/v1/organization/invites/invite-abc \\\n -H \"Authorization: Bearer $OPENAI_ADMIN_KEY\" \\\n -H \"Content-Type: application/json\"\n"},"response":"{\n \"object\": \"organization.invite.deleted\",\n \"id\": \"invite-abc\",\n \"deleted\": true\n}\n"}}}},"/organization/projects":{"get":{"summary":"Returns a list of projects.","operationId":"list-projects","tags":["Projects"],"parameters":[{"name":"limit","in":"query","description":"A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.\n","required":false,"schema":{"type":"integer","default":20}},{"name":"after","in":"query","description":"A cursor for use in pagination. `after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list.\n","required":false,"schema":{"type":"string"}},{"name":"include_archived","in":"query","schema":{"type":"boolean","default":false},"description":"If `true` returns all projects including those that have been `archived`. Archived projects are not included by default."}],"responses":{"200":{"description":"Projects listed successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProjectListResponse"}}}}},"x-oaiMeta":{"name":"List projects","group":"administration","examples":{"request":{"curl":"curl https://api.openai.com/v1/organization/projects?after=proj_abc&limit=20&include_archived=false \\\n -H \"Authorization: Bearer $OPENAI_ADMIN_KEY\" \\\n -H \"Content-Type: application/json\"\n"},"response":"{\n \"object\": \"list\",\n \"data\": [\n {\n \"id\": \"proj_abc\",\n \"object\": \"organization.project\",\n \"name\": \"Project example\",\n \"created_at\": 1711471533,\n \"archived_at\": null,\n \"status\": \"active\"\n }\n ],\n \"first_id\": \"proj-abc\",\n \"last_id\": \"proj-xyz\",\n \"has_more\": false\n}\n"}}},"post":{"summary":"Create a new project in the organization. Projects can be created and archived, but cannot be deleted.","operationId":"create-project","tags":["Projects"],"requestBody":{"description":"The project create request payload.","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProjectCreateRequest"}}}},"responses":{"200":{"description":"Project created successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Project"}}}}},"x-oaiMeta":{"name":"Create project","group":"administration","examples":{"request":{"curl":"curl -X POST https://api.openai.com/v1/organization/projects \\\n -H \"Authorization: Bearer $OPENAI_ADMIN_KEY\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"name\": \"Project ABC\"\n }'\n"},"response":"{\n \"id\": \"proj_abc\",\n \"object\": \"organization.project\",\n \"name\": \"Project ABC\",\n \"created_at\": 1711471533,\n \"archived_at\": null,\n \"status\": \"active\"\n}\n"}}}},"/organization/projects/{project_id}":{"get":{"summary":"Retrieves a project.","operationId":"retrieve-project","tags":["Projects"],"parameters":[{"name":"project_id","in":"path","description":"The ID of the project.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Project retrieved successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Project"}}}}},"x-oaiMeta":{"name":"Retrieve project","group":"administration","description":"Retrieve a project.","examples":{"request":{"curl":"curl https://api.openai.com/v1/organization/projects/proj_abc \\\n -H \"Authorization: Bearer $OPENAI_ADMIN_KEY\" \\\n -H \"Content-Type: application/json\"\n"},"response":"{\n \"id\": \"proj_abc\",\n \"object\": \"organization.project\",\n \"name\": \"Project example\",\n \"created_at\": 1711471533,\n \"archived_at\": null,\n \"status\": \"active\"\n}\n"}}},"post":{"summary":"Modifies a project in the organization.","operationId":"modify-project","tags":["Projects"],"parameters":[{"name":"project_id","in":"path","description":"The ID of the project.","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"The project update request payload.","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProjectUpdateRequest"}}}},"responses":{"200":{"description":"Project updated successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Project"}}}},"400":{"description":"Error response when updating the default project.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-oaiMeta":{"name":"Modify project","group":"administration","examples":{"request":{"curl":"curl -X POST https://api.openai.com/v1/organization/projects/proj_abc \\\n -H \"Authorization: Bearer $OPENAI_ADMIN_KEY\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"name\": \"Project DEF\"\n }'\n"},"response":""}}}},"/organization/projects/{project_id}/api_keys":{"get":{"summary":"Returns a list of API keys in the project.","operationId":"list-project-api-keys","tags":["Projects"],"parameters":[{"name":"project_id","in":"path","description":"The ID of the project.","required":true,"schema":{"type":"string"}},{"name":"limit","in":"query","description":"A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.\n","required":false,"schema":{"type":"integer","default":20}},{"name":"after","in":"query","description":"A cursor for use in pagination. `after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list.\n","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Project API keys listed successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProjectApiKeyListResponse"}}}}},"x-oaiMeta":{"name":"List project API keys","group":"administration","examples":{"request":{"curl":"curl https://api.openai.com/v1/organization/projects/proj_abc/api_keys?after=key_abc&limit=20 \\\n -H \"Authorization: Bearer $OPENAI_ADMIN_KEY\" \\\n -H \"Content-Type: application/json\"\n"},"response":"{\n \"object\": \"list\",\n \"data\": [\n {\n \"object\": \"organization.project.api_key\",\n \"redacted_value\": \"sk-abc...def\",\n \"name\": \"My API Key\",\n \"created_at\": 1711471533,\n \"last_used_at\": 1711471534,\n \"id\": \"key_abc\",\n \"owner\": {\n \"type\": \"user\",\n \"user\": {\n \"object\": \"organization.project.user\",\n \"id\": \"user_abc\",\n \"name\": \"First Last\",\n \"email\": \"user@example.com\",\n \"role\": \"owner\",\n \"added_at\": 1711471533\n }\n }\n }\n ],\n \"first_id\": \"key_abc\",\n \"last_id\": \"key_xyz\",\n \"has_more\": false\n}\n"}}}},"/organization/projects/{project_id}/api_keys/{key_id}":{"get":{"summary":"Retrieves an API key in the project.","operationId":"retrieve-project-api-key","tags":["Projects"],"parameters":[{"name":"project_id","in":"path","description":"The ID of the project.","required":true,"schema":{"type":"string"}},{"name":"key_id","in":"path","description":"The ID of the API key.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Project API key retrieved successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProjectApiKey"}}}}},"x-oaiMeta":{"name":"Retrieve project API key","group":"administration","examples":{"request":{"curl":"curl https://api.openai.com/v1/organization/projects/proj_abc/api_keys/key_abc \\\n -H \"Authorization: Bearer $OPENAI_ADMIN_KEY\" \\\n -H \"Content-Type: application/json\"\n"},"response":"{\n \"object\": \"organization.project.api_key\",\n \"redacted_value\": \"sk-abc...def\",\n \"name\": \"My API Key\",\n \"created_at\": 1711471533,\n \"last_used_at\": 1711471534,\n \"id\": \"key_abc\",\n \"owner\": {\n \"type\": \"user\",\n \"user\": {\n \"object\": \"organization.project.user\",\n \"id\": \"user_abc\",\n \"name\": \"First Last\",\n \"email\": \"user@example.com\",\n \"role\": \"owner\",\n \"added_at\": 1711471533\n }\n }\n}\n"}}},"delete":{"summary":"Deletes an API key from the project.\n\nReturns confirmation of the key deletion, or an error if the key belonged to\na service account.\n","operationId":"delete-project-api-key","tags":["Projects"],"parameters":[{"name":"project_id","in":"path","description":"The ID of the project.","required":true,"schema":{"type":"string"}},{"name":"key_id","in":"path","description":"The ID of the API key.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Project API key deleted successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProjectApiKeyDeleteResponse"}}}},"400":{"description":"Error response for various conditions.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-oaiMeta":{"name":"Delete project API key","group":"administration","examples":{"request":{"curl":"curl -X DELETE https://api.openai.com/v1/organization/projects/proj_abc/api_keys/key_abc \\\n -H \"Authorization: Bearer $OPENAI_ADMIN_KEY\" \\\n -H \"Content-Type: application/json\"\n"},"response":"{\n \"object\": \"organization.project.api_key.deleted\",\n \"id\": \"key_abc\",\n \"deleted\": true\n}\n"}}}},"/organization/projects/{project_id}/archive":{"post":{"summary":"Archives a project in the organization. Archived projects cannot be used or updated.","operationId":"archive-project","tags":["Projects"],"parameters":[{"name":"project_id","in":"path","description":"The ID of the project.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Project archived successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Project"}}}}},"x-oaiMeta":{"name":"Archive project","group":"administration","examples":{"request":{"curl":"curl -X POST https://api.openai.com/v1/organization/projects/proj_abc/archive \\\n -H \"Authorization: Bearer $OPENAI_ADMIN_KEY\" \\\n -H \"Content-Type: application/json\"\n"},"response":"{\n \"id\": \"proj_abc\",\n \"object\": \"organization.project\",\n \"name\": \"Project DEF\",\n \"created_at\": 1711471533,\n \"archived_at\": 1711471533,\n \"status\": \"archived\"\n}\n"}}}},"/organization/projects/{project_id}/certificates":{"get":{"summary":"List certificates for this project.","operationId":"listProjectCertificates","tags":["Certificates"],"parameters":[{"name":"project_id","in":"path","description":"The ID of the project.","required":true,"schema":{"type":"string"}},{"name":"limit","in":"query","description":"A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.\n","required":false,"schema":{"type":"integer","default":20}},{"name":"after","in":"query","description":"A cursor for use in pagination. `after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list.\n","required":false,"schema":{"type":"string"}},{"name":"order","in":"query","description":"Sort order by the `created_at` timestamp of the objects. `asc` for ascending order and `desc` for descending order.\n","schema":{"type":"string","default":"desc","enum":["asc","desc"]}}],"responses":{"200":{"description":"Certificates listed successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListCertificatesResponse"}}}}},"x-oaiMeta":{"name":"List project certificates","group":"administration","examples":{"request":{"curl":"curl https://api.openai.com/v1/organization/projects/proj_abc/certificates \\\n-H \"Authorization: Bearer $OPENAI_ADMIN_KEY\"\n"},"response":"{\n \"object\": \"list\",\n \"data\": [\n {\n \"object\": \"organization.project.certificate\",\n \"id\": \"cert_abc\",\n \"name\": \"My Example Certificate\",\n \"active\": true,\n \"created_at\": 1234567,\n \"certificate_details\": {\n \"valid_at\": 12345667,\n \"expires_at\": 12345678\n }\n },\n ],\n \"first_id\": \"cert_abc\",\n \"last_id\": \"cert_abc\",\n \"has_more\": false\n}\n"}}}},"/organization/projects/{project_id}/certificates/activate":{"post":{"summary":"Activate certificates at the project level.\n\nYou can atomically and idempotently activate up to 10 certificates at a time.\n","operationId":"activateProjectCertificates","tags":["Certificates"],"parameters":[{"name":"project_id","in":"path","description":"The ID of the project.","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"The certificate activation payload.","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ToggleCertificatesRequest"}}}},"responses":{"200":{"description":"Certificates activated successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListCertificatesResponse"}}}}},"x-oaiMeta":{"name":"Activate certificates for project","group":"administration","examples":{"request":{"curl":"curl https://api.openai.com/v1/organization/projects/proj_abc/certificates/activate \\\n-H \"Authorization: Bearer $OPENAI_ADMIN_KEY\" \\\n-H \"Content-Type: application/json\" \\\n-d '{\n \"data\": [\"cert_abc\", \"cert_def\"]\n}'\n"},"response":"{\n \"object\": \"organization.project.certificate.activation\",\n \"data\": [\n {\n \"object\": \"organization.project.certificate\",\n \"id\": \"cert_abc\",\n \"name\": \"My Example Certificate\",\n \"active\": true,\n \"created_at\": 1234567,\n \"certificate_details\": {\n \"valid_at\": 12345667,\n \"expires_at\": 12345678\n }\n },\n {\n \"object\": \"organization.project.certificate\",\n \"id\": \"cert_def\",\n \"name\": \"My Example Certificate 2\",\n \"active\": true,\n \"created_at\": 1234567,\n \"certificate_details\": {\n \"valid_at\": 12345667,\n \"expires_at\": 12345678\n }\n },\n ],\n}\n"}}}},"/organization/projects/{project_id}/certificates/deactivate":{"post":{"summary":"Deactivate certificates at the project level. You can atomically and \nidempotently deactivate up to 10 certificates at a time.\n","operationId":"deactivateProjectCertificates","tags":["Certificates"],"parameters":[{"name":"project_id","in":"path","description":"The ID of the project.","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"The certificate deactivation payload.","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ToggleCertificatesRequest"}}}},"responses":{"200":{"description":"Certificates deactivated successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListCertificatesResponse"}}}}},"x-oaiMeta":{"name":"Deactivate certificates for project","group":"administration","examples":{"request":{"curl":"curl https://api.openai.com/v1/organization/projects/proj_abc/certificates/deactivate \\\n-H \"Authorization: Bearer $OPENAI_ADMIN_KEY\" \\\n-H \"Content-Type: application/json\" \\\n-d '{\n \"data\": [\"cert_abc\", \"cert_def\"]\n}'\n"},"response":"{\n \"object\": \"organization.project.certificate.deactivation\",\n \"data\": [\n {\n \"object\": \"organization.project.certificate\",\n \"id\": \"cert_abc\",\n \"name\": \"My Example Certificate\",\n \"active\": false,\n \"created_at\": 1234567,\n \"certificate_details\": {\n \"valid_at\": 12345667,\n \"expires_at\": 12345678\n }\n },\n {\n \"object\": \"organization.project.certificate\",\n \"id\": \"cert_def\",\n \"name\": \"My Example Certificate 2\",\n \"active\": false,\n \"created_at\": 1234567,\n \"certificate_details\": {\n \"valid_at\": 12345667,\n \"expires_at\": 12345678\n }\n },\n ],\n}\n"}}}},"/organization/projects/{project_id}/groups":{"get":{"summary":"Lists the groups that have access to a project.","operationId":"list-project-groups","tags":["Project groups"],"parameters":[{"name":"project_id","in":"path","description":"The ID of the project to inspect.","required":true,"schema":{"type":"string"}},{"name":"limit","in":"query","description":"A limit on the number of project groups to return. Defaults to 20.","required":false,"schema":{"type":"integer","minimum":0,"maximum":100,"default":20}},{"name":"after","in":"query","description":"Cursor for pagination. Provide the ID of the last group from the previous response to fetch the next page.","required":false,"schema":{"type":"string"}},{"name":"order","in":"query","description":"Sort order for the returned groups.","required":false,"schema":{"type":"string","enum":["asc","desc"],"default":"asc"}}],"responses":{"200":{"description":"Project groups listed successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProjectGroupListResource"}}}}},"x-oaiMeta":{"name":"List project groups","group":"administration","examples":{"request":{"curl":"curl https://api.openai.com/v1/organization/projects/proj_abc123/groups?limit=20 \\\n -H \"Authorization: Bearer $OPENAI_ADMIN_KEY\" \\\n -H \"Content-Type: application/json\"\n"},"response":"{\n \"object\": \"list\",\n \"data\": [\n {\n \"object\": \"project.group\",\n \"project_id\": \"proj_abc123\",\n \"group_id\": \"group_01J1F8ABCDXYZ\",\n \"group_name\": \"Support Team\",\n \"created_at\": 1711471533\n }\n ],\n \"has_more\": false,\n \"next\": null\n}\n"}}},"post":{"summary":"Grants a group access to a project.","operationId":"add-project-group","tags":["Project groups"],"parameters":[{"name":"project_id","in":"path","description":"The ID of the project to update.","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Identifies the group and role to assign to the project.","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InviteProjectGroupBody"}}}},"responses":{"200":{"description":"Group granted access to the project successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProjectGroup"}}}}},"x-oaiMeta":{"name":"Add project group","group":"administration","examples":{"request":{"curl":"curl -X POST https://api.openai.com/v1/organization/projects/proj_abc123/groups \\\n -H \"Authorization: Bearer $OPENAI_ADMIN_KEY\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"group_id\": \"group_01J1F8ABCDXYZ\",\n \"role\": \"role_01J1F8PROJ\"\n }'\n"},"response":"{\n \"object\": \"project.group\",\n \"project_id\": \"proj_abc123\",\n \"group_id\": \"group_01J1F8ABCDXYZ\",\n \"group_name\": \"Support Team\",\n \"created_at\": 1711471533\n}\n"}}}},"/organization/projects/{project_id}/groups/{group_id}":{"delete":{"summary":"Revokes a group's access to a project.","operationId":"remove-project-group","tags":["Project groups"],"parameters":[{"name":"project_id","in":"path","description":"The ID of the project to update.","required":true,"schema":{"type":"string"}},{"name":"group_id","in":"path","description":"The ID of the group to remove from the project.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Group removed from the project successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProjectGroupDeletedResource"}}}}},"x-oaiMeta":{"name":"Remove project group","group":"administration","examples":{"request":{"curl":"curl -X DELETE https://api.openai.com/v1/organization/projects/proj_abc123/groups/group_01J1F8ABCDXYZ \\\n -H \"Authorization: Bearer $OPENAI_ADMIN_KEY\" \\\n -H \"Content-Type: application/json\"\n"},"response":"{\n \"object\": \"project.group.deleted\",\n \"deleted\": true\n}\n"}}}},"/organization/projects/{project_id}/rate_limits":{"get":{"summary":"Returns the rate limits per model for a project.","operationId":"list-project-rate-limits","tags":["Projects"],"parameters":[{"name":"project_id","in":"path","description":"The ID of the project.","required":true,"schema":{"type":"string"}},{"name":"limit","in":"query","description":"A limit on the number of objects to be returned. The default is 100.\n","required":false,"schema":{"type":"integer","default":100}},{"name":"after","in":"query","description":"A cursor for use in pagination. `after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list.\n","required":false,"schema":{"type":"string"}},{"name":"before","in":"query","description":"A cursor for use in pagination. `before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, beginning with obj_foo, your subsequent call can include before=obj_foo in order to fetch the previous page of the list.\n","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Project rate limits listed successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProjectRateLimitListResponse"}}}}},"x-oaiMeta":{"name":"List project rate limits","group":"administration","examples":{"request":{"curl":"curl https://api.openai.com/v1/organization/projects/proj_abc/rate_limits?after=rl_xxx&limit=20 \\\n -H \"Authorization: Bearer $OPENAI_ADMIN_KEY\" \\\n -H \"Content-Type: application/json\"\n"},"response":"{\n \"object\": \"list\",\n \"data\": [\n {\n \"object\": \"project.rate_limit\",\n \"id\": \"rl-ada\",\n \"model\": \"ada\",\n \"max_requests_per_1_minute\": 600,\n \"max_tokens_per_1_minute\": 150000,\n \"max_images_per_1_minute\": 10\n }\n ],\n \"first_id\": \"rl-ada\",\n \"last_id\": \"rl-ada\",\n \"has_more\": false\n}\n","error_response":"{\n \"code\": 404,\n \"message\": \"The project {project_id} was not found\"\n}\n"}}}},"/organization/projects/{project_id}/rate_limits/{rate_limit_id}":{"post":{"summary":"Updates a project rate limit.","operationId":"update-project-rate-limits","tags":["Projects"],"parameters":[{"name":"project_id","in":"path","description":"The ID of the project.","required":true,"schema":{"type":"string"}},{"name":"rate_limit_id","in":"path","description":"The ID of the rate limit.","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"The project rate limit update request payload.","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProjectRateLimitUpdateRequest"}}}},"responses":{"200":{"description":"Project rate limit updated successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProjectRateLimit"}}}},"400":{"description":"Error response for various conditions.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-oaiMeta":{"name":"Modify project rate limit","group":"administration","examples":{"request":{"curl":"curl -X POST https://api.openai.com/v1/organization/projects/proj_abc/rate_limits/rl_xxx \\\n -H \"Authorization: Bearer $OPENAI_ADMIN_KEY\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"max_requests_per_1_minute\": 500\n }'\n"},"response":"{\n \"object\": \"project.rate_limit\",\n \"id\": \"rl-ada\",\n \"model\": \"ada\",\n \"max_requests_per_1_minute\": 600,\n \"max_tokens_per_1_minute\": 150000,\n \"max_images_per_1_minute\": 10\n }\n","error_response":"{\n \"code\": 404,\n \"message\": \"The project {project_id} was not found\"\n}\n"}}}},"/organization/projects/{project_id}/service_accounts":{"get":{"summary":"Returns a list of service accounts in the project.","operationId":"list-project-service-accounts","tags":["Projects"],"parameters":[{"name":"project_id","in":"path","description":"The ID of the project.","required":true,"schema":{"type":"string"}},{"name":"limit","in":"query","description":"A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.\n","required":false,"schema":{"type":"integer","default":20}},{"name":"after","in":"query","description":"A cursor for use in pagination. `after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list.\n","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Project service accounts listed successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProjectServiceAccountListResponse"}}}},"400":{"description":"Error response when project is archived.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-oaiMeta":{"name":"List project service accounts","group":"administration","examples":{"request":{"curl":"curl https://api.openai.com/v1/organization/projects/proj_abc/service_accounts?after=custom_id&limit=20 \\\n -H \"Authorization: Bearer $OPENAI_ADMIN_KEY\" \\\n -H \"Content-Type: application/json\"\n"},"response":"{\n \"object\": \"list\",\n \"data\": [\n {\n \"object\": \"organization.project.service_account\",\n \"id\": \"svc_acct_abc\",\n \"name\": \"Service Account\",\n \"role\": \"owner\",\n \"created_at\": 1711471533\n }\n ],\n \"first_id\": \"svc_acct_abc\",\n \"last_id\": \"svc_acct_xyz\",\n \"has_more\": false\n}\n"}}},"post":{"summary":"Creates a new service account in the project. This also returns an unredacted API key for the service account.","operationId":"create-project-service-account","tags":["Projects"],"parameters":[{"name":"project_id","in":"path","description":"The ID of the project.","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"The project service account create request payload.","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProjectServiceAccountCreateRequest"}}}},"responses":{"200":{"description":"Project service account created successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProjectServiceAccountCreateResponse"}}}},"400":{"description":"Error response when project is archived.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-oaiMeta":{"name":"Create project service account","group":"administration","examples":{"request":{"curl":"curl -X POST https://api.openai.com/v1/organization/projects/proj_abc/service_accounts \\\n -H \"Authorization: Bearer $OPENAI_ADMIN_KEY\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"name\": \"Production App\"\n }'\n"},"response":"{\n \"object\": \"organization.project.service_account\",\n \"id\": \"svc_acct_abc\",\n \"name\": \"Production App\",\n \"role\": \"member\",\n \"created_at\": 1711471533,\n \"api_key\": {\n \"object\": \"organization.project.service_account.api_key\",\n \"value\": \"sk-abcdefghijklmnop123\",\n \"name\": \"Secret Key\",\n \"created_at\": 1711471533,\n \"id\": \"key_abc\"\n }\n}\n"}}}},"/organization/projects/{project_id}/service_accounts/{service_account_id}":{"get":{"summary":"Retrieves a service account in the project.","operationId":"retrieve-project-service-account","tags":["Projects"],"parameters":[{"name":"project_id","in":"path","description":"The ID of the project.","required":true,"schema":{"type":"string"}},{"name":"service_account_id","in":"path","description":"The ID of the service account.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Project service account retrieved successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProjectServiceAccount"}}}}},"x-oaiMeta":{"name":"Retrieve project service account","group":"administration","examples":{"request":{"curl":"curl https://api.openai.com/v1/organization/projects/proj_abc/service_accounts/svc_acct_abc \\\n -H \"Authorization: Bearer $OPENAI_ADMIN_KEY\" \\\n -H \"Content-Type: application/json\"\n"},"response":"{\n \"object\": \"organization.project.service_account\",\n \"id\": \"svc_acct_abc\",\n \"name\": \"Service Account\",\n \"role\": \"owner\",\n \"created_at\": 1711471533\n}\n"}}},"delete":{"summary":"Deletes a service account from the project.\n\nReturns confirmation of service account deletion, or an error if the project\nis archived (archived projects have no service accounts).\n","operationId":"delete-project-service-account","tags":["Projects"],"parameters":[{"name":"project_id","in":"path","description":"The ID of the project.","required":true,"schema":{"type":"string"}},{"name":"service_account_id","in":"path","description":"The ID of the service account.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Project service account deleted successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProjectServiceAccountDeleteResponse"}}}}},"x-oaiMeta":{"name":"Delete project service account","group":"administration","examples":{"request":{"curl":"curl -X DELETE https://api.openai.com/v1/organization/projects/proj_abc/service_accounts/svc_acct_abc \\\n -H \"Authorization: Bearer $OPENAI_ADMIN_KEY\" \\\n -H \"Content-Type: application/json\"\n"},"response":"{\n \"object\": \"organization.project.service_account.deleted\",\n \"id\": \"svc_acct_abc\",\n \"deleted\": true\n}\n"}}}},"/organization/projects/{project_id}/users":{"get":{"summary":"Returns a list of users in the project.","operationId":"list-project-users","tags":["Projects"],"parameters":[{"name":"project_id","in":"path","description":"The ID of the project.","required":true,"schema":{"type":"string"}},{"name":"limit","in":"query","description":"A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.\n","required":false,"schema":{"type":"integer","default":20}},{"name":"after","in":"query","description":"A cursor for use in pagination. `after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list.\n","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Project users listed successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProjectUserListResponse"}}}},"400":{"description":"Error response when project is archived.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-oaiMeta":{"name":"List project users","group":"administration","examples":{"request":{"curl":"curl https://api.openai.com/v1/organization/projects/proj_abc/users?after=user_abc&limit=20 \\\n -H \"Authorization: Bearer $OPENAI_ADMIN_KEY\" \\\n -H \"Content-Type: application/json\"\n"},"response":"{\n \"object\": \"list\",\n \"data\": [\n {\n \"object\": \"organization.project.user\",\n \"id\": \"user_abc\",\n \"name\": \"First Last\",\n \"email\": \"user@example.com\",\n \"role\": \"owner\",\n \"added_at\": 1711471533\n }\n ],\n \"first_id\": \"user-abc\",\n \"last_id\": \"user-xyz\",\n \"has_more\": false\n}\n"}}},"post":{"summary":"Adds a user to the project. Users must already be members of the organization to be added to a project.","operationId":"create-project-user","parameters":[{"name":"project_id","in":"path","description":"The ID of the project.","required":true,"schema":{"type":"string"}}],"tags":["Projects"],"requestBody":{"description":"The project user create request payload.","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProjectUserCreateRequest"}}}},"responses":{"200":{"description":"User added to project successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProjectUser"}}}},"400":{"description":"Error response for various conditions.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-oaiMeta":{"name":"Create project user","group":"administration","examples":{"request":{"curl":"curl -X POST https://api.openai.com/v1/organization/projects/proj_abc/users \\\n -H \"Authorization: Bearer $OPENAI_ADMIN_KEY\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"user_id\": \"user_abc\",\n \"role\": \"member\"\n }'\n"},"response":"{\n \"object\": \"organization.project.user\",\n \"id\": \"user_abc\",\n \"email\": \"user@example.com\",\n \"role\": \"owner\",\n \"added_at\": 1711471533\n}\n"}}}},"/organization/projects/{project_id}/users/{user_id}":{"get":{"summary":"Retrieves a user in the project.","operationId":"retrieve-project-user","tags":["Projects"],"parameters":[{"name":"project_id","in":"path","description":"The ID of the project.","required":true,"schema":{"type":"string"}},{"name":"user_id","in":"path","description":"The ID of the user.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Project user retrieved successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProjectUser"}}}}},"x-oaiMeta":{"name":"Retrieve project user","group":"administration","examples":{"request":{"curl":"curl https://api.openai.com/v1/organization/projects/proj_abc/users/user_abc \\\n -H \"Authorization: Bearer $OPENAI_ADMIN_KEY\" \\\n -H \"Content-Type: application/json\"\n"},"response":"{\n \"object\": \"organization.project.user\",\n \"id\": \"user_abc\",\n \"name\": \"First Last\",\n \"email\": \"user@example.com\",\n \"role\": \"owner\",\n \"added_at\": 1711471533\n}\n"}}},"post":{"summary":"Modifies a user's role in the project.","operationId":"modify-project-user","tags":["Projects"],"parameters":[{"name":"project_id","in":"path","description":"The ID of the project.","required":true,"schema":{"type":"string"}},{"name":"user_id","in":"path","description":"The ID of the user.","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"The project user update request payload.","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProjectUserUpdateRequest"}}}},"responses":{"200":{"description":"Project user's role updated successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProjectUser"}}}},"400":{"description":"Error response for various conditions.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-oaiMeta":{"name":"Modify project user","group":"administration","examples":{"request":{"curl":"curl -X POST https://api.openai.com/v1/organization/projects/proj_abc/users/user_abc \\\n -H \"Authorization: Bearer $OPENAI_ADMIN_KEY\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"role\": \"owner\"\n }'\n"},"response":"{\n \"object\": \"organization.project.user\",\n \"id\": \"user_abc\",\n \"name\": \"First Last\",\n \"email\": \"user@example.com\",\n \"role\": \"owner\",\n \"added_at\": 1711471533\n}\n"}}},"delete":{"summary":"Deletes a user from the project.\n\nReturns confirmation of project user deletion, or an error if the project is\narchived (archived projects have no users).\n","operationId":"delete-project-user","tags":["Projects"],"parameters":[{"name":"project_id","in":"path","description":"The ID of the project.","required":true,"schema":{"type":"string"}},{"name":"user_id","in":"path","description":"The ID of the user.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Project user deleted successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProjectUserDeleteResponse"}}}},"400":{"description":"Error response for various conditions.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-oaiMeta":{"name":"Delete project user","group":"administration","examples":{"request":{"curl":"curl -X DELETE https://api.openai.com/v1/organization/projects/proj_abc/users/user_abc \\\n -H \"Authorization: Bearer $OPENAI_ADMIN_KEY\" \\\n -H \"Content-Type: application/json\"\n"},"response":"{\n \"object\": \"organization.project.user.deleted\",\n \"id\": \"user_abc\",\n \"deleted\": true\n}\n"}}}},"/organization/roles":{"get":{"summary":"Lists the roles configured for the organization.","operationId":"list-roles","tags":["Roles"],"parameters":[{"name":"limit","in":"query","description":"A limit on the number of roles to return. Defaults to 1000.","required":false,"schema":{"type":"integer","minimum":0,"maximum":1000,"default":1000}},{"name":"after","in":"query","description":"Cursor for pagination. Provide the value from the previous response's `next` field to continue listing roles.","required":false,"schema":{"type":"string"}},{"name":"order","in":"query","description":"Sort order for the returned roles.","required":false,"schema":{"type":"string","enum":["asc","desc"],"default":"asc"}}],"responses":{"200":{"description":"Roles listed successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicRoleListResource"}}}}},"x-oaiMeta":{"name":"List organization roles","group":"administration","examples":{"request":{"curl":"curl https://api.openai.com/v1/organization/roles?limit=20 \\\n -H \"Authorization: Bearer $OPENAI_ADMIN_KEY\" \\\n -H \"Content-Type: application/json\"\n"},"response":"{\n \"object\": \"list\",\n \"data\": [\n {\n \"object\": \"role\",\n \"id\": \"role_01J1F8ROLE01\",\n \"name\": \"API Group Manager\",\n \"description\": \"Allows managing organization groups\",\n \"permissions\": [\n \"api.groups.read\",\n \"api.groups.write\"\n ],\n \"resource_type\": \"api.organization\",\n \"predefined_role\": false\n }\n ],\n \"has_more\": false,\n \"next\": null\n}\n"}}},"post":{"summary":"Creates a custom role for the organization.","operationId":"create-role","tags":["Roles"],"requestBody":{"description":"Parameters for the role you want to create.","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicCreateOrganizationRoleBody"}}}},"responses":{"200":{"description":"Role created successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Role"}}}}},"x-oaiMeta":{"name":"Create organization role","group":"administration","examples":{"request":{"curl":"curl -X POST https://api.openai.com/v1/organization/roles \\\n -H \"Authorization: Bearer $OPENAI_ADMIN_KEY\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"role_name\": \"API Group Manager\",\n \"permissions\": [\n \"api.groups.read\",\n \"api.groups.write\"\n ],\n \"description\": \"Allows managing organization groups\"\n }'\n"},"response":"{\n \"object\": \"role\",\n \"id\": \"role_01J1F8ROLE01\",\n \"name\": \"API Group Manager\",\n \"description\": \"Allows managing organization groups\",\n \"permissions\": [\n \"api.groups.read\",\n \"api.groups.write\"\n ],\n \"resource_type\": \"api.organization\",\n \"predefined_role\": false\n}\n"}}}},"/organization/roles/{role_id}":{"post":{"summary":"Updates an existing organization role.","operationId":"update-role","tags":["Roles"],"parameters":[{"name":"role_id","in":"path","description":"The ID of the role to update.","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Fields to update on the role.","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicUpdateOrganizationRoleBody"}}}},"responses":{"200":{"description":"Role updated successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Role"}}}}},"x-oaiMeta":{"name":"Update organization role","group":"administration","examples":{"request":{"curl":"curl -X POST https://api.openai.com/v1/organization/roles/role_01J1F8ROLE01 \\\n -H \"Authorization: Bearer $OPENAI_ADMIN_KEY\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"role_name\": \"API Group Manager\",\n \"permissions\": [\n \"api.groups.read\",\n \"api.groups.write\"\n ],\n \"description\": \"Allows managing organization groups\"\n }'\n"},"response":"{\n \"object\": \"role\",\n \"id\": \"role_01J1F8ROLE01\",\n \"name\": \"API Group Manager\",\n \"description\": \"Allows managing organization groups\",\n \"permissions\": [\n \"api.groups.read\",\n \"api.groups.write\"\n ],\n \"resource_type\": \"api.organization\",\n \"predefined_role\": false\n}\n"}}},"delete":{"summary":"Deletes a custom role from the organization.","operationId":"delete-role","tags":["Roles"],"parameters":[{"name":"role_id","in":"path","description":"The ID of the role to delete.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Role deleted successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RoleDeletedResource"}}}}},"x-oaiMeta":{"name":"Delete organization role","group":"administration","examples":{"request":{"curl":"curl -X DELETE https://api.openai.com/v1/organization/roles/role_01J1F8ROLE01 \\\n -H \"Authorization: Bearer $OPENAI_ADMIN_KEY\" \\\n -H \"Content-Type: application/json\"\n"},"response":"{\n \"object\": \"role.deleted\",\n \"id\": \"role_01J1F8ROLE01\",\n \"deleted\": true\n}\n"}}}},"/organization/usage/audio_speeches":{"get":{"summary":"Get audio speeches usage details for the organization.","operationId":"usage-audio-speeches","tags":["Usage"],"parameters":[{"name":"start_time","in":"query","description":"Start time (Unix seconds) of the query time range, inclusive.","required":true,"schema":{"type":"integer"}},{"name":"end_time","in":"query","description":"End time (Unix seconds) of the query time range, exclusive.","required":false,"schema":{"type":"integer"}},{"name":"bucket_width","in":"query","description":"Width of each time bucket in response. Currently `1m`, `1h` and `1d` are supported, default to `1d`.","required":false,"schema":{"type":"string","enum":["1m","1h","1d"],"default":"1d"}},{"name":"project_ids","in":"query","description":"Return only usage for these projects.","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"user_ids","in":"query","description":"Return only usage for these users.","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"api_key_ids","in":"query","description":"Return only usage for these API keys.","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"models","in":"query","description":"Return only usage for these models.","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"group_by","in":"query","description":"Group the usage data by the specified fields. Support fields include `project_id`, `user_id`, `api_key_id`, `model` or any combination of them.","required":false,"schema":{"type":"array","items":{"type":"string","enum":["project_id","user_id","api_key_id","model"]}}},{"name":"limit","in":"query","description":"Specifies the number of buckets to return.\n- `bucket_width=1d`: default: 7, max: 31\n- `bucket_width=1h`: default: 24, max: 168\n- `bucket_width=1m`: default: 60, max: 1440\n","required":false,"schema":{"type":"integer"}},{"name":"page","in":"query","description":"A cursor for use in pagination. Corresponding to the `next_page` field from the previous response.","schema":{"type":"string"}}],"responses":{"200":{"description":"Usage data retrieved successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UsageResponse"}}}}},"x-oaiMeta":{"name":"Audio speeches","group":"usage-audio-speeches","examples":{"request":{"curl":"curl \"https://api.openai.com/v1/organization/usage/audio_speeches?start_time=1730419200&limit=1\" \\\n-H \"Authorization: Bearer $OPENAI_ADMIN_KEY\" \\\n-H \"Content-Type: application/json\"\n"},"response":"{\n \"object\": \"page\",\n \"data\": [\n {\n \"object\": \"bucket\",\n \"start_time\": 1730419200,\n \"end_time\": 1730505600,\n \"results\": [\n {\n \"object\": \"organization.usage.audio_speeches.result\",\n \"characters\": 45,\n \"num_model_requests\": 1,\n \"project_id\": null,\n \"user_id\": null,\n \"api_key_id\": null,\n \"model\": null\n }\n ]\n }\n ],\n \"has_more\": false,\n \"next_page\": null\n}\n"}}}},"/organization/usage/audio_transcriptions":{"get":{"summary":"Get audio transcriptions usage details for the organization.","operationId":"usage-audio-transcriptions","tags":["Usage"],"parameters":[{"name":"start_time","in":"query","description":"Start time (Unix seconds) of the query time range, inclusive.","required":true,"schema":{"type":"integer"}},{"name":"end_time","in":"query","description":"End time (Unix seconds) of the query time range, exclusive.","required":false,"schema":{"type":"integer"}},{"name":"bucket_width","in":"query","description":"Width of each time bucket in response. Currently `1m`, `1h` and `1d` are supported, default to `1d`.","required":false,"schema":{"type":"string","enum":["1m","1h","1d"],"default":"1d"}},{"name":"project_ids","in":"query","description":"Return only usage for these projects.","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"user_ids","in":"query","description":"Return only usage for these users.","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"api_key_ids","in":"query","description":"Return only usage for these API keys.","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"models","in":"query","description":"Return only usage for these models.","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"group_by","in":"query","description":"Group the usage data by the specified fields. Support fields include `project_id`, `user_id`, `api_key_id`, `model` or any combination of them.","required":false,"schema":{"type":"array","items":{"type":"string","enum":["project_id","user_id","api_key_id","model"]}}},{"name":"limit","in":"query","description":"Specifies the number of buckets to return.\n- `bucket_width=1d`: default: 7, max: 31\n- `bucket_width=1h`: default: 24, max: 168\n- `bucket_width=1m`: default: 60, max: 1440\n","required":false,"schema":{"type":"integer"}},{"name":"page","in":"query","description":"A cursor for use in pagination. Corresponding to the `next_page` field from the previous response.","schema":{"type":"string"}}],"responses":{"200":{"description":"Usage data retrieved successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UsageResponse"}}}}},"x-oaiMeta":{"name":"Audio transcriptions","group":"usage-audio-transcriptions","examples":{"request":{"curl":"curl \"https://api.openai.com/v1/organization/usage/audio_transcriptions?start_time=1730419200&limit=1\" \\\n-H \"Authorization: Bearer $OPENAI_ADMIN_KEY\" \\\n-H \"Content-Type: application/json\"\n"},"response":"{\n \"object\": \"page\",\n \"data\": [\n {\n \"object\": \"bucket\",\n \"start_time\": 1730419200,\n \"end_time\": 1730505600,\n \"results\": [\n {\n \"object\": \"organization.usage.audio_transcriptions.result\",\n \"seconds\": 20,\n \"num_model_requests\": 1,\n \"project_id\": null,\n \"user_id\": null,\n \"api_key_id\": null,\n \"model\": null\n }\n ]\n }\n ],\n \"has_more\": false,\n \"next_page\": null\n}\n"}}}},"/organization/usage/code_interpreter_sessions":{"get":{"summary":"Get code interpreter sessions usage details for the organization.","operationId":"usage-code-interpreter-sessions","tags":["Usage"],"parameters":[{"name":"start_time","in":"query","description":"Start time (Unix seconds) of the query time range, inclusive.","required":true,"schema":{"type":"integer"}},{"name":"end_time","in":"query","description":"End time (Unix seconds) of the query time range, exclusive.","required":false,"schema":{"type":"integer"}},{"name":"bucket_width","in":"query","description":"Width of each time bucket in response. Currently `1m`, `1h` and `1d` are supported, default to `1d`.","required":false,"schema":{"type":"string","enum":["1m","1h","1d"],"default":"1d"}},{"name":"project_ids","in":"query","description":"Return only usage for these projects.","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"group_by","in":"query","description":"Group the usage data by the specified fields. Support fields include `project_id`.","required":false,"schema":{"type":"array","items":{"type":"string","enum":["project_id"]}}},{"name":"limit","in":"query","description":"Specifies the number of buckets to return.\n- `bucket_width=1d`: default: 7, max: 31\n- `bucket_width=1h`: default: 24, max: 168\n- `bucket_width=1m`: default: 60, max: 1440\n","required":false,"schema":{"type":"integer"}},{"name":"page","in":"query","description":"A cursor for use in pagination. Corresponding to the `next_page` field from the previous response.","schema":{"type":"string"}}],"responses":{"200":{"description":"Usage data retrieved successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UsageResponse"}}}}},"x-oaiMeta":{"name":"Code interpreter sessions","group":"usage-code-interpreter-sessions","examples":{"request":{"curl":"curl \"https://api.openai.com/v1/organization/usage/code_interpreter_sessions?start_time=1730419200&limit=1\" \\\n-H \"Authorization: Bearer $OPENAI_ADMIN_KEY\" \\\n-H \"Content-Type: application/json\"\n"},"response":"{\n \"object\": \"page\",\n \"data\": [\n {\n \"object\": \"bucket\",\n \"start_time\": 1730419200,\n \"end_time\": 1730505600,\n \"results\": [\n {\n \"object\": \"organization.usage.code_interpreter_sessions.result\",\n \"num_sessions\": 1,\n \"project_id\": null\n }\n ]\n }\n ],\n \"has_more\": false,\n \"next_page\": null\n}\n"}}}},"/organization/usage/completions":{"get":{"summary":"Get completions usage details for the organization.","operationId":"usage-completions","tags":["Usage"],"parameters":[{"name":"start_time","in":"query","description":"Start time (Unix seconds) of the query time range, inclusive.","required":true,"schema":{"type":"integer"}},{"name":"end_time","in":"query","description":"End time (Unix seconds) of the query time range, exclusive.","required":false,"schema":{"type":"integer"}},{"name":"bucket_width","in":"query","description":"Width of each time bucket in response. Currently `1m`, `1h` and `1d` are supported, default to `1d`.","required":false,"schema":{"type":"string","enum":["1m","1h","1d"],"default":"1d"}},{"name":"project_ids","in":"query","description":"Return only usage for these projects.","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"user_ids","in":"query","description":"Return only usage for these users.","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"api_key_ids","in":"query","description":"Return only usage for these API keys.","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"models","in":"query","description":"Return only usage for these models.","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"batch","in":"query","description":"If `true`, return batch jobs only. If `false`, return non-batch jobs only. By default, return both.\n","required":false,"schema":{"type":"boolean"}},{"name":"group_by","in":"query","description":"Group the usage data by the specified fields. Support fields include `project_id`, `user_id`, `api_key_id`, `model`, `batch`, `service_tier` or any combination of them.","required":false,"schema":{"type":"array","items":{"type":"string","enum":["project_id","user_id","api_key_id","model","batch","service_tier"]}}},{"name":"limit","in":"query","description":"Specifies the number of buckets to return.\n- `bucket_width=1d`: default: 7, max: 31\n- `bucket_width=1h`: default: 24, max: 168\n- `bucket_width=1m`: default: 60, max: 1440\n","required":false,"schema":{"type":"integer"}},{"name":"page","in":"query","description":"A cursor for use in pagination. Corresponding to the `next_page` field from the previous response.","schema":{"type":"string"}}],"responses":{"200":{"description":"Usage data retrieved successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UsageResponse"}}}}},"x-oaiMeta":{"name":"Completions","group":"usage-completions","examples":{"request":{"curl":"curl \"https://api.openai.com/v1/organization/usage/completions?start_time=1730419200&limit=1\" \\\n-H \"Authorization: Bearer $OPENAI_ADMIN_KEY\" \\\n-H \"Content-Type: application/json\"\n"},"response":"{\n \"object\": \"page\",\n \"data\": [\n {\n \"object\": \"bucket\",\n \"start_time\": 1730419200,\n \"end_time\": 1730505600,\n \"results\": [\n {\n \"object\": \"organization.usage.completions.result\",\n \"input_tokens\": 1000,\n \"output_tokens\": 500,\n \"input_cached_tokens\": 800,\n \"input_audio_tokens\": 0,\n \"output_audio_tokens\": 0,\n \"num_model_requests\": 5,\n \"project_id\": null,\n \"user_id\": null,\n \"api_key_id\": null,\n \"model\": null,\n \"batch\": null,\n \"service_tier\": null\n }\n ]\n }\n ],\n \"has_more\": true,\n \"next_page\": \"page_AAAAAGdGxdEiJdKOAAAAAGcqsYA=\"\n}\n"}}}},"/organization/usage/embeddings":{"get":{"summary":"Get embeddings usage details for the organization.","operationId":"usage-embeddings","tags":["Usage"],"parameters":[{"name":"start_time","in":"query","description":"Start time (Unix seconds) of the query time range, inclusive.","required":true,"schema":{"type":"integer"}},{"name":"end_time","in":"query","description":"End time (Unix seconds) of the query time range, exclusive.","required":false,"schema":{"type":"integer"}},{"name":"bucket_width","in":"query","description":"Width of each time bucket in response. Currently `1m`, `1h` and `1d` are supported, default to `1d`.","required":false,"schema":{"type":"string","enum":["1m","1h","1d"],"default":"1d"}},{"name":"project_ids","in":"query","description":"Return only usage for these projects.","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"user_ids","in":"query","description":"Return only usage for these users.","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"api_key_ids","in":"query","description":"Return only usage for these API keys.","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"models","in":"query","description":"Return only usage for these models.","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"group_by","in":"query","description":"Group the usage data by the specified fields. Support fields include `project_id`, `user_id`, `api_key_id`, `model` or any combination of them.","required":false,"schema":{"type":"array","items":{"type":"string","enum":["project_id","user_id","api_key_id","model"]}}},{"name":"limit","in":"query","description":"Specifies the number of buckets to return.\n- `bucket_width=1d`: default: 7, max: 31\n- `bucket_width=1h`: default: 24, max: 168\n- `bucket_width=1m`: default: 60, max: 1440\n","required":false,"schema":{"type":"integer"}},{"name":"page","in":"query","description":"A cursor for use in pagination. Corresponding to the `next_page` field from the previous response.","schema":{"type":"string"}}],"responses":{"200":{"description":"Usage data retrieved successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UsageResponse"}}}}},"x-oaiMeta":{"name":"Embeddings","group":"usage-embeddings","examples":{"request":{"curl":"curl \"https://api.openai.com/v1/organization/usage/embeddings?start_time=1730419200&limit=1\" \\\n-H \"Authorization: Bearer $OPENAI_ADMIN_KEY\" \\\n-H \"Content-Type: application/json\"\n"},"response":"{\n \"object\": \"page\",\n \"data\": [\n {\n \"object\": \"bucket\",\n \"start_time\": 1730419200,\n \"end_time\": 1730505600,\n \"results\": [\n {\n \"object\": \"organization.usage.embeddings.result\",\n \"input_tokens\": 16,\n \"num_model_requests\": 2,\n \"project_id\": null,\n \"user_id\": null,\n \"api_key_id\": null,\n \"model\": null\n }\n ]\n }\n ],\n \"has_more\": false,\n \"next_page\": null\n}\n"}}}},"/organization/usage/images":{"get":{"summary":"Get images usage details for the organization.","operationId":"usage-images","tags":["Usage"],"parameters":[{"name":"start_time","in":"query","description":"Start time (Unix seconds) of the query time range, inclusive.","required":true,"schema":{"type":"integer"}},{"name":"end_time","in":"query","description":"End time (Unix seconds) of the query time range, exclusive.","required":false,"schema":{"type":"integer"}},{"name":"bucket_width","in":"query","description":"Width of each time bucket in response. Currently `1m`, `1h` and `1d` are supported, default to `1d`.","required":false,"schema":{"type":"string","enum":["1m","1h","1d"],"default":"1d"}},{"name":"sources","in":"query","description":"Return only usages for these sources. Possible values are `image.generation`, `image.edit`, `image.variation` or any combination of them.","required":false,"schema":{"type":"array","items":{"type":"string","enum":["image.generation","image.edit","image.variation"]}}},{"name":"sizes","in":"query","description":"Return only usages for these image sizes. Possible values are `256x256`, `512x512`, `1024x1024`, `1792x1792`, `1024x1792` or any combination of them.","required":false,"schema":{"type":"array","items":{"type":"string","enum":["256x256","512x512","1024x1024","1792x1792","1024x1792"]}}},{"name":"project_ids","in":"query","description":"Return only usage for these projects.","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"user_ids","in":"query","description":"Return only usage for these users.","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"api_key_ids","in":"query","description":"Return only usage for these API keys.","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"models","in":"query","description":"Return only usage for these models.","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"group_by","in":"query","description":"Group the usage data by the specified fields. Support fields include `project_id`, `user_id`, `api_key_id`, `model`, `size`, `source` or any combination of them.","required":false,"schema":{"type":"array","items":{"type":"string","enum":["project_id","user_id","api_key_id","model","size","source"]}}},{"name":"limit","in":"query","description":"Specifies the number of buckets to return.\n- `bucket_width=1d`: default: 7, max: 31\n- `bucket_width=1h`: default: 24, max: 168\n- `bucket_width=1m`: default: 60, max: 1440\n","required":false,"schema":{"type":"integer"}},{"name":"page","in":"query","description":"A cursor for use in pagination. Corresponding to the `next_page` field from the previous response.","schema":{"type":"string"}}],"responses":{"200":{"description":"Usage data retrieved successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UsageResponse"}}}}},"x-oaiMeta":{"name":"Images","group":"usage-images","examples":{"request":{"curl":"curl \"https://api.openai.com/v1/organization/usage/images?start_time=1730419200&limit=1\" \\\n-H \"Authorization: Bearer $OPENAI_ADMIN_KEY\" \\\n-H \"Content-Type: application/json\"\n"},"response":"{\n \"object\": \"page\",\n \"data\": [\n {\n \"object\": \"bucket\",\n \"start_time\": 1730419200,\n \"end_time\": 1730505600,\n \"results\": [\n {\n \"object\": \"organization.usage.images.result\",\n \"images\": 2,\n \"num_model_requests\": 2,\n \"size\": null,\n \"source\": null,\n \"project_id\": null,\n \"user_id\": null,\n \"api_key_id\": null,\n \"model\": null\n }\n ]\n }\n ],\n \"has_more\": false,\n \"next_page\": null\n}\n"}}}},"/organization/usage/moderations":{"get":{"summary":"Get moderations usage details for the organization.","operationId":"usage-moderations","tags":["Usage"],"parameters":[{"name":"start_time","in":"query","description":"Start time (Unix seconds) of the query time range, inclusive.","required":true,"schema":{"type":"integer"}},{"name":"end_time","in":"query","description":"End time (Unix seconds) of the query time range, exclusive.","required":false,"schema":{"type":"integer"}},{"name":"bucket_width","in":"query","description":"Width of each time bucket in response. Currently `1m`, `1h` and `1d` are supported, default to `1d`.","required":false,"schema":{"type":"string","enum":["1m","1h","1d"],"default":"1d"}},{"name":"project_ids","in":"query","description":"Return only usage for these projects.","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"user_ids","in":"query","description":"Return only usage for these users.","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"api_key_ids","in":"query","description":"Return only usage for these API keys.","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"models","in":"query","description":"Return only usage for these models.","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"group_by","in":"query","description":"Group the usage data by the specified fields. Support fields include `project_id`, `user_id`, `api_key_id`, `model` or any combination of them.","required":false,"schema":{"type":"array","items":{"type":"string","enum":["project_id","user_id","api_key_id","model"]}}},{"name":"limit","in":"query","description":"Specifies the number of buckets to return.\n- `bucket_width=1d`: default: 7, max: 31\n- `bucket_width=1h`: default: 24, max: 168\n- `bucket_width=1m`: default: 60, max: 1440\n","required":false,"schema":{"type":"integer"}},{"name":"page","in":"query","description":"A cursor for use in pagination. Corresponding to the `next_page` field from the previous response.","schema":{"type":"string"}}],"responses":{"200":{"description":"Usage data retrieved successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UsageResponse"}}}}},"x-oaiMeta":{"name":"Moderations","group":"usage-moderations","examples":{"request":{"curl":"curl \"https://api.openai.com/v1/organization/usage/moderations?start_time=1730419200&limit=1\" \\\n-H \"Authorization: Bearer $OPENAI_ADMIN_KEY\" \\\n-H \"Content-Type: application/json\"\n"},"response":"{\n \"object\": \"page\",\n \"data\": [\n {\n \"object\": \"bucket\",\n \"start_time\": 1730419200,\n \"end_time\": 1730505600,\n \"results\": [\n {\n \"object\": \"organization.usage.moderations.result\",\n \"input_tokens\": 16,\n \"num_model_requests\": 2,\n \"project_id\": null,\n \"user_id\": null,\n \"api_key_id\": null,\n \"model\": null\n }\n ]\n }\n ],\n \"has_more\": false,\n \"next_page\": null\n}\n"}}}},"/organization/usage/vector_stores":{"get":{"summary":"Get vector stores usage details for the organization.","operationId":"usage-vector-stores","tags":["Usage"],"parameters":[{"name":"start_time","in":"query","description":"Start time (Unix seconds) of the query time range, inclusive.","required":true,"schema":{"type":"integer"}},{"name":"end_time","in":"query","description":"End time (Unix seconds) of the query time range, exclusive.","required":false,"schema":{"type":"integer"}},{"name":"bucket_width","in":"query","description":"Width of each time bucket in response. Currently `1m`, `1h` and `1d` are supported, default to `1d`.","required":false,"schema":{"type":"string","enum":["1m","1h","1d"],"default":"1d"}},{"name":"project_ids","in":"query","description":"Return only usage for these projects.","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"group_by","in":"query","description":"Group the usage data by the specified fields. Support fields include `project_id`.","required":false,"schema":{"type":"array","items":{"type":"string","enum":["project_id"]}}},{"name":"limit","in":"query","description":"Specifies the number of buckets to return.\n- `bucket_width=1d`: default: 7, max: 31\n- `bucket_width=1h`: default: 24, max: 168\n- `bucket_width=1m`: default: 60, max: 1440\n","required":false,"schema":{"type":"integer"}},{"name":"page","in":"query","description":"A cursor for use in pagination. Corresponding to the `next_page` field from the previous response.","schema":{"type":"string"}}],"responses":{"200":{"description":"Usage data retrieved successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UsageResponse"}}}}},"x-oaiMeta":{"name":"Vector stores","group":"usage-vector-stores","examples":{"request":{"curl":"curl \"https://api.openai.com/v1/organization/usage/vector_stores?start_time=1730419200&limit=1\" \\\n-H \"Authorization: Bearer $OPENAI_ADMIN_KEY\" \\\n-H \"Content-Type: application/json\"\n"},"response":"{\n \"object\": \"page\",\n \"data\": [\n {\n \"object\": \"bucket\",\n \"start_time\": 1730419200,\n \"end_time\": 1730505600,\n \"results\": [\n {\n \"object\": \"organization.usage.vector_stores.result\",\n \"usage_bytes\": 1024,\n \"project_id\": null\n }\n ]\n }\n ],\n \"has_more\": false,\n \"next_page\": null\n}\n"}}}},"/organization/users":{"get":{"summary":"Lists all of the users in the organization.","operationId":"list-users","tags":["Users"],"parameters":[{"name":"limit","in":"query","description":"A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.\n","required":false,"schema":{"type":"integer","default":20}},{"name":"after","in":"query","description":"A cursor for use in pagination. `after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list.\n","required":false,"schema":{"type":"string"}},{"name":"emails","in":"query","description":"Filter by the email address of users.","required":false,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"Users listed successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserListResponse"}}}}},"x-oaiMeta":{"name":"List users","group":"administration","examples":{"request":{"curl":"curl https://api.openai.com/v1/organization/users?after=user_abc&limit=20 \\\n -H \"Authorization: Bearer $OPENAI_ADMIN_KEY\" \\\n -H \"Content-Type: application/json\"\n"},"response":"{\n \"object\": \"list\",\n \"data\": [\n {\n \"object\": \"organization.user\",\n \"id\": \"user_abc\",\n \"name\": \"First Last\",\n \"email\": \"user@example.com\",\n \"role\": \"owner\",\n \"added_at\": 1711471533\n }\n ],\n \"first_id\": \"user-abc\",\n \"last_id\": \"user-xyz\",\n \"has_more\": false\n}\n"}}}},"/organization/users/{user_id}":{"get":{"summary":"Retrieves a user by their identifier.","operationId":"retrieve-user","tags":["Users"],"parameters":[{"name":"user_id","in":"path","description":"The ID of the user.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"User retrieved successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/User"}}}}},"x-oaiMeta":{"name":"Retrieve user","group":"administration","examples":{"request":{"curl":"curl https://api.openai.com/v1/organization/users/user_abc \\\n -H \"Authorization: Bearer $OPENAI_ADMIN_KEY\" \\\n -H \"Content-Type: application/json\"\n"},"response":"{\n \"object\": \"organization.user\",\n \"id\": \"user_abc\",\n \"name\": \"First Last\",\n \"email\": \"user@example.com\",\n \"role\": \"owner\",\n \"added_at\": 1711471533\n}\n"}}},"post":{"summary":"Modifies a user's role in the organization.","operationId":"modify-user","tags":["Users"],"parameters":[{"name":"user_id","in":"path","description":"The ID of the user.","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"The new user role to modify. This must be one of `owner` or `member`.","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserRoleUpdateRequest"}}}},"responses":{"200":{"description":"User role updated successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/User"}}}}},"x-oaiMeta":{"name":"Modify user","group":"administration","examples":{"request":{"curl":"curl -X POST https://api.openai.com/v1/organization/users/user_abc \\\n -H \"Authorization: Bearer $OPENAI_ADMIN_KEY\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"role\": \"owner\"\n }'\n"},"response":"{\n \"object\": \"organization.user\",\n \"id\": \"user_abc\",\n \"name\": \"First Last\",\n \"email\": \"user@example.com\",\n \"role\": \"owner\",\n \"added_at\": 1711471533\n}\n"}}},"delete":{"summary":"Deletes a user from the organization.","operationId":"delete-user","tags":["Users"],"parameters":[{"name":"user_id","in":"path","description":"The ID of the user.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"User deleted successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserDeleteResponse"}}}}},"x-oaiMeta":{"name":"Delete user","group":"administration","examples":{"request":{"curl":"curl -X DELETE https://api.openai.com/v1/organization/users/user_abc \\\n -H \"Authorization: Bearer $OPENAI_ADMIN_KEY\" \\\n -H \"Content-Type: application/json\"\n"},"response":"{\n \"object\": \"organization.user.deleted\",\n \"id\": \"user_abc\",\n \"deleted\": true\n}\n"}}}},"/organization/users/{user_id}/roles":{"get":{"summary":"Lists the organization roles assigned to a user within the organization.","operationId":"list-user-role-assignments","tags":["User organization role assignments"],"parameters":[{"name":"user_id","in":"path","description":"The ID of the user to inspect.","required":true,"schema":{"type":"string"}},{"name":"limit","in":"query","description":"A limit on the number of organization role assignments to return.","required":false,"schema":{"type":"integer","minimum":0,"maximum":1000}},{"name":"after","in":"query","description":"Cursor for pagination. Provide the value from the previous response's `next` field to continue listing organization roles.","required":false,"schema":{"type":"string"}},{"name":"order","in":"query","description":"Sort order for the returned organization roles.","required":false,"schema":{"type":"string","enum":["asc","desc"]}}],"responses":{"200":{"description":"User organization role assignments listed successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RoleListResource"}}}}},"x-oaiMeta":{"name":"List user organization role assignments","group":"administration","examples":{"request":{"curl":"curl https://api.openai.com/v1/organization/users/user_abc123/roles \\\n -H \"Authorization: Bearer $OPENAI_ADMIN_KEY\" \\\n -H \"Content-Type: application/json\"\n"},"response":"{\n \"object\": \"list\",\n \"data\": [\n {\n \"id\": \"role_01J1F8ROLE01\",\n \"name\": \"API Group Manager\",\n \"permissions\": [\n \"api.groups.read\",\n \"api.groups.write\"\n ],\n \"resource_type\": \"api.organization\",\n \"predefined_role\": false,\n \"description\": \"Allows managing organization groups\",\n \"created_at\": 1711471533,\n \"updated_at\": 1711472599,\n \"created_by\": \"user_abc123\",\n \"created_by_user_obj\": {\n \"id\": \"user_abc123\",\n \"name\": \"Ada Lovelace\",\n \"email\": \"ada@example.com\"\n },\n \"metadata\": {}\n }\n ],\n \"has_more\": false,\n \"next\": null\n}\n"}}},"post":{"summary":"Assigns an organization role to a user within the organization.","operationId":"assign-user-role","tags":["User organization role assignments"],"parameters":[{"name":"user_id","in":"path","description":"The ID of the user that should receive the organization role.","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Identifies the organization role to assign to the user.","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicAssignOrganizationGroupRoleBody"}}}},"responses":{"200":{"description":"Organization role assigned to the user successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserRoleAssignment"}}}}},"x-oaiMeta":{"name":"Assign organization role to user","group":"administration","examples":{"request":{"curl":"curl -X POST https://api.openai.com/v1/organization/users/user_abc123/roles \\\n -H \"Authorization: Bearer $OPENAI_ADMIN_KEY\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"role_id\": \"role_01J1F8ROLE01\"\n }'\n"},"response":"{\n \"object\": \"user.role\",\n \"user\": {\n \"object\": \"organization.user\",\n \"id\": \"user_abc123\",\n \"name\": \"Ada Lovelace\",\n \"email\": \"ada@example.com\",\n \"role\": \"owner\",\n \"added_at\": 1711470000\n },\n \"role\": {\n \"object\": \"role\",\n \"id\": \"role_01J1F8ROLE01\",\n \"name\": \"API Group Manager\",\n \"description\": \"Allows managing organization groups\",\n \"permissions\": [\n \"api.groups.read\",\n \"api.groups.write\"\n ],\n \"resource_type\": \"api.organization\",\n \"predefined_role\": false\n }\n}\n"}}}},"/organization/users/{user_id}/roles/{role_id}":{"delete":{"summary":"Unassigns an organization role from a user within the organization.","operationId":"unassign-user-role","tags":["User organization role assignments"],"parameters":[{"name":"user_id","in":"path","description":"The ID of the user to modify.","required":true,"schema":{"type":"string"}},{"name":"role_id","in":"path","description":"The ID of the organization role to remove from the user.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Organization role unassigned from the user successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeletedRoleAssignmentResource"}}}}},"x-oaiMeta":{"name":"Unassign organization role from user","group":"administration","examples":{"request":{"curl":"curl -X DELETE https://api.openai.com/v1/organization/users/user_abc123/roles/role_01J1F8ROLE01 \\\n -H \"Authorization: Bearer $OPENAI_ADMIN_KEY\" \\\n -H \"Content-Type: application/json\"\n"},"response":"{\n \"object\": \"user.role.deleted\",\n \"deleted\": true\n}\n"}}}},"/projects/{project_id}/groups/{group_id}/roles":{"get":{"summary":"Lists the project roles assigned to a group within a project.","operationId":"list-project-group-role-assignments","tags":["Project group role assignments"],"parameters":[{"name":"project_id","in":"path","description":"The ID of the project to inspect.","required":true,"schema":{"type":"string"}},{"name":"group_id","in":"path","description":"The ID of the group to inspect.","required":true,"schema":{"type":"string"}},{"name":"limit","in":"query","description":"A limit on the number of project role assignments to return.","required":false,"schema":{"type":"integer","minimum":0,"maximum":1000}},{"name":"after","in":"query","description":"Cursor for pagination. Provide the value from the previous response's `next` field to continue listing project roles.","required":false,"schema":{"type":"string"}},{"name":"order","in":"query","description":"Sort order for the returned project roles.","required":false,"schema":{"type":"string","enum":["asc","desc"]}}],"responses":{"200":{"description":"Project group role assignments listed successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RoleListResource"}}}}},"x-oaiMeta":{"name":"List project group role assignments","group":"administration","examples":{"request":{"curl":"curl https://api.openai.com/v1/projects/proj_abc123/groups/group_01J1F8ABCDXYZ/roles \\\n -H \"Authorization: Bearer $OPENAI_ADMIN_KEY\" \\\n -H \"Content-Type: application/json\"\n"},"response":"{\n \"object\": \"list\",\n \"data\": [\n {\n \"id\": \"role_01J1F8PROJ\",\n \"name\": \"API Project Key Manager\",\n \"permissions\": [\n \"api.organization.projects.api_keys.read\",\n \"api.organization.projects.api_keys.write\"\n ],\n \"resource_type\": \"api.project\",\n \"predefined_role\": false,\n \"description\": \"Allows managing API keys for the project\",\n \"created_at\": 1711471533,\n \"updated_at\": 1711472599,\n \"created_by\": \"user_abc123\",\n \"created_by_user_obj\": {\n \"id\": \"user_abc123\",\n \"name\": \"Ada Lovelace\",\n \"email\": \"ada@example.com\"\n },\n \"metadata\": {}\n }\n ],\n \"has_more\": false,\n \"next\": null\n}\n"}}},"post":{"summary":"Assigns a project role to a group within a project.","operationId":"assign-project-group-role","tags":["Project group role assignments"],"parameters":[{"name":"project_id","in":"path","description":"The ID of the project to update.","required":true,"schema":{"type":"string"}},{"name":"group_id","in":"path","description":"The ID of the group that should receive the project role.","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Identifies the project role to assign to the group.","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicAssignOrganizationGroupRoleBody"}}}},"responses":{"200":{"description":"Project role assigned to the group successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GroupRoleAssignment"}}}}},"x-oaiMeta":{"name":"Assign project role to group","group":"administration","examples":{"request":{"curl":"curl -X POST https://api.openai.com/v1/projects/proj_abc123/groups/group_01J1F8ABCDXYZ/roles \\\n -H \"Authorization: Bearer $OPENAI_ADMIN_KEY\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"role_id\": \"role_01J1F8PROJ\"\n }'\n"},"response":"{\n \"object\": \"group.role\",\n \"group\": {\n \"object\": \"group\",\n \"id\": \"group_01J1F8ABCDXYZ\",\n \"name\": \"Support Team\",\n \"created_at\": 1711471533,\n \"scim_managed\": false\n },\n \"role\": {\n \"object\": \"role\",\n \"id\": \"role_01J1F8PROJ\",\n \"name\": \"API Project Key Manager\",\n \"description\": \"Allows managing API keys for the project\",\n \"permissions\": [\n \"api.organization.projects.api_keys.read\",\n \"api.organization.projects.api_keys.write\"\n ],\n \"resource_type\": \"api.project\",\n \"predefined_role\": false\n }\n}\n"}}}},"/projects/{project_id}/groups/{group_id}/roles/{role_id}":{"delete":{"summary":"Unassigns a project role from a group within a project.","operationId":"unassign-project-group-role","tags":["Project group role assignments"],"parameters":[{"name":"project_id","in":"path","description":"The ID of the project to modify.","required":true,"schema":{"type":"string"}},{"name":"group_id","in":"path","description":"The ID of the group whose project role assignment should be removed.","required":true,"schema":{"type":"string"}},{"name":"role_id","in":"path","description":"The ID of the project role to remove from the group.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Project role unassigned from the group successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeletedRoleAssignmentResource"}}}}},"x-oaiMeta":{"name":"Unassign project role from group","group":"administration","examples":{"request":{"curl":"curl -X DELETE https://api.openai.com/v1/projects/proj_abc123/groups/group_01J1F8ABCDXYZ/roles/role_01J1F8PROJ \\\n -H \"Authorization: Bearer $OPENAI_ADMIN_KEY\" \\\n -H \"Content-Type: application/json\"\n"},"response":"{\n \"object\": \"group.role.deleted\",\n \"deleted\": true\n}\n"}}}},"/projects/{project_id}/roles":{"get":{"summary":"Lists the roles configured for a project.","operationId":"list-project-roles","tags":["Roles"],"parameters":[{"name":"project_id","in":"path","description":"The ID of the project to inspect.","required":true,"schema":{"type":"string"}},{"name":"limit","in":"query","description":"A limit on the number of roles to return. Defaults to 1000.","required":false,"schema":{"type":"integer","minimum":0,"maximum":1000,"default":1000}},{"name":"after","in":"query","description":"Cursor for pagination. Provide the value from the previous response's `next` field to continue listing roles.","required":false,"schema":{"type":"string"}},{"name":"order","in":"query","description":"Sort order for the returned roles.","required":false,"schema":{"type":"string","enum":["asc","desc"],"default":"asc"}}],"responses":{"200":{"description":"Project roles listed successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicRoleListResource"}}}}},"x-oaiMeta":{"name":"List project roles","group":"administration","examples":{"request":{"curl":"curl https://api.openai.com/v1/projects/proj_abc123/roles?limit=20 \\\n -H \"Authorization: Bearer $OPENAI_ADMIN_KEY\" \\\n -H \"Content-Type: application/json\"\n"},"response":"{\n \"object\": \"list\",\n \"data\": [\n {\n \"object\": \"role\",\n \"id\": \"role_01J1F8PROJ\",\n \"name\": \"API Project Key Manager\",\n \"description\": \"Allows managing API keys for the project\",\n \"permissions\": [\n \"api.organization.projects.api_keys.read\",\n \"api.organization.projects.api_keys.write\"\n ],\n \"resource_type\": \"api.project\",\n \"predefined_role\": false\n }\n ],\n \"has_more\": false,\n \"next\": null\n}\n"}}},"post":{"summary":"Creates a custom role for a project.","operationId":"create-project-role","tags":["Roles"],"parameters":[{"name":"project_id","in":"path","description":"The ID of the project to update.","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Parameters for the project role you want to create.","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicCreateOrganizationRoleBody"}}}},"responses":{"200":{"description":"Project role created successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Role"}}}}},"x-oaiMeta":{"name":"Create project role","group":"administration","examples":{"request":{"curl":"curl -X POST https://api.openai.com/v1/projects/proj_abc123/roles \\\n -H \"Authorization: Bearer $OPENAI_ADMIN_KEY\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"role_name\": \"API Project Key Manager\",\n \"permissions\": [\n \"api.organization.projects.api_keys.read\",\n \"api.organization.projects.api_keys.write\"\n ],\n \"description\": \"Allows managing API keys for the project\"\n }'\n"},"response":"{\n \"object\": \"role\",\n \"id\": \"role_01J1F8PROJ\",\n \"name\": \"API Project Key Manager\",\n \"description\": \"Allows managing API keys for the project\",\n \"permissions\": [\n \"api.organization.projects.api_keys.read\",\n \"api.organization.projects.api_keys.write\"\n ],\n \"resource_type\": \"api.project\",\n \"predefined_role\": false\n}\n"}}}},"/projects/{project_id}/roles/{role_id}":{"post":{"summary":"Updates an existing project role.","operationId":"update-project-role","tags":["Roles"],"parameters":[{"name":"project_id","in":"path","description":"The ID of the project to update.","required":true,"schema":{"type":"string"}},{"name":"role_id","in":"path","description":"The ID of the role to update.","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Fields to update on the project role.","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicUpdateOrganizationRoleBody"}}}},"responses":{"200":{"description":"Project role updated successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Role"}}}}},"x-oaiMeta":{"name":"Update project role","group":"administration","examples":{"request":{"curl":"curl -X POST https://api.openai.com/v1/projects/proj_abc123/roles/role_01J1F8PROJ \\\n -H \"Authorization: Bearer $OPENAI_ADMIN_KEY\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"role_name\": \"API Project Key Manager\",\n \"permissions\": [\n \"api.organization.projects.api_keys.read\",\n \"api.organization.projects.api_keys.write\"\n ],\n \"description\": \"Allows managing API keys for the project\"\n }'\n"},"response":"{\n \"object\": \"role\",\n \"id\": \"role_01J1F8PROJ\",\n \"name\": \"API Project Key Manager\",\n \"description\": \"Allows managing API keys for the project\",\n \"permissions\": [\n \"api.organization.projects.api_keys.read\",\n \"api.organization.projects.api_keys.write\"\n ],\n \"resource_type\": \"api.project\",\n \"predefined_role\": false\n}\n"}}},"delete":{"summary":"Deletes a custom role from a project.","operationId":"delete-project-role","tags":["Roles"],"parameters":[{"name":"project_id","in":"path","description":"The ID of the project to update.","required":true,"schema":{"type":"string"}},{"name":"role_id","in":"path","description":"The ID of the role to delete.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Project role deleted successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RoleDeletedResource"}}}}},"x-oaiMeta":{"name":"Delete project role","group":"administration","examples":{"request":{"curl":"curl -X DELETE https://api.openai.com/v1/projects/proj_abc123/roles/role_01J1F8PROJ \\\n -H \"Authorization: Bearer $OPENAI_ADMIN_KEY\" \\\n -H \"Content-Type: application/json\"\n"},"response":"{\n \"object\": \"role.deleted\",\n \"id\": \"role_01J1F8PROJ\",\n \"deleted\": true\n}\n"}}}},"/projects/{project_id}/users/{user_id}/roles":{"get":{"summary":"Lists the project roles assigned to a user within a project.","operationId":"list-project-user-role-assignments","tags":["Project user role assignments"],"parameters":[{"name":"project_id","in":"path","description":"The ID of the project to inspect.","required":true,"schema":{"type":"string"}},{"name":"user_id","in":"path","description":"The ID of the user to inspect.","required":true,"schema":{"type":"string"}},{"name":"limit","in":"query","description":"A limit on the number of project role assignments to return.","required":false,"schema":{"type":"integer","minimum":0,"maximum":1000}},{"name":"after","in":"query","description":"Cursor for pagination. Provide the value from the previous response's `next` field to continue listing project roles.","required":false,"schema":{"type":"string"}},{"name":"order","in":"query","description":"Sort order for the returned project roles.","required":false,"schema":{"type":"string","enum":["asc","desc"]}}],"responses":{"200":{"description":"Project user role assignments listed successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RoleListResource"}}}}},"x-oaiMeta":{"name":"List project user role assignments","group":"administration","examples":{"request":{"curl":"curl https://api.openai.com/v1/projects/proj_abc123/users/user_abc123/roles \\\n -H \"Authorization: Bearer $OPENAI_ADMIN_KEY\" \\\n -H \"Content-Type: application/json\"\n"},"response":"{\n \"object\": \"list\",\n \"data\": [\n {\n \"id\": \"role_01J1F8PROJ\",\n \"name\": \"API Project Key Manager\",\n \"permissions\": [\n \"api.organization.projects.api_keys.read\",\n \"api.organization.projects.api_keys.write\"\n ],\n \"resource_type\": \"api.project\",\n \"predefined_role\": false,\n \"description\": \"Allows managing API keys for the project\",\n \"created_at\": 1711471533,\n \"updated_at\": 1711472599,\n \"created_by\": \"user_abc123\",\n \"created_by_user_obj\": {\n \"id\": \"user_abc123\",\n \"name\": \"Ada Lovelace\",\n \"email\": \"ada@example.com\"\n },\n \"metadata\": {}\n }\n ],\n \"has_more\": false,\n \"next\": null\n}\n"}}},"post":{"summary":"Assigns a project role to a user within a project.","operationId":"assign-project-user-role","tags":["Project user role assignments"],"parameters":[{"name":"project_id","in":"path","description":"The ID of the project to update.","required":true,"schema":{"type":"string"}},{"name":"user_id","in":"path","description":"The ID of the user that should receive the project role.","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Identifies the project role to assign to the user.","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicAssignOrganizationGroupRoleBody"}}}},"responses":{"200":{"description":"Project role assigned to the user successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserRoleAssignment"}}}}},"x-oaiMeta":{"name":"Assign project role to user","group":"administration","examples":{"request":{"curl":"curl -X POST https://api.openai.com/v1/projects/proj_abc123/users/user_abc123/roles \\\n -H \"Authorization: Bearer $OPENAI_ADMIN_KEY\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"role_id\": \"role_01J1F8PROJ\"\n }'\n"},"response":"{\n \"object\": \"user.role\",\n \"user\": {\n \"object\": \"organization.user\",\n \"id\": \"user_abc123\",\n \"name\": \"Ada Lovelace\",\n \"email\": \"ada@example.com\",\n \"role\": \"owner\",\n \"added_at\": 1711470000\n },\n \"role\": {\n \"object\": \"role\",\n \"id\": \"role_01J1F8PROJ\",\n \"name\": \"API Project Key Manager\",\n \"description\": \"Allows managing API keys for the project\",\n \"permissions\": [\n \"api.organization.projects.api_keys.read\",\n \"api.organization.projects.api_keys.write\"\n ],\n \"resource_type\": \"api.project\",\n \"predefined_role\": false\n }\n}\n"}}}},"/projects/{project_id}/users/{user_id}/roles/{role_id}":{"delete":{"summary":"Unassigns a project role from a user within a project.","operationId":"unassign-project-user-role","tags":["Project user role assignments"],"parameters":[{"name":"project_id","in":"path","description":"The ID of the project to modify.","required":true,"schema":{"type":"string"}},{"name":"user_id","in":"path","description":"The ID of the user whose project role assignment should be removed.","required":true,"schema":{"type":"string"}},{"name":"role_id","in":"path","description":"The ID of the project role to remove from the user.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Project role unassigned from the user successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeletedRoleAssignmentResource"}}}}},"x-oaiMeta":{"name":"Unassign project role from user","group":"administration","examples":{"request":{"curl":"curl -X DELETE https://api.openai.com/v1/projects/proj_abc123/users/user_abc123/roles/role_01J1F8PROJ \\\n -H \"Authorization: Bearer $OPENAI_ADMIN_KEY\" \\\n -H \"Content-Type: application/json\"\n"},"response":"{\n \"object\": \"user.role.deleted\",\n \"deleted\": true\n}\n"}}}},"/realtime/calls":{"post":{"summary":"Create a new Realtime API call over WebRTC and receive the SDP answer needed\nto complete the peer connection.","operationId":"create-realtime-call","tags":["Realtime"],"requestBody":{"required":true,"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/RealtimeCallCreateRequest"},"encoding":{"sdp":{"contentType":"application/sdp"},"session":{"contentType":"application/json"}}},"application/sdp":{"schema":{"type":"string","description":"WebRTC SDP offer. Use this variant when you have previously created an\nephemeral **session token** and are authenticating the request with it.\nRealtime session parameters will be retrieved from the session token."}}}},"responses":{"201":{"description":"Realtime call created successfully.","headers":{"Location":{"description":"Relative URL containing the call ID for subsequent control requests.","schema":{"type":"string"}}},"content":{"application/sdp":{"schema":{"type":"string","description":"SDP answer produced by OpenAI for the peer connection."}}}}},"x-oaiMeta":{"name":"Create call","group":"realtime","returns":"Returns `201 Created` with the SDP answer in the response body. The\n`Location` response header includes the call ID for follow-up requests,\ne.g., establishing a monitoring WebSocket or hanging up the call.","examples":{"request":{"curl":"curl -X POST https://api.openai.com/v1/realtime/calls \\\n -H \"Authorization: Bearer $OPENAI_API_KEY\" \\\n -F \"sdp=<offer.sdp;type=application/sdp\" \\\n -F 'session={\"type\":\"realtime\",\"model\":\"gpt-realtime\"};type=application/json'","python":"import os\nfrom openai import OpenAI\n\nclient = OpenAI(\n api_key=os.environ.get(\"OPENAI_API_KEY\"), # This is the default and can be omitted\n)\ncall = client.realtime.calls.create(\n sdp=\"sdp\",\n)\nprint(call)\ncontent = call.read()\nprint(content)"},"response":"v=0\no=- 4227147428 1719357865 IN IP4 127.0.0.1\ns=-\nc=IN IP4 0.0.0.0\nt=0 0\na=group:BUNDLE 0 1\na=msid-semantic:WMS *\na=fingerprint:sha-256 CA:92:52:51:B4:91:3B:34:DD:9C:0B:FB:76:19:7E:3B:F1:21:0F:32:2C:38:01:72:5D:3F:78:C7:5F:8B:C7:36\nm=audio 9 UDP/TLS/RTP/SAVPF 111 0 8\na=mid:0\na=ice-ufrag:kZ2qkHXX/u11\na=ice-pwd:uoD16Di5OGx3VbqgA3ymjEQV2kwiOjw6\na=setup:active\na=rtcp-mux\na=rtpmap:111 opus/48000/2\na=candidate:993865896 1 udp 2130706431 4.155.146.196 3478 typ host ufrag kZ2qkHXX/u11\na=candidate:1432411780 1 tcp 1671430143 4.155.146.196 443 typ host tcptype passive ufrag kZ2qkHXX/u11\nm=application 9 UDP/DTLS/SCTP webrtc-datachannel\na=mid:1\na=sctp-port:5000"}}}},"/realtime/calls/{call_id}/accept":{"post":{"summary":"Accept an incoming SIP call and configure the realtime session that will\nhandle it.","operationId":"accept-realtime-call","tags":["Realtime"],"parameters":[{"in":"path","name":"call_id","required":true,"schema":{"type":"string"},"description":"The identifier for the call provided in the\n[`realtime.call.incoming`](/docs/api-reference/webhook-events/realtime/call/incoming)\nwebhook."}],"requestBody":{"required":true,"description":"Session configuration to apply before the caller is bridged to the model.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RealtimeSessionCreateRequestGA"}}}},"responses":{"200":{"description":"Call accepted successfully."}},"x-oaiMeta":{"name":"Accept call","group":"realtime-calls","returns":"Returns `200 OK` once OpenAI starts ringing the SIP leg with the supplied\nsession configuration.","examples":{"request":{"curl":"curl -X POST https://api.openai.com/v1/realtime/calls/$CALL_ID/accept \\\n -H \"Authorization: Bearer $OPENAI_API_KEY\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"type\": \"realtime\",\n \"model\": \"gpt-realtime\",\n \"instructions\": \"You are Alex, a friendly concierge for Example Corp.\",\n }'","node.js":"import OpenAI from 'openai';\n\nconst client = new OpenAI({\n apiKey: process.env['OPENAI_API_KEY'], // This is the default and can be omitted\n});\n\nawait client.realtime.calls.accept('call_id', { type: 'realtime' });","python":"import os\nfrom openai import OpenAI\n\nclient = OpenAI(\n api_key=os.environ.get(\"OPENAI_API_KEY\"), # This is the default and can be omitted\n)\nclient.realtime.calls.accept(\n call_id=\"call_id\",\n type=\"realtime\",\n)","go":"package main\n\nimport (\n\t\"context\"\n\n\t\"github.com/openai/openai-go\"\n\t\"github.com/openai/openai-go/option\"\n\t\"github.com/openai/openai-go/realtime\"\n)\n\nfunc main() {\n\tclient := openai.NewClient(\n\t\toption.WithAPIKey(\"My API Key\"),\n\t)\n\terr := client.Realtime.Calls.Accept(\n\t\tcontext.TODO(),\n\t\t\"call_id\",\n\t\trealtime.CallAcceptParams{\n\t\t\tRealtimeSessionCreateRequest: realtime.RealtimeSessionCreateRequestParam{},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n","java":"package com.openai.example;\n\nimport com.openai.client.OpenAIClient;\nimport com.openai.client.okhttp.OpenAIOkHttpClient;\nimport com.openai.models.realtime.RealtimeSessionCreateRequest;\nimport com.openai.models.realtime.calls.CallAcceptParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n OpenAIClient client = OpenAIOkHttpClient.fromEnv();\n\n CallAcceptParams params = CallAcceptParams.builder()\n .callId(\"call_id\")\n .realtimeSessionCreateRequest(RealtimeSessionCreateRequest.builder().build())\n .build();\n client.realtime().calls().accept(params);\n }\n}","ruby":"require \"openai\"\n\nopenai = OpenAI::Client.new(api_key: \"My API Key\")\n\nresult = openai.realtime.calls.accept(\"call_id\", type: :realtime)\n\nputs(result)"},"response":""}}}},"/realtime/calls/{call_id}/hangup":{"post":{"summary":"End an active Realtime API call, whether it was initiated over SIP or\nWebRTC.","operationId":"hangup-realtime-call","tags":["Realtime"],"parameters":[{"in":"path","name":"call_id","required":true,"schema":{"type":"string"},"description":"The identifier for the call. For SIP calls, use the value provided in the\n[`realtime.call.incoming`](/docs/api-reference/webhook-events/realtime/call/incoming)\nwebhook. For WebRTC sessions, reuse the call ID returned in the `Location`\nheader when creating the call with\n[`POST /v1/realtime/calls`](/docs/api-reference/realtime/create-call)."}],"responses":{"200":{"description":"Call hangup initiated successfully."}},"x-oaiMeta":{"name":"Hang up call","group":"realtime-calls","returns":"Returns `200 OK` when OpenAI begins terminating the realtime call.","examples":{"request":{"curl":"curl -X POST https://api.openai.com/v1/realtime/calls/$CALL_ID/hangup \\\n -H \"Authorization: Bearer $OPENAI_API_KEY\"","node.js":"import OpenAI from 'openai';\n\nconst client = new OpenAI({\n apiKey: process.env['OPENAI_API_KEY'], // This is the default and can be omitted\n});\n\nawait client.realtime.calls.hangup('call_id');","python":"import os\nfrom openai import OpenAI\n\nclient = OpenAI(\n api_key=os.environ.get(\"OPENAI_API_KEY\"), # This is the default and can be omitted\n)\nclient.realtime.calls.hangup(\n \"call_id\",\n)","go":"package main\n\nimport (\n\t\"context\"\n\n\t\"github.com/openai/openai-go\"\n\t\"github.com/openai/openai-go/option\"\n)\n\nfunc main() {\n\tclient := openai.NewClient(\n\t\toption.WithAPIKey(\"My API Key\"),\n\t)\n\terr := client.Realtime.Calls.Hangup(context.TODO(), \"call_id\")\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n","java":"package com.openai.example;\n\nimport com.openai.client.OpenAIClient;\nimport com.openai.client.okhttp.OpenAIOkHttpClient;\nimport com.openai.models.realtime.calls.CallHangupParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n OpenAIClient client = OpenAIOkHttpClient.fromEnv();\n\n client.realtime().calls().hangup(\"call_id\");\n }\n}","ruby":"require \"openai\"\n\nopenai = OpenAI::Client.new(api_key: \"My API Key\")\n\nresult = openai.realtime.calls.hangup(\"call_id\")\n\nputs(result)"},"response":""}}}},"/realtime/calls/{call_id}/refer":{"post":{"summary":"Transfer an active SIP call to a new destination using the SIP REFER verb.","operationId":"refer-realtime-call","tags":["Realtime"],"parameters":[{"in":"path","name":"call_id","required":true,"schema":{"type":"string"},"description":"The identifier for the call provided in the\n[`realtime.call.incoming`](/docs/api-reference/webhook-events/realtime/call/incoming)\nwebhook."}],"requestBody":{"required":true,"description":"Destination URI for the REFER request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RealtimeCallReferRequest"}}}},"responses":{"200":{"description":"Call referred successfully."}},"x-oaiMeta":{"name":"Refer call","group":"realtime-calls","returns":"Returns `200 OK` once the REFER is handed off to your SIP provider.","examples":{"request":{"curl":"curl -X POST https://api.openai.com/v1/realtime/calls/$CALL_ID/refer \\\n -H \"Authorization: Bearer $OPENAI_API_KEY\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"target_uri\": \"tel:+14155550123\"}'","node.js":"import OpenAI from 'openai';\n\nconst client = new OpenAI({\n apiKey: process.env['OPENAI_API_KEY'], // This is the default and can be omitted\n});\n\nawait client.realtime.calls.refer('call_id', { target_uri: 'tel:+14155550123' });","python":"import os\nfrom openai import OpenAI\n\nclient = OpenAI(\n api_key=os.environ.get(\"OPENAI_API_KEY\"), # This is the default and can be omitted\n)\nclient.realtime.calls.refer(\n call_id=\"call_id\",\n target_uri=\"tel:+14155550123\",\n)","go":"package main\n\nimport (\n\t\"context\"\n\n\t\"github.com/openai/openai-go\"\n\t\"github.com/openai/openai-go/option\"\n\t\"github.com/openai/openai-go/realtime\"\n)\n\nfunc main() {\n\tclient := openai.NewClient(\n\t\toption.WithAPIKey(\"My API Key\"),\n\t)\n\terr := client.Realtime.Calls.Refer(\n\t\tcontext.TODO(),\n\t\t\"call_id\",\n\t\trealtime.CallReferParams{\n\t\t\tTargetUri: \"tel:+14155550123\",\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n","java":"package com.openai.example;\n\nimport com.openai.client.OpenAIClient;\nimport com.openai.client.okhttp.OpenAIOkHttpClient;\nimport com.openai.models.realtime.calls.CallReferParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n OpenAIClient client = OpenAIOkHttpClient.fromEnv();\n\n CallReferParams params = CallReferParams.builder()\n .callId(\"call_id\")\n .targetUri(\"tel:+14155550123\")\n .build();\n client.realtime().calls().refer(params);\n }\n}","ruby":"require \"openai\"\n\nopenai = OpenAI::Client.new(api_key: \"My API Key\")\n\nresult = openai.realtime.calls.refer(\"call_id\", target_uri: \"tel:+14155550123\")\n\nputs(result)"},"response":""}}}},"/realtime/calls/{call_id}/reject":{"post":{"summary":"Decline an incoming SIP call by returning a SIP status code to the caller.","operationId":"reject-realtime-call","tags":["Realtime"],"parameters":[{"in":"path","name":"call_id","required":true,"schema":{"type":"string"},"description":"The identifier for the call provided in the\n[`realtime.call.incoming`](/docs/api-reference/webhook-events/realtime/call/incoming)\nwebhook."}],"requestBody":{"required":false,"description":"Provide an optional SIP status code. When omitted the API responds with\n`603 Decline`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RealtimeCallRejectRequest"}}}},"responses":{"200":{"description":"Call rejected successfully."}},"x-oaiMeta":{"name":"Reject call","group":"realtime-calls","returns":"Returns `200 OK` after OpenAI sends the SIP status code to the caller.","examples":{"request":{"curl":"curl -X POST https://api.openai.com/v1/realtime/calls/$CALL_ID/reject \\\n -H \"Authorization: Bearer $OPENAI_API_KEY\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"status_code\": 486}'","node.js":"import OpenAI from 'openai';\n\nconst client = new OpenAI({\n apiKey: process.env['OPENAI_API_KEY'], // This is the default and can be omitted\n});\n\nawait client.realtime.calls.reject('call_id');","python":"import os\nfrom openai import OpenAI\n\nclient = OpenAI(\n api_key=os.environ.get(\"OPENAI_API_KEY\"), # This is the default and can be omitted\n)\nclient.realtime.calls.reject(\n call_id=\"call_id\",\n)","go":"package main\n\nimport (\n\t\"context\"\n\n\t\"github.com/openai/openai-go\"\n\t\"github.com/openai/openai-go/option\"\n\t\"github.com/openai/openai-go/realtime\"\n)\n\nfunc main() {\n\tclient := openai.NewClient(\n\t\toption.WithAPIKey(\"My API Key\"),\n\t)\n\terr := client.Realtime.Calls.Reject(\n\t\tcontext.TODO(),\n\t\t\"call_id\",\n\t\trealtime.CallRejectParams{},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n","java":"package com.openai.example;\n\nimport com.openai.client.OpenAIClient;\nimport com.openai.client.okhttp.OpenAIOkHttpClient;\nimport com.openai.models.realtime.calls.CallRejectParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n OpenAIClient client = OpenAIOkHttpClient.fromEnv();\n\n client.realtime().calls().reject(\"call_id\");\n }\n}","ruby":"require \"openai\"\n\nopenai = OpenAI::Client.new(api_key: \"My API Key\")\n\nresult = openai.realtime.calls.reject(\"call_id\")\n\nputs(result)"},"response":""}}}},"/realtime/client_secrets":{"post":{"summary":"Create a Realtime client secret with an associated session configuration.\n\nClient secrets are short-lived tokens that can be passed to a client app,\nsuch as a web frontend or mobile client, which grants access to the Realtime API without\nleaking your main API key. You can configure a custom TTL for each client secret.\n\nYou can also attach session configuration options to the client secret, which will be\napplied to any sessions created using that client secret, but these can also be overridden\nby the client connection.\n\n[Learn more about authentication with client secrets over WebRTC](/docs/guides/realtime-webrtc).\n\nReturns the created client secret and the effective session object. The client secret is a string that looks like `ek_1234`.\n","operationId":"create-realtime-client-secret","tags":["Realtime"],"requestBody":{"description":"Create a client secret with the given session configuration.","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RealtimeCreateClientSecretRequest"}}}},"responses":{"200":{"description":"Client secret created successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RealtimeCreateClientSecretResponse"}}}}},"x-oaiMeta":{"name":"Create client secret","group":"realtime","examples":{"request":{"curl":"curl -X POST https://api.openai.com/v1/realtime/client_secrets \\\n -H \"Authorization: Bearer $OPENAI_API_KEY\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"expires_after\": {\n \"anchor\": \"created_at\",\n \"seconds\": 600\n },\n \"session\": {\n \"type\": \"realtime\",\n \"model\": \"gpt-realtime\",\n \"instructions\": \"You are a friendly assistant.\"\n }\n }'\n","node.js":"import OpenAI from 'openai';\n\nconst client = new OpenAI({\n apiKey: process.env['OPENAI_API_KEY'], // This is the default and can be omitted\n});\n\nconst clientSecret = await client.realtime.clientSecrets.create();\n\nconsole.log(clientSecret.expires_at);","python":"import os\nfrom openai import OpenAI\n\nclient = OpenAI(\n api_key=os.environ.get(\"OPENAI_API_KEY\"), # This is the default and can be omitted\n)\nclient_secret = client.realtime.client_secrets.create()\nprint(client_secret.expires_at)","go":"package main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\n\t\"github.com/openai/openai-go\"\n\t\"github.com/openai/openai-go/option\"\n\t\"github.com/openai/openai-go/realtime\"\n)\n\nfunc main() {\n\tclient := openai.NewClient(\n\t\toption.WithAPIKey(\"My API Key\"),\n\t)\n\tclientSecret, err := client.Realtime.ClientSecrets.New(context.TODO(), realtime.ClientSecretNewParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf(\"%+v\\n\", clientSecret.ExpiresAt)\n}\n","java":"package com.openai.example;\n\nimport com.openai.client.OpenAIClient;\nimport com.openai.client.okhttp.OpenAIOkHttpClient;\nimport com.openai.models.realtime.clientsecrets.ClientSecretCreateParams;\nimport com.openai.models.realtime.clientsecrets.ClientSecretCreateResponse;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n OpenAIClient client = OpenAIOkHttpClient.fromEnv();\n\n ClientSecretCreateResponse clientSecret = client.realtime().clientSecrets().create();\n }\n}","ruby":"require \"openai\"\n\nopenai = OpenAI::Client.new(api_key: \"My API Key\")\n\nclient_secret = openai.realtime.client_secrets.create\n\nputs(client_secret)"},"response":"{\n \"value\": \"ek_68af296e8e408191a1120ab6383263c2\",\n \"expires_at\": 1756310470,\n \"session\": {\n \"type\": \"realtime\",\n \"object\": \"realtime.session\",\n \"id\": \"sess_C9CiUVUzUzYIssh3ELY1d\",\n \"model\": \"gpt-realtime\",\n \"output_modalities\": [\n \"audio\"\n ],\n \"instructions\": \"You are a friendly assistant.\",\n \"tools\": [],\n \"tool_choice\": \"auto\",\n \"max_output_tokens\": \"inf\",\n \"tracing\": null,\n \"truncation\": \"auto\",\n \"prompt\": null,\n \"expires_at\": 0,\n \"audio\": {\n \"input\": {\n \"format\": {\n \"type\": \"audio/pcm\",\n \"rate\": 24000\n },\n \"transcription\": null,\n \"noise_reduction\": null,\n \"turn_detection\": {\n \"type\": \"server_vad\",\n }\n },\n \"output\": {\n \"format\": {\n \"type\": \"audio/pcm\",\n \"rate\": 24000\n },\n \"voice\": \"alloy\",\n \"speed\": 1.0\n }\n },\n \"include\": null\n }\n}\n"}}}},"/realtime/sessions":{"post":{"summary":"Create an ephemeral API token for use in client-side applications with the\nRealtime API. Can be configured with the same session parameters as the\n`session.update` client event.\n\nIt responds with a session object, plus a `client_secret` key which contains\na usable ephemeral API token that can be used to authenticate browser clients\nfor the Realtime API.\n\nReturns the created Realtime session object, plus an ephemeral key.\n","operationId":"create-realtime-session","tags":["Realtime"],"requestBody":{"description":"Create an ephemeral API key with the given session configuration.","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RealtimeSessionCreateRequest"}}}},"responses":{"200":{"description":"Session created successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RealtimeSessionCreateResponse"}}}}},"x-oaiMeta":{"name":"Create session","group":"realtime","examples":{"request":{"curl":"curl -X POST https://api.openai.com/v1/realtime/sessions \\\n -H \"Authorization: Bearer $OPENAI_API_KEY\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"model\": \"gpt-realtime\",\n \"modalities\": [\"audio\", \"text\"],\n \"instructions\": \"You are a friendly assistant.\"\n }'\n"},"response":"{\n \"id\": \"sess_001\",\n \"object\": \"realtime.session\",\n \"model\": \"gpt-realtime-2025-08-25\",\n \"modalities\": [\"audio\", \"text\"],\n \"instructions\": \"You are a friendly assistant.\",\n \"voice\": \"alloy\",\n \"input_audio_format\": \"pcm16\",\n \"output_audio_format\": \"pcm16\",\n \"input_audio_transcription\": {\n \"model\": \"whisper-1\"\n },\n \"turn_detection\": null,\n \"tools\": [],\n \"tool_choice\": \"none\",\n \"temperature\": 0.7,\n \"max_response_output_tokens\": 200,\n \"speed\": 1.1,\n \"tracing\": \"auto\",\n \"client_secret\": {\n \"value\": \"ek_abc123\", \n \"expires_at\": 1234567890\n }\n}\n"}}}},"/realtime/transcription_sessions":{"post":{"summary":"Create an ephemeral API token for use in client-side applications with the\nRealtime API specifically for realtime transcriptions. \nCan be configured with the same session parameters as the `transcription_session.update` client event.\n\nIt responds with a session object, plus a `client_secret` key which contains\na usable ephemeral API token that can be used to authenticate browser clients\nfor the Realtime API.\n\nReturns the created Realtime transcription session object, plus an ephemeral key.\n","operationId":"create-realtime-transcription-session","tags":["Realtime"],"requestBody":{"description":"Create an ephemeral API key with the given session configuration.","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RealtimeTranscriptionSessionCreateRequest"}}}},"responses":{"200":{"description":"Session created successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RealtimeTranscriptionSessionCreateResponse"}}}}},"x-oaiMeta":{"name":"Create transcription session","group":"realtime","examples":{"request":{"curl":"curl -X POST https://api.openai.com/v1/realtime/transcription_sessions \\\n -H \"Authorization: Bearer $OPENAI_API_KEY\" \\\n -H \"Content-Type: application/json\" \\\n -d '{}'\n"},"response":"{\n \"id\": \"sess_BBwZc7cFV3XizEyKGDCGL\",\n \"object\": \"realtime.transcription_session\",\n \"modalities\": [\"audio\", \"text\"],\n \"turn_detection\": {\n \"type\": \"server_vad\",\n \"threshold\": 0.5,\n \"prefix_padding_ms\": 300,\n \"silence_duration_ms\": 200\n },\n \"input_audio_format\": \"pcm16\",\n \"input_audio_transcription\": {\n \"model\": \"gpt-4o-transcribe\",\n \"language\": null,\n \"prompt\": \"\"\n },\n \"client_secret\": null\n}\n"}}}},"/responses":{"post":{"operationId":"createResponse","tags":["Responses"],"summary":"Creates a model response. Provide [text](/docs/guides/text) or\n[image](/docs/guides/images) inputs to generate [text](/docs/guides/text)\nor [JSON](/docs/guides/structured-outputs) outputs. Have the model call\nyour own [custom code](/docs/guides/function-calling) or use built-in\n[tools](/docs/guides/tools) like [web search](/docs/guides/tools-web-search)\nor [file search](/docs/guides/tools-file-search) to use your own data\nas input for the model's response.\n","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateResponse"}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}},"text/event-stream":{"schema":{"$ref":"#/components/schemas/ResponseStreamEvent"}}}}},"x-oaiMeta":{"name":"Create a model response","group":"responses","path":"create","examples":[{"title":"Text input","request":{"curl":"curl https://api.openai.com/v1/responses \\\n -H \"Content-Type: application/json\" \\\n -H \"Authorization: Bearer $OPENAI_API_KEY\" \\\n -d '{\n \"model\": \"gpt-5.4\",\n \"input\": \"Tell me a three sentence bedtime story about a unicorn.\"\n }'\n","javascript":"import OpenAI from \"openai\";\n\nconst openai = new OpenAI();\n\nconst response = await openai.responses.create({\n model: \"gpt-5.4\",\n input: \"Tell me a three sentence bedtime story about a unicorn.\"\n});\n\nconsole.log(response);\n","python":"import os\nfrom openai import OpenAI\n\nclient = OpenAI(\n api_key=os.environ.get(\"OPENAI_API_KEY\"), # This is the default and can be omitted\n)\nfor response in client.responses.create():\n print(response)","csharp":"using System;\nusing OpenAI.Responses;\n\nOpenAIResponseClient client = new(\n model: \"gpt-5.4\",\n apiKey: Environment.GetEnvironmentVariable(\"OPENAI_API_KEY\")\n);\n\nOpenAIResponse response = client.CreateResponse(\"Tell me a three sentence bedtime story about a unicorn.\");\n\nConsole.WriteLine(response.GetOutputText());\n","node.js":"import OpenAI from 'openai';\n\nconst client = new OpenAI({\n apiKey: process.env['OPENAI_API_KEY'], // This is the default and can be omitted\n});\n\nconst response = await client.responses.create();\n\nconsole.log(response.id);","go":"package main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\n\t\"github.com/openai/openai-go\"\n\t\"github.com/openai/openai-go/option\"\n\t\"github.com/openai/openai-go/responses\"\n)\n\nfunc main() {\n\tclient := openai.NewClient(\n\t\toption.WithAPIKey(\"My API Key\"),\n\t)\n\tresponse, err := client.Responses.New(context.TODO(), responses.ResponseNewParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf(\"%+v\\n\", response.ID)\n}\n","java":"package com.openai.example;\n\nimport com.openai.client.OpenAIClient;\nimport com.openai.client.okhttp.OpenAIOkHttpClient;\nimport com.openai.models.responses.Response;\nimport com.openai.models.responses.ResponseCreateParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n OpenAIClient client = OpenAIOkHttpClient.fromEnv();\n\n Response response = client.responses().create();\n }\n}","ruby":"require \"openai\"\n\nopenai = OpenAI::Client.new(api_key: \"My API Key\")\n\nresponse = openai.responses.create\n\nputs(response)"},"response":"{\n \"id\": \"resp_67ccd2bed1ec8190b14f964abc0542670bb6a6b452d3795b\",\n \"object\": \"response\",\n \"created_at\": 1741476542,\n \"status\": \"completed\",\n \"completed_at\": 1741476543,\n \"error\": null,\n \"incomplete_details\": null,\n \"instructions\": null,\n \"max_output_tokens\": null,\n \"model\": \"gpt-5.4\",\n \"output\": [\n {\n \"type\": \"message\",\n \"id\": \"msg_67ccd2bf17f0819081ff3bb2cf6508e60bb6a6b452d3795b\",\n \"status\": \"completed\",\n \"role\": \"assistant\",\n \"content\": [\n {\n \"type\": \"output_text\",\n \"text\": \"In a peaceful grove beneath a silver moon, a unicorn named Lumina discovered a hidden pool that reflected the stars. As she dipped her horn into the water, the pool began to shimmer, revealing a pathway to a magical realm of endless night skies. Filled with wonder, Lumina whispered a wish for all who dream to find their own hidden magic, and as she glanced back, her hoofprints sparkled like stardust.\",\n \"annotations\": []\n }\n ]\n }\n ],\n \"parallel_tool_calls\": true,\n \"previous_response_id\": null,\n \"reasoning\": {\n \"effort\": null,\n \"summary\": null\n },\n \"store\": true,\n \"temperature\": 1.0,\n \"text\": {\n \"format\": {\n \"type\": \"text\"\n }\n },\n \"tool_choice\": \"auto\",\n \"tools\": [],\n \"top_p\": 1.0,\n \"truncation\": \"disabled\",\n \"usage\": {\n \"input_tokens\": 36,\n \"input_tokens_details\": {\n \"cached_tokens\": 0\n },\n \"output_tokens\": 87,\n \"output_tokens_details\": {\n \"reasoning_tokens\": 0\n },\n \"total_tokens\": 123\n },\n \"user\": null,\n \"metadata\": {}\n}\n"},{"title":"Image input","request":{"curl":"curl https://api.openai.com/v1/responses \\\n -H \"Content-Type: application/json\" \\\n -H \"Authorization: Bearer $OPENAI_API_KEY\" \\\n -d '{\n \"model\": \"gpt-5.4\",\n \"input\": [\n {\n \"role\": \"user\",\n \"content\": [\n {\"type\": \"input_text\", \"text\": \"what is in this image?\"},\n {\n \"type\": \"input_image\",\n \"image_url\": \"https://upload.wikimedia.org/wikipedia/commons/thumb/d/dd/Gfp-wisconsin-madison-the-nature-boardwalk.jpg/2560px-Gfp-wisconsin-madison-the-nature-boardwalk.jpg\"\n }\n ]\n }\n ]\n }'\n","javascript":"import OpenAI from \"openai\";\n\nconst openai = new OpenAI();\n\nconst response = await openai.responses.create({\n model: \"gpt-5.4\",\n input: [\n {\n role: \"user\",\n content: [\n { type: \"input_text\", text: \"what is in this image?\" },\n {\n type: \"input_image\",\n image_url:\n \"https://upload.wikimedia.org/wikipedia/commons/thumb/d/dd/Gfp-wisconsin-madison-the-nature-boardwalk.jpg/2560px-Gfp-wisconsin-madison-the-nature-boardwalk.jpg\",\n },\n ],\n },\n ],\n});\n\nconsole.log(response);\n","python":"import os\nfrom openai import OpenAI\n\nclient = OpenAI(\n api_key=os.environ.get(\"OPENAI_API_KEY\"), # This is the default and can be omitted\n)\nfor response in client.responses.create():\n print(response)","csharp":"using System;\nusing System.Collections.Generic;\n\nusing OpenAI.Responses;\n\nOpenAIResponseClient client = new(\n model: \"gpt-5.4\",\n apiKey: Environment.GetEnvironmentVariable(\"OPENAI_API_KEY\")\n);\n\nList<ResponseItem> inputItems =\n[\n ResponseItem.CreateUserMessageItem(\n [\n ResponseContentPart.CreateInputTextPart(\"What is in this image?\"),\n ResponseContentPart.CreateInputImagePart(new Uri(\"https://upload.wikimedia.org/wikipedia/commons/thumb/d/dd/Gfp-wisconsin-madison-the-nature-boardwalk.jpg/2560px-Gfp-wisconsin-madison-the-nature-boardwalk.jpg\"))\n ]\n )\n];\n\nOpenAIResponse response = client.CreateResponse(inputItems);\n\nConsole.WriteLine(response.GetOutputText());\n","node.js":"import OpenAI from 'openai';\n\nconst client = new OpenAI({\n apiKey: process.env['OPENAI_API_KEY'], // This is the default and can be omitted\n});\n\nconst response = await client.responses.create();\n\nconsole.log(response.id);","go":"package main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\n\t\"github.com/openai/openai-go\"\n\t\"github.com/openai/openai-go/option\"\n\t\"github.com/openai/openai-go/responses\"\n)\n\nfunc main() {\n\tclient := openai.NewClient(\n\t\toption.WithAPIKey(\"My API Key\"),\n\t)\n\tresponse, err := client.Responses.New(context.TODO(), responses.ResponseNewParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf(\"%+v\\n\", response.ID)\n}\n","java":"package com.openai.example;\n\nimport com.openai.client.OpenAIClient;\nimport com.openai.client.okhttp.OpenAIOkHttpClient;\nimport com.openai.models.responses.Response;\nimport com.openai.models.responses.ResponseCreateParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n OpenAIClient client = OpenAIOkHttpClient.fromEnv();\n\n Response response = client.responses().create();\n }\n}","ruby":"require \"openai\"\n\nopenai = OpenAI::Client.new(api_key: \"My API Key\")\n\nresponse = openai.responses.create\n\nputs(response)"},"response":"{\n \"id\": \"resp_67ccd3a9da748190baa7f1570fe91ac604becb25c45c1d41\",\n \"object\": \"response\",\n \"created_at\": 1741476777,\n \"status\": \"completed\",\n \"completed_at\": 1741476778,\n \"error\": null,\n \"incomplete_details\": null,\n \"instructions\": null,\n \"max_output_tokens\": null,\n \"model\": \"gpt-5.4\",\n \"output\": [\n {\n \"type\": \"message\",\n \"id\": \"msg_67ccd3acc8d48190a77525dc6de64b4104becb25c45c1d41\",\n \"status\": \"completed\",\n \"role\": \"assistant\",\n \"content\": [\n {\n \"type\": \"output_text\",\n \"text\": \"The image depicts a scenic landscape with a wooden boardwalk or pathway leading through lush, green grass under a blue sky with some clouds. The setting suggests a peaceful natural area, possibly a park or nature reserve. There are trees and shrubs in the background.\",\n \"annotations\": []\n }\n ]\n }\n ],\n \"parallel_tool_calls\": true,\n \"previous_response_id\": null,\n \"reasoning\": {\n \"effort\": null,\n \"summary\": null\n },\n \"store\": true,\n \"temperature\": 1.0,\n \"text\": {\n \"format\": {\n \"type\": \"text\"\n }\n },\n \"tool_choice\": \"auto\",\n \"tools\": [],\n \"top_p\": 1.0,\n \"truncation\": \"disabled\",\n \"usage\": {\n \"input_tokens\": 328,\n \"input_tokens_details\": {\n \"cached_tokens\": 0\n },\n \"output_tokens\": 52,\n \"output_tokens_details\": {\n \"reasoning_tokens\": 0\n },\n \"total_tokens\": 380\n },\n \"user\": null,\n \"metadata\": {}\n}\n"},{"title":"File input","request":{"curl":"curl https://api.openai.com/v1/responses \\\n -H \"Content-Type: application/json\" \\\n -H \"Authorization: Bearer $OPENAI_API_KEY\" \\\n -d '{\n \"model\": \"gpt-5.4\",\n \"input\": [\n {\n \"role\": \"user\",\n \"content\": [\n {\"type\": \"input_text\", \"text\": \"what is in this file?\"},\n {\n \"type\": \"input_file\",\n \"file_url\": \"https://www.berkshirehathaway.com/letters/2024ltr.pdf\"\n }\n ]\n }\n ]\n }'\n","javascript":"import OpenAI from \"openai\";\n\nconst openai = new OpenAI();\n\nconst response = await openai.responses.create({\n model: \"gpt-5.4\",\n input: [\n {\n role: \"user\",\n content: [\n { type: \"input_text\", text: \"what is in this file?\" },\n {\n type: \"input_file\",\n file_url: \"https://www.berkshirehathaway.com/letters/2024ltr.pdf\",\n },\n ],\n },\n ],\n});\n\nconsole.log(response);\n","python":"import os\nfrom openai import OpenAI\n\nclient = OpenAI(\n api_key=os.environ.get(\"OPENAI_API_KEY\"), # This is the default and can be omitted\n)\nfor response in client.responses.create():\n print(response)","node.js":"import OpenAI from 'openai';\n\nconst client = new OpenAI({\n apiKey: process.env['OPENAI_API_KEY'], // This is the default and can be omitted\n});\n\nconst response = await client.responses.create();\n\nconsole.log(response.id);","go":"package main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\n\t\"github.com/openai/openai-go\"\n\t\"github.com/openai/openai-go/option\"\n\t\"github.com/openai/openai-go/responses\"\n)\n\nfunc main() {\n\tclient := openai.NewClient(\n\t\toption.WithAPIKey(\"My API Key\"),\n\t)\n\tresponse, err := client.Responses.New(context.TODO(), responses.ResponseNewParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf(\"%+v\\n\", response.ID)\n}\n","java":"package com.openai.example;\n\nimport com.openai.client.OpenAIClient;\nimport com.openai.client.okhttp.OpenAIOkHttpClient;\nimport com.openai.models.responses.Response;\nimport com.openai.models.responses.ResponseCreateParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n OpenAIClient client = OpenAIOkHttpClient.fromEnv();\n\n Response response = client.responses().create();\n }\n}","ruby":"require \"openai\"\n\nopenai = OpenAI::Client.new(api_key: \"My API Key\")\n\nresponse = openai.responses.create\n\nputs(response)"},"response":"{\n \"id\": \"resp_686eef60237881a2bd1180bb8b13de430e34c516d176ff86\",\n \"object\": \"response\",\n \"created_at\": 1752100704,\n \"status\": \"completed\",\n \"completed_at\": 1752100705,\n \"background\": false,\n \"error\": null,\n \"incomplete_details\": null,\n \"instructions\": null,\n \"max_output_tokens\": null,\n \"max_tool_calls\": null,\n \"model\": \"gpt-5.4\",\n \"output\": [\n {\n \"id\": \"msg_686eef60d3e081a29283bdcbc4322fd90e34c516d176ff86\",\n \"type\": \"message\",\n \"status\": \"completed\",\n \"content\": [\n {\n \"type\": \"output_text\",\n \"annotations\": [],\n \"logprobs\": [],\n \"text\": \"The file seems to contain excerpts from a letter to the shareholders of Berkshire Hathaway Inc., likely written by Warren Buffett. It covers several topics:\\n\\n1. **Communication Philosophy**: Buffett emphasizes the importance of transparency and candidness in reporting mistakes and successes to shareholders.\\n\\n2. **Mistakes and Learnings**: The letter acknowledges past mistakes in business assessments and management hires, highlighting the importance of correcting errors promptly.\\n\\n3. **CEO Succession**: Mention of Greg Abel stepping in as the new CEO and continuing the tradition of honest communication.\\n\\n4. **Pete Liegl Story**: A detailed account of acquiring Forest River and the relationship with its founder, highlighting trust and effective business decisions.\\n\\n5. **2024 Performance**: Overview of business performance, particularly in insurance and investment activities, with a focus on GEICO's improvement.\\n\\n6. **Tax Contributions**: Discussion of significant tax payments to the U.S. Treasury, credited to shareholders' reinvestments.\\n\\n7. **Investment Strategy**: A breakdown of Berkshire\\u2019s investments in both controlled subsidiaries and marketable equities, along with a focus on long-term holding strategies.\\n\\n8. **American Capitalism**: Reflections on America\\u2019s economic development and Berkshire\\u2019s role within it.\\n\\n9. **Property-Casualty Insurance**: Insights into the P/C insurance business model and its challenges and benefits.\\n\\n10. **Japanese Investments**: Information about Berkshire\\u2019s investments in Japanese companies and future plans.\\n\\n11. **Annual Meeting**: Details about the upcoming annual gathering in Omaha, including schedule changes and new book releases.\\n\\n12. **Personal Anecdotes**: Light-hearted stories about family and interactions, conveying Buffett's personable approach.\\n\\n13. **Financial Performance Data**: Tables comparing Berkshire\\u2019s annual performance to the S&P 500, showing impressive long-term gains.\\n\\nOverall, the letter reinforces Berkshire Hathaway's commitment to transparency, investment in both its businesses and the wider economy, and emphasizes strong leadership and prudent financial management.\"\n }\n ],\n \"role\": \"assistant\"\n }\n ],\n \"parallel_tool_calls\": true,\n \"previous_response_id\": null,\n \"reasoning\": {\n \"effort\": null,\n \"summary\": null\n },\n \"service_tier\": \"default\",\n \"store\": true,\n \"temperature\": 1.0,\n \"text\": {\n \"format\": {\n \"type\": \"text\"\n }\n },\n \"tool_choice\": \"auto\",\n \"tools\": [],\n \"top_logprobs\": 0,\n \"top_p\": 1.0,\n \"truncation\": \"disabled\",\n \"usage\": {\n \"input_tokens\": 8438,\n \"input_tokens_details\": {\n \"cached_tokens\": 0\n },\n \"output_tokens\": 398,\n \"output_tokens_details\": {\n \"reasoning_tokens\": 0\n },\n \"total_tokens\": 8836\n },\n \"user\": null,\n \"metadata\": {}\n}\n"},{"title":"Web search","request":{"curl":"curl https://api.openai.com/v1/responses \\\n -H \"Content-Type: application/json\" \\\n -H \"Authorization: Bearer $OPENAI_API_KEY\" \\\n -d '{\n \"model\": \"gpt-5.4\",\n \"tools\": [{ \"type\": \"web_search_preview\" }],\n \"input\": \"What was a positive news story from today?\"\n }'\n","javascript":"import OpenAI from \"openai\";\n\nconst openai = new OpenAI();\n\nconst response = await openai.responses.create({\n model: \"gpt-5.4\",\n tools: [{ type: \"web_search_preview\" }],\n input: \"What was a positive news story from today?\",\n});\n\nconsole.log(response);\n","python":"import os\nfrom openai import OpenAI\n\nclient = OpenAI(\n api_key=os.environ.get(\"OPENAI_API_KEY\"), # This is the default and can be omitted\n)\nfor response in client.responses.create():\n print(response)","csharp":"using System;\n\nusing OpenAI.Responses;\n\nOpenAIResponseClient client = new(\n model: \"gpt-5.4\",\n apiKey: Environment.GetEnvironmentVariable(\"OPENAI_API_KEY\")\n);\n\nstring userInputText = \"What was a positive news story from today?\";\n\nResponseCreationOptions options = new()\n{\n Tools =\n {\n ResponseTool.CreateWebSearchTool()\n },\n};\n\nOpenAIResponse response = client.CreateResponse(userInputText, options);\n\nConsole.WriteLine(response.GetOutputText());\n","node.js":"import OpenAI from 'openai';\n\nconst client = new OpenAI({\n apiKey: process.env['OPENAI_API_KEY'], // This is the default and can be omitted\n});\n\nconst response = await client.responses.create();\n\nconsole.log(response.id);","go":"package main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\n\t\"github.com/openai/openai-go\"\n\t\"github.com/openai/openai-go/option\"\n\t\"github.com/openai/openai-go/responses\"\n)\n\nfunc main() {\n\tclient := openai.NewClient(\n\t\toption.WithAPIKey(\"My API Key\"),\n\t)\n\tresponse, err := client.Responses.New(context.TODO(), responses.ResponseNewParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf(\"%+v\\n\", response.ID)\n}\n","java":"package com.openai.example;\n\nimport com.openai.client.OpenAIClient;\nimport com.openai.client.okhttp.OpenAIOkHttpClient;\nimport com.openai.models.responses.Response;\nimport com.openai.models.responses.ResponseCreateParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n OpenAIClient client = OpenAIOkHttpClient.fromEnv();\n\n Response response = client.responses().create();\n }\n}","ruby":"require \"openai\"\n\nopenai = OpenAI::Client.new(api_key: \"My API Key\")\n\nresponse = openai.responses.create\n\nputs(response)"},"response":"{\n \"id\": \"resp_67ccf18ef5fc8190b16dbee19bc54e5f087bb177ab789d5c\",\n \"object\": \"response\",\n \"created_at\": 1741484430,\n \"status\": \"completed\",\n \"completed_at\": 1741484431,\n \"error\": null,\n \"incomplete_details\": null,\n \"instructions\": null,\n \"max_output_tokens\": null,\n \"model\": \"gpt-5.4\",\n \"output\": [\n {\n \"type\": \"web_search_call\",\n \"id\": \"ws_67ccf18f64008190a39b619f4c8455ef087bb177ab789d5c\",\n \"status\": \"completed\"\n },\n {\n \"type\": \"message\",\n \"id\": \"msg_67ccf190ca3881909d433c50b1f6357e087bb177ab789d5c\",\n \"status\": \"completed\",\n \"role\": \"assistant\",\n \"content\": [\n {\n \"type\": \"output_text\",\n \"text\": \"As of today, March 9, 2025, one notable positive news story...\",\n \"annotations\": [\n {\n \"type\": \"url_citation\",\n \"start_index\": 442,\n \"end_index\": 557,\n \"url\": \"https://.../?utm_source=chatgpt.com\",\n \"title\": \"...\"\n },\n {\n \"type\": \"url_citation\",\n \"start_index\": 962,\n \"end_index\": 1077,\n \"url\": \"https://.../?utm_source=chatgpt.com\",\n \"title\": \"...\"\n },\n {\n \"type\": \"url_citation\",\n \"start_index\": 1336,\n \"end_index\": 1451,\n \"url\": \"https://.../?utm_source=chatgpt.com\",\n \"title\": \"...\"\n }\n ]\n }\n ]\n }\n ],\n \"parallel_tool_calls\": true,\n \"previous_response_id\": null,\n \"reasoning\": {\n \"effort\": null,\n \"summary\": null\n },\n \"store\": true,\n \"temperature\": 1.0,\n \"text\": {\n \"format\": {\n \"type\": \"text\"\n }\n },\n \"tool_choice\": \"auto\",\n \"tools\": [\n {\n \"type\": \"web_search_preview\",\n \"domains\": [],\n \"search_context_size\": \"medium\",\n \"user_location\": {\n \"type\": \"approximate\",\n \"city\": null,\n \"country\": \"US\",\n \"region\": null,\n \"timezone\": null\n }\n }\n ],\n \"top_p\": 1.0,\n \"truncation\": \"disabled\",\n \"usage\": {\n \"input_tokens\": 328,\n \"input_tokens_details\": {\n \"cached_tokens\": 0\n },\n \"output_tokens\": 356,\n \"output_tokens_details\": {\n \"reasoning_tokens\": 0\n },\n \"total_tokens\": 684\n },\n \"user\": null,\n \"metadata\": {}\n}\n"},{"title":"File search","request":{"curl":"curl https://api.openai.com/v1/responses \\\n -H \"Content-Type: application/json\" \\\n -H \"Authorization: Bearer $OPENAI_API_KEY\" \\\n -d '{\n \"model\": \"gpt-5.4\",\n \"tools\": [{\n \"type\": \"file_search\",\n \"vector_store_ids\": [\"vs_1234567890\"],\n \"max_num_results\": 20\n }],\n \"input\": \"What are the attributes of an ancient brown dragon?\"\n }'\n","javascript":"import OpenAI from \"openai\";\n\nconst openai = new OpenAI();\n\nconst response = await openai.responses.create({\n model: \"gpt-5.4\",\n tools: [{\n type: \"file_search\",\n vector_store_ids: [\"vs_1234567890\"],\n max_num_results: 20\n }],\n input: \"What are the attributes of an ancient brown dragon?\",\n});\n\nconsole.log(response);\n","python":"import os\nfrom openai import OpenAI\n\nclient = OpenAI(\n api_key=os.environ.get(\"OPENAI_API_KEY\"), # This is the default and can be omitted\n)\nfor response in client.responses.create():\n print(response)","csharp":"using System;\n\nusing OpenAI.Responses;\n\nOpenAIResponseClient client = new(\n model: \"gpt-5.4\",\n apiKey: Environment.GetEnvironmentVariable(\"OPENAI_API_KEY\")\n);\n\nstring userInputText = \"What are the attributes of an ancient brown dragon?\";\n\nResponseCreationOptions options = new()\n{\n Tools =\n {\n ResponseTool.CreateFileSearchTool(\n vectorStoreIds: [\"vs_1234567890\"],\n maxResultCount: 20\n )\n },\n};\n\nOpenAIResponse response = client.CreateResponse(userInputText, options);\n\nConsole.WriteLine(response.GetOutputText());\n","node.js":"import OpenAI from 'openai';\n\nconst client = new OpenAI({\n apiKey: process.env['OPENAI_API_KEY'], // This is the default and can be omitted\n});\n\nconst response = await client.responses.create();\n\nconsole.log(response.id);","go":"package main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\n\t\"github.com/openai/openai-go\"\n\t\"github.com/openai/openai-go/option\"\n\t\"github.com/openai/openai-go/responses\"\n)\n\nfunc main() {\n\tclient := openai.NewClient(\n\t\toption.WithAPIKey(\"My API Key\"),\n\t)\n\tresponse, err := client.Responses.New(context.TODO(), responses.ResponseNewParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf(\"%+v\\n\", response.ID)\n}\n","java":"package com.openai.example;\n\nimport com.openai.client.OpenAIClient;\nimport com.openai.client.okhttp.OpenAIOkHttpClient;\nimport com.openai.models.responses.Response;\nimport com.openai.models.responses.ResponseCreateParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n OpenAIClient client = OpenAIOkHttpClient.fromEnv();\n\n Response response = client.responses().create();\n }\n}","ruby":"require \"openai\"\n\nopenai = OpenAI::Client.new(api_key: \"My API Key\")\n\nresponse = openai.responses.create\n\nputs(response)"},"response":"{\n \"id\": \"resp_67ccf4c55fc48190b71bd0463ad3306d09504fb6872380d7\",\n \"object\": \"response\",\n \"created_at\": 1741485253,\n \"status\": \"completed\",\n \"completed_at\": 1741485254,\n \"error\": null,\n \"incomplete_details\": null,\n \"instructions\": null,\n \"max_output_tokens\": null,\n \"model\": \"gpt-5.4\",\n \"output\": [\n {\n \"type\": \"file_search_call\",\n \"id\": \"fs_67ccf4c63cd08190887ef6464ba5681609504fb6872380d7\",\n \"status\": \"completed\",\n \"queries\": [\n \"attributes of an ancient brown dragon\"\n ],\n \"results\": null\n },\n {\n \"type\": \"message\",\n \"id\": \"msg_67ccf4c93e5c81909d595b369351a9d309504fb6872380d7\",\n \"status\": \"completed\",\n \"role\": \"assistant\",\n \"content\": [\n {\n \"type\": \"output_text\",\n \"text\": \"The attributes of an ancient brown dragon include...\",\n \"annotations\": [\n {\n \"type\": \"file_citation\",\n \"index\": 320,\n \"file_id\": \"file-4wDz5b167pAf72nx1h9eiN\",\n \"filename\": \"dragons.pdf\"\n },\n {\n \"type\": \"file_citation\",\n \"index\": 576,\n \"file_id\": \"file-4wDz5b167pAf72nx1h9eiN\",\n \"filename\": \"dragons.pdf\"\n },\n {\n \"type\": \"file_citation\",\n \"index\": 815,\n \"file_id\": \"file-4wDz5b167pAf72nx1h9eiN\",\n \"filename\": \"dragons.pdf\"\n },\n {\n \"type\": \"file_citation\",\n \"index\": 815,\n \"file_id\": \"file-4wDz5b167pAf72nx1h9eiN\",\n \"filename\": \"dragons.pdf\"\n },\n {\n \"type\": \"file_citation\",\n \"index\": 1030,\n \"file_id\": \"file-4wDz5b167pAf72nx1h9eiN\",\n \"filename\": \"dragons.pdf\"\n },\n {\n \"type\": \"file_citation\",\n \"index\": 1030,\n \"file_id\": \"file-4wDz5b167pAf72nx1h9eiN\",\n \"filename\": \"dragons.pdf\"\n },\n {\n \"type\": \"file_citation\",\n \"index\": 1156,\n \"file_id\": \"file-4wDz5b167pAf72nx1h9eiN\",\n \"filename\": \"dragons.pdf\"\n },\n {\n \"type\": \"file_citation\",\n \"index\": 1225,\n \"file_id\": \"file-4wDz5b167pAf72nx1h9eiN\",\n \"filename\": \"dragons.pdf\"\n }\n ]\n }\n ]\n }\n ],\n \"parallel_tool_calls\": true,\n \"previous_response_id\": null,\n \"reasoning\": {\n \"effort\": null,\n \"summary\": null\n },\n \"store\": true,\n \"temperature\": 1.0,\n \"text\": {\n \"format\": {\n \"type\": \"text\"\n }\n },\n \"tool_choice\": \"auto\",\n \"tools\": [\n {\n \"type\": \"file_search\",\n \"filters\": null,\n \"max_num_results\": 20,\n \"ranking_options\": {\n \"ranker\": \"auto\",\n \"score_threshold\": 0.0\n },\n \"vector_store_ids\": [\n \"vs_1234567890\"\n ]\n }\n ],\n \"top_p\": 1.0,\n \"truncation\": \"disabled\",\n \"usage\": {\n \"input_tokens\": 18307,\n \"input_tokens_details\": {\n \"cached_tokens\": 0\n },\n \"output_tokens\": 348,\n \"output_tokens_details\": {\n \"reasoning_tokens\": 0\n },\n \"total_tokens\": 18655\n },\n \"user\": null,\n \"metadata\": {}\n}\n"},{"title":"Streaming","request":{"curl":"curl https://api.openai.com/v1/responses \\\n -H \"Content-Type: application/json\" \\\n -H \"Authorization: Bearer $OPENAI_API_KEY\" \\\n -d '{\n \"model\": \"gpt-5.4\",\n \"instructions\": \"You are a helpful assistant.\",\n \"input\": \"Hello!\",\n \"stream\": true\n }'\n","python":"import os\nfrom openai import OpenAI\n\nclient = OpenAI(\n api_key=os.environ.get(\"OPENAI_API_KEY\"), # This is the default and can be omitted\n)\nfor response in client.responses.create():\n print(response)","javascript":"import OpenAI from \"openai\";\n\nconst openai = new OpenAI();\n\nconst response = await openai.responses.create({\n model: \"gpt-5.4\",\n instructions: \"You are a helpful assistant.\",\n input: \"Hello!\",\n stream: true,\n});\n\nfor await (const event of response) {\n console.log(event);\n}\n","csharp":"using System;\nusing System.ClientModel;\nusing System.Threading.Tasks;\n\nusing OpenAI.Responses;\n\nOpenAIResponseClient client = new(\n model: \"gpt-5.4\",\n apiKey: Environment.GetEnvironmentVariable(\"OPENAI_API_KEY\")\n);\n\nstring userInputText = \"Hello!\";\n\nResponseCreationOptions options = new()\n{\n Instructions = \"You are a helpful assistant.\",\n};\n\nAsyncCollectionResult<StreamingResponseUpdate> responseUpdates = client.CreateResponseStreamingAsync(userInputText, options);\n\nawait foreach (StreamingResponseUpdate responseUpdate in responseUpdates)\n{\n if (responseUpdate is StreamingResponseOutputTextDeltaUpdate outputTextDeltaUpdate)\n {\n Console.Write(outputTextDeltaUpdate.Delta);\n }\n}\n","node.js":"import OpenAI from 'openai';\n\nconst client = new OpenAI({\n apiKey: process.env['OPENAI_API_KEY'], // This is the default and can be omitted\n});\n\nconst response = await client.responses.create();\n\nconsole.log(response.id);","go":"package main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\n\t\"github.com/openai/openai-go\"\n\t\"github.com/openai/openai-go/option\"\n\t\"github.com/openai/openai-go/responses\"\n)\n\nfunc main() {\n\tclient := openai.NewClient(\n\t\toption.WithAPIKey(\"My API Key\"),\n\t)\n\tresponse, err := client.Responses.New(context.TODO(), responses.ResponseNewParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf(\"%+v\\n\", response.ID)\n}\n","java":"package com.openai.example;\n\nimport com.openai.client.OpenAIClient;\nimport com.openai.client.okhttp.OpenAIOkHttpClient;\nimport com.openai.models.responses.Response;\nimport com.openai.models.responses.ResponseCreateParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n OpenAIClient client = OpenAIOkHttpClient.fromEnv();\n\n Response response = client.responses().create();\n }\n}","ruby":"require \"openai\"\n\nopenai = OpenAI::Client.new(api_key: \"My API Key\")\n\nresponse = openai.responses.create\n\nputs(response)"},"response":"event: response.created\ndata: {\"type\":\"response.created\",\"response\":{\"id\":\"resp_67c9fdcecf488190bdd9a0409de3a1ec07b8b0ad4e5eb654\",\"object\":\"response\",\"created_at\":1741290958,\"status\":\"in_progress\",\"error\":null,\"incomplete_details\":null,\"instructions\":\"You are a helpful assistant.\",\"max_output_tokens\":null,\"model\":\"gpt-5.4\",\"output\":[],\"parallel_tool_calls\":true,\"previous_response_id\":null,\"reasoning\":{\"effort\":null,\"summary\":null},\"store\":true,\"temperature\":1.0,\"text\":{\"format\":{\"type\":\"text\"}},\"tool_choice\":\"auto\",\"tools\":[],\"top_p\":1.0,\"truncation\":\"disabled\",\"usage\":null,\"user\":null,\"metadata\":{}}}\n\nevent: response.in_progress\ndata: {\"type\":\"response.in_progress\",\"response\":{\"id\":\"resp_67c9fdcecf488190bdd9a0409de3a1ec07b8b0ad4e5eb654\",\"object\":\"response\",\"created_at\":1741290958,\"status\":\"in_progress\",\"error\":null,\"incomplete_details\":null,\"instructions\":\"You are a helpful assistant.\",\"max_output_tokens\":null,\"model\":\"gpt-5.4\",\"output\":[],\"parallel_tool_calls\":true,\"previous_response_id\":null,\"reasoning\":{\"effort\":null,\"summary\":null},\"store\":true,\"temperature\":1.0,\"text\":{\"format\":{\"type\":\"text\"}},\"tool_choice\":\"auto\",\"tools\":[],\"top_p\":1.0,\"truncation\":\"disabled\",\"usage\":null,\"user\":null,\"metadata\":{}}}\n\nevent: response.output_item.added\ndata: {\"type\":\"response.output_item.added\",\"output_index\":0,\"item\":{\"id\":\"msg_67c9fdcf37fc8190ba82116e33fb28c507b8b0ad4e5eb654\",\"type\":\"message\",\"status\":\"in_progress\",\"role\":\"assistant\",\"content\":[]}}\n\nevent: response.content_part.added\ndata: {\"type\":\"response.content_part.added\",\"item_id\":\"msg_67c9fdcf37fc8190ba82116e33fb28c507b8b0ad4e5eb654\",\"output_index\":0,\"content_index\":0,\"part\":{\"type\":\"output_text\",\"text\":\"\",\"annotations\":[]}}\n\nevent: response.output_text.delta\ndata: {\"type\":\"response.output_text.delta\",\"item_id\":\"msg_67c9fdcf37fc8190ba82116e33fb28c507b8b0ad4e5eb654\",\"output_index\":0,\"content_index\":0,\"delta\":\"Hi\"}\n\n...\n\nevent: response.output_text.done\ndata: {\"type\":\"response.output_text.done\",\"item_id\":\"msg_67c9fdcf37fc8190ba82116e33fb28c507b8b0ad4e5eb654\",\"output_index\":0,\"content_index\":0,\"text\":\"Hi there! How can I assist you today?\"}\n\nevent: response.content_part.done\ndata: {\"type\":\"response.content_part.done\",\"item_id\":\"msg_67c9fdcf37fc8190ba82116e33fb28c507b8b0ad4e5eb654\",\"output_index\":0,\"content_index\":0,\"part\":{\"type\":\"output_text\",\"text\":\"Hi there! How can I assist you today?\",\"annotations\":[]}}\n\nevent: response.output_item.done\ndata: {\"type\":\"response.output_item.done\",\"output_index\":0,\"item\":{\"id\":\"msg_67c9fdcf37fc8190ba82116e33fb28c507b8b0ad4e5eb654\",\"type\":\"message\",\"status\":\"completed\",\"role\":\"assistant\",\"content\":[{\"type\":\"output_text\",\"text\":\"Hi there! How can I assist you today?\",\"annotations\":[]}]}}\n\nevent: response.completed\ndata: {\"type\":\"response.completed\",\"response\":{\"id\":\"resp_67c9fdcecf488190bdd9a0409de3a1ec07b8b0ad4e5eb654\",\"object\":\"response\",\"created_at\":1741290958,\"status\":\"completed\",\"error\":null,\"incomplete_details\":null,\"instructions\":\"You are a helpful assistant.\",\"max_output_tokens\":null,\"model\":\"gpt-5.4\",\"output\":[{\"id\":\"msg_67c9fdcf37fc8190ba82116e33fb28c507b8b0ad4e5eb654\",\"type\":\"message\",\"status\":\"completed\",\"role\":\"assistant\",\"content\":[{\"type\":\"output_text\",\"text\":\"Hi there! How can I assist you today?\",\"annotations\":[]}]}],\"parallel_tool_calls\":true,\"previous_response_id\":null,\"reasoning\":{\"effort\":null,\"summary\":null},\"store\":true,\"temperature\":1.0,\"text\":{\"format\":{\"type\":\"text\"}},\"tool_choice\":\"auto\",\"tools\":[],\"top_p\":1.0,\"truncation\":\"disabled\",\"usage\":{\"input_tokens\":37,\"output_tokens\":11,\"output_tokens_details\":{\"reasoning_tokens\":0},\"total_tokens\":48},\"user\":null,\"metadata\":{}}}\n"},{"title":"Functions","request":{"curl":"curl https://api.openai.com/v1/responses \\\n -H \"Content-Type: application/json\" \\\n -H \"Authorization: Bearer $OPENAI_API_KEY\" \\\n -d '{\n \"model\": \"gpt-5.4\",\n \"input\": \"What is the weather like in Boston today?\",\n \"tools\": [\n {\n \"type\": \"function\",\n \"name\": \"get_current_weather\",\n \"description\": \"Get the current weather in a given location\",\n \"parameters\": {\n \"type\": \"object\",\n \"properties\": {\n \"location\": {\n \"type\": \"string\",\n \"description\": \"The city and state, e.g. San Francisco, CA\"\n },\n \"unit\": {\n \"type\": \"string\",\n \"enum\": [\"celsius\", \"fahrenheit\"]\n }\n },\n \"required\": [\"location\", \"unit\"]\n }\n }\n ],\n \"tool_choice\": \"auto\"\n }'\n","python":"import os\nfrom openai import OpenAI\n\nclient = OpenAI(\n api_key=os.environ.get(\"OPENAI_API_KEY\"), # This is the default and can be omitted\n)\nfor response in client.responses.create():\n print(response)","javascript":"import OpenAI from \"openai\";\n\nconst openai = new OpenAI();\n\nconst tools = [\n {\n type: \"function\",\n name: \"get_current_weather\",\n description: \"Get the current weather in a given location\",\n parameters: {\n type: \"object\",\n properties: {\n location: {\n type: \"string\",\n description: \"The city and state, e.g. San Francisco, CA\",\n },\n unit: { type: \"string\", enum: [\"celsius\", \"fahrenheit\"] },\n },\n required: [\"location\", \"unit\"],\n },\n },\n];\n\nconst response = await openai.responses.create({\n model: \"gpt-5.4\",\n tools: tools,\n input: \"What is the weather like in Boston today?\",\n tool_choice: \"auto\",\n});\n\nconsole.log(response);\n","csharp":"using System;\nusing OpenAI.Responses;\n\nOpenAIResponseClient client = new(\n model: \"gpt-5.4\",\n apiKey: Environment.GetEnvironmentVariable(\"OPENAI_API_KEY\")\n);\n\nResponseTool getCurrentWeatherFunctionTool = ResponseTool.CreateFunctionTool(\n functionName: \"get_current_weather\",\n functionDescription: \"Get the current weather in a given location\",\n functionParameters: BinaryData.FromString(\"\"\"\n {\n \"type\": \"object\",\n \"properties\": {\n \"location\": {\n \"type\": \"string\",\n \"description\": \"The city and state, e.g. San Francisco, CA\"\n },\n \"unit\": {\"type\": \"string\", \"enum\": [\"celsius\", \"fahrenheit\"]}\n },\n \"required\": [\"location\", \"unit\"]\n }\n \"\"\"\n )\n);\n\nstring userInputText = \"What is the weather like in Boston today?\";\n\nResponseCreationOptions options = new()\n{\n Tools =\n {\n getCurrentWeatherFunctionTool\n },\n ToolChoice = ResponseToolChoice.CreateAutoChoice(),\n};\n\nOpenAIResponse response = client.CreateResponse(userInputText, options);\n","node.js":"import OpenAI from 'openai';\n\nconst client = new OpenAI({\n apiKey: process.env['OPENAI_API_KEY'], // This is the default and can be omitted\n});\n\nconst response = await client.responses.create();\n\nconsole.log(response.id);","go":"package main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\n\t\"github.com/openai/openai-go\"\n\t\"github.com/openai/openai-go/option\"\n\t\"github.com/openai/openai-go/responses\"\n)\n\nfunc main() {\n\tclient := openai.NewClient(\n\t\toption.WithAPIKey(\"My API Key\"),\n\t)\n\tresponse, err := client.Responses.New(context.TODO(), responses.ResponseNewParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf(\"%+v\\n\", response.ID)\n}\n","java":"package com.openai.example;\n\nimport com.openai.client.OpenAIClient;\nimport com.openai.client.okhttp.OpenAIOkHttpClient;\nimport com.openai.models.responses.Response;\nimport com.openai.models.responses.ResponseCreateParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n OpenAIClient client = OpenAIOkHttpClient.fromEnv();\n\n Response response = client.responses().create();\n }\n}","ruby":"require \"openai\"\n\nopenai = OpenAI::Client.new(api_key: \"My API Key\")\n\nresponse = openai.responses.create\n\nputs(response)"},"response":"{\n \"id\": \"resp_67ca09c5efe0819096d0511c92b8c890096610f474011cc0\",\n \"object\": \"response\",\n \"created_at\": 1741294021,\n \"status\": \"completed\",\n \"completed_at\": 1741294022,\n \"error\": null,\n \"incomplete_details\": null,\n \"instructions\": null,\n \"max_output_tokens\": null,\n \"model\": \"gpt-5.4\",\n \"output\": [\n {\n \"type\": \"function_call\",\n \"id\": \"fc_67ca09c6bedc8190a7abfec07b1a1332096610f474011cc0\",\n \"call_id\": \"call_unLAR8MvFNptuiZK6K6HCy5k\",\n \"name\": \"get_current_weather\",\n \"arguments\": \"{\\\"location\\\":\\\"Boston, MA\\\",\\\"unit\\\":\\\"celsius\\\"}\",\n \"status\": \"completed\"\n }\n ],\n \"parallel_tool_calls\": true,\n \"previous_response_id\": null,\n \"reasoning\": {\n \"effort\": null,\n \"summary\": null\n },\n \"store\": true,\n \"temperature\": 1.0,\n \"text\": {\n \"format\": {\n \"type\": \"text\"\n }\n },\n \"tool_choice\": \"auto\",\n \"tools\": [\n {\n \"type\": \"function\",\n \"description\": \"Get the current weather in a given location\",\n \"name\": \"get_current_weather\",\n \"parameters\": {\n \"type\": \"object\",\n \"properties\": {\n \"location\": {\n \"type\": \"string\",\n \"description\": \"The city and state, e.g. San Francisco, CA\"\n },\n \"unit\": {\n \"type\": \"string\",\n \"enum\": [\n \"celsius\",\n \"fahrenheit\"\n ]\n }\n },\n \"required\": [\n \"location\",\n \"unit\"\n ]\n },\n \"strict\": true\n }\n ],\n \"top_p\": 1.0,\n \"truncation\": \"disabled\",\n \"usage\": {\n \"input_tokens\": 291,\n \"output_tokens\": 23,\n \"output_tokens_details\": {\n \"reasoning_tokens\": 0\n },\n \"total_tokens\": 314\n },\n \"user\": null,\n \"metadata\": {}\n}\n"},{"title":"Reasoning","request":{"curl":"curl https://api.openai.com/v1/responses \\\n -H \"Content-Type: application/json\" \\\n -H \"Authorization: Bearer $OPENAI_API_KEY\" \\\n -d '{\n \"model\": \"o3-mini\",\n \"input\": \"How much wood would a woodchuck chuck?\",\n \"reasoning\": {\n \"effort\": \"high\"\n }\n }'\n","javascript":"import OpenAI from \"openai\";\nconst openai = new OpenAI();\n\nconst response = await openai.responses.create({\n model: \"o3-mini\",\n input: \"How much wood would a woodchuck chuck?\",\n reasoning: {\n effort: \"high\"\n }\n});\n\nconsole.log(response);\n","python":"import os\nfrom openai import OpenAI\n\nclient = OpenAI(\n api_key=os.environ.get(\"OPENAI_API_KEY\"), # This is the default and can be omitted\n)\nfor response in client.responses.create():\n print(response)","csharp":"using System;\nusing OpenAI.Responses;\n\nOpenAIResponseClient client = new(\n model: \"o3-mini\",\n apiKey: Environment.GetEnvironmentVariable(\"OPENAI_API_KEY\")\n);\n\nstring userInputText = \"How much wood would a woodchuck chuck?\";\n\nResponseCreationOptions options = new()\n{\n ReasoningOptions = new()\n {\n ReasoningEffortLevel = ResponseReasoningEffortLevel.High,\n },\n};\n\nOpenAIResponse response = client.CreateResponse(userInputText, options);\n\nConsole.WriteLine(response.GetOutputText());\n","node.js":"import OpenAI from 'openai';\n\nconst client = new OpenAI({\n apiKey: process.env['OPENAI_API_KEY'], // This is the default and can be omitted\n});\n\nconst response = await client.responses.create();\n\nconsole.log(response.id);","go":"package main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\n\t\"github.com/openai/openai-go\"\n\t\"github.com/openai/openai-go/option\"\n\t\"github.com/openai/openai-go/responses\"\n)\n\nfunc main() {\n\tclient := openai.NewClient(\n\t\toption.WithAPIKey(\"My API Key\"),\n\t)\n\tresponse, err := client.Responses.New(context.TODO(), responses.ResponseNewParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf(\"%+v\\n\", response.ID)\n}\n","java":"package com.openai.example;\n\nimport com.openai.client.OpenAIClient;\nimport com.openai.client.okhttp.OpenAIOkHttpClient;\nimport com.openai.models.responses.Response;\nimport com.openai.models.responses.ResponseCreateParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n OpenAIClient client = OpenAIOkHttpClient.fromEnv();\n\n Response response = client.responses().create();\n }\n}","ruby":"require \"openai\"\n\nopenai = OpenAI::Client.new(api_key: \"My API Key\")\n\nresponse = openai.responses.create\n\nputs(response)"},"response":"{\n \"id\": \"resp_67ccd7eca01881908ff0b5146584e408072912b2993db808\",\n \"object\": \"response\",\n \"created_at\": 1741477868,\n \"status\": \"completed\",\n \"completed_at\": 1741477869,\n \"error\": null,\n \"incomplete_details\": null,\n \"instructions\": null,\n \"max_output_tokens\": null,\n \"model\": \"o1-2024-12-17\",\n \"output\": [\n {\n \"type\": \"message\",\n \"id\": \"msg_67ccd7f7b5848190a6f3e95d809f6b44072912b2993db808\",\n \"status\": \"completed\",\n \"role\": \"assistant\",\n \"content\": [\n {\n \"type\": \"output_text\",\n \"text\": \"The classic tongue twister...\",\n \"annotations\": []\n }\n ]\n }\n ],\n \"parallel_tool_calls\": true,\n \"previous_response_id\": null,\n \"reasoning\": {\n \"effort\": \"high\",\n \"summary\": null\n },\n \"store\": true,\n \"temperature\": 1.0,\n \"text\": {\n \"format\": {\n \"type\": \"text\"\n }\n },\n \"tool_choice\": \"auto\",\n \"tools\": [],\n \"top_p\": 1.0,\n \"truncation\": \"disabled\",\n \"usage\": {\n \"input_tokens\": 81,\n \"input_tokens_details\": {\n \"cached_tokens\": 0\n },\n \"output_tokens\": 1035,\n \"output_tokens_details\": {\n \"reasoning_tokens\": 832\n },\n \"total_tokens\": 1116\n },\n \"user\": null,\n \"metadata\": {}\n}\n"}]}}},"/responses/{response_id}":{"get":{"operationId":"getResponse","tags":["Responses"],"summary":"Retrieves a model response with the given ID.\n","parameters":[{"in":"path","name":"response_id","required":true,"schema":{"type":"string","example":"resp_677efb5139a88190b512bc3fef8e535d"},"description":"The ID of the response to retrieve."},{"in":"query","name":"include","schema":{"type":"array","items":{"$ref":"#/components/schemas/IncludeEnum"}},"description":"Additional fields to include in the response. See the `include`\nparameter for Response creation above for more information.\n"},{"in":"query","name":"stream","schema":{"type":"boolean"},"description":"If set to true, the model response data will be streamed to the client\nas it is generated using [server-sent events](https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events/Using_server-sent_events#Event_stream_format).\nSee the [Streaming section below](/docs/api-reference/responses-streaming)\nfor more information.\n"},{"in":"query","name":"starting_after","schema":{"type":"integer"},"description":"The sequence number of the event after which to start streaming.\n"},{"in":"query","name":"include_obfuscation","schema":{"type":"boolean"},"description":"When true, stream obfuscation will be enabled. Stream obfuscation adds\nrandom characters to an `obfuscation` field on streaming delta events\nto normalize payload sizes as a mitigation to certain side-channel\nattacks. These obfuscation fields are included by default, but add a\nsmall amount of overhead to the data stream. You can set\n`include_obfuscation` to false to optimize for bandwidth if you trust\nthe network links between your application and the OpenAI API.\n"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}}}},"x-oaiMeta":{"name":"Get a model response","group":"responses","examples":{"request":{"curl":"curl https://api.openai.com/v1/responses/resp_123 \\\n -H \"Content-Type: application/json\" \\\n -H \"Authorization: Bearer $OPENAI_API_KEY\"\n","javascript":"import OpenAI from \"openai\";\nconst client = new OpenAI();\n\nconst response = await client.responses.retrieve(\"resp_123\");\nconsole.log(response);\n","python":"import os\nfrom openai import OpenAI\n\nclient = OpenAI(\n api_key=os.environ.get(\"OPENAI_API_KEY\"), # This is the default and can be omitted\n)\nfor response in client.responses.retrieve(\n response_id=\"resp_677efb5139a88190b512bc3fef8e535d\",\n):\n print(response)","node.js":"import OpenAI from 'openai';\n\nconst client = new OpenAI({\n apiKey: process.env['OPENAI_API_KEY'], // This is the default and can be omitted\n});\n\nconst response = await client.responses.retrieve('resp_677efb5139a88190b512bc3fef8e535d');\n\nconsole.log(response.id);","go":"package main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\n\t\"github.com/openai/openai-go\"\n\t\"github.com/openai/openai-go/option\"\n\t\"github.com/openai/openai-go/responses\"\n)\n\nfunc main() {\n\tclient := openai.NewClient(\n\t\toption.WithAPIKey(\"My API Key\"),\n\t)\n\tresponse, err := client.Responses.Get(\n\t\tcontext.TODO(),\n\t\t\"resp_677efb5139a88190b512bc3fef8e535d\",\n\t\tresponses.ResponseGetParams{},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf(\"%+v\\n\", response.ID)\n}\n","java":"package com.openai.example;\n\nimport com.openai.client.OpenAIClient;\nimport com.openai.client.okhttp.OpenAIOkHttpClient;\nimport com.openai.models.responses.Response;\nimport com.openai.models.responses.ResponseRetrieveParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n OpenAIClient client = OpenAIOkHttpClient.fromEnv();\n\n Response response = client.responses().retrieve(\"resp_677efb5139a88190b512bc3fef8e535d\");\n }\n}","ruby":"require \"openai\"\n\nopenai = OpenAI::Client.new(api_key: \"My API Key\")\n\nresponse = openai.responses.retrieve(\"resp_677efb5139a88190b512bc3fef8e535d\")\n\nputs(response)"},"response":"{\n \"id\": \"resp_67cb71b351908190a308f3859487620d06981a8637e6bc44\",\n \"object\": \"response\",\n \"created_at\": 1741386163,\n \"status\": \"completed\",\n \"completed_at\": 1741386164,\n \"error\": null,\n \"incomplete_details\": null,\n \"instructions\": null,\n \"max_output_tokens\": null,\n \"model\": \"gpt-4o-2024-08-06\",\n \"output\": [\n {\n \"type\": \"message\",\n \"id\": \"msg_67cb71b3c2b0819084d481baaaf148f206981a8637e6bc44\",\n \"status\": \"completed\",\n \"role\": \"assistant\",\n \"content\": [\n {\n \"type\": \"output_text\",\n \"text\": \"Silent circuits hum, \\nThoughts emerge in data streams— \\nDigital dawn breaks.\",\n \"annotations\": []\n }\n ]\n }\n ],\n \"parallel_tool_calls\": true,\n \"previous_response_id\": null,\n \"reasoning\": {\n \"effort\": null,\n \"summary\": null\n },\n \"store\": true,\n \"temperature\": 1.0,\n \"text\": {\n \"format\": {\n \"type\": \"text\"\n }\n },\n \"tool_choice\": \"auto\",\n \"tools\": [],\n \"top_p\": 1.0,\n \"truncation\": \"disabled\",\n \"usage\": {\n \"input_tokens\": 32,\n \"input_tokens_details\": {\n \"cached_tokens\": 0\n },\n \"output_tokens\": 18,\n \"output_tokens_details\": {\n \"reasoning_tokens\": 0\n },\n \"total_tokens\": 50\n },\n \"user\": null,\n \"metadata\": {}\n}\n"}}},"delete":{"operationId":"deleteResponse","tags":["Responses"],"summary":"Deletes a model response with the given ID.\n","parameters":[{"in":"path","name":"response_id","required":true,"schema":{"type":"string","example":"resp_677efb5139a88190b512bc3fef8e535d"},"description":"The ID of the response to delete."}],"responses":{"200":{"description":"OK"},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-oaiMeta":{"name":"Delete a model response","group":"responses","examples":{"request":{"curl":"curl -X DELETE https://api.openai.com/v1/responses/resp_123 \\\n -H \"Content-Type: application/json\" \\\n -H \"Authorization: Bearer $OPENAI_API_KEY\"\n","javascript":"import OpenAI from \"openai\";\nconst client = new OpenAI();\n\nconst response = await client.responses.delete(\"resp_123\");\nconsole.log(response);\n","python":"import os\nfrom openai import OpenAI\n\nclient = OpenAI(\n api_key=os.environ.get(\"OPENAI_API_KEY\"), # This is the default and can be omitted\n)\nclient.responses.delete(\n \"resp_677efb5139a88190b512bc3fef8e535d\",\n)","node.js":"import OpenAI from 'openai';\n\nconst client = new OpenAI({\n apiKey: process.env['OPENAI_API_KEY'], // This is the default and can be omitted\n});\n\nawait client.responses.delete('resp_677efb5139a88190b512bc3fef8e535d');","go":"package main\n\nimport (\n\t\"context\"\n\n\t\"github.com/openai/openai-go\"\n\t\"github.com/openai/openai-go/option\"\n)\n\nfunc main() {\n\tclient := openai.NewClient(\n\t\toption.WithAPIKey(\"My API Key\"),\n\t)\n\terr := client.Responses.Delete(context.TODO(), \"resp_677efb5139a88190b512bc3fef8e535d\")\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n","java":"package com.openai.example;\n\nimport com.openai.client.OpenAIClient;\nimport com.openai.client.okhttp.OpenAIOkHttpClient;\nimport com.openai.models.responses.ResponseDeleteParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n OpenAIClient client = OpenAIOkHttpClient.fromEnv();\n\n client.responses().delete(\"resp_677efb5139a88190b512bc3fef8e535d\");\n }\n}","ruby":"require \"openai\"\n\nopenai = OpenAI::Client.new(api_key: \"My API Key\")\n\nresult = openai.responses.delete(\"resp_677efb5139a88190b512bc3fef8e535d\")\n\nputs(result)"},"response":"{\n \"id\": \"resp_6786a1bec27481909a17d673315b29f6\",\n \"object\": \"response\",\n \"deleted\": true\n}\n"}}}},"/responses/{response_id}/cancel":{"post":{"operationId":"cancelResponse","tags":["Responses"],"summary":"Cancels a model response with the given ID. Only responses created with\nthe `background` parameter set to `true` can be cancelled. \n[Learn more](/docs/guides/background).\n","parameters":[{"in":"path","name":"response_id","required":true,"schema":{"type":"string","example":"resp_677efb5139a88190b512bc3fef8e535d"},"description":"The ID of the response to cancel."}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-oaiMeta":{"name":"Cancel a response","group":"responses","examples":{"request":{"curl":"curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \\\n -H \"Content-Type: application/json\" \\\n -H \"Authorization: Bearer $OPENAI_API_KEY\"\n","javascript":"import OpenAI from \"openai\";\nconst client = new OpenAI();\n\nconst response = await client.responses.cancel(\"resp_123\");\nconsole.log(response);\n","python":"import os\nfrom openai import OpenAI\n\nclient = OpenAI(\n api_key=os.environ.get(\"OPENAI_API_KEY\"), # This is the default and can be omitted\n)\nresponse = client.responses.cancel(\n \"resp_677efb5139a88190b512bc3fef8e535d\",\n)\nprint(response.id)","node.js":"import OpenAI from 'openai';\n\nconst client = new OpenAI({\n apiKey: process.env['OPENAI_API_KEY'], // This is the default and can be omitted\n});\n\nconst response = await client.responses.cancel('resp_677efb5139a88190b512bc3fef8e535d');\n\nconsole.log(response.id);","go":"package main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\n\t\"github.com/openai/openai-go\"\n\t\"github.com/openai/openai-go/option\"\n)\n\nfunc main() {\n\tclient := openai.NewClient(\n\t\toption.WithAPIKey(\"My API Key\"),\n\t)\n\tresponse, err := client.Responses.Cancel(context.TODO(), \"resp_677efb5139a88190b512bc3fef8e535d\")\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf(\"%+v\\n\", response.ID)\n}\n","java":"package com.openai.example;\n\nimport com.openai.client.OpenAIClient;\nimport com.openai.client.okhttp.OpenAIOkHttpClient;\nimport com.openai.models.responses.Response;\nimport com.openai.models.responses.ResponseCancelParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n OpenAIClient client = OpenAIOkHttpClient.fromEnv();\n\n Response response = client.responses().cancel(\"resp_677efb5139a88190b512bc3fef8e535d\");\n }\n}","ruby":"require \"openai\"\n\nopenai = OpenAI::Client.new(api_key: \"My API Key\")\n\nresponse = openai.responses.cancel(\"resp_677efb5139a88190b512bc3fef8e535d\")\n\nputs(response)"},"response":"{\n \"id\": \"resp_67cb71b351908190a308f3859487620d06981a8637e6bc44\",\n \"object\": \"response\",\n \"created_at\": 1741386163,\n \"status\": \"cancelled\",\n \"background\": true,\n \"completed_at\": null,\n \"error\": null,\n \"incomplete_details\": null,\n \"instructions\": null,\n \"max_output_tokens\": null,\n \"model\": \"gpt-4o-2024-08-06\",\n \"output\": [\n {\n \"type\": \"message\",\n \"id\": \"msg_67cb71b3c2b0819084d481baaaf148f206981a8637e6bc44\",\n \"status\": \"in_progress\",\n \"role\": \"assistant\",\n \"content\": [\n {\n \"type\": \"output_text\",\n \"text\": \"Silent circuits hum, \\nThoughts emerge in data streams— \\nDigital dawn breaks.\",\n \"annotations\": []\n }\n ]\n }\n ],\n \"parallel_tool_calls\": true,\n \"previous_response_id\": null,\n \"reasoning\": {\n \"effort\": null,\n \"summary\": null\n },\n \"store\": true,\n \"temperature\": 1.0,\n \"text\": {\n \"format\": {\n \"type\": \"text\"\n }\n },\n \"tool_choice\": \"auto\",\n \"tools\": [],\n \"top_p\": 1.0,\n \"truncation\": \"disabled\",\n \"usage\": null,\n \"user\": null,\n \"metadata\": {}\n}\n"}}}},"/responses/{response_id}/input_items":{"get":{"operationId":"listInputItems","tags":["Responses"],"summary":"Returns a list of input items for a given response.","parameters":[{"in":"path","name":"response_id","required":true,"schema":{"type":"string"},"description":"The ID of the response to retrieve input items for."},{"name":"limit","in":"query","description":"A limit on the number of objects to be returned. Limit can range between\n1 and 100, and the default is 20.\n","required":false,"schema":{"type":"integer","default":20}},{"in":"query","name":"order","schema":{"type":"string","enum":["asc","desc"]},"description":"The order to return the input items in. Default is `desc`.\n- `asc`: Return the input items in ascending order.\n- `desc`: Return the input items in descending order.\n"},{"in":"query","name":"after","schema":{"type":"string"},"description":"An item ID to list items after, used in pagination.\n"},{"in":"query","name":"include","schema":{"type":"array","items":{"$ref":"#/components/schemas/IncludeEnum"}},"description":"Additional fields to include in the response. See the `include`\nparameter for Response creation above for more information.\n"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseItemList"}}}}},"x-oaiMeta":{"name":"List input items","group":"responses","examples":{"request":{"curl":"curl https://api.openai.com/v1/responses/resp_abc123/input_items \\\n -H \"Content-Type: application/json\" \\\n -H \"Authorization: Bearer $OPENAI_API_KEY\"\n","javascript":"import OpenAI from \"openai\";\nconst client = new OpenAI();\n\nconst response = await client.responses.inputItems.list(\"resp_123\");\nconsole.log(response.data);\n","python":"import os\nfrom openai import OpenAI\n\nclient = OpenAI(\n api_key=os.environ.get(\"OPENAI_API_KEY\"), # This is the default and can be omitted\n)\npage = client.responses.input_items.list(\n response_id=\"response_id\",\n)\npage = page.data[0]\nprint(page)","node.js":"import OpenAI from 'openai';\n\nconst client = new OpenAI({\n apiKey: process.env['OPENAI_API_KEY'], // This is the default and can be omitted\n});\n\n// Automatically fetches more pages as needed.\nfor await (const responseItem of client.responses.inputItems.list('response_id')) {\n console.log(responseItem);\n}","go":"package main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\n\t\"github.com/openai/openai-go\"\n\t\"github.com/openai/openai-go/option\"\n\t\"github.com/openai/openai-go/responses\"\n)\n\nfunc main() {\n\tclient := openai.NewClient(\n\t\toption.WithAPIKey(\"My API Key\"),\n\t)\n\tpage, err := client.Responses.InputItems.List(\n\t\tcontext.TODO(),\n\t\t\"response_id\",\n\t\tresponses.InputItemListParams{},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf(\"%+v\\n\", page)\n}\n","java":"package com.openai.example;\n\nimport com.openai.client.OpenAIClient;\nimport com.openai.client.okhttp.OpenAIOkHttpClient;\nimport com.openai.models.responses.inputitems.InputItemListPage;\nimport com.openai.models.responses.inputitems.InputItemListParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n OpenAIClient client = OpenAIOkHttpClient.fromEnv();\n\n InputItemListPage page = client.responses().inputItems().list(\"response_id\");\n }\n}","ruby":"require \"openai\"\n\nopenai = OpenAI::Client.new(api_key: \"My API Key\")\n\npage = openai.responses.input_items.list(\"response_id\")\n\nputs(page)"},"response":"{\n \"object\": \"list\",\n \"data\": [\n {\n \"id\": \"msg_abc123\",\n \"type\": \"message\",\n \"role\": \"user\",\n \"content\": [\n {\n \"type\": \"input_text\",\n \"text\": \"Tell me a three sentence bedtime story about a unicorn.\"\n }\n ]\n }\n ],\n \"first_id\": \"msg_abc123\",\n \"last_id\": \"msg_abc123\",\n \"has_more\": false\n}\n"}}}},"/threads":{"post":{"operationId":"createThread","tags":["Assistants"],"summary":"Create a thread.","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateThreadRequest"}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThreadObject"}}}}},"x-oaiMeta":{"name":"Create thread","group":"threads","beta":true,"examples":[{"title":"Empty","request":{"curl":"curl https://api.openai.com/v1/threads \\\n -H \"Content-Type: application/json\" \\\n -H \"Authorization: Bearer $OPENAI_API_KEY\" \\\n -H \"OpenAI-Beta: assistants=v2\" \\\n -d ''\n","python":"import os\nfrom openai import OpenAI\n\nclient = OpenAI(\n api_key=os.environ.get(\"OPENAI_API_KEY\"), # This is the default and can be omitted\n)\nthread = client.beta.threads.create()\nprint(thread.id)","javascript":"import OpenAI from \"openai\";\n\nconst openai = new OpenAI();\n\nasync function main() {\n const emptyThread = await openai.beta.threads.create();\n\n console.log(emptyThread);\n}\n\nmain();","node.js":"import OpenAI from 'openai';\n\nconst client = new OpenAI({\n apiKey: process.env['OPENAI_API_KEY'], // This is the default and can be omitted\n});\n\nconst thread = await client.beta.threads.create();\n\nconsole.log(thread.id);","go":"package main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\n\t\"github.com/openai/openai-go\"\n\t\"github.com/openai/openai-go/option\"\n)\n\nfunc main() {\n\tclient := openai.NewClient(\n\t\toption.WithAPIKey(\"My API Key\"),\n\t)\n\tthread, err := client.Beta.Threads.New(context.TODO(), openai.BetaThreadNewParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf(\"%+v\\n\", thread.ID)\n}\n","java":"package com.openai.example;\n\nimport com.openai.client.OpenAIClient;\nimport com.openai.client.okhttp.OpenAIOkHttpClient;\nimport com.openai.models.beta.threads.Thread;\nimport com.openai.models.beta.threads.ThreadCreateParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n OpenAIClient client = OpenAIOkHttpClient.fromEnv();\n\n Thread thread = client.beta().threads().create();\n }\n}","ruby":"require \"openai\"\n\nopenai = OpenAI::Client.new(api_key: \"My API Key\")\n\nthread = openai.beta.threads.create\n\nputs(thread)"},"response":"{\n \"id\": \"thread_abc123\",\n \"object\": \"thread\",\n \"created_at\": 1699012949,\n \"metadata\": {},\n \"tool_resources\": {}\n}\n"},{"title":"Messages","request":{"curl":"curl https://api.openai.com/v1/threads \\\n-H \"Content-Type: application/json\" \\\n-H \"Authorization: Bearer $OPENAI_API_KEY\" \\\n-H \"OpenAI-Beta: assistants=v2\" \\\n-d '{\n \"messages\": [{\n \"role\": \"user\",\n \"content\": \"Hello, what is AI?\"\n }, {\n \"role\": \"user\",\n \"content\": \"How does AI work? Explain it in simple terms.\"\n }]\n }'\n","python":"import os\nfrom openai import OpenAI\n\nclient = OpenAI(\n api_key=os.environ.get(\"OPENAI_API_KEY\"), # This is the default and can be omitted\n)\nthread = client.beta.threads.create()\nprint(thread.id)","javascript":"import OpenAI from \"openai\";\n\nconst openai = new OpenAI();\n\nasync function main() {\n const messageThread = await openai.beta.threads.create({\n messages: [\n {\n role: \"user\",\n content: \"Hello, what is AI?\"\n },\n {\n role: \"user\",\n content: \"How does AI work? Explain it in simple terms.\",\n },\n ],\n });\n\n console.log(messageThread);\n}\n\nmain();","node.js":"import OpenAI from 'openai';\n\nconst client = new OpenAI({\n apiKey: process.env['OPENAI_API_KEY'], // This is the default and can be omitted\n});\n\nconst thread = await client.beta.threads.create();\n\nconsole.log(thread.id);","go":"package main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\n\t\"github.com/openai/openai-go\"\n\t\"github.com/openai/openai-go/option\"\n)\n\nfunc main() {\n\tclient := openai.NewClient(\n\t\toption.WithAPIKey(\"My API Key\"),\n\t)\n\tthread, err := client.Beta.Threads.New(context.TODO(), openai.BetaThreadNewParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf(\"%+v\\n\", thread.ID)\n}\n","java":"package com.openai.example;\n\nimport com.openai.client.OpenAIClient;\nimport com.openai.client.okhttp.OpenAIOkHttpClient;\nimport com.openai.models.beta.threads.Thread;\nimport com.openai.models.beta.threads.ThreadCreateParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n OpenAIClient client = OpenAIOkHttpClient.fromEnv();\n\n Thread thread = client.beta().threads().create();\n }\n}","ruby":"require \"openai\"\n\nopenai = OpenAI::Client.new(api_key: \"My API Key\")\n\nthread = openai.beta.threads.create\n\nputs(thread)"},"response":"{\n \"id\": \"thread_abc123\",\n \"object\": \"thread\",\n \"created_at\": 1699014083,\n \"metadata\": {},\n \"tool_resources\": {}\n}\n"}]}}},"/threads/runs":{"post":{"operationId":"createThreadAndRun","tags":["Assistants"],"summary":"Create a thread and run it in one request.","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateThreadAndRunRequest"}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunObject"}}}}},"x-oaiMeta":{"name":"Create thread and run","group":"threads","beta":true,"examples":[{"title":"Default","request":{"curl":"curl https://api.openai.com/v1/threads/runs \\\n -H \"Authorization: Bearer $OPENAI_API_KEY\" \\\n -H \"Content-Type: application/json\" \\\n -H \"OpenAI-Beta: assistants=v2\" \\\n -d '{\n \"assistant_id\": \"asst_abc123\",\n \"thread\": {\n \"messages\": [\n {\"role\": \"user\", \"content\": \"Explain deep learning to a 5 year old.\"}\n ]\n }\n }'\n","python":"import os\nfrom openai import OpenAI\n\nclient = OpenAI(\n api_key=os.environ.get(\"OPENAI_API_KEY\"), # This is the default and can be omitted\n)\nfor thread in client.beta.threads.create_and_run(\n assistant_id=\"assistant_id\",\n):\n print(thread)","javascript":"import OpenAI from \"openai\";\n\nconst openai = new OpenAI();\n\nasync function main() {\n const run = await openai.beta.threads.createAndRun({\n assistant_id: \"asst_abc123\",\n thread: {\n messages: [\n { role: \"user\", content: \"Explain deep learning to a 5 year old.\" },\n ],\n },\n });\n\n console.log(run);\n}\n\nmain();\n","node.js":"import OpenAI from 'openai';\n\nconst client = new OpenAI({\n apiKey: process.env['OPENAI_API_KEY'], // This is the default and can be omitted\n});\n\nconst run = await client.beta.threads.createAndRun({ assistant_id: 'assistant_id' });\n\nconsole.log(run.id);","go":"package main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\n\t\"github.com/openai/openai-go\"\n\t\"github.com/openai/openai-go/option\"\n)\n\nfunc main() {\n\tclient := openai.NewClient(\n\t\toption.WithAPIKey(\"My API Key\"),\n\t)\n\trun, err := client.Beta.Threads.NewAndRun(context.TODO(), openai.BetaThreadNewAndRunParams{\n\t\tAssistantID: \"assistant_id\",\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf(\"%+v\\n\", run.ID)\n}\n","java":"package com.openai.example;\n\nimport com.openai.client.OpenAIClient;\nimport com.openai.client.okhttp.OpenAIOkHttpClient;\nimport com.openai.models.beta.threads.ThreadCreateAndRunParams;\nimport com.openai.models.beta.threads.runs.Run;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n OpenAIClient client = OpenAIOkHttpClient.fromEnv();\n\n ThreadCreateAndRunParams params = ThreadCreateAndRunParams.builder()\n .assistantId(\"assistant_id\")\n .build();\n Run run = client.beta().threads().createAndRun(params);\n }\n}","ruby":"require \"openai\"\n\nopenai = OpenAI::Client.new(api_key: \"My API Key\")\n\nrun = openai.beta.threads.create_and_run(assistant_id: \"assistant_id\")\n\nputs(run)"},"response":"{\n \"id\": \"run_abc123\",\n \"object\": \"thread.run\",\n \"created_at\": 1699076792,\n \"assistant_id\": \"asst_abc123\",\n \"thread_id\": \"thread_abc123\",\n \"status\": \"queued\",\n \"started_at\": null,\n \"expires_at\": 1699077392,\n \"cancelled_at\": null,\n \"failed_at\": null,\n \"completed_at\": null,\n \"required_action\": null,\n \"last_error\": null,\n \"model\": \"gpt-4o\",\n \"instructions\": \"You are a helpful assistant.\",\n \"tools\": [],\n \"tool_resources\": {},\n \"metadata\": {},\n \"temperature\": 1.0,\n \"top_p\": 1.0,\n \"max_completion_tokens\": null,\n \"max_prompt_tokens\": null,\n \"truncation_strategy\": {\n \"type\": \"auto\",\n \"last_messages\": null\n },\n \"incomplete_details\": null,\n \"usage\": null,\n \"response_format\": \"auto\",\n \"tool_choice\": \"auto\",\n \"parallel_tool_calls\": true\n}\n"},{"title":"Streaming","request":{"curl":"curl https://api.openai.com/v1/threads/runs \\\n -H \"Authorization: Bearer $OPENAI_API_KEY\" \\\n -H \"Content-Type: application/json\" \\\n -H \"OpenAI-Beta: assistants=v2\" \\\n -d '{\n \"assistant_id\": \"asst_123\",\n \"thread\": {\n \"messages\": [\n {\"role\": \"user\", \"content\": \"Hello\"}\n ]\n },\n \"stream\": true\n }'\n","python":"import os\nfrom openai import OpenAI\n\nclient = OpenAI(\n api_key=os.environ.get(\"OPENAI_API_KEY\"), # This is the default and can be omitted\n)\nfor thread in client.beta.threads.create_and_run(\n assistant_id=\"assistant_id\",\n):\n print(thread)","javascript":"import OpenAI from \"openai\";\n\nconst openai = new OpenAI();\n\nasync function main() {\n const stream = await openai.beta.threads.createAndRun({\n assistant_id: \"asst_123\",\n thread: {\n messages: [\n { role: \"user\", content: \"Hello\" },\n ],\n },\n stream: true\n });\n\n for await (const event of stream) {\n console.log(event);\n }\n}\n\nmain();\n","node.js":"import OpenAI from 'openai';\n\nconst client = new OpenAI({\n apiKey: process.env['OPENAI_API_KEY'], // This is the default and can be omitted\n});\n\nconst run = await client.beta.threads.createAndRun({ assistant_id: 'assistant_id' });\n\nconsole.log(run.id);","go":"package main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\n\t\"github.com/openai/openai-go\"\n\t\"github.com/openai/openai-go/option\"\n)\n\nfunc main() {\n\tclient := openai.NewClient(\n\t\toption.WithAPIKey(\"My API Key\"),\n\t)\n\trun, err := client.Beta.Threads.NewAndRun(context.TODO(), openai.BetaThreadNewAndRunParams{\n\t\tAssistantID: \"assistant_id\",\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf(\"%+v\\n\", run.ID)\n}\n","java":"package com.openai.example;\n\nimport com.openai.client.OpenAIClient;\nimport com.openai.client.okhttp.OpenAIOkHttpClient;\nimport com.openai.models.beta.threads.ThreadCreateAndRunParams;\nimport com.openai.models.beta.threads.runs.Run;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n OpenAIClient client = OpenAIOkHttpClient.fromEnv();\n\n ThreadCreateAndRunParams params = ThreadCreateAndRunParams.builder()\n .assistantId(\"assistant_id\")\n .build();\n Run run = client.beta().threads().createAndRun(params);\n }\n}","ruby":"require \"openai\"\n\nopenai = OpenAI::Client.new(api_key: \"My API Key\")\n\nrun = openai.beta.threads.create_and_run(assistant_id: \"assistant_id\")\n\nputs(run)"},"response":"event: thread.created\ndata: {\"id\":\"thread_123\",\"object\":\"thread\",\"created_at\":1710348075,\"metadata\":{}}\n\nevent: thread.run.created\ndata: {\"id\":\"run_123\",\"object\":\"thread.run\",\"created_at\":1710348075,\"assistant_id\":\"asst_123\",\"thread_id\":\"thread_123\",\"status\":\"queued\",\"started_at\":null,\"expires_at\":1710348675,\"cancelled_at\":null,\"failed_at\":null,\"completed_at\":null,\"required_action\":null,\"last_error\":null,\"model\":\"gpt-4o\",\"instructions\":null,\"tools\":[],\"tool_resources\":{},\"metadata\":{},\"temperature\":1.0,\"top_p\":1.0,\"max_completion_tokens\":null,\"max_prompt_tokens\":null,\"truncation_strategy\":{\"type\":\"auto\",\"last_messages\":null},\"incomplete_details\":null,\"usage\":null,\"response_format\":\"auto\",\"tool_choice\":\"auto\",\"parallel_tool_calls\":true}\n\nevent: thread.run.queued\ndata: {\"id\":\"run_123\",\"object\":\"thread.run\",\"created_at\":1710348075,\"assistant_id\":\"asst_123\",\"thread_id\":\"thread_123\",\"status\":\"queued\",\"started_at\":null,\"expires_at\":1710348675,\"cancelled_at\":null,\"failed_at\":null,\"completed_at\":null,\"required_action\":null,\"last_error\":null,\"model\":\"gpt-4o\",\"instructions\":null,\"tools\":[],\"tool_resources\":{},\"metadata\":{},\"temperature\":1.0,\"top_p\":1.0,\"max_completion_tokens\":null,\"max_prompt_tokens\":null,\"truncation_strategy\":{\"type\":\"auto\",\"last_messages\":null},\"incomplete_details\":null,\"usage\":null,\"response_format\":\"auto\",\"tool_choice\":\"auto\",\"parallel_tool_calls\":true}\n\nevent: thread.run.in_progress\ndata: {\"id\":\"run_123\",\"object\":\"thread.run\",\"created_at\":1710348075,\"assistant_id\":\"asst_123\",\"thread_id\":\"thread_123\",\"status\":\"in_progress\",\"started_at\":null,\"expires_at\":1710348675,\"cancelled_at\":null,\"failed_at\":null,\"completed_at\":null,\"required_action\":null,\"last_error\":null,\"model\":\"gpt-4o\",\"instructions\":null,\"tools\":[],\"tool_resources\":{},\"metadata\":{},\"temperature\":1.0,\"top_p\":1.0,\"max_completion_tokens\":null,\"max_prompt_tokens\":null,\"truncation_strategy\":{\"type\":\"auto\",\"last_messages\":null},\"incomplete_details\":null,\"usage\":null,\"response_format\":\"auto\",\"tool_choice\":\"auto\",\"parallel_tool_calls\":true}\n\nevent: thread.run.step.created\ndata: {\"id\":\"step_001\",\"object\":\"thread.run.step\",\"created_at\":1710348076,\"run_id\":\"run_123\",\"assistant_id\":\"asst_123\",\"thread_id\":\"thread_123\",\"type\":\"message_creation\",\"status\":\"in_progress\",\"cancelled_at\":null,\"completed_at\":null,\"expires_at\":1710348675,\"failed_at\":null,\"last_error\":null,\"step_details\":{\"type\":\"message_creation\",\"message_creation\":{\"message_id\":\"msg_001\"}},\"usage\":null}\n\nevent: thread.run.step.in_progress\ndata: {\"id\":\"step_001\",\"object\":\"thread.run.step\",\"created_at\":1710348076,\"run_id\":\"run_123\",\"assistant_id\":\"asst_123\",\"thread_id\":\"thread_123\",\"type\":\"message_creation\",\"status\":\"in_progress\",\"cancelled_at\":null,\"completed_at\":null,\"expires_at\":1710348675,\"failed_at\":null,\"last_error\":null,\"step_details\":{\"type\":\"message_creation\",\"message_creation\":{\"message_id\":\"msg_001\"}},\"usage\":null}\n\nevent: thread.message.created\ndata: {\"id\":\"msg_001\",\"object\":\"thread.message\",\"created_at\":1710348076,\"assistant_id\":\"asst_123\",\"thread_id\":\"thread_123\",\"run_id\":\"run_123\",\"status\":\"in_progress\",\"incomplete_details\":null,\"incomplete_at\":null,\"completed_at\":null,\"role\":\"assistant\",\"content\":[], \"metadata\":{}}\n\nevent: thread.message.in_progress\ndata: {\"id\":\"msg_001\",\"object\":\"thread.message\",\"created_at\":1710348076,\"assistant_id\":\"asst_123\",\"thread_id\":\"thread_123\",\"run_id\":\"run_123\",\"status\":\"in_progress\",\"incomplete_details\":null,\"incomplete_at\":null,\"completed_at\":null,\"role\":\"assistant\",\"content\":[], \"metadata\":{}}\n\nevent: thread.message.delta\ndata: {\"id\":\"msg_001\",\"object\":\"thread.message.delta\",\"delta\":{\"content\":[{\"index\":0,\"type\":\"text\",\"text\":{\"value\":\"Hello\",\"annotations\":[]}}]}}\n\n...\n\nevent: thread.message.delta\ndata: {\"id\":\"msg_001\",\"object\":\"thread.message.delta\",\"delta\":{\"content\":[{\"index\":0,\"type\":\"text\",\"text\":{\"value\":\" today\"}}]}}\n\nevent: thread.message.delta\ndata: {\"id\":\"msg_001\",\"object\":\"thread.message.delta\",\"delta\":{\"content\":[{\"index\":0,\"type\":\"text\",\"text\":{\"value\":\"?\"}}]}}\n\nevent: thread.message.completed\ndata: {\"id\":\"msg_001\",\"object\":\"thread.message\",\"created_at\":1710348076,\"assistant_id\":\"asst_123\",\"thread_id\":\"thread_123\",\"run_id\":\"run_123\",\"status\":\"completed\",\"incomplete_details\":null,\"incomplete_at\":null,\"completed_at\":1710348077,\"role\":\"assistant\",\"content\":[{\"type\":\"text\",\"text\":{\"value\":\"Hello! How can I assist you today?\",\"annotations\":[]}}], \"metadata\":{}}\n\nevent: thread.run.step.completed\ndata: {\"id\":\"step_001\",\"object\":\"thread.run.step\",\"created_at\":1710348076,\"run_id\":\"run_123\",\"assistant_id\":\"asst_123\",\"thread_id\":\"thread_123\",\"type\":\"message_creation\",\"status\":\"completed\",\"cancelled_at\":null,\"completed_at\":1710348077,\"expires_at\":1710348675,\"failed_at\":null,\"last_error\":null,\"step_details\":{\"type\":\"message_creation\",\"message_creation\":{\"message_id\":\"msg_001\"}},\"usage\":{\"prompt_tokens\":20,\"completion_tokens\":11,\"total_tokens\":31}}\n\nevent: thread.run.completed\n{\"id\":\"run_123\",\"object\":\"thread.run\",\"created_at\":1710348076,\"assistant_id\":\"asst_123\",\"thread_id\":\"thread_123\",\"status\":\"completed\",\"started_at\":1713226836,\"expires_at\":null,\"cancelled_at\":null,\"failed_at\":null,\"completed_at\":1713226837,\"required_action\":null,\"last_error\":null,\"model\":\"gpt-4o\",\"instructions\":null,\"tools\":[],\"metadata\":{},\"temperature\":1.0,\"top_p\":1.0,\"max_completion_tokens\":null,\"max_prompt_tokens\":null,\"truncation_strategy\":{\"type\":\"auto\",\"last_messages\":null},\"incomplete_details\":null,\"usage\":{\"prompt_tokens\":345,\"completion_tokens\":11,\"total_tokens\":356},\"response_format\":\"auto\",\"tool_choice\":\"auto\",\"parallel_tool_calls\":true}\n\nevent: done\ndata: [DONE]\n"},{"title":"Streaming with Functions","request":{"curl":"curl https://api.openai.com/v1/threads/runs \\\n -H \"Authorization: Bearer $OPENAI_API_KEY\" \\\n -H \"Content-Type: application/json\" \\\n -H \"OpenAI-Beta: assistants=v2\" \\\n -d '{\n \"assistant_id\": \"asst_abc123\",\n \"thread\": {\n \"messages\": [\n {\"role\": \"user\", \"content\": \"What is the weather like in San Francisco?\"}\n ]\n },\n \"tools\": [\n {\n \"type\": \"function\",\n \"function\": {\n \"name\": \"get_current_weather\",\n \"description\": \"Get the current weather in a given location\",\n \"parameters\": {\n \"type\": \"object\",\n \"properties\": {\n \"location\": {\n \"type\": \"string\",\n \"description\": \"The city and state, e.g. San Francisco, CA\"\n },\n \"unit\": {\n \"type\": \"string\",\n \"enum\": [\"celsius\", \"fahrenheit\"]\n }\n },\n \"required\": [\"location\"]\n }\n }\n }\n ],\n \"stream\": true\n }'\n","python":"import os\nfrom openai import OpenAI\n\nclient = OpenAI(\n api_key=os.environ.get(\"OPENAI_API_KEY\"), # This is the default and can be omitted\n)\nfor thread in client.beta.threads.create_and_run(\n assistant_id=\"assistant_id\",\n):\n print(thread)","javascript":"import OpenAI from \"openai\";\n\nconst openai = new OpenAI();\n\nconst tools = [\n {\n \"type\": \"function\",\n \"function\": {\n \"name\": \"get_current_weather\",\n \"description\": \"Get the current weather in a given location\",\n \"parameters\": {\n \"type\": \"object\",\n \"properties\": {\n \"location\": {\n \"type\": \"string\",\n \"description\": \"The city and state, e.g. San Francisco, CA\",\n },\n \"unit\": {\"type\": \"string\", \"enum\": [\"celsius\", \"fahrenheit\"]},\n },\n \"required\": [\"location\"],\n },\n }\n }\n];\n\nasync function main() {\n const stream = await openai.beta.threads.createAndRun({\n assistant_id: \"asst_123\",\n thread: {\n messages: [\n { role: \"user\", content: \"What is the weather like in San Francisco?\" },\n ],\n },\n tools: tools,\n stream: true\n });\n\n for await (const event of stream) {\n console.log(event);\n }\n}\n\nmain();\n","node.js":"import OpenAI from 'openai';\n\nconst client = new OpenAI({\n apiKey: process.env['OPENAI_API_KEY'], // This is the default and can be omitted\n});\n\nconst run = await client.beta.threads.createAndRun({ assistant_id: 'assistant_id' });\n\nconsole.log(run.id);","go":"package main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\n\t\"github.com/openai/openai-go\"\n\t\"github.com/openai/openai-go/option\"\n)\n\nfunc main() {\n\tclient := openai.NewClient(\n\t\toption.WithAPIKey(\"My API Key\"),\n\t)\n\trun, err := client.Beta.Threads.NewAndRun(context.TODO(), openai.BetaThreadNewAndRunParams{\n\t\tAssistantID: \"assistant_id\",\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf(\"%+v\\n\", run.ID)\n}\n","java":"package com.openai.example;\n\nimport com.openai.client.OpenAIClient;\nimport com.openai.client.okhttp.OpenAIOkHttpClient;\nimport com.openai.models.beta.threads.ThreadCreateAndRunParams;\nimport com.openai.models.beta.threads.runs.Run;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n OpenAIClient client = OpenAIOkHttpClient.fromEnv();\n\n ThreadCreateAndRunParams params = ThreadCreateAndRunParams.builder()\n .assistantId(\"assistant_id\")\n .build();\n Run run = client.beta().threads().createAndRun(params);\n }\n}","ruby":"require \"openai\"\n\nopenai = OpenAI::Client.new(api_key: \"My API Key\")\n\nrun = openai.beta.threads.create_and_run(assistant_id: \"assistant_id\")\n\nputs(run)"},"response":"event: thread.created\ndata: {\"id\":\"thread_123\",\"object\":\"thread\",\"created_at\":1710351818,\"metadata\":{}}\n\nevent: thread.run.created\ndata: {\"id\":\"run_123\",\"object\":\"thread.run\",\"created_at\":1710351818,\"assistant_id\":\"asst_123\",\"thread_id\":\"thread_123\",\"status\":\"queued\",\"started_at\":null,\"expires_at\":1710352418,\"cancelled_at\":null,\"failed_at\":null,\"completed_at\":null,\"required_action\":null,\"last_error\":null,\"model\":\"gpt-4o\",\"instructions\":null,\"tools\":[{\"type\":\"function\",\"function\":{\"name\":\"get_current_weather\",\"description\":\"Get the current weather in a given location\",\"parameters\":{\"type\":\"object\",\"properties\":{\"location\":{\"type\":\"string\",\"description\":\"The city and state, e.g. San Francisco, CA\"},\"unit\":{\"type\":\"string\",\"enum\":[\"celsius\",\"fahrenheit\"]}},\"required\":[\"location\"]}}}],\"metadata\":{},\"temperature\":1.0,\"top_p\":1.0,\"max_completion_tokens\":null,\"max_prompt_tokens\":null,\"truncation_strategy\":{\"type\":\"auto\",\"last_messages\":null},\"incomplete_details\":null,\"usage\":null,\"response_format\":\"auto\",\"tool_choice\":\"auto\",\"parallel_tool_calls\":true}}\n\nevent: thread.run.queued\ndata: {\"id\":\"run_123\",\"object\":\"thread.run\",\"created_at\":1710351818,\"assistant_id\":\"asst_123\",\"thread_id\":\"thread_123\",\"status\":\"queued\",\"started_at\":null,\"expires_at\":1710352418,\"cancelled_at\":null,\"failed_at\":null,\"completed_at\":null,\"required_action\":null,\"last_error\":null,\"model\":\"gpt-4o\",\"instructions\":null,\"tools\":[{\"type\":\"function\",\"function\":{\"name\":\"get_current_weather\",\"description\":\"Get the current weather in a given location\",\"parameters\":{\"type\":\"object\",\"properties\":{\"location\":{\"type\":\"string\",\"description\":\"The city and state, e.g. San Francisco, CA\"},\"unit\":{\"type\":\"string\",\"enum\":[\"celsius\",\"fahrenheit\"]}},\"required\":[\"location\"]}}}],\"metadata\":{},\"temperature\":1.0,\"top_p\":1.0,\"max_completion_tokens\":null,\"max_prompt_tokens\":null,\"truncation_strategy\":{\"type\":\"auto\",\"last_messages\":null},\"incomplete_details\":null,\"usage\":null,\"response_format\":\"auto\",\"tool_choice\":\"auto\",\"parallel_tool_calls\":true}}\n\nevent: thread.run.in_progress\ndata: {\"id\":\"run_123\",\"object\":\"thread.run\",\"created_at\":1710351818,\"assistant_id\":\"asst_123\",\"thread_id\":\"thread_123\",\"status\":\"in_progress\",\"started_at\":1710351818,\"expires_at\":1710352418,\"cancelled_at\":null,\"failed_at\":null,\"completed_at\":null,\"required_action\":null,\"last_error\":null,\"model\":\"gpt-4o\",\"instructions\":null,\"tools\":[{\"type\":\"function\",\"function\":{\"name\":\"get_current_weather\",\"description\":\"Get the current weather in a given location\",\"parameters\":{\"type\":\"object\",\"properties\":{\"location\":{\"type\":\"string\",\"description\":\"The city and state, e.g. San Francisco, CA\"},\"unit\":{\"type\":\"string\",\"enum\":[\"celsius\",\"fahrenheit\"]}},\"required\":[\"location\"]}}}],\"metadata\":{},\"temperature\":1.0,\"top_p\":1.0,\"max_completion_tokens\":null,\"max_prompt_tokens\":null,\"truncation_strategy\":{\"type\":\"auto\",\"last_messages\":null},\"incomplete_details\":null,\"usage\":null,\"response_format\":\"auto\",\"tool_choice\":\"auto\",\"parallel_tool_calls\":true}}\n\nevent: thread.run.step.created\ndata: {\"id\":\"step_001\",\"object\":\"thread.run.step\",\"created_at\":1710351819,\"run_id\":\"run_123\",\"assistant_id\":\"asst_123\",\"thread_id\":\"thread_123\",\"type\":\"tool_calls\",\"status\":\"in_progress\",\"cancelled_at\":null,\"completed_at\":null,\"expires_at\":1710352418,\"failed_at\":null,\"last_error\":null,\"step_details\":{\"type\":\"tool_calls\",\"tool_calls\":[]},\"usage\":null}\n\nevent: thread.run.step.in_progress\ndata: {\"id\":\"step_001\",\"object\":\"thread.run.step\",\"created_at\":1710351819,\"run_id\":\"run_123\",\"assistant_id\":\"asst_123\",\"thread_id\":\"thread_123\",\"type\":\"tool_calls\",\"status\":\"in_progress\",\"cancelled_at\":null,\"completed_at\":null,\"expires_at\":1710352418,\"failed_at\":null,\"last_error\":null,\"step_details\":{\"type\":\"tool_calls\",\"tool_calls\":[]},\"usage\":null}\n\nevent: thread.run.step.delta\ndata: {\"id\":\"step_001\",\"object\":\"thread.run.step.delta\",\"delta\":{\"step_details\":{\"type\":\"tool_calls\",\"tool_calls\":[{\"index\":0,\"id\":\"call_XXNp8YGaFrjrSjgqxtC8JJ1B\",\"type\":\"function\",\"function\":{\"name\":\"get_current_weather\",\"arguments\":\"\",\"output\":null}}]}}}\n\nevent: thread.run.step.delta\ndata: {\"id\":\"step_001\",\"object\":\"thread.run.step.delta\",\"delta\":{\"step_details\":{\"type\":\"tool_calls\",\"tool_calls\":[{\"index\":0,\"type\":\"function\",\"function\":{\"arguments\":\"{\\\"\"}}]}}}\n\nevent: thread.run.step.delta\ndata: {\"id\":\"step_001\",\"object\":\"thread.run.step.delta\",\"delta\":{\"step_details\":{\"type\":\"tool_calls\",\"tool_calls\":[{\"index\":0,\"type\":\"function\",\"function\":{\"arguments\":\"location\"}}]}}}\n\n...\n\nevent: thread.run.step.delta\ndata: {\"id\":\"step_001\",\"object\":\"thread.run.step.delta\",\"delta\":{\"step_details\":{\"type\":\"tool_calls\",\"tool_calls\":[{\"index\":0,\"type\":\"function\",\"function\":{\"arguments\":\"ahrenheit\"}}]}}}\n\nevent: thread.run.step.delta\ndata: {\"id\":\"step_001\",\"object\":\"thread.run.step.delta\",\"delta\":{\"step_details\":{\"type\":\"tool_calls\",\"tool_calls\":[{\"index\":0,\"type\":\"function\",\"function\":{\"arguments\":\"\\\"}\"}}]}}}\n\nevent: thread.run.requires_action\ndata: {\"id\":\"run_123\",\"object\":\"thread.run\",\"created_at\":1710351818,\"assistant_id\":\"asst_123\",\"thread_id\":\"thread_123\",\"status\":\"requires_action\",\"started_at\":1710351818,\"expires_at\":1710352418,\"cancelled_at\":null,\"failed_at\":null,\"completed_at\":null,\"required_action\":{\"type\":\"submit_tool_outputs\",\"submit_tool_outputs\":{\"tool_calls\":[{\"id\":\"call_XXNp8YGaFrjrSjgqxtC8JJ1B\",\"type\":\"function\",\"function\":{\"name\":\"get_current_weather\",\"arguments\":\"{\\\"location\\\":\\\"San Francisco, CA\\\",\\\"unit\\\":\\\"fahrenheit\\\"}\"}}]}},\"last_error\":null,\"model\":\"gpt-4o\",\"instructions\":null,\"tools\":[{\"type\":\"function\",\"function\":{\"name\":\"get_current_weather\",\"description\":\"Get the current weather in a given location\",\"parameters\":{\"type\":\"object\",\"properties\":{\"location\":{\"type\":\"string\",\"description\":\"The city and state, e.g. San Francisco, CA\"},\"unit\":{\"type\":\"string\",\"enum\":[\"celsius\",\"fahrenheit\"]}},\"required\":[\"location\"]}}}],\"metadata\":{},\"temperature\":1.0,\"top_p\":1.0,\"max_completion_tokens\":null,\"max_prompt_tokens\":null,\"truncation_strategy\":{\"type\":\"auto\",\"last_messages\":null},\"incomplete_details\":null,\"usage\":{\"prompt_tokens\":345,\"completion_tokens\":11,\"total_tokens\":356},\"response_format\":\"auto\",\"tool_choice\":\"auto\",\"parallel_tool_calls\":true}}\n\nevent: done\ndata: [DONE]\n"}]}}},"/threads/{thread_id}":{"get":{"operationId":"getThread","tags":["Assistants"],"summary":"Retrieves a thread.","parameters":[{"in":"path","name":"thread_id","required":true,"schema":{"type":"string"},"description":"The ID of the thread to retrieve."}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThreadObject"}}}}},"x-oaiMeta":{"name":"Retrieve thread","group":"threads","beta":true,"examples":{"request":{"curl":"curl https://api.openai.com/v1/threads/thread_abc123 \\\n -H \"Content-Type: application/json\" \\\n -H \"Authorization: Bearer $OPENAI_API_KEY\" \\\n -H \"OpenAI-Beta: assistants=v2\"\n","python":"import os\nfrom openai import OpenAI\n\nclient = OpenAI(\n api_key=os.environ.get(\"OPENAI_API_KEY\"), # This is the default and can be omitted\n)\nthread = client.beta.threads.retrieve(\n \"thread_id\",\n)\nprint(thread.id)","javascript":"import OpenAI from \"openai\";\n\nconst openai = new OpenAI();\n\nasync function main() {\n const myThread = await openai.beta.threads.retrieve(\n \"thread_abc123\"\n );\n\n console.log(myThread);\n}\n\nmain();","node.js":"import OpenAI from 'openai';\n\nconst client = new OpenAI({\n apiKey: process.env['OPENAI_API_KEY'], // This is the default and can be omitted\n});\n\nconst thread = await client.beta.threads.retrieve('thread_id');\n\nconsole.log(thread.id);","go":"package main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\n\t\"github.com/openai/openai-go\"\n\t\"github.com/openai/openai-go/option\"\n)\n\nfunc main() {\n\tclient := openai.NewClient(\n\t\toption.WithAPIKey(\"My API Key\"),\n\t)\n\tthread, err := client.Beta.Threads.Get(context.TODO(), \"thread_id\")\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf(\"%+v\\n\", thread.ID)\n}\n","java":"package com.openai.example;\n\nimport com.openai.client.OpenAIClient;\nimport com.openai.client.okhttp.OpenAIOkHttpClient;\nimport com.openai.models.beta.threads.Thread;\nimport com.openai.models.beta.threads.ThreadRetrieveParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n OpenAIClient client = OpenAIOkHttpClient.fromEnv();\n\n Thread thread = client.beta().threads().retrieve(\"thread_id\");\n }\n}","ruby":"require \"openai\"\n\nopenai = OpenAI::Client.new(api_key: \"My API Key\")\n\nthread = openai.beta.threads.retrieve(\"thread_id\")\n\nputs(thread)"},"response":"{\n \"id\": \"thread_abc123\",\n \"object\": \"thread\",\n \"created_at\": 1699014083,\n \"metadata\": {},\n \"tool_resources\": {\n \"code_interpreter\": {\n \"file_ids\": []\n }\n }\n}\n"}}},"post":{"operationId":"modifyThread","tags":["Assistants"],"summary":"Modifies a thread.","parameters":[{"in":"path","name":"thread_id","required":true,"schema":{"type":"string"},"description":"The ID of the thread to modify. Only the `metadata` can be modified."}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModifyThreadRequest"}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThreadObject"}}}}},"x-oaiMeta":{"name":"Modify thread","group":"threads","beta":true,"examples":{"request":{"curl":"curl https://api.openai.com/v1/threads/thread_abc123 \\\n -H \"Content-Type: application/json\" \\\n -H \"Authorization: Bearer $OPENAI_API_KEY\" \\\n -H \"OpenAI-Beta: assistants=v2\" \\\n -d '{\n \"metadata\": {\n \"modified\": \"true\",\n \"user\": \"abc123\"\n }\n }'\n","python":"import os\nfrom openai import OpenAI\n\nclient = OpenAI(\n api_key=os.environ.get(\"OPENAI_API_KEY\"), # This is the default and can be omitted\n)\nthread = client.beta.threads.update(\n thread_id=\"thread_id\",\n)\nprint(thread.id)","javascript":"import OpenAI from \"openai\";\n\nconst openai = new OpenAI();\n\nasync function main() {\n const updatedThread = await openai.beta.threads.update(\n \"thread_abc123\",\n {\n metadata: { modified: \"true\", user: \"abc123\" },\n }\n );\n\n console.log(updatedThread);\n}\n\nmain();","node.js":"import OpenAI from 'openai';\n\nconst client = new OpenAI({\n apiKey: process.env['OPENAI_API_KEY'], // This is the default and can be omitted\n});\n\nconst thread = await client.beta.threads.update('thread_id');\n\nconsole.log(thread.id);","go":"package main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\n\t\"github.com/openai/openai-go\"\n\t\"github.com/openai/openai-go/option\"\n)\n\nfunc main() {\n\tclient := openai.NewClient(\n\t\toption.WithAPIKey(\"My API Key\"),\n\t)\n\tthread, err := client.Beta.Threads.Update(\n\t\tcontext.TODO(),\n\t\t\"thread_id\",\n\t\topenai.BetaThreadUpdateParams{},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf(\"%+v\\n\", thread.ID)\n}\n","java":"package com.openai.example;\n\nimport com.openai.client.OpenAIClient;\nimport com.openai.client.okhttp.OpenAIOkHttpClient;\nimport com.openai.models.beta.threads.Thread;\nimport com.openai.models.beta.threads.ThreadUpdateParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n OpenAIClient client = OpenAIOkHttpClient.fromEnv();\n\n Thread thread = client.beta().threads().update(\"thread_id\");\n }\n}","ruby":"require \"openai\"\n\nopenai = OpenAI::Client.new(api_key: \"My API Key\")\n\nthread = openai.beta.threads.update(\"thread_id\")\n\nputs(thread)"},"response":"{\n \"id\": \"thread_abc123\",\n \"object\": \"thread\",\n \"created_at\": 1699014083,\n \"metadata\": {\n \"modified\": \"true\",\n \"user\": \"abc123\"\n },\n \"tool_resources\": {}\n}\n"}}},"delete":{"operationId":"deleteThread","tags":["Assistants"],"summary":"Delete a thread.","parameters":[{"in":"path","name":"thread_id","required":true,"schema":{"type":"string"},"description":"The ID of the thread to delete."}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteThreadResponse"}}}}},"x-oaiMeta":{"name":"Delete thread","group":"threads","beta":true,"examples":{"request":{"curl":"curl https://api.openai.com/v1/threads/thread_abc123 \\\n -H \"Content-Type: application/json\" \\\n -H \"Authorization: Bearer $OPENAI_API_KEY\" \\\n -H \"OpenAI-Beta: assistants=v2\" \\\n -X DELETE\n","python":"import os\nfrom openai import OpenAI\n\nclient = OpenAI(\n api_key=os.environ.get(\"OPENAI_API_KEY\"), # This is the default and can be omitted\n)\nthread_deleted = client.beta.threads.delete(\n \"thread_id\",\n)\nprint(thread_deleted.id)","javascript":"import OpenAI from \"openai\";\n\nconst openai = new OpenAI();\n\nasync function main() {\n const response = await openai.beta.threads.delete(\"thread_abc123\");\n\n console.log(response);\n}\nmain();","node.js":"import OpenAI from 'openai';\n\nconst client = new OpenAI({\n apiKey: process.env['OPENAI_API_KEY'], // This is the default and can be omitted\n});\n\nconst threadDeleted = await client.beta.threads.delete('thread_id');\n\nconsole.log(threadDeleted.id);","go":"package main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\n\t\"github.com/openai/openai-go\"\n\t\"github.com/openai/openai-go/option\"\n)\n\nfunc main() {\n\tclient := openai.NewClient(\n\t\toption.WithAPIKey(\"My API Key\"),\n\t)\n\tthreadDeleted, err := client.Beta.Threads.Delete(context.TODO(), \"thread_id\")\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf(\"%+v\\n\", threadDeleted.ID)\n}\n","java":"package com.openai.example;\n\nimport com.openai.client.OpenAIClient;\nimport com.openai.client.okhttp.OpenAIOkHttpClient;\nimport com.openai.models.beta.threads.ThreadDeleteParams;\nimport com.openai.models.beta.threads.ThreadDeleted;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n OpenAIClient client = OpenAIOkHttpClient.fromEnv();\n\n ThreadDeleted threadDeleted = client.beta().threads().delete(\"thread_id\");\n }\n}","ruby":"require \"openai\"\n\nopenai = OpenAI::Client.new(api_key: \"My API Key\")\n\nthread_deleted = openai.beta.threads.delete(\"thread_id\")\n\nputs(thread_deleted)"},"response":"{\n \"id\": \"thread_abc123\",\n \"object\": \"thread.deleted\",\n \"deleted\": true\n}\n"}}}},"/threads/{thread_id}/messages":{"get":{"operationId":"listMessages","tags":["Assistants"],"summary":"Returns a list of messages for a given thread.","parameters":[{"in":"path","name":"thread_id","required":true,"schema":{"type":"string"},"description":"The ID of the [thread](/docs/api-reference/threads) the messages belong to."},{"name":"limit","in":"query","description":"A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.\n","required":false,"schema":{"type":"integer","default":20}},{"name":"order","in":"query","description":"Sort order by the `created_at` timestamp of the objects. `asc` for ascending order and `desc` for descending order.\n","schema":{"type":"string","default":"desc","enum":["asc","desc"]}},{"name":"after","in":"query","description":"A cursor for use in pagination. `after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list.\n","schema":{"type":"string"}},{"name":"before","in":"query","description":"A cursor for use in pagination. `before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_foo, your subsequent call can include before=obj_foo in order to fetch the previous page of the list.\n","schema":{"type":"string"}},{"name":"run_id","in":"query","description":"Filter messages by the run ID that generated them.\n","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListMessagesResponse"}}}}},"x-oaiMeta":{"name":"List messages","group":"threads","beta":true,"examples":{"request":{"curl":"curl https://api.openai.com/v1/threads/thread_abc123/messages \\\n -H \"Content-Type: application/json\" \\\n -H \"Authorization: Bearer $OPENAI_API_KEY\" \\\n -H \"OpenAI-Beta: assistants=v2\"\n","python":"import os\nfrom openai import OpenAI\n\nclient = OpenAI(\n api_key=os.environ.get(\"OPENAI_API_KEY\"), # This is the default and can be omitted\n)\npage = client.beta.threads.messages.list(\n thread_id=\"thread_id\",\n)\npage = page.data[0]\nprint(page.id)","javascript":"import OpenAI from \"openai\";\n\nconst openai = new OpenAI();\n\nasync function main() {\n const threadMessages = await openai.beta.threads.messages.list(\n \"thread_abc123\"\n );\n\n console.log(threadMessages.data);\n}\n\nmain();","node.js":"import OpenAI from 'openai';\n\nconst client = new OpenAI({\n apiKey: process.env['OPENAI_API_KEY'], // This is the default and can be omitted\n});\n\n// Automatically fetches more pages as needed.\nfor await (const message of client.beta.threads.messages.list('thread_id')) {\n console.log(message.id);\n}","go":"package main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\n\t\"github.com/openai/openai-go\"\n\t\"github.com/openai/openai-go/option\"\n)\n\nfunc main() {\n\tclient := openai.NewClient(\n\t\toption.WithAPIKey(\"My API Key\"),\n\t)\n\tpage, err := client.Beta.Threads.Messages.List(\n\t\tcontext.TODO(),\n\t\t\"thread_id\",\n\t\topenai.BetaThreadMessageListParams{},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf(\"%+v\\n\", page)\n}\n","java":"package com.openai.example;\n\nimport com.openai.client.OpenAIClient;\nimport com.openai.client.okhttp.OpenAIOkHttpClient;\nimport com.openai.models.beta.threads.messages.MessageListPage;\nimport com.openai.models.beta.threads.messages.MessageListParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n OpenAIClient client = OpenAIOkHttpClient.fromEnv();\n\n MessageListPage page = client.beta().threads().messages().list(\"thread_id\");\n }\n}","ruby":"require \"openai\"\n\nopenai = OpenAI::Client.new(api_key: \"My API Key\")\n\npage = openai.beta.threads.messages.list(\"thread_id\")\n\nputs(page)"},"response":"{\n \"object\": \"list\",\n \"data\": [\n {\n \"id\": \"msg_abc123\",\n \"object\": \"thread.message\",\n \"created_at\": 1699016383,\n \"assistant_id\": null,\n \"thread_id\": \"thread_abc123\",\n \"run_id\": null,\n \"role\": \"user\",\n \"content\": [\n {\n \"type\": \"text\",\n \"text\": {\n \"value\": \"How does AI work? Explain it in simple terms.\",\n \"annotations\": []\n }\n }\n ],\n \"attachments\": [],\n \"metadata\": {}\n },\n {\n \"id\": \"msg_abc456\",\n \"object\": \"thread.message\",\n \"created_at\": 1699016383,\n \"assistant_id\": null,\n \"thread_id\": \"thread_abc123\",\n \"run_id\": null,\n \"role\": \"user\",\n \"content\": [\n {\n \"type\": \"text\",\n \"text\": {\n \"value\": \"Hello, what is AI?\",\n \"annotations\": []\n }\n }\n ],\n \"attachments\": [],\n \"metadata\": {}\n }\n ],\n \"first_id\": \"msg_abc123\",\n \"last_id\": \"msg_abc456\",\n \"has_more\": false\n}\n"}}},"post":{"operationId":"createMessage","tags":["Assistants"],"summary":"Create a message.","parameters":[{"in":"path","name":"thread_id","required":true,"schema":{"type":"string"},"description":"The ID of the [thread](/docs/api-reference/threads) to create a message for."}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateMessageRequest"}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessageObject"}}}}},"x-oaiMeta":{"name":"Create message","group":"threads","beta":true,"examples":{"request":{"curl":"curl https://api.openai.com/v1/threads/thread_abc123/messages \\\n -H \"Content-Type: application/json\" \\\n -H \"Authorization: Bearer $OPENAI_API_KEY\" \\\n -H \"OpenAI-Beta: assistants=v2\" \\\n -d '{\n \"role\": \"user\",\n \"content\": \"How does AI work? Explain it in simple terms.\"\n }'\n","python":"import os\nfrom openai import OpenAI\n\nclient = OpenAI(\n api_key=os.environ.get(\"OPENAI_API_KEY\"), # This is the default and can be omitted\n)\nmessage = client.beta.threads.messages.create(\n thread_id=\"thread_id\",\n content=\"string\",\n role=\"user\",\n)\nprint(message.id)","javascript":"import OpenAI from \"openai\";\n\nconst openai = new OpenAI();\n\nasync function main() {\n const threadMessages = await openai.beta.threads.messages.create(\n \"thread_abc123\",\n { role: \"user\", content: \"How does AI work? Explain it in simple terms.\" }\n );\n\n console.log(threadMessages);\n}\n\nmain();","node.js":"import OpenAI from 'openai';\n\nconst client = new OpenAI({\n apiKey: process.env['OPENAI_API_KEY'], // This is the default and can be omitted\n});\n\nconst message = await client.beta.threads.messages.create('thread_id', {\n content: 'string',\n role: 'user',\n});\n\nconsole.log(message.id);","go":"package main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\n\t\"github.com/openai/openai-go\"\n\t\"github.com/openai/openai-go/option\"\n)\n\nfunc main() {\n\tclient := openai.NewClient(\n\t\toption.WithAPIKey(\"My API Key\"),\n\t)\n\tmessage, err := client.Beta.Threads.Messages.New(\n\t\tcontext.TODO(),\n\t\t\"thread_id\",\n\t\topenai.BetaThreadMessageNewParams{\n\t\t\tContent: openai.BetaThreadMessageNewParamsContentUnion{\n\t\t\t\tOfString: openai.String(\"string\"),\n\t\t\t},\n\t\t\tRole: openai.BetaThreadMessageNewParamsRoleUser,\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf(\"%+v\\n\", message.ID)\n}\n","java":"package com.openai.example;\n\nimport com.openai.client.OpenAIClient;\nimport com.openai.client.okhttp.OpenAIOkHttpClient;\nimport com.openai.models.beta.threads.messages.Message;\nimport com.openai.models.beta.threads.messages.MessageCreateParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n OpenAIClient client = OpenAIOkHttpClient.fromEnv();\n\n MessageCreateParams params = MessageCreateParams.builder()\n .threadId(\"thread_id\")\n .content(\"string\")\n .role(MessageCreateParams.Role.USER)\n .build();\n Message message = client.beta().threads().messages().create(params);\n }\n}","ruby":"require \"openai\"\n\nopenai = OpenAI::Client.new(api_key: \"My API Key\")\n\nmessage = openai.beta.threads.messages.create(\"thread_id\", content: \"string\", role: :user)\n\nputs(message)"},"response":"{\n \"id\": \"msg_abc123\",\n \"object\": \"thread.message\",\n \"created_at\": 1713226573,\n \"assistant_id\": null,\n \"thread_id\": \"thread_abc123\",\n \"run_id\": null,\n \"role\": \"user\",\n \"content\": [\n {\n \"type\": \"text\",\n \"text\": {\n \"value\": \"How does AI work? Explain it in simple terms.\",\n \"annotations\": []\n }\n }\n ],\n \"attachments\": [],\n \"metadata\": {}\n}\n"}}}},"/threads/{thread_id}/messages/{message_id}":{"get":{"operationId":"getMessage","tags":["Assistants"],"summary":"Retrieve a message.","parameters":[{"in":"path","name":"thread_id","required":true,"schema":{"type":"string"},"description":"The ID of the [thread](/docs/api-reference/threads) to which this message belongs."},{"in":"path","name":"message_id","required":true,"schema":{"type":"string"},"description":"The ID of the message to retrieve."}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessageObject"}}}}},"x-oaiMeta":{"name":"Retrieve message","group":"threads","beta":true,"examples":{"request":{"curl":"curl https://api.openai.com/v1/threads/thread_abc123/messages/msg_abc123 \\\n -H \"Content-Type: application/json\" \\\n -H \"Authorization: Bearer $OPENAI_API_KEY\" \\\n -H \"OpenAI-Beta: assistants=v2\"\n","python":"import os\nfrom openai import OpenAI\n\nclient = OpenAI(\n api_key=os.environ.get(\"OPENAI_API_KEY\"), # This is the default and can be omitted\n)\nmessage = client.beta.threads.messages.retrieve(\n message_id=\"message_id\",\n thread_id=\"thread_id\",\n)\nprint(message.id)","javascript":"import OpenAI from \"openai\";\n\nconst openai = new OpenAI();\n\nasync function main() {\n const message = await openai.beta.threads.messages.retrieve(\n \"msg_abc123\",\n { thread_id: \"thread_abc123\" }\n );\n\n console.log(message);\n}\n\nmain();","node.js":"import OpenAI from 'openai';\n\nconst client = new OpenAI({\n apiKey: process.env['OPENAI_API_KEY'], // This is the default and can be omitted\n});\n\nconst message = await client.beta.threads.messages.retrieve('message_id', {\n thread_id: 'thread_id',\n});\n\nconsole.log(message.id);","go":"package main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\n\t\"github.com/openai/openai-go\"\n\t\"github.com/openai/openai-go/option\"\n)\n\nfunc main() {\n\tclient := openai.NewClient(\n\t\toption.WithAPIKey(\"My API Key\"),\n\t)\n\tmessage, err := client.Beta.Threads.Messages.Get(\n\t\tcontext.TODO(),\n\t\t\"thread_id\",\n\t\t\"message_id\",\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf(\"%+v\\n\", message.ID)\n}\n","java":"package com.openai.example;\n\nimport com.openai.client.OpenAIClient;\nimport com.openai.client.okhttp.OpenAIOkHttpClient;\nimport com.openai.models.beta.threads.messages.Message;\nimport com.openai.models.beta.threads.messages.MessageRetrieveParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n OpenAIClient client = OpenAIOkHttpClient.fromEnv();\n\n MessageRetrieveParams params = MessageRetrieveParams.builder()\n .threadId(\"thread_id\")\n .messageId(\"message_id\")\n .build();\n Message message = client.beta().threads().messages().retrieve(params);\n }\n}","ruby":"require \"openai\"\n\nopenai = OpenAI::Client.new(api_key: \"My API Key\")\n\nmessage = openai.beta.threads.messages.retrieve(\"message_id\", thread_id: \"thread_id\")\n\nputs(message)"},"response":"{\n \"id\": \"msg_abc123\",\n \"object\": \"thread.message\",\n \"created_at\": 1699017614,\n \"assistant_id\": null,\n \"thread_id\": \"thread_abc123\",\n \"run_id\": null,\n \"role\": \"user\",\n \"content\": [\n {\n \"type\": \"text\",\n \"text\": {\n \"value\": \"How does AI work? Explain it in simple terms.\",\n \"annotations\": []\n }\n }\n ],\n \"attachments\": [],\n \"metadata\": {}\n}\n"}}},"post":{"operationId":"modifyMessage","tags":["Assistants"],"summary":"Modifies a message.","parameters":[{"in":"path","name":"thread_id","required":true,"schema":{"type":"string"},"description":"The ID of the thread to which this message belongs."},{"in":"path","name":"message_id","required":true,"schema":{"type":"string"},"description":"The ID of the message to modify."}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModifyMessageRequest"}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessageObject"}}}}},"x-oaiMeta":{"name":"Modify message","group":"threads","beta":true,"examples":{"request":{"curl":"curl https://api.openai.com/v1/threads/thread_abc123/messages/msg_abc123 \\\n -H \"Content-Type: application/json\" \\\n -H \"Authorization: Bearer $OPENAI_API_KEY\" \\\n -H \"OpenAI-Beta: assistants=v2\" \\\n -d '{\n \"metadata\": {\n \"modified\": \"true\",\n \"user\": \"abc123\"\n }\n }'\n","python":"import os\nfrom openai import OpenAI\n\nclient = OpenAI(\n api_key=os.environ.get(\"OPENAI_API_KEY\"), # This is the default and can be omitted\n)\nmessage = client.beta.threads.messages.update(\n message_id=\"message_id\",\n thread_id=\"thread_id\",\n)\nprint(message.id)","javascript":"import OpenAI from \"openai\";\n\nconst openai = new OpenAI();\n\nasync function main() {\n const message = await openai.beta.threads.messages.update(\n \"thread_abc123\",\n \"msg_abc123\",\n {\n metadata: {\n modified: \"true\",\n user: \"abc123\",\n },\n }\n }'","node.js":"import OpenAI from 'openai';\n\nconst client = new OpenAI({\n apiKey: process.env['OPENAI_API_KEY'], // This is the default and can be omitted\n});\n\nconst message = await client.beta.threads.messages.update('message_id', { thread_id: 'thread_id' });\n\nconsole.log(message.id);","go":"package main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\n\t\"github.com/openai/openai-go\"\n\t\"github.com/openai/openai-go/option\"\n)\n\nfunc main() {\n\tclient := openai.NewClient(\n\t\toption.WithAPIKey(\"My API Key\"),\n\t)\n\tmessage, err := client.Beta.Threads.Messages.Update(\n\t\tcontext.TODO(),\n\t\t\"thread_id\",\n\t\t\"message_id\",\n\t\topenai.BetaThreadMessageUpdateParams{},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf(\"%+v\\n\", message.ID)\n}\n","java":"package com.openai.example;\n\nimport com.openai.client.OpenAIClient;\nimport com.openai.client.okhttp.OpenAIOkHttpClient;\nimport com.openai.models.beta.threads.messages.Message;\nimport com.openai.models.beta.threads.messages.MessageUpdateParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n OpenAIClient client = OpenAIOkHttpClient.fromEnv();\n\n MessageUpdateParams params = MessageUpdateParams.builder()\n .threadId(\"thread_id\")\n .messageId(\"message_id\")\n .build();\n Message message = client.beta().threads().messages().update(params);\n }\n}","ruby":"require \"openai\"\n\nopenai = OpenAI::Client.new(api_key: \"My API Key\")\n\nmessage = openai.beta.threads.messages.update(\"message_id\", thread_id: \"thread_id\")\n\nputs(message)"},"response":"{\n \"id\": \"msg_abc123\",\n \"object\": \"thread.message\",\n \"created_at\": 1699017614,\n \"assistant_id\": null,\n \"thread_id\": \"thread_abc123\",\n \"run_id\": null,\n \"role\": \"user\",\n \"content\": [\n {\n \"type\": \"text\",\n \"text\": {\n \"value\": \"How does AI work? Explain it in simple terms.\",\n \"annotations\": []\n }\n }\n ],\n \"file_ids\": [],\n \"metadata\": {\n \"modified\": \"true\",\n \"user\": \"abc123\"\n }\n}\n"}}},"delete":{"operationId":"deleteMessage","tags":["Assistants"],"summary":"Deletes a message.","parameters":[{"in":"path","name":"thread_id","required":true,"schema":{"type":"string"},"description":"The ID of the thread to which this message belongs."},{"in":"path","name":"message_id","required":true,"schema":{"type":"string"},"description":"The ID of the message to delete."}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteMessageResponse"}}}}},"x-oaiMeta":{"name":"Delete message","group":"threads","beta":true,"examples":{"request":{"curl":"curl -X DELETE https://api.openai.com/v1/threads/thread_abc123/messages/msg_abc123 \\\n -H \"Content-Type: application/json\" \\\n -H \"Authorization: Bearer $OPENAI_API_KEY\" \\\n -H \"OpenAI-Beta: assistants=v2\"\n","python":"import os\nfrom openai import OpenAI\n\nclient = OpenAI(\n api_key=os.environ.get(\"OPENAI_API_KEY\"), # This is the default and can be omitted\n)\nmessage_deleted = client.beta.threads.messages.delete(\n message_id=\"message_id\",\n thread_id=\"thread_id\",\n)\nprint(message_deleted.id)","javascript":"import OpenAI from \"openai\";\n\nconst openai = new OpenAI();\n\nasync function main() {\n const deletedMessage = await openai.beta.threads.messages.delete(\n \"msg_abc123\",\n { thread_id: \"thread_abc123\" }\n );\n\n console.log(deletedMessage);\n}","node.js":"import OpenAI from 'openai';\n\nconst client = new OpenAI({\n apiKey: process.env['OPENAI_API_KEY'], // This is the default and can be omitted\n});\n\nconst messageDeleted = await client.beta.threads.messages.delete('message_id', {\n thread_id: 'thread_id',\n});\n\nconsole.log(messageDeleted.id);","go":"package main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\n\t\"github.com/openai/openai-go\"\n\t\"github.com/openai/openai-go/option\"\n)\n\nfunc main() {\n\tclient := openai.NewClient(\n\t\toption.WithAPIKey(\"My API Key\"),\n\t)\n\tmessageDeleted, err := client.Beta.Threads.Messages.Delete(\n\t\tcontext.TODO(),\n\t\t\"thread_id\",\n\t\t\"message_id\",\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf(\"%+v\\n\", messageDeleted.ID)\n}\n","java":"package com.openai.example;\n\nimport com.openai.client.OpenAIClient;\nimport com.openai.client.okhttp.OpenAIOkHttpClient;\nimport com.openai.models.beta.threads.messages.MessageDeleteParams;\nimport com.openai.models.beta.threads.messages.MessageDeleted;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n OpenAIClient client = OpenAIOkHttpClient.fromEnv();\n\n MessageDeleteParams params = MessageDeleteParams.builder()\n .threadId(\"thread_id\")\n .messageId(\"message_id\")\n .build();\n MessageDeleted messageDeleted = client.beta().threads().messages().delete(params);\n }\n}","ruby":"require \"openai\"\n\nopenai = OpenAI::Client.new(api_key: \"My API Key\")\n\nmessage_deleted = openai.beta.threads.messages.delete(\"message_id\", thread_id: \"thread_id\")\n\nputs(message_deleted)"},"response":"{\n \"id\": \"msg_abc123\",\n \"object\": \"thread.message.deleted\",\n \"deleted\": true\n}\n"}}}},"/threads/{thread_id}/runs":{"get":{"operationId":"listRuns","tags":["Assistants"],"summary":"Returns a list of runs belonging to a thread.","parameters":[{"name":"thread_id","in":"path","required":true,"schema":{"type":"string"},"description":"The ID of the thread the run belongs to."},{"name":"limit","in":"query","description":"A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.\n","required":false,"schema":{"type":"integer","default":20}},{"name":"order","in":"query","description":"Sort order by the `created_at` timestamp of the objects. `asc` for ascending order and `desc` for descending order.\n","schema":{"type":"string","default":"desc","enum":["asc","desc"]}},{"name":"after","in":"query","description":"A cursor for use in pagination. `after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list.\n","schema":{"type":"string"}},{"name":"before","in":"query","description":"A cursor for use in pagination. `before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_foo, your subsequent call can include before=obj_foo in order to fetch the previous page of the list.\n","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListRunsResponse"}}}}},"x-oaiMeta":{"name":"List runs","group":"threads","beta":true,"examples":{"request":{"curl":"curl https://api.openai.com/v1/threads/thread_abc123/runs \\\n -H \"Authorization: Bearer $OPENAI_API_KEY\" \\\n -H \"Content-Type: application/json\" \\\n -H \"OpenAI-Beta: assistants=v2\"\n","python":"import os\nfrom openai import OpenAI\n\nclient = OpenAI(\n api_key=os.environ.get(\"OPENAI_API_KEY\"), # This is the default and can be omitted\n)\npage = client.beta.threads.runs.list(\n thread_id=\"thread_id\",\n)\npage = page.data[0]\nprint(page.id)","javascript":"import OpenAI from \"openai\";\n\nconst openai = new OpenAI();\n\nasync function main() {\n const runs = await openai.beta.threads.runs.list(\n \"thread_abc123\"\n );\n\n console.log(runs);\n}\n\nmain();\n","node.js":"import OpenAI from 'openai';\n\nconst client = new OpenAI({\n apiKey: process.env['OPENAI_API_KEY'], // This is the default and can be omitted\n});\n\n// Automatically fetches more pages as needed.\nfor await (const run of client.beta.threads.runs.list('thread_id')) {\n console.log(run.id);\n}","go":"package main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\n\t\"github.com/openai/openai-go\"\n\t\"github.com/openai/openai-go/option\"\n)\n\nfunc main() {\n\tclient := openai.NewClient(\n\t\toption.WithAPIKey(\"My API Key\"),\n\t)\n\tpage, err := client.Beta.Threads.Runs.List(\n\t\tcontext.TODO(),\n\t\t\"thread_id\",\n\t\topenai.BetaThreadRunListParams{},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf(\"%+v\\n\", page)\n}\n","java":"package com.openai.example;\n\nimport com.openai.client.OpenAIClient;\nimport com.openai.client.okhttp.OpenAIOkHttpClient;\nimport com.openai.models.beta.threads.runs.RunListPage;\nimport com.openai.models.beta.threads.runs.RunListParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n OpenAIClient client = OpenAIOkHttpClient.fromEnv();\n\n RunListPage page = client.beta().threads().runs().list(\"thread_id\");\n }\n}","ruby":"require \"openai\"\n\nopenai = OpenAI::Client.new(api_key: \"My API Key\")\n\npage = openai.beta.threads.runs.list(\"thread_id\")\n\nputs(page)"},"response":"{\n \"object\": \"list\",\n \"data\": [\n {\n \"id\": \"run_abc123\",\n \"object\": \"thread.run\",\n \"created_at\": 1699075072,\n \"assistant_id\": \"asst_abc123\",\n \"thread_id\": \"thread_abc123\",\n \"status\": \"completed\",\n \"started_at\": 1699075072,\n \"expires_at\": null,\n \"cancelled_at\": null,\n \"failed_at\": null,\n \"completed_at\": 1699075073,\n \"last_error\": null,\n \"model\": \"gpt-4o\",\n \"instructions\": null,\n \"incomplete_details\": null,\n \"tools\": [\n {\n \"type\": \"code_interpreter\"\n }\n ],\n \"tool_resources\": {\n \"code_interpreter\": {\n \"file_ids\": [\n \"file-abc123\",\n \"file-abc456\"\n ]\n }\n },\n \"metadata\": {},\n \"usage\": {\n \"prompt_tokens\": 123,\n \"completion_tokens\": 456,\n \"total_tokens\": 579\n },\n \"temperature\": 1.0,\n \"top_p\": 1.0,\n \"max_prompt_tokens\": 1000,\n \"max_completion_tokens\": 1000,\n \"truncation_strategy\": {\n \"type\": \"auto\",\n \"last_messages\": null\n },\n \"response_format\": \"auto\",\n \"tool_choice\": \"auto\",\n \"parallel_tool_calls\": true\n },\n {\n \"id\": \"run_abc456\",\n \"object\": \"thread.run\",\n \"created_at\": 1699063290,\n \"assistant_id\": \"asst_abc123\",\n \"thread_id\": \"thread_abc123\",\n \"status\": \"completed\",\n \"started_at\": 1699063290,\n \"expires_at\": null,\n \"cancelled_at\": null,\n \"failed_at\": null,\n \"completed_at\": 1699063291,\n \"last_error\": null,\n \"model\": \"gpt-4o\",\n \"instructions\": null,\n \"incomplete_details\": null,\n \"tools\": [\n {\n \"type\": \"code_interpreter\"\n }\n ],\n \"tool_resources\": {\n \"code_interpreter\": {\n \"file_ids\": [\n \"file-abc123\",\n \"file-abc456\"\n ]\n }\n },\n \"metadata\": {},\n \"usage\": {\n \"prompt_tokens\": 123,\n \"completion_tokens\": 456,\n \"total_tokens\": 579\n },\n \"temperature\": 1.0,\n \"top_p\": 1.0,\n \"max_prompt_tokens\": 1000,\n \"max_completion_tokens\": 1000,\n \"truncation_strategy\": {\n \"type\": \"auto\",\n \"last_messages\": null\n },\n \"response_format\": \"auto\",\n \"tool_choice\": \"auto\",\n \"parallel_tool_calls\": true\n }\n ],\n \"first_id\": \"run_abc123\",\n \"last_id\": \"run_abc456\",\n \"has_more\": false\n}\n"}}},"post":{"operationId":"createRun","tags":["Assistants"],"summary":"Create a run.","parameters":[{"in":"path","name":"thread_id","required":true,"schema":{"type":"string"},"description":"The ID of the thread to run."},{"name":"include[]","in":"query","description":"A list of additional fields to include in the response. Currently the only supported value is `step_details.tool_calls[*].file_search.results[*].content` to fetch the file search result content.\n\nSee the [file search tool documentation](/docs/assistants/tools/file-search#customizing-file-search-settings) for more information.\n","schema":{"type":"array","items":{"type":"string","enum":["step_details.tool_calls[*].file_search.results[*].content"]}}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateRunRequest"}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunObject"}}}}},"x-oaiMeta":{"name":"Create run","group":"threads","beta":true,"examples":[{"title":"Default","request":{"curl":"curl https://api.openai.com/v1/threads/thread_abc123/runs \\\n -H \"Authorization: Bearer $OPENAI_API_KEY\" \\\n -H \"Content-Type: application/json\" \\\n -H \"OpenAI-Beta: assistants=v2\" \\\n -d '{\n \"assistant_id\": \"asst_abc123\"\n }'\n","python":"import os\nfrom openai import OpenAI\n\nclient = OpenAI(\n api_key=os.environ.get(\"OPENAI_API_KEY\"), # This is the default and can be omitted\n)\nfor run in client.beta.threads.runs.create(\n thread_id=\"thread_id\",\n assistant_id=\"assistant_id\",\n):\n print(run)","javascript":"import OpenAI from \"openai\";\n\nconst openai = new OpenAI();\n\nasync function main() {\n const run = await openai.beta.threads.runs.create(\n \"thread_abc123\",\n { assistant_id: \"asst_abc123\" }\n );\n\n console.log(run);\n}\n\nmain();\n","node.js":"import OpenAI from 'openai';\n\nconst client = new OpenAI({\n apiKey: process.env['OPENAI_API_KEY'], // This is the default and can be omitted\n});\n\nconst run = await client.beta.threads.runs.create('thread_id', { assistant_id: 'assistant_id' });\n\nconsole.log(run.id);","go":"package main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\n\t\"github.com/openai/openai-go\"\n\t\"github.com/openai/openai-go/option\"\n)\n\nfunc main() {\n\tclient := openai.NewClient(\n\t\toption.WithAPIKey(\"My API Key\"),\n\t)\n\trun, err := client.Beta.Threads.Runs.New(\n\t\tcontext.TODO(),\n\t\t\"thread_id\",\n\t\topenai.BetaThreadRunNewParams{\n\t\t\tAssistantID: \"assistant_id\",\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf(\"%+v\\n\", run.ID)\n}\n","java":"package com.openai.example;\n\nimport com.openai.client.OpenAIClient;\nimport com.openai.client.okhttp.OpenAIOkHttpClient;\nimport com.openai.models.beta.threads.runs.Run;\nimport com.openai.models.beta.threads.runs.RunCreateParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n OpenAIClient client = OpenAIOkHttpClient.fromEnv();\n\n RunCreateParams params = RunCreateParams.builder()\n .threadId(\"thread_id\")\n .assistantId(\"assistant_id\")\n .build();\n Run run = client.beta().threads().runs().create(params);\n }\n}","ruby":"require \"openai\"\n\nopenai = OpenAI::Client.new(api_key: \"My API Key\")\n\nrun = openai.beta.threads.runs.create(\"thread_id\", assistant_id: \"assistant_id\")\n\nputs(run)"},"response":"{\n \"id\": \"run_abc123\",\n \"object\": \"thread.run\",\n \"created_at\": 1699063290,\n \"assistant_id\": \"asst_abc123\",\n \"thread_id\": \"thread_abc123\",\n \"status\": \"queued\",\n \"started_at\": 1699063290,\n \"expires_at\": null,\n \"cancelled_at\": null,\n \"failed_at\": null,\n \"completed_at\": 1699063291,\n \"last_error\": null,\n \"model\": \"gpt-4o\",\n \"instructions\": null,\n \"incomplete_details\": null,\n \"tools\": [\n {\n \"type\": \"code_interpreter\"\n }\n ],\n \"metadata\": {},\n \"usage\": null,\n \"temperature\": 1.0,\n \"top_p\": 1.0,\n \"max_prompt_tokens\": 1000,\n \"max_completion_tokens\": 1000,\n \"truncation_strategy\": {\n \"type\": \"auto\",\n \"last_messages\": null\n },\n \"response_format\": \"auto\",\n \"tool_choice\": \"auto\",\n \"parallel_tool_calls\": true\n}\n"},{"title":"Streaming","request":{"curl":"curl https://api.openai.com/v1/threads/thread_123/runs \\\n -H \"Authorization: Bearer $OPENAI_API_KEY\" \\\n -H \"Content-Type: application/json\" \\\n -H \"OpenAI-Beta: assistants=v2\" \\\n -d '{\n \"assistant_id\": \"asst_123\",\n \"stream\": true\n }'\n","python":"import os\nfrom openai import OpenAI\n\nclient = OpenAI(\n api_key=os.environ.get(\"OPENAI_API_KEY\"), # This is the default and can be omitted\n)\nfor run in client.beta.threads.runs.create(\n thread_id=\"thread_id\",\n assistant_id=\"assistant_id\",\n):\n print(run)","javascript":"import OpenAI from \"openai\";\n\nconst openai = new OpenAI();\n\nasync function main() {\n const stream = await openai.beta.threads.runs.create(\n \"thread_123\",\n { assistant_id: \"asst_123\", stream: true }\n );\n\n for await (const event of stream) {\n console.log(event);\n }\n}\n\nmain();\n","node.js":"import OpenAI from 'openai';\n\nconst client = new OpenAI({\n apiKey: process.env['OPENAI_API_KEY'], // This is the default and can be omitted\n});\n\nconst run = await client.beta.threads.runs.create('thread_id', { assistant_id: 'assistant_id' });\n\nconsole.log(run.id);","go":"package main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\n\t\"github.com/openai/openai-go\"\n\t\"github.com/openai/openai-go/option\"\n)\n\nfunc main() {\n\tclient := openai.NewClient(\n\t\toption.WithAPIKey(\"My API Key\"),\n\t)\n\trun, err := client.Beta.Threads.Runs.New(\n\t\tcontext.TODO(),\n\t\t\"thread_id\",\n\t\topenai.BetaThreadRunNewParams{\n\t\t\tAssistantID: \"assistant_id\",\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf(\"%+v\\n\", run.ID)\n}\n","java":"package com.openai.example;\n\nimport com.openai.client.OpenAIClient;\nimport com.openai.client.okhttp.OpenAIOkHttpClient;\nimport com.openai.models.beta.threads.runs.Run;\nimport com.openai.models.beta.threads.runs.RunCreateParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n OpenAIClient client = OpenAIOkHttpClient.fromEnv();\n\n RunCreateParams params = RunCreateParams.builder()\n .threadId(\"thread_id\")\n .assistantId(\"assistant_id\")\n .build();\n Run run = client.beta().threads().runs().create(params);\n }\n}","ruby":"require \"openai\"\n\nopenai = OpenAI::Client.new(api_key: \"My API Key\")\n\nrun = openai.beta.threads.runs.create(\"thread_id\", assistant_id: \"assistant_id\")\n\nputs(run)"},"response":"event: thread.run.created\ndata: {\"id\":\"run_123\",\"object\":\"thread.run\",\"created_at\":1710330640,\"assistant_id\":\"asst_123\",\"thread_id\":\"thread_123\",\"status\":\"queued\",\"started_at\":null,\"expires_at\":1710331240,\"cancelled_at\":null,\"failed_at\":null,\"completed_at\":null,\"required_action\":null,\"last_error\":null,\"model\":\"gpt-4o\",\"instructions\":null,\"tools\":[],\"metadata\":{},\"temperature\":1.0,\"top_p\":1.0,\"max_completion_tokens\":null,\"max_prompt_tokens\":null,\"truncation_strategy\":{\"type\":\"auto\",\"last_messages\":null},\"incomplete_details\":null,\"usage\":null,\"response_format\":\"auto\",\"tool_choice\":\"auto\",\"parallel_tool_calls\":true}}\n\nevent: thread.run.queued\ndata: {\"id\":\"run_123\",\"object\":\"thread.run\",\"created_at\":1710330640,\"assistant_id\":\"asst_123\",\"thread_id\":\"thread_123\",\"status\":\"queued\",\"started_at\":null,\"expires_at\":1710331240,\"cancelled_at\":null,\"failed_at\":null,\"completed_at\":null,\"required_action\":null,\"last_error\":null,\"model\":\"gpt-4o\",\"instructions\":null,\"tools\":[],\"metadata\":{},\"temperature\":1.0,\"top_p\":1.0,\"max_completion_tokens\":null,\"max_prompt_tokens\":null,\"truncation_strategy\":{\"type\":\"auto\",\"last_messages\":null},\"incomplete_details\":null,\"usage\":null,\"response_format\":\"auto\",\"tool_choice\":\"auto\",\"parallel_tool_calls\":true}}\n\nevent: thread.run.in_progress\ndata: {\"id\":\"run_123\",\"object\":\"thread.run\",\"created_at\":1710330640,\"assistant_id\":\"asst_123\",\"thread_id\":\"thread_123\",\"status\":\"in_progress\",\"started_at\":1710330641,\"expires_at\":1710331240,\"cancelled_at\":null,\"failed_at\":null,\"completed_at\":null,\"required_action\":null,\"last_error\":null,\"model\":\"gpt-4o\",\"instructions\":null,\"tools\":[],\"metadata\":{},\"temperature\":1.0,\"top_p\":1.0,\"max_completion_tokens\":null,\"max_prompt_tokens\":null,\"truncation_strategy\":{\"type\":\"auto\",\"last_messages\":null},\"incomplete_details\":null,\"usage\":null,\"response_format\":\"auto\",\"tool_choice\":\"auto\",\"parallel_tool_calls\":true}}\n\nevent: thread.run.step.created\ndata: {\"id\":\"step_001\",\"object\":\"thread.run.step\",\"created_at\":1710330641,\"run_id\":\"run_123\",\"assistant_id\":\"asst_123\",\"thread_id\":\"thread_123\",\"type\":\"message_creation\",\"status\":\"in_progress\",\"cancelled_at\":null,\"completed_at\":null,\"expires_at\":1710331240,\"failed_at\":null,\"last_error\":null,\"step_details\":{\"type\":\"message_creation\",\"message_creation\":{\"message_id\":\"msg_001\"}},\"usage\":null}\n\nevent: thread.run.step.in_progress\ndata: {\"id\":\"step_001\",\"object\":\"thread.run.step\",\"created_at\":1710330641,\"run_id\":\"run_123\",\"assistant_id\":\"asst_123\",\"thread_id\":\"thread_123\",\"type\":\"message_creation\",\"status\":\"in_progress\",\"cancelled_at\":null,\"completed_at\":null,\"expires_at\":1710331240,\"failed_at\":null,\"last_error\":null,\"step_details\":{\"type\":\"message_creation\",\"message_creation\":{\"message_id\":\"msg_001\"}},\"usage\":null}\n\nevent: thread.message.created\ndata: {\"id\":\"msg_001\",\"object\":\"thread.message\",\"created_at\":1710330641,\"assistant_id\":\"asst_123\",\"thread_id\":\"thread_123\",\"run_id\":\"run_123\",\"status\":\"in_progress\",\"incomplete_details\":null,\"incomplete_at\":null,\"completed_at\":null,\"role\":\"assistant\",\"content\":[],\"metadata\":{}}\n\nevent: thread.message.in_progress\ndata: {\"id\":\"msg_001\",\"object\":\"thread.message\",\"created_at\":1710330641,\"assistant_id\":\"asst_123\",\"thread_id\":\"thread_123\",\"run_id\":\"run_123\",\"status\":\"in_progress\",\"incomplete_details\":null,\"incomplete_at\":null,\"completed_at\":null,\"role\":\"assistant\",\"content\":[],\"metadata\":{}}\n\nevent: thread.message.delta\ndata: {\"id\":\"msg_001\",\"object\":\"thread.message.delta\",\"delta\":{\"content\":[{\"index\":0,\"type\":\"text\",\"text\":{\"value\":\"Hello\",\"annotations\":[]}}]}}\n\n...\n\nevent: thread.message.delta\ndata: {\"id\":\"msg_001\",\"object\":\"thread.message.delta\",\"delta\":{\"content\":[{\"index\":0,\"type\":\"text\",\"text\":{\"value\":\" today\"}}]}}\n\nevent: thread.message.delta\ndata: {\"id\":\"msg_001\",\"object\":\"thread.message.delta\",\"delta\":{\"content\":[{\"index\":0,\"type\":\"text\",\"text\":{\"value\":\"?\"}}]}}\n\nevent: thread.message.completed\ndata: {\"id\":\"msg_001\",\"object\":\"thread.message\",\"created_at\":1710330641,\"assistant_id\":\"asst_123\",\"thread_id\":\"thread_123\",\"run_id\":\"run_123\",\"status\":\"completed\",\"incomplete_details\":null,\"incomplete_at\":null,\"completed_at\":1710330642,\"role\":\"assistant\",\"content\":[{\"type\":\"text\",\"text\":{\"value\":\"Hello! How can I assist you today?\",\"annotations\":[]}}],\"metadata\":{}}\n\nevent: thread.run.step.completed\ndata: {\"id\":\"step_001\",\"object\":\"thread.run.step\",\"created_at\":1710330641,\"run_id\":\"run_123\",\"assistant_id\":\"asst_123\",\"thread_id\":\"thread_123\",\"type\":\"message_creation\",\"status\":\"completed\",\"cancelled_at\":null,\"completed_at\":1710330642,\"expires_at\":1710331240,\"failed_at\":null,\"last_error\":null,\"step_details\":{\"type\":\"message_creation\",\"message_creation\":{\"message_id\":\"msg_001\"}},\"usage\":{\"prompt_tokens\":20,\"completion_tokens\":11,\"total_tokens\":31}}\n\nevent: thread.run.completed\ndata: {\"id\":\"run_123\",\"object\":\"thread.run\",\"created_at\":1710330640,\"assistant_id\":\"asst_123\",\"thread_id\":\"thread_123\",\"status\":\"completed\",\"started_at\":1710330641,\"expires_at\":null,\"cancelled_at\":null,\"failed_at\":null,\"completed_at\":1710330642,\"required_action\":null,\"last_error\":null,\"model\":\"gpt-4o\",\"instructions\":null,\"tools\":[],\"metadata\":{},\"temperature\":1.0,\"top_p\":1.0,\"max_completion_tokens\":null,\"max_prompt_tokens\":null,\"truncation_strategy\":{\"type\":\"auto\",\"last_messages\":null},\"incomplete_details\":null,\"usage\":{\"prompt_tokens\":20,\"completion_tokens\":11,\"total_tokens\":31},\"response_format\":\"auto\",\"tool_choice\":\"auto\",\"parallel_tool_calls\":true}}\n\nevent: done\ndata: [DONE]\n"},{"title":"Streaming with Functions","request":{"curl":"curl https://api.openai.com/v1/threads/thread_abc123/runs \\\n -H \"Authorization: Bearer $OPENAI_API_KEY\" \\\n -H \"Content-Type: application/json\" \\\n -H \"OpenAI-Beta: assistants=v2\" \\\n -d '{\n \"assistant_id\": \"asst_abc123\",\n \"tools\": [\n {\n \"type\": \"function\",\n \"function\": {\n \"name\": \"get_current_weather\",\n \"description\": \"Get the current weather in a given location\",\n \"parameters\": {\n \"type\": \"object\",\n \"properties\": {\n \"location\": {\n \"type\": \"string\",\n \"description\": \"The city and state, e.g. San Francisco, CA\"\n },\n \"unit\": {\n \"type\": \"string\",\n \"enum\": [\"celsius\", \"fahrenheit\"]\n }\n },\n \"required\": [\"location\"]\n }\n }\n }\n ],\n \"stream\": true\n }'\n","python":"import os\nfrom openai import OpenAI\n\nclient = OpenAI(\n api_key=os.environ.get(\"OPENAI_API_KEY\"), # This is the default and can be omitted\n)\nfor run in client.beta.threads.runs.create(\n thread_id=\"thread_id\",\n assistant_id=\"assistant_id\",\n):\n print(run)","javascript":"import OpenAI from \"openai\";\n\nconst openai = new OpenAI();\n\nconst tools = [\n {\n \"type\": \"function\",\n \"function\": {\n \"name\": \"get_current_weather\",\n \"description\": \"Get the current weather in a given location\",\n \"parameters\": {\n \"type\": \"object\",\n \"properties\": {\n \"location\": {\n \"type\": \"string\",\n \"description\": \"The city and state, e.g. San Francisco, CA\",\n },\n \"unit\": {\"type\": \"string\", \"enum\": [\"celsius\", \"fahrenheit\"]},\n },\n \"required\": [\"location\"],\n },\n }\n }\n];\n\nasync function main() {\n const stream = await openai.beta.threads.runs.create(\n \"thread_abc123\",\n {\n assistant_id: \"asst_abc123\",\n tools: tools,\n stream: true\n }\n );\n\n for await (const event of stream) {\n console.log(event);\n }\n}\n\nmain();\n","node.js":"import OpenAI from 'openai';\n\nconst client = new OpenAI({\n apiKey: process.env['OPENAI_API_KEY'], // This is the default and can be omitted\n});\n\nconst run = await client.beta.threads.runs.create('thread_id', { assistant_id: 'assistant_id' });\n\nconsole.log(run.id);","go":"package main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\n\t\"github.com/openai/openai-go\"\n\t\"github.com/openai/openai-go/option\"\n)\n\nfunc main() {\n\tclient := openai.NewClient(\n\t\toption.WithAPIKey(\"My API Key\"),\n\t)\n\trun, err := client.Beta.Threads.Runs.New(\n\t\tcontext.TODO(),\n\t\t\"thread_id\",\n\t\topenai.BetaThreadRunNewParams{\n\t\t\tAssistantID: \"assistant_id\",\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf(\"%+v\\n\", run.ID)\n}\n","java":"package com.openai.example;\n\nimport com.openai.client.OpenAIClient;\nimport com.openai.client.okhttp.OpenAIOkHttpClient;\nimport com.openai.models.beta.threads.runs.Run;\nimport com.openai.models.beta.threads.runs.RunCreateParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n OpenAIClient client = OpenAIOkHttpClient.fromEnv();\n\n RunCreateParams params = RunCreateParams.builder()\n .threadId(\"thread_id\")\n .assistantId(\"assistant_id\")\n .build();\n Run run = client.beta().threads().runs().create(params);\n }\n}","ruby":"require \"openai\"\n\nopenai = OpenAI::Client.new(api_key: \"My API Key\")\n\nrun = openai.beta.threads.runs.create(\"thread_id\", assistant_id: \"assistant_id\")\n\nputs(run)"},"response":"event: thread.run.created\ndata: {\"id\":\"run_123\",\"object\":\"thread.run\",\"created_at\":1710348075,\"assistant_id\":\"asst_123\",\"thread_id\":\"thread_123\",\"status\":\"queued\",\"started_at\":null,\"expires_at\":1710348675,\"cancelled_at\":null,\"failed_at\":null,\"completed_at\":null,\"required_action\":null,\"last_error\":null,\"model\":\"gpt-4o\",\"instructions\":null,\"tools\":[],\"metadata\":{},\"temperature\":1.0,\"top_p\":1.0,\"max_completion_tokens\":null,\"max_prompt_tokens\":null,\"truncation_strategy\":{\"type\":\"auto\",\"last_messages\":null},\"incomplete_details\":null,\"usage\":null,\"response_format\":\"auto\",\"tool_choice\":\"auto\",\"parallel_tool_calls\":true}}\n\nevent: thread.run.queued\ndata: {\"id\":\"run_123\",\"object\":\"thread.run\",\"created_at\":1710348075,\"assistant_id\":\"asst_123\",\"thread_id\":\"thread_123\",\"status\":\"queued\",\"started_at\":null,\"expires_at\":1710348675,\"cancelled_at\":null,\"failed_at\":null,\"completed_at\":null,\"required_action\":null,\"last_error\":null,\"model\":\"gpt-4o\",\"instructions\":null,\"tools\":[],\"metadata\":{},\"temperature\":1.0,\"top_p\":1.0,\"max_completion_tokens\":null,\"max_prompt_tokens\":null,\"truncation_strategy\":{\"type\":\"auto\",\"last_messages\":null},\"incomplete_details\":null,\"usage\":null,\"response_format\":\"auto\",\"tool_choice\":\"auto\",\"parallel_tool_calls\":true}}\n\nevent: thread.run.in_progress\ndata: {\"id\":\"run_123\",\"object\":\"thread.run\",\"created_at\":1710348075,\"assistant_id\":\"asst_123\",\"thread_id\":\"thread_123\",\"status\":\"in_progress\",\"started_at\":1710348075,\"expires_at\":1710348675,\"cancelled_at\":null,\"failed_at\":null,\"completed_at\":null,\"required_action\":null,\"last_error\":null,\"model\":\"gpt-4o\",\"instructions\":null,\"tools\":[],\"metadata\":{},\"temperature\":1.0,\"top_p\":1.0,\"max_completion_tokens\":null,\"max_prompt_tokens\":null,\"truncation_strategy\":{\"type\":\"auto\",\"last_messages\":null},\"incomplete_details\":null,\"usage\":null,\"response_format\":\"auto\",\"tool_choice\":\"auto\",\"parallel_tool_calls\":true}}\n\nevent: thread.run.step.created\ndata: {\"id\":\"step_001\",\"object\":\"thread.run.step\",\"created_at\":1710348076,\"run_id\":\"run_123\",\"assistant_id\":\"asst_123\",\"thread_id\":\"thread_123\",\"type\":\"message_creation\",\"status\":\"in_progress\",\"cancelled_at\":null,\"completed_at\":null,\"expires_at\":1710348675,\"failed_at\":null,\"last_error\":null,\"step_details\":{\"type\":\"message_creation\",\"message_creation\":{\"message_id\":\"msg_001\"}},\"usage\":null}\n\nevent: thread.run.step.in_progress\ndata: {\"id\":\"step_001\",\"object\":\"thread.run.step\",\"created_at\":1710348076,\"run_id\":\"run_123\",\"assistant_id\":\"asst_123\",\"thread_id\":\"thread_123\",\"type\":\"message_creation\",\"status\":\"in_progress\",\"cancelled_at\":null,\"completed_at\":null,\"expires_at\":1710348675,\"failed_at\":null,\"last_error\":null,\"step_details\":{\"type\":\"message_creation\",\"message_creation\":{\"message_id\":\"msg_001\"}},\"usage\":null}\n\nevent: thread.message.created\ndata: {\"id\":\"msg_001\",\"object\":\"thread.message\",\"created_at\":1710348076,\"assistant_id\":\"asst_123\",\"thread_id\":\"thread_123\",\"run_id\":\"run_123\",\"status\":\"in_progress\",\"incomplete_details\":null,\"incomplete_at\":null,\"completed_at\":null,\"role\":\"assistant\",\"content\":[],\"metadata\":{}}\n\nevent: thread.message.in_progress\ndata: {\"id\":\"msg_001\",\"object\":\"thread.message\",\"created_at\":1710348076,\"assistant_id\":\"asst_123\",\"thread_id\":\"thread_123\",\"run_id\":\"run_123\",\"status\":\"in_progress\",\"incomplete_details\":null,\"incomplete_at\":null,\"completed_at\":null,\"role\":\"assistant\",\"content\":[],\"metadata\":{}}\n\nevent: thread.message.delta\ndata: {\"id\":\"msg_001\",\"object\":\"thread.message.delta\",\"delta\":{\"content\":[{\"index\":0,\"type\":\"text\",\"text\":{\"value\":\"Hello\",\"annotations\":[]}}]}}\n\n...\n\nevent: thread.message.delta\ndata: {\"id\":\"msg_001\",\"object\":\"thread.message.delta\",\"delta\":{\"content\":[{\"index\":0,\"type\":\"text\",\"text\":{\"value\":\" today\"}}]}}\n\nevent: thread.message.delta\ndata: {\"id\":\"msg_001\",\"object\":\"thread.message.delta\",\"delta\":{\"content\":[{\"index\":0,\"type\":\"text\",\"text\":{\"value\":\"?\"}}]}}\n\nevent: thread.message.completed\ndata: {\"id\":\"msg_001\",\"object\":\"thread.message\",\"created_at\":1710348076,\"assistant_id\":\"asst_123\",\"thread_id\":\"thread_123\",\"run_id\":\"run_123\",\"status\":\"completed\",\"incomplete_details\":null,\"incomplete_at\":null,\"completed_at\":1710348077,\"role\":\"assistant\",\"content\":[{\"type\":\"text\",\"text\":{\"value\":\"Hello! How can I assist you today?\",\"annotations\":[]}}],\"metadata\":{}}\n\nevent: thread.run.step.completed\ndata: {\"id\":\"step_001\",\"object\":\"thread.run.step\",\"created_at\":1710348076,\"run_id\":\"run_123\",\"assistant_id\":\"asst_123\",\"thread_id\":\"thread_123\",\"type\":\"message_creation\",\"status\":\"completed\",\"cancelled_at\":null,\"completed_at\":1710348077,\"expires_at\":1710348675,\"failed_at\":null,\"last_error\":null,\"step_details\":{\"type\":\"message_creation\",\"message_creation\":{\"message_id\":\"msg_001\"}},\"usage\":{\"prompt_tokens\":20,\"completion_tokens\":11,\"total_tokens\":31}}\n\nevent: thread.run.completed\ndata: {\"id\":\"run_123\",\"object\":\"thread.run\",\"created_at\":1710348075,\"assistant_id\":\"asst_123\",\"thread_id\":\"thread_123\",\"status\":\"completed\",\"started_at\":1710348075,\"expires_at\":null,\"cancelled_at\":null,\"failed_at\":null,\"completed_at\":1710348077,\"required_action\":null,\"last_error\":null,\"model\":\"gpt-4o\",\"instructions\":null,\"tools\":[],\"metadata\":{},\"temperature\":1.0,\"top_p\":1.0,\"max_completion_tokens\":null,\"max_prompt_tokens\":null,\"truncation_strategy\":{\"type\":\"auto\",\"last_messages\":null},\"incomplete_details\":null,\"usage\":{\"prompt_tokens\":20,\"completion_tokens\":11,\"total_tokens\":31},\"response_format\":\"auto\",\"tool_choice\":\"auto\",\"parallel_tool_calls\":true}}\n\nevent: done\ndata: [DONE]\n"}]}}},"/threads/{thread_id}/runs/{run_id}":{"get":{"operationId":"getRun","tags":["Assistants"],"summary":"Retrieves a run.","parameters":[{"in":"path","name":"thread_id","required":true,"schema":{"type":"string"},"description":"The ID of the [thread](/docs/api-reference/threads) that was run."},{"in":"path","name":"run_id","required":true,"schema":{"type":"string"},"description":"The ID of the run to retrieve."}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunObject"}}}}},"x-oaiMeta":{"name":"Retrieve run","group":"threads","beta":true,"examples":{"request":{"curl":"curl https://api.openai.com/v1/threads/thread_abc123/runs/run_abc123 \\\n -H \"Authorization: Bearer $OPENAI_API_KEY\" \\\n -H \"OpenAI-Beta: assistants=v2\"\n","python":"import os\nfrom openai import OpenAI\n\nclient = OpenAI(\n api_key=os.environ.get(\"OPENAI_API_KEY\"), # This is the default and can be omitted\n)\nrun = client.beta.threads.runs.retrieve(\n run_id=\"run_id\",\n thread_id=\"thread_id\",\n)\nprint(run.id)","javascript":"import OpenAI from \"openai\";\n\nconst openai = new OpenAI();\n\nasync function main() {\n const run = await openai.beta.threads.runs.retrieve(\n \"run_abc123\",\n { thread_id: \"thread_abc123\" }\n );\n\n console.log(run);\n}\n\nmain();\n","node.js":"import OpenAI from 'openai';\n\nconst client = new OpenAI({\n apiKey: process.env['OPENAI_API_KEY'], // This is the default and can be omitted\n});\n\nconst run = await client.beta.threads.runs.retrieve('run_id', { thread_id: 'thread_id' });\n\nconsole.log(run.id);","go":"package main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\n\t\"github.com/openai/openai-go\"\n\t\"github.com/openai/openai-go/option\"\n)\n\nfunc main() {\n\tclient := openai.NewClient(\n\t\toption.WithAPIKey(\"My API Key\"),\n\t)\n\trun, err := client.Beta.Threads.Runs.Get(\n\t\tcontext.TODO(),\n\t\t\"thread_id\",\n\t\t\"run_id\",\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf(\"%+v\\n\", run.ID)\n}\n","java":"package com.openai.example;\n\nimport com.openai.client.OpenAIClient;\nimport com.openai.client.okhttp.OpenAIOkHttpClient;\nimport com.openai.models.beta.threads.runs.Run;\nimport com.openai.models.beta.threads.runs.RunRetrieveParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n OpenAIClient client = OpenAIOkHttpClient.fromEnv();\n\n RunRetrieveParams params = RunRetrieveParams.builder()\n .threadId(\"thread_id\")\n .runId(\"run_id\")\n .build();\n Run run = client.beta().threads().runs().retrieve(params);\n }\n}","ruby":"require \"openai\"\n\nopenai = OpenAI::Client.new(api_key: \"My API Key\")\n\nrun = openai.beta.threads.runs.retrieve(\"run_id\", thread_id: \"thread_id\")\n\nputs(run)"},"response":"{\n \"id\": \"run_abc123\",\n \"object\": \"thread.run\",\n \"created_at\": 1699075072,\n \"assistant_id\": \"asst_abc123\",\n \"thread_id\": \"thread_abc123\",\n \"status\": \"completed\",\n \"started_at\": 1699075072,\n \"expires_at\": null,\n \"cancelled_at\": null,\n \"failed_at\": null,\n \"completed_at\": 1699075073,\n \"last_error\": null,\n \"model\": \"gpt-4o\",\n \"instructions\": null,\n \"incomplete_details\": null,\n \"tools\": [\n {\n \"type\": \"code_interpreter\"\n }\n ],\n \"metadata\": {},\n \"usage\": {\n \"prompt_tokens\": 123,\n \"completion_tokens\": 456,\n \"total_tokens\": 579\n },\n \"temperature\": 1.0,\n \"top_p\": 1.0,\n \"max_prompt_tokens\": 1000,\n \"max_completion_tokens\": 1000,\n \"truncation_strategy\": {\n \"type\": \"auto\",\n \"last_messages\": null\n },\n \"response_format\": \"auto\",\n \"tool_choice\": \"auto\",\n \"parallel_tool_calls\": true\n}\n"}}},"post":{"operationId":"modifyRun","tags":["Assistants"],"summary":"Modifies a run.","parameters":[{"in":"path","name":"thread_id","required":true,"schema":{"type":"string"},"description":"The ID of the [thread](/docs/api-reference/threads) that was run."},{"in":"path","name":"run_id","required":true,"schema":{"type":"string"},"description":"The ID of the run to modify."}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModifyRunRequest"}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunObject"}}}}},"x-oaiMeta":{"name":"Modify run","group":"threads","beta":true,"examples":{"request":{"curl":"curl https://api.openai.com/v1/threads/thread_abc123/runs/run_abc123 \\\n -H \"Authorization: Bearer $OPENAI_API_KEY\" \\\n -H \"Content-Type: application/json\" \\\n -H \"OpenAI-Beta: assistants=v2\" \\\n -d '{\n \"metadata\": {\n \"user_id\": \"user_abc123\"\n }\n }'\n","python":"import os\nfrom openai import OpenAI\n\nclient = OpenAI(\n api_key=os.environ.get(\"OPENAI_API_KEY\"), # This is the default and can be omitted\n)\nrun = client.beta.threads.runs.update(\n run_id=\"run_id\",\n thread_id=\"thread_id\",\n)\nprint(run.id)","javascript":"import OpenAI from \"openai\";\n\nconst openai = new OpenAI();\n\nasync function main() {\n const run = await openai.beta.threads.runs.update(\n \"run_abc123\",\n {\n thread_id: \"thread_abc123\",\n metadata: {\n user_id: \"user_abc123\",\n },\n }\n );\n\n console.log(run);\n}\n\nmain();\n","node.js":"import OpenAI from 'openai';\n\nconst client = new OpenAI({\n apiKey: process.env['OPENAI_API_KEY'], // This is the default and can be omitted\n});\n\nconst run = await client.beta.threads.runs.update('run_id', { thread_id: 'thread_id' });\n\nconsole.log(run.id);","go":"package main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\n\t\"github.com/openai/openai-go\"\n\t\"github.com/openai/openai-go/option\"\n)\n\nfunc main() {\n\tclient := openai.NewClient(\n\t\toption.WithAPIKey(\"My API Key\"),\n\t)\n\trun, err := client.Beta.Threads.Runs.Update(\n\t\tcontext.TODO(),\n\t\t\"thread_id\",\n\t\t\"run_id\",\n\t\topenai.BetaThreadRunUpdateParams{},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf(\"%+v\\n\", run.ID)\n}\n","java":"package com.openai.example;\n\nimport com.openai.client.OpenAIClient;\nimport com.openai.client.okhttp.OpenAIOkHttpClient;\nimport com.openai.models.beta.threads.runs.Run;\nimport com.openai.models.beta.threads.runs.RunUpdateParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n OpenAIClient client = OpenAIOkHttpClient.fromEnv();\n\n RunUpdateParams params = RunUpdateParams.builder()\n .threadId(\"thread_id\")\n .runId(\"run_id\")\n .build();\n Run run = client.beta().threads().runs().update(params);\n }\n}","ruby":"require \"openai\"\n\nopenai = OpenAI::Client.new(api_key: \"My API Key\")\n\nrun = openai.beta.threads.runs.update(\"run_id\", thread_id: \"thread_id\")\n\nputs(run)"},"response":"{\n \"id\": \"run_abc123\",\n \"object\": \"thread.run\",\n \"created_at\": 1699075072,\n \"assistant_id\": \"asst_abc123\",\n \"thread_id\": \"thread_abc123\",\n \"status\": \"completed\",\n \"started_at\": 1699075072,\n \"expires_at\": null,\n \"cancelled_at\": null,\n \"failed_at\": null,\n \"completed_at\": 1699075073,\n \"last_error\": null,\n \"model\": \"gpt-4o\",\n \"instructions\": null,\n \"incomplete_details\": null,\n \"tools\": [\n {\n \"type\": \"code_interpreter\"\n }\n ],\n \"tool_resources\": {\n \"code_interpreter\": {\n \"file_ids\": [\n \"file-abc123\",\n \"file-abc456\"\n ]\n }\n },\n \"metadata\": {\n \"user_id\": \"user_abc123\"\n },\n \"usage\": {\n \"prompt_tokens\": 123,\n \"completion_tokens\": 456,\n \"total_tokens\": 579\n },\n \"temperature\": 1.0,\n \"top_p\": 1.0,\n \"max_prompt_tokens\": 1000,\n \"max_completion_tokens\": 1000,\n \"truncation_strategy\": {\n \"type\": \"auto\",\n \"last_messages\": null\n },\n \"response_format\": \"auto\",\n \"tool_choice\": \"auto\",\n \"parallel_tool_calls\": true\n}\n"}}}},"/threads/{thread_id}/runs/{run_id}/cancel":{"post":{"operationId":"cancelRun","tags":["Assistants"],"summary":"Cancels a run that is `in_progress`.","parameters":[{"in":"path","name":"thread_id","required":true,"schema":{"type":"string"},"description":"The ID of the thread to which this run belongs."},{"in":"path","name":"run_id","required":true,"schema":{"type":"string"},"description":"The ID of the run to cancel."}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunObject"}}}}},"x-oaiMeta":{"name":"Cancel a run","group":"threads","beta":true,"examples":{"request":{"curl":"curl https://api.openai.com/v1/threads/thread_abc123/runs/run_abc123/cancel \\\n -H \"Authorization: Bearer $OPENAI_API_KEY\" \\\n -H \"OpenAI-Beta: assistants=v2\" \\\n -X POST\n","python":"import os\nfrom openai import OpenAI\n\nclient = OpenAI(\n api_key=os.environ.get(\"OPENAI_API_KEY\"), # This is the default and can be omitted\n)\nrun = client.beta.threads.runs.cancel(\n run_id=\"run_id\",\n thread_id=\"thread_id\",\n)\nprint(run.id)","javascript":"import OpenAI from \"openai\";\n\nconst openai = new OpenAI();\n\nasync function main() {\n const run = await openai.beta.threads.runs.cancel(\n \"run_abc123\",\n { thread_id: \"thread_abc123\" }\n );\n\n console.log(run);\n}\n\nmain();\n","node.js":"import OpenAI from 'openai';\n\nconst client = new OpenAI({\n apiKey: process.env['OPENAI_API_KEY'], // This is the default and can be omitted\n});\n\nconst run = await client.beta.threads.runs.cancel('run_id', { thread_id: 'thread_id' });\n\nconsole.log(run.id);","go":"package main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\n\t\"github.com/openai/openai-go\"\n\t\"github.com/openai/openai-go/option\"\n)\n\nfunc main() {\n\tclient := openai.NewClient(\n\t\toption.WithAPIKey(\"My API Key\"),\n\t)\n\trun, err := client.Beta.Threads.Runs.Cancel(\n\t\tcontext.TODO(),\n\t\t\"thread_id\",\n\t\t\"run_id\",\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf(\"%+v\\n\", run.ID)\n}\n","java":"package com.openai.example;\n\nimport com.openai.client.OpenAIClient;\nimport com.openai.client.okhttp.OpenAIOkHttpClient;\nimport com.openai.models.beta.threads.runs.Run;\nimport com.openai.models.beta.threads.runs.RunCancelParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n OpenAIClient client = OpenAIOkHttpClient.fromEnv();\n\n RunCancelParams params = RunCancelParams.builder()\n .threadId(\"thread_id\")\n .runId(\"run_id\")\n .build();\n Run run = client.beta().threads().runs().cancel(params);\n }\n}","ruby":"require \"openai\"\n\nopenai = OpenAI::Client.new(api_key: \"My API Key\")\n\nrun = openai.beta.threads.runs.cancel(\"run_id\", thread_id: \"thread_id\")\n\nputs(run)"},"response":"{\n \"id\": \"run_abc123\",\n \"object\": \"thread.run\",\n \"created_at\": 1699076126,\n \"assistant_id\": \"asst_abc123\",\n \"thread_id\": \"thread_abc123\",\n \"status\": \"cancelling\",\n \"started_at\": 1699076126,\n \"expires_at\": 1699076726,\n \"cancelled_at\": null,\n \"failed_at\": null,\n \"completed_at\": null,\n \"last_error\": null,\n \"model\": \"gpt-4o\",\n \"instructions\": \"You summarize books.\",\n \"tools\": [\n {\n \"type\": \"file_search\"\n }\n ],\n \"tool_resources\": {\n \"file_search\": {\n \"vector_store_ids\": [\"vs_123\"]\n }\n },\n \"metadata\": {},\n \"usage\": null,\n \"temperature\": 1.0,\n \"top_p\": 1.0,\n \"response_format\": \"auto\",\n \"tool_choice\": \"auto\",\n \"parallel_tool_calls\": true\n}\n"}}}},"/threads/{thread_id}/runs/{run_id}/steps":{"get":{"operationId":"listRunSteps","tags":["Assistants"],"summary":"Returns a list of run steps belonging to a run.","parameters":[{"name":"thread_id","in":"path","required":true,"schema":{"type":"string"},"description":"The ID of the thread the run and run steps belong to."},{"name":"run_id","in":"path","required":true,"schema":{"type":"string"},"description":"The ID of the run the run steps belong to."},{"name":"limit","in":"query","description":"A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.\n","required":false,"schema":{"type":"integer","default":20}},{"name":"order","in":"query","description":"Sort order by the `created_at` timestamp of the objects. `asc` for ascending order and `desc` for descending order.\n","schema":{"type":"string","default":"desc","enum":["asc","desc"]}},{"name":"after","in":"query","description":"A cursor for use in pagination. `after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list.\n","schema":{"type":"string"}},{"name":"before","in":"query","description":"A cursor for use in pagination. `before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_foo, your subsequent call can include before=obj_foo in order to fetch the previous page of the list.\n","schema":{"type":"string"}},{"name":"include[]","in":"query","description":"A list of additional fields to include in the response. Currently the only supported value is `step_details.tool_calls[*].file_search.results[*].content` to fetch the file search result content.\n\nSee the [file search tool documentation](/docs/assistants/tools/file-search#customizing-file-search-settings) for more information.\n","schema":{"type":"array","items":{"type":"string","enum":["step_details.tool_calls[*].file_search.results[*].content"]}}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListRunStepsResponse"}}}}},"x-oaiMeta":{"name":"List run steps","group":"threads","beta":true,"examples":{"request":{"curl":"curl https://api.openai.com/v1/threads/thread_abc123/runs/run_abc123/steps \\\n -H \"Authorization: Bearer $OPENAI_API_KEY\" \\\n -H \"Content-Type: application/json\" \\\n -H \"OpenAI-Beta: assistants=v2\"\n","python":"import os\nfrom openai import OpenAI\n\nclient = OpenAI(\n api_key=os.environ.get(\"OPENAI_API_KEY\"), # This is the default and can be omitted\n)\npage = client.beta.threads.runs.steps.list(\n run_id=\"run_id\",\n thread_id=\"thread_id\",\n)\npage = page.data[0]\nprint(page.id)","javascript":"import OpenAI from \"openai\";\nconst openai = new OpenAI();\n\nasync function main() {\n const runStep = await openai.beta.threads.runs.steps.list(\n \"run_abc123\",\n { thread_id: \"thread_abc123\" }\n );\n console.log(runStep);\n}\n\nmain();\n","node.js":"import OpenAI from 'openai';\n\nconst client = new OpenAI({\n apiKey: process.env['OPENAI_API_KEY'], // This is the default and can be omitted\n});\n\n// Automatically fetches more pages as needed.\nfor await (const runStep of client.beta.threads.runs.steps.list('run_id', {\n thread_id: 'thread_id',\n})) {\n console.log(runStep.id);\n}","go":"package main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\n\t\"github.com/openai/openai-go\"\n\t\"github.com/openai/openai-go/option\"\n)\n\nfunc main() {\n\tclient := openai.NewClient(\n\t\toption.WithAPIKey(\"My API Key\"),\n\t)\n\tpage, err := client.Beta.Threads.Runs.Steps.List(\n\t\tcontext.TODO(),\n\t\t\"thread_id\",\n\t\t\"run_id\",\n\t\topenai.BetaThreadRunStepListParams{},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf(\"%+v\\n\", page)\n}\n","java":"package com.openai.example;\n\nimport com.openai.client.OpenAIClient;\nimport com.openai.client.okhttp.OpenAIOkHttpClient;\nimport com.openai.models.beta.threads.runs.steps.StepListPage;\nimport com.openai.models.beta.threads.runs.steps.StepListParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n OpenAIClient client = OpenAIOkHttpClient.fromEnv();\n\n StepListParams params = StepListParams.builder()\n .threadId(\"thread_id\")\n .runId(\"run_id\")\n .build();\n StepListPage page = client.beta().threads().runs().steps().list(params);\n }\n}","ruby":"require \"openai\"\n\nopenai = OpenAI::Client.new(api_key: \"My API Key\")\n\npage = openai.beta.threads.runs.steps.list(\"run_id\", thread_id: \"thread_id\")\n\nputs(page)"},"response":"{\n \"object\": \"list\",\n \"data\": [\n {\n \"id\": \"step_abc123\",\n \"object\": \"thread.run.step\",\n \"created_at\": 1699063291,\n \"run_id\": \"run_abc123\",\n \"assistant_id\": \"asst_abc123\",\n \"thread_id\": \"thread_abc123\",\n \"type\": \"message_creation\",\n \"status\": \"completed\",\n \"cancelled_at\": null,\n \"completed_at\": 1699063291,\n \"expired_at\": null,\n \"failed_at\": null,\n \"last_error\": null,\n \"step_details\": {\n \"type\": \"message_creation\",\n \"message_creation\": {\n \"message_id\": \"msg_abc123\"\n }\n },\n \"usage\": {\n \"prompt_tokens\": 123,\n \"completion_tokens\": 456,\n \"total_tokens\": 579\n }\n }\n ],\n \"first_id\": \"step_abc123\",\n \"last_id\": \"step_abc456\",\n \"has_more\": false\n}\n"}}}},"/threads/{thread_id}/runs/{run_id}/steps/{step_id}":{"get":{"operationId":"getRunStep","tags":["Assistants"],"summary":"Retrieves a run step.","parameters":[{"in":"path","name":"thread_id","required":true,"schema":{"type":"string"},"description":"The ID of the thread to which the run and run step belongs."},{"in":"path","name":"run_id","required":true,"schema":{"type":"string"},"description":"The ID of the run to which the run step belongs."},{"in":"path","name":"step_id","required":true,"schema":{"type":"string"},"description":"The ID of the run step to retrieve."},{"name":"include[]","in":"query","description":"A list of additional fields to include in the response. Currently the only supported value is `step_details.tool_calls[*].file_search.results[*].content` to fetch the file search result content.\n\nSee the [file search tool documentation](/docs/assistants/tools/file-search#customizing-file-search-settings) for more information.\n","schema":{"type":"array","items":{"type":"string","enum":["step_details.tool_calls[*].file_search.results[*].content"]}}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunStepObject"}}}}},"x-oaiMeta":{"name":"Retrieve run step","group":"threads","beta":true,"examples":{"request":{"curl":"curl https://api.openai.com/v1/threads/thread_abc123/runs/run_abc123/steps/step_abc123 \\\n -H \"Authorization: Bearer $OPENAI_API_KEY\" \\\n -H \"Content-Type: application/json\" \\\n -H \"OpenAI-Beta: assistants=v2\"\n","python":"import os\nfrom openai import OpenAI\n\nclient = OpenAI(\n api_key=os.environ.get(\"OPENAI_API_KEY\"), # This is the default and can be omitted\n)\nrun_step = client.beta.threads.runs.steps.retrieve(\n step_id=\"step_id\",\n thread_id=\"thread_id\",\n run_id=\"run_id\",\n)\nprint(run_step.id)","javascript":"import OpenAI from \"openai\";\nconst openai = new OpenAI();\n\nasync function main() {\n const runStep = await openai.beta.threads.runs.steps.retrieve(\n \"step_abc123\",\n { thread_id: \"thread_abc123\", run_id: \"run_abc123\" }\n );\n console.log(runStep);\n}\n\nmain();\n","node.js":"import OpenAI from 'openai';\n\nconst client = new OpenAI({\n apiKey: process.env['OPENAI_API_KEY'], // This is the default and can be omitted\n});\n\nconst runStep = await client.beta.threads.runs.steps.retrieve('step_id', {\n thread_id: 'thread_id',\n run_id: 'run_id',\n});\n\nconsole.log(runStep.id);","go":"package main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\n\t\"github.com/openai/openai-go\"\n\t\"github.com/openai/openai-go/option\"\n)\n\nfunc main() {\n\tclient := openai.NewClient(\n\t\toption.WithAPIKey(\"My API Key\"),\n\t)\n\trunStep, err := client.Beta.Threads.Runs.Steps.Get(\n\t\tcontext.TODO(),\n\t\t\"thread_id\",\n\t\t\"run_id\",\n\t\t\"step_id\",\n\t\topenai.BetaThreadRunStepGetParams{},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf(\"%+v\\n\", runStep.ID)\n}\n","java":"package com.openai.example;\n\nimport com.openai.client.OpenAIClient;\nimport com.openai.client.okhttp.OpenAIOkHttpClient;\nimport com.openai.models.beta.threads.runs.steps.RunStep;\nimport com.openai.models.beta.threads.runs.steps.StepRetrieveParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n OpenAIClient client = OpenAIOkHttpClient.fromEnv();\n\n StepRetrieveParams params = StepRetrieveParams.builder()\n .threadId(\"thread_id\")\n .runId(\"run_id\")\n .stepId(\"step_id\")\n .build();\n RunStep runStep = client.beta().threads().runs().steps().retrieve(params);\n }\n}","ruby":"require \"openai\"\n\nopenai = OpenAI::Client.new(api_key: \"My API Key\")\n\nrun_step = openai.beta.threads.runs.steps.retrieve(\"step_id\", thread_id: \"thread_id\", run_id: \"run_id\")\n\nputs(run_step)"},"response":"{\n \"id\": \"step_abc123\",\n \"object\": \"thread.run.step\",\n \"created_at\": 1699063291,\n \"run_id\": \"run_abc123\",\n \"assistant_id\": \"asst_abc123\",\n \"thread_id\": \"thread_abc123\",\n \"type\": \"message_creation\",\n \"status\": \"completed\",\n \"cancelled_at\": null,\n \"completed_at\": 1699063291,\n \"expired_at\": null,\n \"failed_at\": null,\n \"last_error\": null,\n \"step_details\": {\n \"type\": \"message_creation\",\n \"message_creation\": {\n \"message_id\": \"msg_abc123\"\n }\n },\n \"usage\": {\n \"prompt_tokens\": 123,\n \"completion_tokens\": 456,\n \"total_tokens\": 579\n }\n}\n"}}}},"/threads/{thread_id}/runs/{run_id}/submit_tool_outputs":{"post":{"operationId":"submitToolOuputsToRun","tags":["Assistants"],"summary":"When a run has the `status: \"requires_action\"` and `required_action.type` is `submit_tool_outputs`, this endpoint can be used to submit the outputs from the tool calls once they're all completed. All outputs must be submitted in a single request.\n","parameters":[{"in":"path","name":"thread_id","required":true,"schema":{"type":"string"},"description":"The ID of the [thread](/docs/api-reference/threads) to which this run belongs."},{"in":"path","name":"run_id","required":true,"schema":{"type":"string"},"description":"The ID of the run that requires the tool output submission."}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubmitToolOutputsRunRequest"}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunObject"}}}}},"x-oaiMeta":{"name":"Submit tool outputs to run","group":"threads","beta":true,"examples":[{"title":"Default","request":{"curl":"curl https://api.openai.com/v1/threads/thread_123/runs/run_123/submit_tool_outputs \\\n -H \"Authorization: Bearer $OPENAI_API_KEY\" \\\n -H \"Content-Type: application/json\" \\\n -H \"OpenAI-Beta: assistants=v2\" \\\n -d '{\n \"tool_outputs\": [\n {\n \"tool_call_id\": \"call_001\",\n \"output\": \"70 degrees and sunny.\"\n }\n ]\n }'\n","python":"import os\nfrom openai import OpenAI\n\nclient = OpenAI(\n api_key=os.environ.get(\"OPENAI_API_KEY\"), # This is the default and can be omitted\n)\nfor run in client.beta.threads.runs.submit_tool_outputs(\n run_id=\"run_id\",\n thread_id=\"thread_id\",\n tool_outputs=[{}],\n):\n print(run)","javascript":"import OpenAI from \"openai\";\n\nconst openai = new OpenAI();\n\nasync function main() {\n const run = await openai.beta.threads.runs.submitToolOutputs(\n \"run_123\",\n {\n thread_id: \"thread_123\",\n tool_outputs: [\n {\n tool_call_id: \"call_001\",\n output: \"70 degrees and sunny.\",\n },\n ],\n }\n );\n\n console.log(run);\n}\n\nmain();\n","node.js":"import OpenAI from 'openai';\n\nconst client = new OpenAI({\n apiKey: process.env['OPENAI_API_KEY'], // This is the default and can be omitted\n});\n\nconst run = await client.beta.threads.runs.submitToolOutputs('run_id', {\n thread_id: 'thread_id',\n tool_outputs: [{}],\n});\n\nconsole.log(run.id);","go":"package main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\n\t\"github.com/openai/openai-go\"\n\t\"github.com/openai/openai-go/option\"\n)\n\nfunc main() {\n\tclient := openai.NewClient(\n\t\toption.WithAPIKey(\"My API Key\"),\n\t)\n\trun, err := client.Beta.Threads.Runs.SubmitToolOutputs(\n\t\tcontext.TODO(),\n\t\t\"thread_id\",\n\t\t\"run_id\",\n\t\topenai.BetaThreadRunSubmitToolOutputsParams{\n\t\t\tToolOutputs: []openai.BetaThreadRunSubmitToolOutputsParamsToolOutput{{}},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf(\"%+v\\n\", run.ID)\n}\n","java":"package com.openai.example;\n\nimport com.openai.client.OpenAIClient;\nimport com.openai.client.okhttp.OpenAIOkHttpClient;\nimport com.openai.models.beta.threads.runs.Run;\nimport com.openai.models.beta.threads.runs.RunSubmitToolOutputsParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n OpenAIClient client = OpenAIOkHttpClient.fromEnv();\n\n RunSubmitToolOutputsParams params = RunSubmitToolOutputsParams.builder()\n .threadId(\"thread_id\")\n .runId(\"run_id\")\n .addToolOutput(RunSubmitToolOutputsParams.ToolOutput.builder().build())\n .build();\n Run run = client.beta().threads().runs().submitToolOutputs(params);\n }\n}","ruby":"require \"openai\"\n\nopenai = OpenAI::Client.new(api_key: \"My API Key\")\n\nrun = openai.beta.threads.runs.submit_tool_outputs(\"run_id\", thread_id: \"thread_id\", tool_outputs: [{}])\n\nputs(run)"},"response":"{\n \"id\": \"run_123\",\n \"object\": \"thread.run\",\n \"created_at\": 1699075592,\n \"assistant_id\": \"asst_123\",\n \"thread_id\": \"thread_123\",\n \"status\": \"queued\",\n \"started_at\": 1699075592,\n \"expires_at\": 1699076192,\n \"cancelled_at\": null,\n \"failed_at\": null,\n \"completed_at\": null,\n \"last_error\": null,\n \"model\": \"gpt-4o\",\n \"instructions\": null,\n \"tools\": [\n {\n \"type\": \"function\",\n \"function\": {\n \"name\": \"get_current_weather\",\n \"description\": \"Get the current weather in a given location\",\n \"parameters\": {\n \"type\": \"object\",\n \"properties\": {\n \"location\": {\n \"type\": \"string\",\n \"description\": \"The city and state, e.g. San Francisco, CA\"\n },\n \"unit\": {\n \"type\": \"string\",\n \"enum\": [\"celsius\", \"fahrenheit\"]\n }\n },\n \"required\": [\"location\"]\n }\n }\n }\n ],\n \"metadata\": {},\n \"usage\": null,\n \"temperature\": 1.0,\n \"top_p\": 1.0,\n \"max_prompt_tokens\": 1000,\n \"max_completion_tokens\": 1000,\n \"truncation_strategy\": {\n \"type\": \"auto\",\n \"last_messages\": null\n },\n \"response_format\": \"auto\",\n \"tool_choice\": \"auto\",\n \"parallel_tool_calls\": true\n}\n"},{"title":"Streaming","request":{"curl":"curl https://api.openai.com/v1/threads/thread_123/runs/run_123/submit_tool_outputs \\\n -H \"Authorization: Bearer $OPENAI_API_KEY\" \\\n -H \"Content-Type: application/json\" \\\n -H \"OpenAI-Beta: assistants=v2\" \\\n -d '{\n \"tool_outputs\": [\n {\n \"tool_call_id\": \"call_001\",\n \"output\": \"70 degrees and sunny.\"\n }\n ],\n \"stream\": true\n }'\n","python":"import os\nfrom openai import OpenAI\n\nclient = OpenAI(\n api_key=os.environ.get(\"OPENAI_API_KEY\"), # This is the default and can be omitted\n)\nfor run in client.beta.threads.runs.submit_tool_outputs(\n run_id=\"run_id\",\n thread_id=\"thread_id\",\n tool_outputs=[{}],\n):\n print(run)","javascript":"import OpenAI from \"openai\";\n\nconst openai = new OpenAI();\n\nasync function main() {\n const stream = await openai.beta.threads.runs.submitToolOutputs(\n \"run_123\",\n {\n thread_id: \"thread_123\",\n tool_outputs: [\n {\n tool_call_id: \"call_001\",\n output: \"70 degrees and sunny.\",\n },\n ],\n }\n );\n\n for await (const event of stream) {\n console.log(event);\n }\n}\n\nmain();\n","node.js":"import OpenAI from 'openai';\n\nconst client = new OpenAI({\n apiKey: process.env['OPENAI_API_KEY'], // This is the default and can be omitted\n});\n\nconst run = await client.beta.threads.runs.submitToolOutputs('run_id', {\n thread_id: 'thread_id',\n tool_outputs: [{}],\n});\n\nconsole.log(run.id);","go":"package main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\n\t\"github.com/openai/openai-go\"\n\t\"github.com/openai/openai-go/option\"\n)\n\nfunc main() {\n\tclient := openai.NewClient(\n\t\toption.WithAPIKey(\"My API Key\"),\n\t)\n\trun, err := client.Beta.Threads.Runs.SubmitToolOutputs(\n\t\tcontext.TODO(),\n\t\t\"thread_id\",\n\t\t\"run_id\",\n\t\topenai.BetaThreadRunSubmitToolOutputsParams{\n\t\t\tToolOutputs: []openai.BetaThreadRunSubmitToolOutputsParamsToolOutput{{}},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf(\"%+v\\n\", run.ID)\n}\n","java":"package com.openai.example;\n\nimport com.openai.client.OpenAIClient;\nimport com.openai.client.okhttp.OpenAIOkHttpClient;\nimport com.openai.models.beta.threads.runs.Run;\nimport com.openai.models.beta.threads.runs.RunSubmitToolOutputsParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n OpenAIClient client = OpenAIOkHttpClient.fromEnv();\n\n RunSubmitToolOutputsParams params = RunSubmitToolOutputsParams.builder()\n .threadId(\"thread_id\")\n .runId(\"run_id\")\n .addToolOutput(RunSubmitToolOutputsParams.ToolOutput.builder().build())\n .build();\n Run run = client.beta().threads().runs().submitToolOutputs(params);\n }\n}","ruby":"require \"openai\"\n\nopenai = OpenAI::Client.new(api_key: \"My API Key\")\n\nrun = openai.beta.threads.runs.submit_tool_outputs(\"run_id\", thread_id: \"thread_id\", tool_outputs: [{}])\n\nputs(run)"},"response":"event: thread.run.step.completed\ndata: {\"id\":\"step_001\",\"object\":\"thread.run.step\",\"created_at\":1710352449,\"run_id\":\"run_123\",\"assistant_id\":\"asst_123\",\"thread_id\":\"thread_123\",\"type\":\"tool_calls\",\"status\":\"completed\",\"cancelled_at\":null,\"completed_at\":1710352475,\"expires_at\":1710353047,\"failed_at\":null,\"last_error\":null,\"step_details\":{\"type\":\"tool_calls\",\"tool_calls\":[{\"id\":\"call_iWr0kQ2EaYMaxNdl0v3KYkx7\",\"type\":\"function\",\"function\":{\"name\":\"get_current_weather\",\"arguments\":\"{\\\"location\\\":\\\"San Francisco, CA\\\",\\\"unit\\\":\\\"fahrenheit\\\"}\",\"output\":\"70 degrees and sunny.\"}}]},\"usage\":{\"prompt_tokens\":291,\"completion_tokens\":24,\"total_tokens\":315}}\n\nevent: thread.run.queued\ndata: {\"id\":\"run_123\",\"object\":\"thread.run\",\"created_at\":1710352447,\"assistant_id\":\"asst_123\",\"thread_id\":\"thread_123\",\"status\":\"queued\",\"started_at\":1710352448,\"expires_at\":1710353047,\"cancelled_at\":null,\"failed_at\":null,\"completed_at\":null,\"required_action\":null,\"last_error\":null,\"model\":\"gpt-4o\",\"instructions\":null,\"tools\":[{\"type\":\"function\",\"function\":{\"name\":\"get_current_weather\",\"description\":\"Get the current weather in a given location\",\"parameters\":{\"type\":\"object\",\"properties\":{\"location\":{\"type\":\"string\",\"description\":\"The city and state, e.g. San Francisco, CA\"},\"unit\":{\"type\":\"string\",\"enum\":[\"celsius\",\"fahrenheit\"]}},\"required\":[\"location\"]}}}],\"metadata\":{},\"temperature\":1.0,\"top_p\":1.0,\"max_completion_tokens\":null,\"max_prompt_tokens\":null,\"truncation_strategy\":{\"type\":\"auto\",\"last_messages\":null},\"incomplete_details\":null,\"usage\":null,\"response_format\":\"auto\",\"tool_choice\":\"auto\",\"parallel_tool_calls\":true}}\n\nevent: thread.run.in_progress\ndata: {\"id\":\"run_123\",\"object\":\"thread.run\",\"created_at\":1710352447,\"assistant_id\":\"asst_123\",\"thread_id\":\"thread_123\",\"status\":\"in_progress\",\"started_at\":1710352475,\"expires_at\":1710353047,\"cancelled_at\":null,\"failed_at\":null,\"completed_at\":null,\"required_action\":null,\"last_error\":null,\"model\":\"gpt-4o\",\"instructions\":null,\"tools\":[{\"type\":\"function\",\"function\":{\"name\":\"get_current_weather\",\"description\":\"Get the current weather in a given location\",\"parameters\":{\"type\":\"object\",\"properties\":{\"location\":{\"type\":\"string\",\"description\":\"The city and state, e.g. San Francisco, CA\"},\"unit\":{\"type\":\"string\",\"enum\":[\"celsius\",\"fahrenheit\"]}},\"required\":[\"location\"]}}}],\"metadata\":{},\"temperature\":1.0,\"top_p\":1.0,\"max_completion_tokens\":null,\"max_prompt_tokens\":null,\"truncation_strategy\":{\"type\":\"auto\",\"last_messages\":null},\"incomplete_details\":null,\"usage\":null,\"response_format\":\"auto\",\"tool_choice\":\"auto\",\"parallel_tool_calls\":true}}\n\nevent: thread.run.step.created\ndata: {\"id\":\"step_002\",\"object\":\"thread.run.step\",\"created_at\":1710352476,\"run_id\":\"run_123\",\"assistant_id\":\"asst_123\",\"thread_id\":\"thread_123\",\"type\":\"message_creation\",\"status\":\"in_progress\",\"cancelled_at\":null,\"completed_at\":null,\"expires_at\":1710353047,\"failed_at\":null,\"last_error\":null,\"step_details\":{\"type\":\"message_creation\",\"message_creation\":{\"message_id\":\"msg_002\"}},\"usage\":null}\n\nevent: thread.run.step.in_progress\ndata: {\"id\":\"step_002\",\"object\":\"thread.run.step\",\"created_at\":1710352476,\"run_id\":\"run_123\",\"assistant_id\":\"asst_123\",\"thread_id\":\"thread_123\",\"type\":\"message_creation\",\"status\":\"in_progress\",\"cancelled_at\":null,\"completed_at\":null,\"expires_at\":1710353047,\"failed_at\":null,\"last_error\":null,\"step_details\":{\"type\":\"message_creation\",\"message_creation\":{\"message_id\":\"msg_002\"}},\"usage\":null}\n\nevent: thread.message.created\ndata: {\"id\":\"msg_002\",\"object\":\"thread.message\",\"created_at\":1710352476,\"assistant_id\":\"asst_123\",\"thread_id\":\"thread_123\",\"run_id\":\"run_123\",\"status\":\"in_progress\",\"incomplete_details\":null,\"incomplete_at\":null,\"completed_at\":null,\"role\":\"assistant\",\"content\":[],\"metadata\":{}}\n\nevent: thread.message.in_progress\ndata: {\"id\":\"msg_002\",\"object\":\"thread.message\",\"created_at\":1710352476,\"assistant_id\":\"asst_123\",\"thread_id\":\"thread_123\",\"run_id\":\"run_123\",\"status\":\"in_progress\",\"incomplete_details\":null,\"incomplete_at\":null,\"completed_at\":null,\"role\":\"assistant\",\"content\":[],\"metadata\":{}}\n\nevent: thread.message.delta\ndata: {\"id\":\"msg_002\",\"object\":\"thread.message.delta\",\"delta\":{\"content\":[{\"index\":0,\"type\":\"text\",\"text\":{\"value\":\"The\",\"annotations\":[]}}]}}\n\nevent: thread.message.delta\ndata: {\"id\":\"msg_002\",\"object\":\"thread.message.delta\",\"delta\":{\"content\":[{\"index\":0,\"type\":\"text\",\"text\":{\"value\":\" current\"}}]}}\n\nevent: thread.message.delta\ndata: {\"id\":\"msg_002\",\"object\":\"thread.message.delta\",\"delta\":{\"content\":[{\"index\":0,\"type\":\"text\",\"text\":{\"value\":\" weather\"}}]}}\n\n...\n\nevent: thread.message.delta\ndata: {\"id\":\"msg_002\",\"object\":\"thread.message.delta\",\"delta\":{\"content\":[{\"index\":0,\"type\":\"text\",\"text\":{\"value\":\" sunny\"}}]}}\n\nevent: thread.message.delta\ndata: {\"id\":\"msg_002\",\"object\":\"thread.message.delta\",\"delta\":{\"content\":[{\"index\":0,\"type\":\"text\",\"text\":{\"value\":\".\"}}]}}\n\nevent: thread.message.completed\ndata: {\"id\":\"msg_002\",\"object\":\"thread.message\",\"created_at\":1710352476,\"assistant_id\":\"asst_123\",\"thread_id\":\"thread_123\",\"run_id\":\"run_123\",\"status\":\"completed\",\"incomplete_details\":null,\"incomplete_at\":null,\"completed_at\":1710352477,\"role\":\"assistant\",\"content\":[{\"type\":\"text\",\"text\":{\"value\":\"The current weather in San Francisco, CA is 70 degrees Fahrenheit and sunny.\",\"annotations\":[]}}],\"metadata\":{}}\n\nevent: thread.run.step.completed\ndata: {\"id\":\"step_002\",\"object\":\"thread.run.step\",\"created_at\":1710352476,\"run_id\":\"run_123\",\"assistant_id\":\"asst_123\",\"thread_id\":\"thread_123\",\"type\":\"message_creation\",\"status\":\"completed\",\"cancelled_at\":null,\"completed_at\":1710352477,\"expires_at\":1710353047,\"failed_at\":null,\"last_error\":null,\"step_details\":{\"type\":\"message_creation\",\"message_creation\":{\"message_id\":\"msg_002\"}},\"usage\":{\"prompt_tokens\":329,\"completion_tokens\":18,\"total_tokens\":347}}\n\nevent: thread.run.completed\ndata: {\"id\":\"run_123\",\"object\":\"thread.run\",\"created_at\":1710352447,\"assistant_id\":\"asst_123\",\"thread_id\":\"thread_123\",\"status\":\"completed\",\"started_at\":1710352475,\"expires_at\":null,\"cancelled_at\":null,\"failed_at\":null,\"completed_at\":1710352477,\"required_action\":null,\"last_error\":null,\"model\":\"gpt-4o\",\"instructions\":null,\"tools\":[{\"type\":\"function\",\"function\":{\"name\":\"get_current_weather\",\"description\":\"Get the current weather in a given location\",\"parameters\":{\"type\":\"object\",\"properties\":{\"location\":{\"type\":\"string\",\"description\":\"The city and state, e.g. San Francisco, CA\"},\"unit\":{\"type\":\"string\",\"enum\":[\"celsius\",\"fahrenheit\"]}},\"required\":[\"location\"]}}}],\"metadata\":{},\"temperature\":1.0,\"top_p\":1.0,\"max_completion_tokens\":null,\"max_prompt_tokens\":null,\"truncation_strategy\":{\"type\":\"auto\",\"last_messages\":null},\"incomplete_details\":null,\"usage\":{\"prompt_tokens\":20,\"completion_tokens\":11,\"total_tokens\":31},\"response_format\":\"auto\",\"tool_choice\":\"auto\",\"parallel_tool_calls\":true}}\n\nevent: done\ndata: [DONE]\n"}]}}},"/uploads":{"post":{"operationId":"createUpload","tags":["Uploads"],"summary":"Creates an intermediate [Upload](/docs/api-reference/uploads/object) object\nthat you can add [Parts](/docs/api-reference/uploads/part-object) to.\nCurrently, an Upload can accept at most 8 GB in total and expires after an\nhour after you create it.\n\nOnce you complete the Upload, we will create a\n[File](/docs/api-reference/files/object) object that contains all the parts\nyou uploaded. This File is usable in the rest of our platform as a regular\nFile object.\n\nFor certain `purpose` values, the correct `mime_type` must be specified. \nPlease refer to documentation for the \n[supported MIME types for your use case](/docs/assistants/tools/file-search#supported-files).\n\nFor guidance on the proper filename extensions for each purpose, please\nfollow the documentation on [creating a\nFile](/docs/api-reference/files/create).\n\nReturns the Upload object with status `pending`.\n","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateUploadRequest"}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Upload"}}}}},"x-oaiMeta":{"name":"Create upload","group":"uploads","examples":{"request":{"curl":"curl https://api.openai.com/v1/uploads \\\n -H \"Authorization: Bearer $OPENAI_API_KEY\" \\\n -d '{\n \"purpose\": \"fine-tune\",\n \"filename\": \"training_examples.jsonl\",\n \"bytes\": 2147483648,\n \"mime_type\": \"text/jsonl\",\n \"expires_after\": {\n \"anchor\": \"created_at\",\n \"seconds\": 3600\n }\n }'\n","node.js":"import OpenAI from 'openai';\n\nconst client = new OpenAI({\n apiKey: process.env['OPENAI_API_KEY'], // This is the default and can be omitted\n});\n\nconst upload = await client.uploads.create({\n bytes: 0,\n filename: 'filename',\n mime_type: 'mime_type',\n purpose: 'assistants',\n});\n\nconsole.log(upload.id);","python":"import os\nfrom openai import OpenAI\n\nclient = OpenAI(\n api_key=os.environ.get(\"OPENAI_API_KEY\"), # This is the default and can be omitted\n)\nupload = client.uploads.create(\n bytes=0,\n filename=\"filename\",\n mime_type=\"mime_type\",\n purpose=\"assistants\",\n)\nprint(upload.id)","go":"package main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\n\t\"github.com/openai/openai-go\"\n\t\"github.com/openai/openai-go/option\"\n)\n\nfunc main() {\n\tclient := openai.NewClient(\n\t\toption.WithAPIKey(\"My API Key\"),\n\t)\n\tupload, err := client.Uploads.New(context.TODO(), openai.UploadNewParams{\n\t\tBytes: 0,\n\t\tFilename: \"filename\",\n\t\tMimeType: \"mime_type\",\n\t\tPurpose: openai.FilePurposeAssistants,\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf(\"%+v\\n\", upload.ID)\n}\n","java":"package com.openai.example;\n\nimport com.openai.client.OpenAIClient;\nimport com.openai.client.okhttp.OpenAIOkHttpClient;\nimport com.openai.models.files.FilePurpose;\nimport com.openai.models.uploads.Upload;\nimport com.openai.models.uploads.UploadCreateParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n OpenAIClient client = OpenAIOkHttpClient.fromEnv();\n\n UploadCreateParams params = UploadCreateParams.builder()\n .bytes(0L)\n .filename(\"filename\")\n .mimeType(\"mime_type\")\n .purpose(FilePurpose.ASSISTANTS)\n .build();\n Upload upload = client.uploads().create(params);\n }\n}","ruby":"require \"openai\"\n\nopenai = OpenAI::Client.new(api_key: \"My API Key\")\n\nupload = openai.uploads.create(bytes: 0, filename: \"filename\", mime_type: \"mime_type\", purpose: :assistants)\n\nputs(upload)"},"response":"{\n \"id\": \"upload_abc123\",\n \"object\": \"upload\",\n \"bytes\": 2147483648,\n \"created_at\": 1719184911,\n \"filename\": \"training_examples.jsonl\",\n \"purpose\": \"fine-tune\",\n \"status\": \"pending\",\n \"expires_at\": 1719127296\n}\n"}}}},"/uploads/{upload_id}/cancel":{"post":{"operationId":"cancelUpload","tags":["Uploads"],"summary":"Cancels the Upload. No Parts may be added after an Upload is cancelled.\n\nReturns the Upload object with status `cancelled`.\n","parameters":[{"in":"path","name":"upload_id","required":true,"schema":{"type":"string","example":"upload_abc123"},"description":"The ID of the Upload.\n"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Upload"}}}}},"x-oaiMeta":{"name":"Cancel upload","group":"uploads","examples":{"request":{"curl":"curl https://api.openai.com/v1/uploads/upload_abc123/cancel\n","node.js":"import OpenAI from 'openai';\n\nconst client = new OpenAI({\n apiKey: process.env['OPENAI_API_KEY'], // This is the default and can be omitted\n});\n\nconst upload = await client.uploads.cancel('upload_abc123');\n\nconsole.log(upload.id);","python":"import os\nfrom openai import OpenAI\n\nclient = OpenAI(\n api_key=os.environ.get(\"OPENAI_API_KEY\"), # This is the default and can be omitted\n)\nupload = client.uploads.cancel(\n \"upload_abc123\",\n)\nprint(upload.id)","go":"package main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\n\t\"github.com/openai/openai-go\"\n\t\"github.com/openai/openai-go/option\"\n)\n\nfunc main() {\n\tclient := openai.NewClient(\n\t\toption.WithAPIKey(\"My API Key\"),\n\t)\n\tupload, err := client.Uploads.Cancel(context.TODO(), \"upload_abc123\")\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf(\"%+v\\n\", upload.ID)\n}\n","java":"package com.openai.example;\n\nimport com.openai.client.OpenAIClient;\nimport com.openai.client.okhttp.OpenAIOkHttpClient;\nimport com.openai.models.uploads.Upload;\nimport com.openai.models.uploads.UploadCancelParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n OpenAIClient client = OpenAIOkHttpClient.fromEnv();\n\n Upload upload = client.uploads().cancel(\"upload_abc123\");\n }\n}","ruby":"require \"openai\"\n\nopenai = OpenAI::Client.new(api_key: \"My API Key\")\n\nupload = openai.uploads.cancel(\"upload_abc123\")\n\nputs(upload)"},"response":"{\n \"id\": \"upload_abc123\",\n \"object\": \"upload\",\n \"bytes\": 2147483648,\n \"created_at\": 1719184911,\n \"filename\": \"training_examples.jsonl\",\n \"purpose\": \"fine-tune\",\n \"status\": \"cancelled\",\n \"expires_at\": 1719127296\n}\n"}}}},"/uploads/{upload_id}/complete":{"post":{"operationId":"completeUpload","tags":["Uploads"],"summary":"Completes the [Upload](/docs/api-reference/uploads/object). \n\nWithin the returned Upload object, there is a nested [File](/docs/api-reference/files/object) object that is ready to use in the rest of the platform.\n\nYou can specify the order of the Parts by passing in an ordered list of the Part IDs.\n\nThe number of bytes uploaded upon completion must match the number of bytes initially specified when creating the Upload object. No Parts may be added after an Upload is completed.\nReturns the Upload object with status `completed`, including an additional `file` property containing the created usable File object.\n","parameters":[{"in":"path","name":"upload_id","required":true,"schema":{"type":"string","example":"upload_abc123"},"description":"The ID of the Upload.\n"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CompleteUploadRequest"}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Upload"}}}}},"x-oaiMeta":{"name":"Complete upload","group":"uploads","examples":{"request":{"curl":"curl https://api.openai.com/v1/uploads/upload_abc123/complete\n -d '{\n \"part_ids\": [\"part_def456\", \"part_ghi789\"]\n }'\n","node.js":"import OpenAI from 'openai';\n\nconst client = new OpenAI({\n apiKey: process.env['OPENAI_API_KEY'], // This is the default and can be omitted\n});\n\nconst upload = await client.uploads.complete('upload_abc123', { part_ids: ['string'] });\n\nconsole.log(upload.id);","python":"import os\nfrom openai import OpenAI\n\nclient = OpenAI(\n api_key=os.environ.get(\"OPENAI_API_KEY\"), # This is the default and can be omitted\n)\nupload = client.uploads.complete(\n upload_id=\"upload_abc123\",\n part_ids=[\"string\"],\n)\nprint(upload.id)","go":"package main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\n\t\"github.com/openai/openai-go\"\n\t\"github.com/openai/openai-go/option\"\n)\n\nfunc main() {\n\tclient := openai.NewClient(\n\t\toption.WithAPIKey(\"My API Key\"),\n\t)\n\tupload, err := client.Uploads.Complete(\n\t\tcontext.TODO(),\n\t\t\"upload_abc123\",\n\t\topenai.UploadCompleteParams{\n\t\t\tPartIDs: []string{\"string\"},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf(\"%+v\\n\", upload.ID)\n}\n","java":"package com.openai.example;\n\nimport com.openai.client.OpenAIClient;\nimport com.openai.client.okhttp.OpenAIOkHttpClient;\nimport com.openai.models.uploads.Upload;\nimport com.openai.models.uploads.UploadCompleteParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n OpenAIClient client = OpenAIOkHttpClient.fromEnv();\n\n UploadCompleteParams params = UploadCompleteParams.builder()\n .uploadId(\"upload_abc123\")\n .addPartId(\"string\")\n .build();\n Upload upload = client.uploads().complete(params);\n }\n}","ruby":"require \"openai\"\n\nopenai = OpenAI::Client.new(api_key: \"My API Key\")\n\nupload = openai.uploads.complete(\"upload_abc123\", part_ids: [\"string\"])\n\nputs(upload)"},"response":"{\n \"id\": \"upload_abc123\",\n \"object\": \"upload\",\n \"bytes\": 2147483648,\n \"created_at\": 1719184911,\n \"filename\": \"training_examples.jsonl\",\n \"purpose\": \"fine-tune\",\n \"status\": \"completed\",\n \"expires_at\": 1719127296,\n \"file\": {\n \"id\": \"file-xyz321\",\n \"object\": \"file\",\n \"bytes\": 2147483648,\n \"created_at\": 1719186911,\n \"expires_at\": 1719127296,\n \"filename\": \"training_examples.jsonl\",\n \"purpose\": \"fine-tune\",\n }\n}\n"}}}},"/uploads/{upload_id}/parts":{"post":{"operationId":"addUploadPart","tags":["Uploads"],"summary":"Adds a [Part](/docs/api-reference/uploads/part-object) to an [Upload](/docs/api-reference/uploads/object) object. A Part represents a chunk of bytes from the file you are trying to upload. \n\nEach Part can be at most 64 MB, and you can add Parts until you hit the Upload maximum of 8 GB.\n\nIt is possible to add multiple Parts in parallel. You can decide the intended order of the Parts when you [complete the Upload](/docs/api-reference/uploads/complete).\n","parameters":[{"in":"path","name":"upload_id","required":true,"schema":{"type":"string","example":"upload_abc123"},"description":"The ID of the Upload.\n"}],"requestBody":{"required":true,"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/AddUploadPartRequest"}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UploadPart"}}}}},"x-oaiMeta":{"name":"Add upload part","group":"uploads","examples":{"request":{"curl":"curl https://api.openai.com/v1/uploads/upload_abc123/parts\n -F data=\"aHR0cHM6Ly9hcGkub3BlbmFpLmNvbS92MS91cGxvYWRz...\"\n","node.js":"import fs from 'fs';\nimport OpenAI from 'openai';\n\nconst client = new OpenAI({\n apiKey: process.env['OPENAI_API_KEY'], // This is the default and can be omitted\n});\n\nconst uploadPart = await client.uploads.parts.create('upload_abc123', {\n data: fs.createReadStream('path/to/file'),\n});\n\nconsole.log(uploadPart.id);","python":"import os\nfrom openai import OpenAI\n\nclient = OpenAI(\n api_key=os.environ.get(\"OPENAI_API_KEY\"), # This is the default and can be omitted\n)\nupload_part = client.uploads.parts.create(\n upload_id=\"upload_abc123\",\n data=b\"Example data\",\n)\nprint(upload_part.id)","go":"package main\n\nimport (\n\t\"bytes\"\n\t\"context\"\n\t\"fmt\"\n\t\"io\"\n\n\t\"github.com/openai/openai-go\"\n\t\"github.com/openai/openai-go/option\"\n)\n\nfunc main() {\n\tclient := openai.NewClient(\n\t\toption.WithAPIKey(\"My API Key\"),\n\t)\n\tuploadPart, err := client.Uploads.Parts.New(\n\t\tcontext.TODO(),\n\t\t\"upload_abc123\",\n\t\topenai.UploadPartNewParams{\n\t\t\tData: io.Reader(bytes.NewBuffer([]byte(\"Example data\"))),\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf(\"%+v\\n\", uploadPart.ID)\n}\n","java":"package com.openai.example;\n\nimport com.openai.client.OpenAIClient;\nimport com.openai.client.okhttp.OpenAIOkHttpClient;\nimport com.openai.models.uploads.parts.PartCreateParams;\nimport com.openai.models.uploads.parts.UploadPart;\nimport java.io.ByteArrayInputStream;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n OpenAIClient client = OpenAIOkHttpClient.fromEnv();\n\n PartCreateParams params = PartCreateParams.builder()\n .uploadId(\"upload_abc123\")\n .data(new ByteArrayInputStream(\"Example data\".getBytes()))\n .build();\n UploadPart uploadPart = client.uploads().parts().create(params);\n }\n}","ruby":"require \"openai\"\n\nopenai = OpenAI::Client.new(api_key: \"My API Key\")\n\nupload_part = openai.uploads.parts.create(\"upload_abc123\", data: StringIO.new(\"Example data\"))\n\nputs(upload_part)"},"response":"{\n \"id\": \"part_def456\",\n \"object\": \"upload.part\",\n \"created_at\": 1719185911,\n \"upload_id\": \"upload_abc123\"\n}\n"}}}},"/vector_stores":{"get":{"operationId":"listVectorStores","tags":["Vector stores"],"summary":"Returns a list of vector stores.","parameters":[{"name":"limit","in":"query","description":"A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.\n","required":false,"schema":{"type":"integer","default":20}},{"name":"order","in":"query","description":"Sort order by the `created_at` timestamp of the objects. `asc` for ascending order and `desc` for descending order.\n","schema":{"type":"string","default":"desc","enum":["asc","desc"]}},{"name":"after","in":"query","description":"A cursor for use in pagination. `after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list.\n","schema":{"type":"string"}},{"name":"before","in":"query","description":"A cursor for use in pagination. `before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_foo, your subsequent call can include before=obj_foo in order to fetch the previous page of the list.\n","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListVectorStoresResponse"}}}}},"x-oaiMeta":{"name":"List vector stores","group":"vector_stores","examples":{"request":{"curl":"curl https://api.openai.com/v1/vector_stores \\\n -H \"Authorization: Bearer $OPENAI_API_KEY\" \\\n -H \"Content-Type: application/json\" \\\n -H \"OpenAI-Beta: assistants=v2\"\n","python":"import os\nfrom openai import OpenAI\n\nclient = OpenAI(\n api_key=os.environ.get(\"OPENAI_API_KEY\"), # This is the default and can be omitted\n)\npage = client.vector_stores.list()\npage = page.data[0]\nprint(page.id)","javascript":"import OpenAI from \"openai\";\nconst openai = new OpenAI();\n\nasync function main() {\n const vectorStores = await openai.vectorStores.list();\n console.log(vectorStores);\n}\n\nmain();\n","node.js":"import OpenAI from 'openai';\n\nconst client = new OpenAI({\n apiKey: process.env['OPENAI_API_KEY'], // This is the default and can be omitted\n});\n\n// Automatically fetches more pages as needed.\nfor await (const vectorStore of client.vectorStores.list()) {\n console.log(vectorStore.id);\n}","go":"package main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\n\t\"github.com/openai/openai-go\"\n\t\"github.com/openai/openai-go/option\"\n)\n\nfunc main() {\n\tclient := openai.NewClient(\n\t\toption.WithAPIKey(\"My API Key\"),\n\t)\n\tpage, err := client.VectorStores.List(context.TODO(), openai.VectorStoreListParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf(\"%+v\\n\", page)\n}\n","java":"package com.openai.example;\n\nimport com.openai.client.OpenAIClient;\nimport com.openai.client.okhttp.OpenAIOkHttpClient;\nimport com.openai.models.vectorstores.VectorStoreListPage;\nimport com.openai.models.vectorstores.VectorStoreListParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n OpenAIClient client = OpenAIOkHttpClient.fromEnv();\n\n VectorStoreListPage page = client.vectorStores().list();\n }\n}","ruby":"require \"openai\"\n\nopenai = OpenAI::Client.new(api_key: \"My API Key\")\n\npage = openai.vector_stores.list\n\nputs(page)"},"response":"{\n \"object\": \"list\",\n \"data\": [\n {\n \"id\": \"vs_abc123\",\n \"object\": \"vector_store\",\n \"created_at\": 1699061776,\n \"name\": \"Support FAQ\",\n \"description\": \"Contains commonly asked questions and answers, organized by topic.\",\n \"bytes\": 139920,\n \"file_counts\": {\n \"in_progress\": 0,\n \"completed\": 3,\n \"failed\": 0,\n \"cancelled\": 0,\n \"total\": 3\n }\n },\n {\n \"id\": \"vs_abc456\",\n \"object\": \"vector_store\",\n \"created_at\": 1699061776,\n \"name\": \"Support FAQ v2\",\n \"description\": null,\n \"bytes\": 139920,\n \"file_counts\": {\n \"in_progress\": 0,\n \"completed\": 3,\n \"failed\": 0,\n \"cancelled\": 0,\n \"total\": 3\n }\n }\n ],\n \"first_id\": \"vs_abc123\",\n \"last_id\": \"vs_abc456\",\n \"has_more\": false\n}\n"}}},"post":{"operationId":"createVectorStore","tags":["Vector stores"],"summary":"Create a vector store.","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateVectorStoreRequest"}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VectorStoreObject"}}}}},"x-oaiMeta":{"name":"Create vector store","group":"vector_stores","examples":{"request":{"curl":"curl https://api.openai.com/v1/vector_stores \\\n -H \"Authorization: Bearer $OPENAI_API_KEY\" \\\n -H \"Content-Type: application/json\" \\\n -H \"OpenAI-Beta: assistants=v2\" \\\n -d '{\n \"name\": \"Support FAQ\"\n }'\n","python":"import os\nfrom openai import OpenAI\n\nclient = OpenAI(\n api_key=os.environ.get(\"OPENAI_API_KEY\"), # This is the default and can be omitted\n)\nvector_store = client.vector_stores.create()\nprint(vector_store.id)","javascript":"import OpenAI from \"openai\";\nconst openai = new OpenAI();\n\nasync function main() {\n const vectorStore = await openai.vectorStores.create({\n name: \"Support FAQ\"\n });\n console.log(vectorStore);\n}\n\nmain();\n","node.js":"import OpenAI from 'openai';\n\nconst client = new OpenAI({\n apiKey: process.env['OPENAI_API_KEY'], // This is the default and can be omitted\n});\n\nconst vectorStore = await client.vectorStores.create();\n\nconsole.log(vectorStore.id);","go":"package main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\n\t\"github.com/openai/openai-go\"\n\t\"github.com/openai/openai-go/option\"\n)\n\nfunc main() {\n\tclient := openai.NewClient(\n\t\toption.WithAPIKey(\"My API Key\"),\n\t)\n\tvectorStore, err := client.VectorStores.New(context.TODO(), openai.VectorStoreNewParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf(\"%+v\\n\", vectorStore.ID)\n}\n","java":"package com.openai.example;\n\nimport com.openai.client.OpenAIClient;\nimport com.openai.client.okhttp.OpenAIOkHttpClient;\nimport com.openai.models.vectorstores.VectorStore;\nimport com.openai.models.vectorstores.VectorStoreCreateParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n OpenAIClient client = OpenAIOkHttpClient.fromEnv();\n\n VectorStore vectorStore = client.vectorStores().create();\n }\n}","ruby":"require \"openai\"\n\nopenai = OpenAI::Client.new(api_key: \"My API Key\")\n\nvector_store = openai.vector_stores.create\n\nputs(vector_store)"},"response":"{\n \"id\": \"vs_abc123\",\n \"object\": \"vector_store\",\n \"created_at\": 1699061776,\n \"name\": \"Support FAQ\",\n \"description\": \"Contains commonly asked questions and answers, organized by topic.\",\n \"bytes\": 139920,\n \"file_counts\": {\n \"in_progress\": 0,\n \"completed\": 3,\n \"failed\": 0,\n \"cancelled\": 0,\n \"total\": 3\n }\n}\n"}}}},"/vector_stores/{vector_store_id}":{"get":{"operationId":"getVectorStore","tags":["Vector stores"],"summary":"Retrieves a vector store.","parameters":[{"in":"path","name":"vector_store_id","required":true,"schema":{"type":"string"},"description":"The ID of the vector store to retrieve."}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VectorStoreObject"}}}}},"x-oaiMeta":{"name":"Retrieve vector store","group":"vector_stores","examples":{"request":{"curl":"curl https://api.openai.com/v1/vector_stores/vs_abc123 \\\n -H \"Authorization: Bearer $OPENAI_API_KEY\" \\\n -H \"Content-Type: application/json\" \\\n -H \"OpenAI-Beta: assistants=v2\"\n","python":"import os\nfrom openai import OpenAI\n\nclient = OpenAI(\n api_key=os.environ.get(\"OPENAI_API_KEY\"), # This is the default and can be omitted\n)\nvector_store = client.vector_stores.retrieve(\n \"vector_store_id\",\n)\nprint(vector_store.id)","javascript":"import OpenAI from \"openai\";\nconst openai = new OpenAI();\n\nasync function main() {\n const vectorStore = await openai.vectorStores.retrieve(\n \"vs_abc123\"\n );\n console.log(vectorStore);\n}\n\nmain();\n","node.js":"import OpenAI from 'openai';\n\nconst client = new OpenAI({\n apiKey: process.env['OPENAI_API_KEY'], // This is the default and can be omitted\n});\n\nconst vectorStore = await client.vectorStores.retrieve('vector_store_id');\n\nconsole.log(vectorStore.id);","go":"package main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\n\t\"github.com/openai/openai-go\"\n\t\"github.com/openai/openai-go/option\"\n)\n\nfunc main() {\n\tclient := openai.NewClient(\n\t\toption.WithAPIKey(\"My API Key\"),\n\t)\n\tvectorStore, err := client.VectorStores.Get(context.TODO(), \"vector_store_id\")\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf(\"%+v\\n\", vectorStore.ID)\n}\n","java":"package com.openai.example;\n\nimport com.openai.client.OpenAIClient;\nimport com.openai.client.okhttp.OpenAIOkHttpClient;\nimport com.openai.models.vectorstores.VectorStore;\nimport com.openai.models.vectorstores.VectorStoreRetrieveParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n OpenAIClient client = OpenAIOkHttpClient.fromEnv();\n\n VectorStore vectorStore = client.vectorStores().retrieve(\"vector_store_id\");\n }\n}","ruby":"require \"openai\"\n\nopenai = OpenAI::Client.new(api_key: \"My API Key\")\n\nvector_store = openai.vector_stores.retrieve(\"vector_store_id\")\n\nputs(vector_store)"},"response":"{\n \"id\": \"vs_abc123\",\n \"object\": \"vector_store\",\n \"created_at\": 1699061776\n}\n"}}},"post":{"operationId":"modifyVectorStore","tags":["Vector stores"],"summary":"Modifies a vector store.","parameters":[{"in":"path","name":"vector_store_id","required":true,"schema":{"type":"string"},"description":"The ID of the vector store to modify."}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateVectorStoreRequest"}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VectorStoreObject"}}}}},"x-oaiMeta":{"name":"Modify vector store","group":"vector_stores","examples":{"request":{"curl":"curl https://api.openai.com/v1/vector_stores/vs_abc123 \\\n -H \"Authorization: Bearer $OPENAI_API_KEY\" \\\n -H \"Content-Type: application/json\" \\\n -H \"OpenAI-Beta: assistants=v2\"\n -d '{\n \"name\": \"Support FAQ\"\n }'\n","python":"import os\nfrom openai import OpenAI\n\nclient = OpenAI(\n api_key=os.environ.get(\"OPENAI_API_KEY\"), # This is the default and can be omitted\n)\nvector_store = client.vector_stores.update(\n vector_store_id=\"vector_store_id\",\n)\nprint(vector_store.id)","javascript":"import OpenAI from \"openai\";\nconst openai = new OpenAI();\n\nasync function main() {\n const vectorStore = await openai.vectorStores.update(\n \"vs_abc123\",\n {\n name: \"Support FAQ\"\n }\n );\n console.log(vectorStore);\n}\n\nmain();\n","node.js":"import OpenAI from 'openai';\n\nconst client = new OpenAI({\n apiKey: process.env['OPENAI_API_KEY'], // This is the default and can be omitted\n});\n\nconst vectorStore = await client.vectorStores.update('vector_store_id');\n\nconsole.log(vectorStore.id);","go":"package main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\n\t\"github.com/openai/openai-go\"\n\t\"github.com/openai/openai-go/option\"\n)\n\nfunc main() {\n\tclient := openai.NewClient(\n\t\toption.WithAPIKey(\"My API Key\"),\n\t)\n\tvectorStore, err := client.VectorStores.Update(\n\t\tcontext.TODO(),\n\t\t\"vector_store_id\",\n\t\topenai.VectorStoreUpdateParams{},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf(\"%+v\\n\", vectorStore.ID)\n}\n","java":"package com.openai.example;\n\nimport com.openai.client.OpenAIClient;\nimport com.openai.client.okhttp.OpenAIOkHttpClient;\nimport com.openai.models.vectorstores.VectorStore;\nimport com.openai.models.vectorstores.VectorStoreUpdateParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n OpenAIClient client = OpenAIOkHttpClient.fromEnv();\n\n VectorStore vectorStore = client.vectorStores().update(\"vector_store_id\");\n }\n}","ruby":"require \"openai\"\n\nopenai = OpenAI::Client.new(api_key: \"My API Key\")\n\nvector_store = openai.vector_stores.update(\"vector_store_id\")\n\nputs(vector_store)"},"response":"{\n \"id\": \"vs_abc123\",\n \"object\": \"vector_store\",\n \"created_at\": 1699061776,\n \"name\": \"Support FAQ\",\n \"description\": \"Contains commonly asked questions and answers, organized by topic.\",\n \"bytes\": 139920,\n \"file_counts\": {\n \"in_progress\": 0,\n \"completed\": 3,\n \"failed\": 0,\n \"cancelled\": 0,\n \"total\": 3\n }\n}\n"}}},"delete":{"operationId":"deleteVectorStore","tags":["Vector stores"],"summary":"Delete a vector store.","parameters":[{"in":"path","name":"vector_store_id","required":true,"schema":{"type":"string"},"description":"The ID of the vector store to delete."}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteVectorStoreResponse"}}}}},"x-oaiMeta":{"name":"Delete vector store","group":"vector_stores","examples":{"request":{"curl":"curl https://api.openai.com/v1/vector_stores/vs_abc123 \\\n -H \"Authorization: Bearer $OPENAI_API_KEY\" \\\n -H \"Content-Type: application/json\" \\\n -H \"OpenAI-Beta: assistants=v2\" \\\n -X DELETE\n","python":"import os\nfrom openai import OpenAI\n\nclient = OpenAI(\n api_key=os.environ.get(\"OPENAI_API_KEY\"), # This is the default and can be omitted\n)\nvector_store_deleted = client.vector_stores.delete(\n \"vector_store_id\",\n)\nprint(vector_store_deleted.id)","javascript":"import OpenAI from \"openai\";\nconst openai = new OpenAI();\n\nasync function main() {\n const deletedVectorStore = await openai.vectorStores.delete(\n \"vs_abc123\"\n );\n console.log(deletedVectorStore);\n}\n\nmain();\n","node.js":"import OpenAI from 'openai';\n\nconst client = new OpenAI({\n apiKey: process.env['OPENAI_API_KEY'], // This is the default and can be omitted\n});\n\nconst vectorStoreDeleted = await client.vectorStores.delete('vector_store_id');\n\nconsole.log(vectorStoreDeleted.id);","go":"package main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\n\t\"github.com/openai/openai-go\"\n\t\"github.com/openai/openai-go/option\"\n)\n\nfunc main() {\n\tclient := openai.NewClient(\n\t\toption.WithAPIKey(\"My API Key\"),\n\t)\n\tvectorStoreDeleted, err := client.VectorStores.Delete(context.TODO(), \"vector_store_id\")\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf(\"%+v\\n\", vectorStoreDeleted.ID)\n}\n","java":"package com.openai.example;\n\nimport com.openai.client.OpenAIClient;\nimport com.openai.client.okhttp.OpenAIOkHttpClient;\nimport com.openai.models.vectorstores.VectorStoreDeleteParams;\nimport com.openai.models.vectorstores.VectorStoreDeleted;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n OpenAIClient client = OpenAIOkHttpClient.fromEnv();\n\n VectorStoreDeleted vectorStoreDeleted = client.vectorStores().delete(\"vector_store_id\");\n }\n}","ruby":"require \"openai\"\n\nopenai = OpenAI::Client.new(api_key: \"My API Key\")\n\nvector_store_deleted = openai.vector_stores.delete(\"vector_store_id\")\n\nputs(vector_store_deleted)"},"response":"{\n id: \"vs_abc123\",\n object: \"vector_store.deleted\",\n deleted: true\n}\n"}}}},"/vector_stores/{vector_store_id}/file_batches":{"post":{"operationId":"createVectorStoreFileBatch","tags":["Vector stores"],"summary":"Create a vector store file batch.","description":"The maximum number of files in a single batch request is 2000.\nVector store file attach requests are rate limited per vector store (300 requests per minute across both this endpoint and `/vector_stores/{vector_store_id}/files`).\nFor ingesting multiple files into the same vector store, this batch endpoint is recommended.\n","parameters":[{"in":"path","name":"vector_store_id","required":true,"schema":{"type":"string","example":"vs_abc123"},"description":"The ID of the vector store for which to create a File Batch.\n"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateVectorStoreFileBatchRequest"}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VectorStoreFileBatchObject"}}}}},"x-oaiMeta":{"name":"Create vector store file batch","group":"vector_stores","description":"Attaches multiple files to a vector store in one request. This is the recommended approach for multi-file ingestion, especially because per-vector-store file attach writes are rate-limited (300 requests/minute shared with `/vector_stores/{vector_store_id}/files`).\n","examples":{"request":{"curl":"curl https://api.openai.com/v1/vector_stores/vs_abc123/file_batches \\\n -H \"Authorization: Bearer $OPENAI_API_KEY\" \\\n -H \"Content-Type: application/json \\\n -H \"OpenAI-Beta: assistants=v2\" \\\n -d '{\n \"files\": [\n {\n \"file_id\": \"file-abc123\",\n \"attributes\": {\"category\": \"finance\"}\n },\n {\n \"file_id\": \"file-abc456\",\n \"chunking_strategy\": {\n \"type\": \"static\",\n \"max_chunk_size_tokens\": 1200,\n \"chunk_overlap_tokens\": 200\n }\n }\n ]\n }'\n","python":"import os\nfrom openai import OpenAI\n\nclient = OpenAI(\n api_key=os.environ.get(\"OPENAI_API_KEY\"), # This is the default and can be omitted\n)\nvector_store_file_batch = client.vector_stores.file_batches.create(\n vector_store_id=\"vs_abc123\",\n)\nprint(vector_store_file_batch.id)","javascript":"import OpenAI from \"openai\";\nconst openai = new OpenAI();\n\nasync function main() {\n const myVectorStoreFileBatch = await openai.vectorStores.fileBatches.create(\n \"vs_abc123\",\n {\n files: [\n {\n file_id: \"file-abc123\",\n attributes: { category: \"finance\" },\n },\n {\n file_id: \"file-abc456\",\n chunking_strategy: {\n type: \"static\",\n max_chunk_size_tokens: 1200,\n chunk_overlap_tokens: 200,\n },\n },\n ]\n }\n );\n console.log(myVectorStoreFileBatch);\n}\n\nmain();\n","node.js":"import OpenAI from 'openai';\n\nconst client = new OpenAI({\n apiKey: process.env['OPENAI_API_KEY'], // This is the default and can be omitted\n});\n\nconst vectorStoreFileBatch = await client.vectorStores.fileBatches.create('vs_abc123');\n\nconsole.log(vectorStoreFileBatch.id);","go":"package main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\n\t\"github.com/openai/openai-go\"\n\t\"github.com/openai/openai-go/option\"\n)\n\nfunc main() {\n\tclient := openai.NewClient(\n\t\toption.WithAPIKey(\"My API Key\"),\n\t)\n\tvectorStoreFileBatch, err := client.VectorStores.FileBatches.New(\n\t\tcontext.TODO(),\n\t\t\"vs_abc123\",\n\t\topenai.VectorStoreFileBatchNewParams{},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf(\"%+v\\n\", vectorStoreFileBatch.ID)\n}\n","java":"package com.openai.example;\n\nimport com.openai.client.OpenAIClient;\nimport com.openai.client.okhttp.OpenAIOkHttpClient;\nimport com.openai.models.vectorstores.filebatches.FileBatchCreateParams;\nimport com.openai.models.vectorstores.filebatches.VectorStoreFileBatch;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n OpenAIClient client = OpenAIOkHttpClient.fromEnv();\n\n VectorStoreFileBatch vectorStoreFileBatch = client.vectorStores().fileBatches().create(\"vs_abc123\");\n }\n}","ruby":"require \"openai\"\n\nopenai = OpenAI::Client.new(api_key: \"My API Key\")\n\nvector_store_file_batch = openai.vector_stores.file_batches.create(\"vs_abc123\")\n\nputs(vector_store_file_batch)"},"response":"{\n \"id\": \"vsfb_abc123\",\n \"object\": \"vector_store.file_batch\",\n \"created_at\": 1699061776,\n \"vector_store_id\": \"vs_abc123\",\n \"status\": \"in_progress\",\n \"file_counts\": {\n \"in_progress\": 1,\n \"completed\": 1,\n \"failed\": 0,\n \"cancelled\": 0,\n \"total\": 0,\n }\n}\n"}}}},"/vector_stores/{vector_store_id}/file_batches/{batch_id}":{"get":{"operationId":"getVectorStoreFileBatch","tags":["Vector stores"],"summary":"Retrieves a vector store file batch.","parameters":[{"in":"path","name":"vector_store_id","required":true,"schema":{"type":"string","example":"vs_abc123"},"description":"The ID of the vector store that the file batch belongs to."},{"in":"path","name":"batch_id","required":true,"schema":{"type":"string","example":"vsfb_abc123"},"description":"The ID of the file batch being retrieved."}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VectorStoreFileBatchObject"}}}}},"x-oaiMeta":{"name":"Retrieve vector store file batch","group":"vector_stores","examples":{"request":{"curl":"curl https://api.openai.com/v1/vector_stores/vs_abc123/file_batches/vsfb_abc123 \\\n -H \"Authorization: Bearer $OPENAI_API_KEY\" \\\n -H \"Content-Type: application/json\" \\\n -H \"OpenAI-Beta: assistants=v2\"\n","python":"import os\nfrom openai import OpenAI\n\nclient = OpenAI(\n api_key=os.environ.get(\"OPENAI_API_KEY\"), # This is the default and can be omitted\n)\nvector_store_file_batch = client.vector_stores.file_batches.retrieve(\n batch_id=\"vsfb_abc123\",\n vector_store_id=\"vs_abc123\",\n)\nprint(vector_store_file_batch.id)","javascript":"import OpenAI from \"openai\";\nconst openai = new OpenAI();\n\nasync function main() {\n const vectorStoreFileBatch = await openai.vectorStores.fileBatches.retrieve(\n \"vsfb_abc123\",\n { vector_store_id: \"vs_abc123\" }\n );\n console.log(vectorStoreFileBatch);\n}\n\nmain();\n","node.js":"import OpenAI from 'openai';\n\nconst client = new OpenAI({\n apiKey: process.env['OPENAI_API_KEY'], // This is the default and can be omitted\n});\n\nconst vectorStoreFileBatch = await client.vectorStores.fileBatches.retrieve('vsfb_abc123', {\n vector_store_id: 'vs_abc123',\n});\n\nconsole.log(vectorStoreFileBatch.id);","go":"package main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\n\t\"github.com/openai/openai-go\"\n\t\"github.com/openai/openai-go/option\"\n)\n\nfunc main() {\n\tclient := openai.NewClient(\n\t\toption.WithAPIKey(\"My API Key\"),\n\t)\n\tvectorStoreFileBatch, err := client.VectorStores.FileBatches.Get(\n\t\tcontext.TODO(),\n\t\t\"vs_abc123\",\n\t\t\"vsfb_abc123\",\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf(\"%+v\\n\", vectorStoreFileBatch.ID)\n}\n","java":"package com.openai.example;\n\nimport com.openai.client.OpenAIClient;\nimport com.openai.client.okhttp.OpenAIOkHttpClient;\nimport com.openai.models.vectorstores.filebatches.FileBatchRetrieveParams;\nimport com.openai.models.vectorstores.filebatches.VectorStoreFileBatch;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n OpenAIClient client = OpenAIOkHttpClient.fromEnv();\n\n FileBatchRetrieveParams params = FileBatchRetrieveParams.builder()\n .vectorStoreId(\"vs_abc123\")\n .batchId(\"vsfb_abc123\")\n .build();\n VectorStoreFileBatch vectorStoreFileBatch = client.vectorStores().fileBatches().retrieve(params);\n }\n}","ruby":"require \"openai\"\n\nopenai = OpenAI::Client.new(api_key: \"My API Key\")\n\nvector_store_file_batch = openai.vector_stores.file_batches.retrieve(\"vsfb_abc123\", vector_store_id: \"vs_abc123\")\n\nputs(vector_store_file_batch)"},"response":"{\n \"id\": \"vsfb_abc123\",\n \"object\": \"vector_store.file_batch\",\n \"created_at\": 1699061776,\n \"vector_store_id\": \"vs_abc123\",\n \"status\": \"in_progress\",\n \"file_counts\": {\n \"in_progress\": 1,\n \"completed\": 1,\n \"failed\": 0,\n \"cancelled\": 0,\n \"total\": 0,\n }\n}\n"}}}},"/vector_stores/{vector_store_id}/file_batches/{batch_id}/cancel":{"post":{"operationId":"cancelVectorStoreFileBatch","tags":["Vector stores"],"summary":"Cancel a vector store file batch. This attempts to cancel the processing of files in this batch as soon as possible.","parameters":[{"in":"path","name":"vector_store_id","required":true,"schema":{"type":"string"},"description":"The ID of the vector store that the file batch belongs to."},{"in":"path","name":"batch_id","required":true,"schema":{"type":"string"},"description":"The ID of the file batch to cancel."}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VectorStoreFileBatchObject"}}}}},"x-oaiMeta":{"name":"Cancel vector store file batch","group":"vector_stores","examples":{"request":{"curl":"curl https://api.openai.com/v1/vector_stores/vs_abc123/files_batches/vsfb_abc123/cancel \\\n -H \"Authorization: Bearer $OPENAI_API_KEY\" \\\n -H \"Content-Type: application/json\" \\\n -H \"OpenAI-Beta: assistants=v2\" \\\n -X POST\n","python":"import os\nfrom openai import OpenAI\n\nclient = OpenAI(\n api_key=os.environ.get(\"OPENAI_API_KEY\"), # This is the default and can be omitted\n)\nvector_store_file_batch = client.vector_stores.file_batches.cancel(\n batch_id=\"batch_id\",\n vector_store_id=\"vector_store_id\",\n)\nprint(vector_store_file_batch.id)","javascript":"import OpenAI from \"openai\";\nconst openai = new OpenAI();\n\nasync function main() {\n const deletedVectorStoreFileBatch = await openai.vectorStores.fileBatches.cancel(\n \"vsfb_abc123\",\n { vector_store_id: \"vs_abc123\" }\n );\n console.log(deletedVectorStoreFileBatch);\n}\n\nmain();\n","node.js":"import OpenAI from 'openai';\n\nconst client = new OpenAI({\n apiKey: process.env['OPENAI_API_KEY'], // This is the default and can be omitted\n});\n\nconst vectorStoreFileBatch = await client.vectorStores.fileBatches.cancel('batch_id', {\n vector_store_id: 'vector_store_id',\n});\n\nconsole.log(vectorStoreFileBatch.id);","go":"package main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\n\t\"github.com/openai/openai-go\"\n\t\"github.com/openai/openai-go/option\"\n)\n\nfunc main() {\n\tclient := openai.NewClient(\n\t\toption.WithAPIKey(\"My API Key\"),\n\t)\n\tvectorStoreFileBatch, err := client.VectorStores.FileBatches.Cancel(\n\t\tcontext.TODO(),\n\t\t\"vector_store_id\",\n\t\t\"batch_id\",\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf(\"%+v\\n\", vectorStoreFileBatch.ID)\n}\n","java":"package com.openai.example;\n\nimport com.openai.client.OpenAIClient;\nimport com.openai.client.okhttp.OpenAIOkHttpClient;\nimport com.openai.models.vectorstores.filebatches.FileBatchCancelParams;\nimport com.openai.models.vectorstores.filebatches.VectorStoreFileBatch;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n OpenAIClient client = OpenAIOkHttpClient.fromEnv();\n\n FileBatchCancelParams params = FileBatchCancelParams.builder()\n .vectorStoreId(\"vector_store_id\")\n .batchId(\"batch_id\")\n .build();\n VectorStoreFileBatch vectorStoreFileBatch = client.vectorStores().fileBatches().cancel(params);\n }\n}","ruby":"require \"openai\"\n\nopenai = OpenAI::Client.new(api_key: \"My API Key\")\n\nvector_store_file_batch = openai.vector_stores.file_batches.cancel(\"batch_id\", vector_store_id: \"vector_store_id\")\n\nputs(vector_store_file_batch)"},"response":"{\n \"id\": \"vsfb_abc123\",\n \"object\": \"vector_store.file_batch\",\n \"created_at\": 1699061776,\n \"vector_store_id\": \"vs_abc123\",\n \"status\": \"in_progress\",\n \"file_counts\": {\n \"in_progress\": 12,\n \"completed\": 3,\n \"failed\": 0,\n \"cancelled\": 0,\n \"total\": 15,\n }\n}\n"}}}},"/vector_stores/{vector_store_id}/file_batches/{batch_id}/files":{"get":{"operationId":"listFilesInVectorStoreBatch","tags":["Vector stores"],"summary":"Returns a list of vector store files in a batch.","parameters":[{"name":"vector_store_id","in":"path","description":"The ID of the vector store that the files belong to.","required":true,"schema":{"type":"string"}},{"name":"batch_id","in":"path","description":"The ID of the file batch that the files belong to.","required":true,"schema":{"type":"string"}},{"name":"limit","in":"query","description":"A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.\n","required":false,"schema":{"type":"integer","default":20}},{"name":"order","in":"query","description":"Sort order by the `created_at` timestamp of the objects. `asc` for ascending order and `desc` for descending order.\n","schema":{"type":"string","default":"desc","enum":["asc","desc"]}},{"name":"after","in":"query","description":"A cursor for use in pagination. `after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list.\n","schema":{"type":"string"}},{"name":"before","in":"query","description":"A cursor for use in pagination. `before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_foo, your subsequent call can include before=obj_foo in order to fetch the previous page of the list.\n","schema":{"type":"string"}},{"name":"filter","in":"query","description":"Filter by file status. One of `in_progress`, `completed`, `failed`, `cancelled`.","schema":{"type":"string","enum":["in_progress","completed","failed","cancelled"]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListVectorStoreFilesResponse"}}}}},"x-oaiMeta":{"name":"List vector store files in a batch","group":"vector_stores","examples":{"request":{"curl":"curl https://api.openai.com/v1/vector_stores/vs_abc123/files_batches/vsfb_abc123/files \\\n -H \"Authorization: Bearer $OPENAI_API_KEY\" \\\n -H \"Content-Type: application/json\" \\\n -H \"OpenAI-Beta: assistants=v2\"\n","python":"import os\nfrom openai import OpenAI\n\nclient = OpenAI(\n api_key=os.environ.get(\"OPENAI_API_KEY\"), # This is the default and can be omitted\n)\npage = client.vector_stores.file_batches.list_files(\n batch_id=\"batch_id\",\n vector_store_id=\"vector_store_id\",\n)\npage = page.data[0]\nprint(page.id)","javascript":"import OpenAI from \"openai\";\nconst openai = new OpenAI();\n\nasync function main() {\n const vectorStoreFiles = await openai.vectorStores.fileBatches.listFiles(\n \"vsfb_abc123\",\n { vector_store_id: \"vs_abc123\" }\n );\n console.log(vectorStoreFiles);\n}\n\nmain();\n","node.js":"import OpenAI from 'openai';\n\nconst client = new OpenAI({\n apiKey: process.env['OPENAI_API_KEY'], // This is the default and can be omitted\n});\n\n// Automatically fetches more pages as needed.\nfor await (const vectorStoreFile of client.vectorStores.fileBatches.listFiles('batch_id', {\n vector_store_id: 'vector_store_id',\n})) {\n console.log(vectorStoreFile.id);\n}","go":"package main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\n\t\"github.com/openai/openai-go\"\n\t\"github.com/openai/openai-go/option\"\n)\n\nfunc main() {\n\tclient := openai.NewClient(\n\t\toption.WithAPIKey(\"My API Key\"),\n\t)\n\tpage, err := client.VectorStores.FileBatches.ListFiles(\n\t\tcontext.TODO(),\n\t\t\"vector_store_id\",\n\t\t\"batch_id\",\n\t\topenai.VectorStoreFileBatchListFilesParams{},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf(\"%+v\\n\", page)\n}\n","java":"package com.openai.example;\n\nimport com.openai.client.OpenAIClient;\nimport com.openai.client.okhttp.OpenAIOkHttpClient;\nimport com.openai.models.vectorstores.filebatches.FileBatchListFilesPage;\nimport com.openai.models.vectorstores.filebatches.FileBatchListFilesParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n OpenAIClient client = OpenAIOkHttpClient.fromEnv();\n\n FileBatchListFilesParams params = FileBatchListFilesParams.builder()\n .vectorStoreId(\"vector_store_id\")\n .batchId(\"batch_id\")\n .build();\n FileBatchListFilesPage page = client.vectorStores().fileBatches().listFiles(params);\n }\n}","ruby":"require \"openai\"\n\nopenai = OpenAI::Client.new(api_key: \"My API Key\")\n\npage = openai.vector_stores.file_batches.list_files(\"batch_id\", vector_store_id: \"vector_store_id\")\n\nputs(page)"},"response":"{\n \"object\": \"list\",\n \"data\": [\n {\n \"id\": \"file-abc123\",\n \"object\": \"vector_store.file\",\n \"created_at\": 1699061776,\n \"vector_store_id\": \"vs_abc123\"\n },\n {\n \"id\": \"file-abc456\",\n \"object\": \"vector_store.file\",\n \"created_at\": 1699061776,\n \"vector_store_id\": \"vs_abc123\"\n }\n ],\n \"first_id\": \"file-abc123\",\n \"last_id\": \"file-abc456\",\n \"has_more\": false\n}\n"}}}},"/vector_stores/{vector_store_id}/files":{"get":{"operationId":"listVectorStoreFiles","tags":["Vector stores"],"summary":"Returns a list of vector store files.","parameters":[{"name":"vector_store_id","in":"path","description":"The ID of the vector store that the files belong to.","required":true,"schema":{"type":"string"}},{"name":"limit","in":"query","description":"A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.\n","required":false,"schema":{"type":"integer","default":20}},{"name":"order","in":"query","description":"Sort order by the `created_at` timestamp of the objects. `asc` for ascending order and `desc` for descending order.\n","schema":{"type":"string","default":"desc","enum":["asc","desc"]}},{"name":"after","in":"query","description":"A cursor for use in pagination. `after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list.\n","schema":{"type":"string"}},{"name":"before","in":"query","description":"A cursor for use in pagination. `before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_foo, your subsequent call can include before=obj_foo in order to fetch the previous page of the list.\n","schema":{"type":"string"}},{"name":"filter","in":"query","description":"Filter by file status. One of `in_progress`, `completed`, `failed`, `cancelled`.","schema":{"type":"string","enum":["in_progress","completed","failed","cancelled"]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListVectorStoreFilesResponse"}}}}},"x-oaiMeta":{"name":"List vector store files","group":"vector_stores","examples":{"request":{"curl":"curl https://api.openai.com/v1/vector_stores/vs_abc123/files \\\n -H \"Authorization: Bearer $OPENAI_API_KEY\" \\\n -H \"Content-Type: application/json\" \\\n -H \"OpenAI-Beta: assistants=v2\"\n","python":"import os\nfrom openai import OpenAI\n\nclient = OpenAI(\n api_key=os.environ.get(\"OPENAI_API_KEY\"), # This is the default and can be omitted\n)\npage = client.vector_stores.files.list(\n vector_store_id=\"vector_store_id\",\n)\npage = page.data[0]\nprint(page.id)","javascript":"import OpenAI from \"openai\";\nconst openai = new OpenAI();\n\nasync function main() {\n const vectorStoreFiles = await openai.vectorStores.files.list(\n \"vs_abc123\"\n );\n console.log(vectorStoreFiles);\n}\n\nmain();\n","node.js":"import OpenAI from 'openai';\n\nconst client = new OpenAI({\n apiKey: process.env['OPENAI_API_KEY'], // This is the default and can be omitted\n});\n\n// Automatically fetches more pages as needed.\nfor await (const vectorStoreFile of client.vectorStores.files.list('vector_store_id')) {\n console.log(vectorStoreFile.id);\n}","go":"package main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\n\t\"github.com/openai/openai-go\"\n\t\"github.com/openai/openai-go/option\"\n)\n\nfunc main() {\n\tclient := openai.NewClient(\n\t\toption.WithAPIKey(\"My API Key\"),\n\t)\n\tpage, err := client.VectorStores.Files.List(\n\t\tcontext.TODO(),\n\t\t\"vector_store_id\",\n\t\topenai.VectorStoreFileListParams{},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf(\"%+v\\n\", page)\n}\n","java":"package com.openai.example;\n\nimport com.openai.client.OpenAIClient;\nimport com.openai.client.okhttp.OpenAIOkHttpClient;\nimport com.openai.models.vectorstores.files.FileListPage;\nimport com.openai.models.vectorstores.files.FileListParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n OpenAIClient client = OpenAIOkHttpClient.fromEnv();\n\n FileListPage page = client.vectorStores().files().list(\"vector_store_id\");\n }\n}","ruby":"require \"openai\"\n\nopenai = OpenAI::Client.new(api_key: \"My API Key\")\n\npage = openai.vector_stores.files.list(\"vector_store_id\")\n\nputs(page)"},"response":"{\n \"object\": \"list\",\n \"data\": [\n {\n \"id\": \"file-abc123\",\n \"object\": \"vector_store.file\",\n \"created_at\": 1699061776,\n \"vector_store_id\": \"vs_abc123\"\n },\n {\n \"id\": \"file-abc456\",\n \"object\": \"vector_store.file\",\n \"created_at\": 1699061776,\n \"vector_store_id\": \"vs_abc123\"\n }\n ],\n \"first_id\": \"file-abc123\",\n \"last_id\": \"file-abc456\",\n \"has_more\": false\n}\n"}}},"post":{"operationId":"createVectorStoreFile","tags":["Vector stores"],"summary":"Create a vector store file by attaching a [File](/docs/api-reference/files) to a [vector store](/docs/api-reference/vector-stores/object).","description":"This endpoint is subject to a per-vector-store write rate limit of 300 requests per minute, shared with `/vector_stores/{vector_store_id}/file_batches`.\nFor uploading multiple files to the same vector store, use the file batches endpoint to reduce request volume.","parameters":[{"in":"path","name":"vector_store_id","required":true,"schema":{"type":"string","example":"vs_abc123"},"description":"The ID of the vector store for which to create a File.\n"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateVectorStoreFileRequest"}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VectorStoreFileObject"}}}}},"x-oaiMeta":{"name":"Create vector store file","group":"vector_stores","description":"Attaches one file to a vector store. File attach writes are rate-limited per vector store (300 requests/minute shared with `/vector_stores/{vector_store_id}/file_batches`), so use file batches when uploading multiple files.\n","examples":{"request":{"curl":"curl https://api.openai.com/v1/vector_stores/vs_abc123/files \\\n -H \"Authorization: Bearer $OPENAI_API_KEY\" \\\n -H \"Content-Type: application/json\" \\\n -H \"OpenAI-Beta: assistants=v2\" \\\n -d '{\n \"file_id\": \"file-abc123\"\n }'\n","python":"import os\nfrom openai import OpenAI\n\nclient = OpenAI(\n api_key=os.environ.get(\"OPENAI_API_KEY\"), # This is the default and can be omitted\n)\nvector_store_file = client.vector_stores.files.create(\n vector_store_id=\"vs_abc123\",\n file_id=\"file_id\",\n)\nprint(vector_store_file.id)","javascript":"import OpenAI from \"openai\";\nconst openai = new OpenAI();\n\nasync function main() {\n const myVectorStoreFile = await openai.vectorStores.files.create(\n \"vs_abc123\",\n {\n file_id: \"file-abc123\"\n }\n );\n console.log(myVectorStoreFile);\n}\n\nmain();\n","node.js":"import OpenAI from 'openai';\n\nconst client = new OpenAI({\n apiKey: process.env['OPENAI_API_KEY'], // This is the default and can be omitted\n});\n\nconst vectorStoreFile = await client.vectorStores.files.create('vs_abc123', { file_id: 'file_id' });\n\nconsole.log(vectorStoreFile.id);","go":"package main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\n\t\"github.com/openai/openai-go\"\n\t\"github.com/openai/openai-go/option\"\n)\n\nfunc main() {\n\tclient := openai.NewClient(\n\t\toption.WithAPIKey(\"My API Key\"),\n\t)\n\tvectorStoreFile, err := client.VectorStores.Files.New(\n\t\tcontext.TODO(),\n\t\t\"vs_abc123\",\n\t\topenai.VectorStoreFileNewParams{\n\t\t\tFileID: \"file_id\",\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf(\"%+v\\n\", vectorStoreFile.ID)\n}\n","java":"package com.openai.example;\n\nimport com.openai.client.OpenAIClient;\nimport com.openai.client.okhttp.OpenAIOkHttpClient;\nimport com.openai.models.vectorstores.files.FileCreateParams;\nimport com.openai.models.vectorstores.files.VectorStoreFile;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n OpenAIClient client = OpenAIOkHttpClient.fromEnv();\n\n FileCreateParams params = FileCreateParams.builder()\n .vectorStoreId(\"vs_abc123\")\n .fileId(\"file_id\")\n .build();\n VectorStoreFile vectorStoreFile = client.vectorStores().files().create(params);\n }\n}","ruby":"require \"openai\"\n\nopenai = OpenAI::Client.new(api_key: \"My API Key\")\n\nvector_store_file = openai.vector_stores.files.create(\"vs_abc123\", file_id: \"file_id\")\n\nputs(vector_store_file)"},"response":"{\n \"id\": \"file-abc123\",\n \"object\": \"vector_store.file\",\n \"created_at\": 1699061776,\n \"usage_bytes\": 1234,\n \"vector_store_id\": \"vs_abcd\",\n \"status\": \"completed\",\n \"last_error\": null\n}\n"}}}},"/vector_stores/{vector_store_id}/files/{file_id}":{"get":{"operationId":"getVectorStoreFile","tags":["Vector stores"],"summary":"Retrieves a vector store file.","parameters":[{"in":"path","name":"vector_store_id","required":true,"schema":{"type":"string","example":"vs_abc123"},"description":"The ID of the vector store that the file belongs to."},{"in":"path","name":"file_id","required":true,"schema":{"type":"string","example":"file-abc123"},"description":"The ID of the file being retrieved."}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VectorStoreFileObject"}}}}},"x-oaiMeta":{"name":"Retrieve vector store file","group":"vector_stores","examples":{"request":{"curl":"curl https://api.openai.com/v1/vector_stores/vs_abc123/files/file-abc123 \\\n -H \"Authorization: Bearer $OPENAI_API_KEY\" \\\n -H \"Content-Type: application/json\" \\\n -H \"OpenAI-Beta: assistants=v2\"\n","python":"import os\nfrom openai import OpenAI\n\nclient = OpenAI(\n api_key=os.environ.get(\"OPENAI_API_KEY\"), # This is the default and can be omitted\n)\nvector_store_file = client.vector_stores.files.retrieve(\n file_id=\"file-abc123\",\n vector_store_id=\"vs_abc123\",\n)\nprint(vector_store_file.id)","javascript":"import OpenAI from \"openai\";\nconst openai = new OpenAI();\n\nasync function main() {\n const vectorStoreFile = await openai.vectorStores.files.retrieve(\n \"file-abc123\",\n { vector_store_id: \"vs_abc123\" }\n );\n console.log(vectorStoreFile);\n}\n\nmain();\n","node.js":"import OpenAI from 'openai';\n\nconst client = new OpenAI({\n apiKey: process.env['OPENAI_API_KEY'], // This is the default and can be omitted\n});\n\nconst vectorStoreFile = await client.vectorStores.files.retrieve('file-abc123', {\n vector_store_id: 'vs_abc123',\n});\n\nconsole.log(vectorStoreFile.id);","go":"package main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\n\t\"github.com/openai/openai-go\"\n\t\"github.com/openai/openai-go/option\"\n)\n\nfunc main() {\n\tclient := openai.NewClient(\n\t\toption.WithAPIKey(\"My API Key\"),\n\t)\n\tvectorStoreFile, err := client.VectorStores.Files.Get(\n\t\tcontext.TODO(),\n\t\t\"vs_abc123\",\n\t\t\"file-abc123\",\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf(\"%+v\\n\", vectorStoreFile.ID)\n}\n","java":"package com.openai.example;\n\nimport com.openai.client.OpenAIClient;\nimport com.openai.client.okhttp.OpenAIOkHttpClient;\nimport com.openai.models.vectorstores.files.FileRetrieveParams;\nimport com.openai.models.vectorstores.files.VectorStoreFile;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n OpenAIClient client = OpenAIOkHttpClient.fromEnv();\n\n FileRetrieveParams params = FileRetrieveParams.builder()\n .vectorStoreId(\"vs_abc123\")\n .fileId(\"file-abc123\")\n .build();\n VectorStoreFile vectorStoreFile = client.vectorStores().files().retrieve(params);\n }\n}","ruby":"require \"openai\"\n\nopenai = OpenAI::Client.new(api_key: \"My API Key\")\n\nvector_store_file = openai.vector_stores.files.retrieve(\"file-abc123\", vector_store_id: \"vs_abc123\")\n\nputs(vector_store_file)"},"response":"{\n \"id\": \"file-abc123\",\n \"object\": \"vector_store.file\",\n \"created_at\": 1699061776,\n \"vector_store_id\": \"vs_abcd\",\n \"status\": \"completed\",\n \"last_error\": null\n}\n"}}},"delete":{"operationId":"deleteVectorStoreFile","tags":["Vector stores"],"summary":"Delete a vector store file. This will remove the file from the vector store but the file itself will not be deleted. To delete the file, use the [delete file](/docs/api-reference/files/delete) endpoint.","parameters":[{"in":"path","name":"vector_store_id","required":true,"schema":{"type":"string"},"description":"The ID of the vector store that the file belongs to."},{"in":"path","name":"file_id","required":true,"schema":{"type":"string"},"description":"The ID of the file to delete."}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteVectorStoreFileResponse"}}}}},"x-oaiMeta":{"name":"Delete vector store file","group":"vector_stores","examples":{"request":{"curl":"curl https://api.openai.com/v1/vector_stores/vs_abc123/files/file-abc123 \\\n -H \"Authorization: Bearer $OPENAI_API_KEY\" \\\n -H \"Content-Type: application/json\" \\\n -H \"OpenAI-Beta: assistants=v2\" \\\n -X DELETE\n","python":"import os\nfrom openai import OpenAI\n\nclient = OpenAI(\n api_key=os.environ.get(\"OPENAI_API_KEY\"), # This is the default and can be omitted\n)\nvector_store_file_deleted = client.vector_stores.files.delete(\n file_id=\"file_id\",\n vector_store_id=\"vector_store_id\",\n)\nprint(vector_store_file_deleted.id)","javascript":"import OpenAI from \"openai\";\nconst openai = new OpenAI();\n\nasync function main() {\n const deletedVectorStoreFile = await openai.vectorStores.files.delete(\n \"file-abc123\",\n { vector_store_id: \"vs_abc123\" }\n );\n console.log(deletedVectorStoreFile);\n}\n\nmain();\n","node.js":"import OpenAI from 'openai';\n\nconst client = new OpenAI({\n apiKey: process.env['OPENAI_API_KEY'], // This is the default and can be omitted\n});\n\nconst vectorStoreFileDeleted = await client.vectorStores.files.delete('file_id', {\n vector_store_id: 'vector_store_id',\n});\n\nconsole.log(vectorStoreFileDeleted.id);","go":"package main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\n\t\"github.com/openai/openai-go\"\n\t\"github.com/openai/openai-go/option\"\n)\n\nfunc main() {\n\tclient := openai.NewClient(\n\t\toption.WithAPIKey(\"My API Key\"),\n\t)\n\tvectorStoreFileDeleted, err := client.VectorStores.Files.Delete(\n\t\tcontext.TODO(),\n\t\t\"vector_store_id\",\n\t\t\"file_id\",\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf(\"%+v\\n\", vectorStoreFileDeleted.ID)\n}\n","java":"package com.openai.example;\n\nimport com.openai.client.OpenAIClient;\nimport com.openai.client.okhttp.OpenAIOkHttpClient;\nimport com.openai.models.vectorstores.files.FileDeleteParams;\nimport com.openai.models.vectorstores.files.VectorStoreFileDeleted;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n OpenAIClient client = OpenAIOkHttpClient.fromEnv();\n\n FileDeleteParams params = FileDeleteParams.builder()\n .vectorStoreId(\"vector_store_id\")\n .fileId(\"file_id\")\n .build();\n VectorStoreFileDeleted vectorStoreFileDeleted = client.vectorStores().files().delete(params);\n }\n}","ruby":"require \"openai\"\n\nopenai = OpenAI::Client.new(api_key: \"My API Key\")\n\nvector_store_file_deleted = openai.vector_stores.files.delete(\"file_id\", vector_store_id: \"vector_store_id\")\n\nputs(vector_store_file_deleted)"},"response":"{\n id: \"file-abc123\",\n object: \"vector_store.file.deleted\",\n deleted: true\n}\n"}}},"post":{"operationId":"updateVectorStoreFileAttributes","tags":["Vector stores"],"summary":"Update attributes on a vector store file.","parameters":[{"in":"path","name":"vector_store_id","required":true,"schema":{"type":"string","example":"vs_abc123"},"description":"The ID of the vector store the file belongs to."},{"in":"path","name":"file_id","required":true,"schema":{"type":"string","example":"file-abc123"},"description":"The ID of the file to update attributes."}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateVectorStoreFileAttributesRequest"}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VectorStoreFileObject"}}}}},"x-oaiMeta":{"name":"Update vector store file attributes","group":"vector_stores","examples":{"request":{"curl":"curl https://api.openai.com/v1/vector_stores/{vector_store_id}/files/{file_id} \\\n -H \"Authorization: Bearer $OPENAI_API_KEY\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"attributes\": {\"key1\": \"value1\", \"key2\": 2}}'\n","node.js":"import OpenAI from 'openai';\n\nconst client = new OpenAI({\n apiKey: process.env['OPENAI_API_KEY'], // This is the default and can be omitted\n});\n\nconst vectorStoreFile = await client.vectorStores.files.update('file-abc123', {\n vector_store_id: 'vs_abc123',\n attributes: { foo: 'string' },\n});\n\nconsole.log(vectorStoreFile.id);","python":"import os\nfrom openai import OpenAI\n\nclient = OpenAI(\n api_key=os.environ.get(\"OPENAI_API_KEY\"), # This is the default and can be omitted\n)\nvector_store_file = client.vector_stores.files.update(\n file_id=\"file-abc123\",\n vector_store_id=\"vs_abc123\",\n attributes={\n \"foo\": \"string\"\n },\n)\nprint(vector_store_file.id)","go":"package main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\n\t\"github.com/openai/openai-go\"\n\t\"github.com/openai/openai-go/option\"\n)\n\nfunc main() {\n\tclient := openai.NewClient(\n\t\toption.WithAPIKey(\"My API Key\"),\n\t)\n\tvectorStoreFile, err := client.VectorStores.Files.Update(\n\t\tcontext.TODO(),\n\t\t\"vs_abc123\",\n\t\t\"file-abc123\",\n\t\topenai.VectorStoreFileUpdateParams{\n\t\t\tAttributes: map[string]openai.VectorStoreFileUpdateParamsAttributeUnion{\n\t\t\t\t\"foo\": {\n\t\t\t\t\tOfString: openai.String(\"string\"),\n\t\t\t\t},\n\t\t\t},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf(\"%+v\\n\", vectorStoreFile.ID)\n}\n","java":"package com.openai.example;\n\nimport com.openai.client.OpenAIClient;\nimport com.openai.client.okhttp.OpenAIOkHttpClient;\nimport com.openai.core.JsonValue;\nimport com.openai.models.vectorstores.files.FileUpdateParams;\nimport com.openai.models.vectorstores.files.VectorStoreFile;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n OpenAIClient client = OpenAIOkHttpClient.fromEnv();\n\n FileUpdateParams params = FileUpdateParams.builder()\n .vectorStoreId(\"vs_abc123\")\n .fileId(\"file-abc123\")\n .attributes(FileUpdateParams.Attributes.builder()\n .putAdditionalProperty(\"foo\", JsonValue.from(\"string\"))\n .build())\n .build();\n VectorStoreFile vectorStoreFile = client.vectorStores().files().update(params);\n }\n}","ruby":"require \"openai\"\n\nopenai = OpenAI::Client.new(api_key: \"My API Key\")\n\nvector_store_file = openai.vector_stores.files.update(\n \"file-abc123\",\n vector_store_id: \"vs_abc123\",\n attributes: {foo: \"string\"}\n)\n\nputs(vector_store_file)"},"response":"{\n \"id\": \"file-abc123\",\n \"object\": \"vector_store.file\",\n \"usage_bytes\": 1234,\n \"created_at\": 1699061776,\n \"vector_store_id\": \"vs_abcd\",\n \"status\": \"completed\",\n \"last_error\": null,\n \"chunking_strategy\": {...},\n \"attributes\": {\"key1\": \"value1\", \"key2\": 2}\n}\n"}}}},"/vector_stores/{vector_store_id}/files/{file_id}/content":{"get":{"operationId":"retrieveVectorStoreFileContent","tags":["Vector stores"],"summary":"Retrieve the parsed contents of a vector store file.","parameters":[{"in":"path","name":"vector_store_id","required":true,"schema":{"type":"string","example":"vs_abc123"},"description":"The ID of the vector store."},{"in":"path","name":"file_id","required":true,"schema":{"type":"string","example":"file-abc123"},"description":"The ID of the file within the vector store."}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VectorStoreFileContentResponse"}}}}},"x-oaiMeta":{"name":"Retrieve vector store file content","group":"vector_stores","examples":{"request":{"curl":"curl \\\nhttps://api.openai.com/v1/vector_stores/vs_abc123/files/file-abc123/content \\\n-H \"Authorization: Bearer $OPENAI_API_KEY\"\n","node.js":"import OpenAI from 'openai';\n\nconst client = new OpenAI({\n apiKey: process.env['OPENAI_API_KEY'], // This is the default and can be omitted\n});\n\n// Automatically fetches more pages as needed.\nfor await (const fileContentResponse of client.vectorStores.files.content('file-abc123', {\n vector_store_id: 'vs_abc123',\n})) {\n console.log(fileContentResponse.text);\n}","python":"import os\nfrom openai import OpenAI\n\nclient = OpenAI(\n api_key=os.environ.get(\"OPENAI_API_KEY\"), # This is the default and can be omitted\n)\npage = client.vector_stores.files.content(\n file_id=\"file-abc123\",\n vector_store_id=\"vs_abc123\",\n)\npage = page.data[0]\nprint(page.text)","go":"package main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\n\t\"github.com/openai/openai-go\"\n\t\"github.com/openai/openai-go/option\"\n)\n\nfunc main() {\n\tclient := openai.NewClient(\n\t\toption.WithAPIKey(\"My API Key\"),\n\t)\n\tpage, err := client.VectorStores.Files.Content(\n\t\tcontext.TODO(),\n\t\t\"vs_abc123\",\n\t\t\"file-abc123\",\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf(\"%+v\\n\", page)\n}\n","java":"package com.openai.example;\n\nimport com.openai.client.OpenAIClient;\nimport com.openai.client.okhttp.OpenAIOkHttpClient;\nimport com.openai.models.vectorstores.files.FileContentPage;\nimport com.openai.models.vectorstores.files.FileContentParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n OpenAIClient client = OpenAIOkHttpClient.fromEnv();\n\n FileContentParams params = FileContentParams.builder()\n .vectorStoreId(\"vs_abc123\")\n .fileId(\"file-abc123\")\n .build();\n FileContentPage page = client.vectorStores().files().content(params);\n }\n}","ruby":"require \"openai\"\n\nopenai = OpenAI::Client.new(api_key: \"My API Key\")\n\npage = openai.vector_stores.files.content(\"file-abc123\", vector_store_id: \"vs_abc123\")\n\nputs(page)"},"response":"{\n \"file_id\": \"file-abc123\",\n \"filename\": \"example.txt\",\n \"attributes\": {\"key\": \"value\"},\n \"content\": [\n {\"type\": \"text\", \"text\": \"...\"},\n ...\n ]\n}\n"}}}},"/vector_stores/{vector_store_id}/search":{"post":{"operationId":"searchVectorStore","tags":["Vector stores"],"summary":"Search a vector store for relevant chunks based on a query and file attributes filter.","parameters":[{"in":"path","name":"vector_store_id","required":true,"schema":{"type":"string","example":"vs_abc123"},"description":"The ID of the vector store to search."}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/VectorStoreSearchRequest"}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VectorStoreSearchResultsPage"}}}}},"x-oaiMeta":{"name":"Search vector store","group":"vector_stores","examples":{"request":{"curl":"curl -X POST \\\nhttps://api.openai.com/v1/vector_stores/vs_abc123/search \\\n-H \"Authorization: Bearer $OPENAI_API_KEY\" \\\n-H \"Content-Type: application/json\" \\\n-d '{\"query\": \"What is the return policy?\", \"filters\": {...}}'\n","node.js":"import OpenAI from 'openai';\n\nconst client = new OpenAI({\n apiKey: process.env['OPENAI_API_KEY'], // This is the default and can be omitted\n});\n\n// Automatically fetches more pages as needed.\nfor await (const vectorStoreSearchResponse of client.vectorStores.search('vs_abc123', {\n query: 'string',\n})) {\n console.log(vectorStoreSearchResponse.file_id);\n}","python":"import os\nfrom openai import OpenAI\n\nclient = OpenAI(\n api_key=os.environ.get(\"OPENAI_API_KEY\"), # This is the default and can be omitted\n)\npage = client.vector_stores.search(\n vector_store_id=\"vs_abc123\",\n query=\"string\",\n)\npage = page.data[0]\nprint(page.file_id)","go":"package main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\n\t\"github.com/openai/openai-go\"\n\t\"github.com/openai/openai-go/option\"\n)\n\nfunc main() {\n\tclient := openai.NewClient(\n\t\toption.WithAPIKey(\"My API Key\"),\n\t)\n\tpage, err := client.VectorStores.Search(\n\t\tcontext.TODO(),\n\t\t\"vs_abc123\",\n\t\topenai.VectorStoreSearchParams{\n\t\t\tQuery: openai.VectorStoreSearchParamsQueryUnion{\n\t\t\t\tOfString: openai.String(\"string\"),\n\t\t\t},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf(\"%+v\\n\", page)\n}\n","java":"package com.openai.example;\n\nimport com.openai.client.OpenAIClient;\nimport com.openai.client.okhttp.OpenAIOkHttpClient;\nimport com.openai.models.vectorstores.VectorStoreSearchPage;\nimport com.openai.models.vectorstores.VectorStoreSearchParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n OpenAIClient client = OpenAIOkHttpClient.fromEnv();\n\n VectorStoreSearchParams params = VectorStoreSearchParams.builder()\n .vectorStoreId(\"vs_abc123\")\n .query(\"string\")\n .build();\n VectorStoreSearchPage page = client.vectorStores().search(params);\n }\n}","ruby":"require \"openai\"\n\nopenai = OpenAI::Client.new(api_key: \"My API Key\")\n\npage = openai.vector_stores.search(\"vs_abc123\", query: \"string\")\n\nputs(page)"},"response":"{\n \"object\": \"vector_store.search_results.page\",\n \"search_query\": \"What is the return policy?\",\n \"data\": [\n {\n \"file_id\": \"file_123\",\n \"filename\": \"document.pdf\",\n \"score\": 0.95,\n \"attributes\": {\n \"author\": \"John Doe\",\n \"date\": \"2023-01-01\"\n },\n \"content\": [\n {\n \"type\": \"text\",\n \"text\": \"Relevant chunk\"\n }\n ]\n },\n {\n \"file_id\": \"file_456\",\n \"filename\": \"notes.txt\",\n \"score\": 0.89,\n \"attributes\": {\n \"author\": \"Jane Smith\",\n \"date\": \"2023-01-02\"\n },\n \"content\": [\n {\n \"type\": \"text\",\n \"text\": \"Sample text content from the vector store.\"\n }\n ]\n }\n ],\n \"has_more\": false,\n \"next_page\": null\n}\n"}}}},"/conversations":{"post":{"tags":["Conversations"],"summary":"Create a conversation.","operationId":"createConversation","parameters":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateConversationBody"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConversationResource"}}}}},"x-oaiMeta":{"name":"Create a conversation","group":"conversations","path":"create","examples":{"request":{"curl":"curl https://api.openai.com/v1/conversations \\\n -H \"Content-Type: application/json\" \\\n -H \"Authorization: Bearer $OPENAI_API_KEY\" \\\n -d '{\n \"metadata\": {\"topic\": \"demo\"},\n \"items\": [\n {\n \"type\": \"message\",\n \"role\": \"user\",\n \"content\": \"Hello!\"\n }\n ]\n }'\n","javascript":"import OpenAI from \"openai\";\nconst client = new OpenAI();\n\nconst conversation = await client.conversations.create({\n metadata: { topic: \"demo\" },\n items: [\n { type: \"message\", role: \"user\", content: \"Hello!\" }\n ],\n});\nconsole.log(conversation);\n","python":"import os\nfrom openai import OpenAI\n\nclient = OpenAI(\n api_key=os.environ.get(\"OPENAI_API_KEY\"), # This is the default and can be omitted\n)\nconversation = client.conversations.create()\nprint(conversation.id)","csharp":"using System;\nusing System.Collections.Generic;\nusing OpenAI.Conversations;\n\nOpenAIConversationClient client = new(\n apiKey: Environment.GetEnvironmentVariable(\"OPENAI_API_KEY\")\n);\n\nConversation conversation = client.CreateConversation(\n new CreateConversationOptions\n {\n Metadata = new Dictionary<string, string>\n {\n { \"topic\", \"demo\" }\n },\n Items =\n {\n new ConversationMessageInput\n {\n Role = \"user\",\n Content = \"Hello!\",\n }\n }\n }\n);\nConsole.WriteLine(conversation.Id);\n","node.js":"import OpenAI from 'openai';\n\nconst client = new OpenAI({\n apiKey: process.env['OPENAI_API_KEY'], // This is the default and can be omitted\n});\n\nconst conversation = await client.conversations.create();\n\nconsole.log(conversation.id);","go":"package main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\n\t\"github.com/openai/openai-go\"\n\t\"github.com/openai/openai-go/conversations\"\n\t\"github.com/openai/openai-go/option\"\n)\n\nfunc main() {\n\tclient := openai.NewClient(\n\t\toption.WithAPIKey(\"My API Key\"),\n\t)\n\tconversation, err := client.Conversations.New(context.TODO(), conversations.ConversationNewParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf(\"%+v\\n\", conversation.ID)\n}\n","java":"package com.openai.example;\n\nimport com.openai.client.OpenAIClient;\nimport com.openai.client.okhttp.OpenAIOkHttpClient;\nimport com.openai.models.conversations.Conversation;\nimport com.openai.models.conversations.ConversationCreateParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n OpenAIClient client = OpenAIOkHttpClient.fromEnv();\n\n Conversation conversation = client.conversations().create();\n }\n}","ruby":"require \"openai\"\n\nopenai = OpenAI::Client.new(api_key: \"My API Key\")\n\nconversation = openai.conversations.create\n\nputs(conversation)"},"response":"{\n \"id\": \"conv_123\",\n \"object\": \"conversation\",\n \"created_at\": 1741900000,\n \"metadata\": {\"topic\": \"demo\"}\n}\n"}}}},"/conversations/{conversation_id}":{"get":{"tags":["Conversations"],"summary":"Get a conversation","operationId":"getConversation","parameters":[{"name":"conversation_id","in":"path","description":"The ID of the conversation to retrieve.","required":true,"schema":{"example":"conv_123","type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConversationResource"}}}}},"x-oaiMeta":{"name":"Retrieve a conversation","group":"conversations","path":"retrieve","examples":{"request":{"curl":"curl https://api.openai.com/v1/conversations/conv_123 \\\n -H \"Authorization: Bearer $OPENAI_API_KEY\"\n","javascript":"import OpenAI from \"openai\";\nconst client = new OpenAI();\n\nconst conversation = await client.conversations.retrieve(\"conv_123\");\nconsole.log(conversation);\n","python":"import os\nfrom openai import OpenAI\n\nclient = OpenAI(\n api_key=os.environ.get(\"OPENAI_API_KEY\"), # This is the default and can be omitted\n)\nconversation = client.conversations.retrieve(\n \"conv_123\",\n)\nprint(conversation.id)","csharp":"using System;\nusing OpenAI.Conversations;\n\nOpenAIConversationClient client = new(\n apiKey: Environment.GetEnvironmentVariable(\"OPENAI_API_KEY\")\n);\n\nConversation conversation = client.GetConversation(\"conv_123\");\nConsole.WriteLine(conversation.Id);\n","node.js":"import OpenAI from 'openai';\n\nconst client = new OpenAI({\n apiKey: process.env['OPENAI_API_KEY'], // This is the default and can be omitted\n});\n\nconst conversation = await client.conversations.retrieve('conv_123');\n\nconsole.log(conversation.id);","go":"package main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\n\t\"github.com/openai/openai-go\"\n\t\"github.com/openai/openai-go/option\"\n)\n\nfunc main() {\n\tclient := openai.NewClient(\n\t\toption.WithAPIKey(\"My API Key\"),\n\t)\n\tconversation, err := client.Conversations.Get(context.TODO(), \"conv_123\")\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf(\"%+v\\n\", conversation.ID)\n}\n","java":"package com.openai.example;\n\nimport com.openai.client.OpenAIClient;\nimport com.openai.client.okhttp.OpenAIOkHttpClient;\nimport com.openai.models.conversations.Conversation;\nimport com.openai.models.conversations.ConversationRetrieveParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n OpenAIClient client = OpenAIOkHttpClient.fromEnv();\n\n Conversation conversation = client.conversations().retrieve(\"conv_123\");\n }\n}","ruby":"require \"openai\"\n\nopenai = OpenAI::Client.new(api_key: \"My API Key\")\n\nconversation = openai.conversations.retrieve(\"conv_123\")\n\nputs(conversation)"},"response":"{\n \"id\": \"conv_123\",\n \"object\": \"conversation\",\n \"created_at\": 1741900000,\n \"metadata\": {\"topic\": \"demo\"}\n}\n"}}},"delete":{"tags":["Conversations"],"summary":"Delete a conversation. Items in the conversation will not be deleted.","operationId":"deleteConversation","parameters":[{"name":"conversation_id","in":"path","description":"The ID of the conversation to delete.","required":true,"schema":{"example":"conv_123","type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeletedConversationResource"}}}}},"x-oaiMeta":{"name":"Delete a conversation","group":"conversations","path":"delete","examples":{"request":{"curl":"curl -X DELETE https://api.openai.com/v1/conversations/conv_123 \\\n -H \"Authorization: Bearer $OPENAI_API_KEY\"\n","javascript":"import OpenAI from \"openai\";\nconst client = new OpenAI();\n\nconst deleted = await client.conversations.delete(\"conv_123\");\nconsole.log(deleted);\n","python":"import os\nfrom openai import OpenAI\n\nclient = OpenAI(\n api_key=os.environ.get(\"OPENAI_API_KEY\"), # This is the default and can be omitted\n)\nconversation_deleted_resource = client.conversations.delete(\n \"conv_123\",\n)\nprint(conversation_deleted_resource.id)","csharp":"using System;\nusing OpenAI.Conversations;\n\nOpenAIConversationClient client = new(\n apiKey: Environment.GetEnvironmentVariable(\"OPENAI_API_KEY\")\n);\n\nDeletedConversation deleted = client.DeleteConversation(\"conv_123\");\nConsole.WriteLine(deleted.Id);\n","node.js":"import OpenAI from 'openai';\n\nconst client = new OpenAI({\n apiKey: process.env['OPENAI_API_KEY'], // This is the default and can be omitted\n});\n\nconst conversationDeletedResource = await client.conversations.delete('conv_123');\n\nconsole.log(conversationDeletedResource.id);","go":"package main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\n\t\"github.com/openai/openai-go\"\n\t\"github.com/openai/openai-go/option\"\n)\n\nfunc main() {\n\tclient := openai.NewClient(\n\t\toption.WithAPIKey(\"My API Key\"),\n\t)\n\tconversationDeletedResource, err := client.Conversations.Delete(context.TODO(), \"conv_123\")\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf(\"%+v\\n\", conversationDeletedResource.ID)\n}\n","java":"package com.openai.example;\n\nimport com.openai.client.OpenAIClient;\nimport com.openai.client.okhttp.OpenAIOkHttpClient;\nimport com.openai.models.conversations.ConversationDeleteParams;\nimport com.openai.models.conversations.ConversationDeletedResource;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n OpenAIClient client = OpenAIOkHttpClient.fromEnv();\n\n ConversationDeletedResource conversationDeletedResource = client.conversations().delete(\"conv_123\");\n }\n}","ruby":"require \"openai\"\n\nopenai = OpenAI::Client.new(api_key: \"My API Key\")\n\nconversation_deleted_resource = openai.conversations.delete(\"conv_123\")\n\nputs(conversation_deleted_resource)"},"response":"{\n \"id\": \"conv_123\",\n \"object\": \"conversation.deleted\",\n \"deleted\": true\n}\n"}}},"post":{"tags":["Conversations"],"summary":"Update a conversation","operationId":"updateConversation","parameters":[{"name":"conversation_id","in":"path","description":"The ID of the conversation to update.","required":true,"schema":{"example":"conv_123","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateConversationBody"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConversationResource"}}}}},"x-oaiMeta":{"name":"Update a conversation","group":"conversations","path":"update","examples":{"request":{"curl":"curl https://api.openai.com/v1/conversations/conv_123 \\\n -H \"Content-Type: application/json\" \\\n -H \"Authorization: Bearer $OPENAI_API_KEY\" \\\n -d '{\n \"metadata\": {\"topic\": \"project-x\"}\n }'\n","javascript":"import OpenAI from \"openai\";\nconst client = new OpenAI();\n\nconst updated = await client.conversations.update(\n \"conv_123\",\n { metadata: { topic: \"project-x\" } }\n);\nconsole.log(updated);\n","python":"import os\nfrom openai import OpenAI\n\nclient = OpenAI(\n api_key=os.environ.get(\"OPENAI_API_KEY\"), # This is the default and can be omitted\n)\nconversation = client.conversations.update(\n conversation_id=\"conv_123\",\n metadata={\n \"foo\": \"string\"\n },\n)\nprint(conversation.id)","csharp":"using System;\nusing System.Collections.Generic;\nusing OpenAI.Conversations;\n\nOpenAIConversationClient client = new(\n apiKey: Environment.GetEnvironmentVariable(\"OPENAI_API_KEY\")\n);\n\nConversation updated = client.UpdateConversation(\n conversationId: \"conv_123\",\n new UpdateConversationOptions\n {\n Metadata = new Dictionary<string, string>\n {\n { \"topic\", \"project-x\" }\n }\n }\n);\nConsole.WriteLine(updated.Id);\n","node.js":"import OpenAI from 'openai';\n\nconst client = new OpenAI({\n apiKey: process.env['OPENAI_API_KEY'], // This is the default and can be omitted\n});\n\nconst conversation = await client.conversations.update('conv_123', { metadata: { foo: 'string' } });\n\nconsole.log(conversation.id);","go":"package main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\n\t\"github.com/openai/openai-go\"\n\t\"github.com/openai/openai-go/conversations\"\n\t\"github.com/openai/openai-go/option\"\n\t\"github.com/openai/openai-go/shared\"\n)\n\nfunc main() {\n\tclient := openai.NewClient(\n\t\toption.WithAPIKey(\"My API Key\"),\n\t)\n\tconversation, err := client.Conversations.Update(\n\t\tcontext.TODO(),\n\t\t\"conv_123\",\n\t\tconversations.ConversationUpdateParams{\n\t\t\tMetadata: shared.Metadata{\n\t\t\t\t\"foo\": \"string\",\n\t\t\t},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf(\"%+v\\n\", conversation.ID)\n}\n","java":"package com.openai.example;\n\nimport com.openai.client.OpenAIClient;\nimport com.openai.client.okhttp.OpenAIOkHttpClient;\nimport com.openai.core.JsonValue;\nimport com.openai.models.conversations.Conversation;\nimport com.openai.models.conversations.ConversationUpdateParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n OpenAIClient client = OpenAIOkHttpClient.fromEnv();\n\n ConversationUpdateParams params = ConversationUpdateParams.builder()\n .conversationId(\"conv_123\")\n .metadata(ConversationUpdateParams.Metadata.builder()\n .putAdditionalProperty(\"foo\", JsonValue.from(\"string\"))\n .build())\n .build();\n Conversation conversation = client.conversations().update(params);\n }\n}","ruby":"require \"openai\"\n\nopenai = OpenAI::Client.new(api_key: \"My API Key\")\n\nconversation = openai.conversations.update(\"conv_123\", metadata: {foo: \"string\"})\n\nputs(conversation)"},"response":"{\n \"id\": \"conv_123\",\n \"object\": \"conversation\",\n \"created_at\": 1741900000,\n \"metadata\": {\"topic\": \"project-x\"}\n}\n"}}}},"/videos":{"post":{"tags":["Videos"],"summary":"Create a new video generation job from a prompt and optional reference assets.","operationId":"createVideo","parameters":[],"requestBody":{"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/CreateVideoMultipartBody"}},"application/json":{"schema":{"$ref":"#/components/schemas/CreateVideoJsonBody"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VideoResource"}}}}},"x-oaiMeta":{"name":"Create video","group":"videos","path":"create","examples":{"request":{"curl":"curl https://api.openai.com/v1/videos \\\n -H \"Authorization: Bearer $OPENAI_API_KEY\" \\\n -F \"model=sora-2\" \\\n -F \"prompt=A calico cat playing a piano on stage\"\n","javascript":"import OpenAI from 'openai';\n\nconst openai = new OpenAI();\n\nconst video = await openai.videos.create({ prompt: 'A calico cat playing a piano on stage' });\n\nconsole.log(video.id);\n","python":"import os\nfrom openai import OpenAI\n\nclient = OpenAI(\n api_key=os.environ.get(\"OPENAI_API_KEY\"), # This is the default and can be omitted\n)\nvideo = client.videos.create(\n prompt=\"x\",\n)\nprint(video.id)","go":"package main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\n\t\"github.com/openai/openai-go\"\n\t\"github.com/openai/openai-go/option\"\n)\n\nfunc main() {\n\tclient := openai.NewClient(\n\t\toption.WithAPIKey(\"My API Key\"),\n\t)\n\tvideo, err := client.Videos.New(context.TODO(), openai.VideoNewParams{\n\t\tPrompt: \"x\",\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf(\"%+v\\n\", video.ID)\n}\n","ruby":"require \"openai\"\n\nopenai = OpenAI::Client.new(api_key: \"My API Key\")\n\nvideo = openai.videos.create(prompt: \"x\")\n\nputs(video)","java":"package com.openai.example;\n\nimport com.openai.client.OpenAIClient;\nimport com.openai.client.okhttp.OpenAIOkHttpClient;\nimport com.openai.models.videos.Video;\nimport com.openai.models.videos.VideoCreateParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n OpenAIClient client = OpenAIOkHttpClient.fromEnv();\n\n VideoCreateParams params = VideoCreateParams.builder()\n .prompt(\"x\")\n .build();\n Video video = client.videos().create(params);\n }\n}","node.js":"import OpenAI from 'openai';\n\nconst client = new OpenAI({\n apiKey: process.env['OPENAI_API_KEY'], // This is the default and can be omitted\n});\n\nconst video = await client.videos.create({ prompt: 'x' });\n\nconsole.log(video.id);"},"response":"{\n \"id\": \"video_123\",\n \"object\": \"video\",\n \"model\": \"sora-2\",\n \"status\": \"queued\",\n \"progress\": 0,\n \"created_at\": 1712697600,\n \"size\": \"1024x1792\",\n \"seconds\": \"8\",\n \"quality\": \"standard\"\n}\n"}}},"get":{"tags":["Videos"],"summary":"List recently generated videos for the current project.","operationId":"ListVideos","parameters":[{"name":"limit","in":"query","description":"Number of items to retrieve","required":false,"schema":{"type":"integer","minimum":0,"maximum":100}},{"name":"order","in":"query","description":"Sort order of results by timestamp. Use `asc` for ascending order or `desc` for descending order.","required":false,"schema":{"$ref":"#/components/schemas/OrderEnum"}},{"name":"after","in":"query","description":"Identifier for the last item from the previous pagination request","required":false,"schema":{"description":"Identifier for the last item from the previous pagination request","type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VideoListResource"}}}}},"x-oaiMeta":{"name":"List videos","group":"videos","path":"list for the organization.","examples":{"request":{"curl":"curl https://api.openai.com/v1/videos \\\n -H \"Authorization: Bearer $OPENAI_API_KEY\"\n","javascript":"import OpenAI from 'openai';\n\nconst openai = new OpenAI();\n\n// Automatically fetches more pages as needed.\nfor await (const video of openai.videos.list()) {\n console.log(video.id);\n}\n","python":"import os\nfrom openai import OpenAI\n\nclient = OpenAI(\n api_key=os.environ.get(\"OPENAI_API_KEY\"), # This is the default and can be omitted\n)\npage = client.videos.list()\npage = page.data[0]\nprint(page.id)","go":"package main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\n\t\"github.com/openai/openai-go\"\n\t\"github.com/openai/openai-go/option\"\n)\n\nfunc main() {\n\tclient := openai.NewClient(\n\t\toption.WithAPIKey(\"My API Key\"),\n\t)\n\tpage, err := client.Videos.List(context.TODO(), openai.VideoListParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf(\"%+v\\n\", page)\n}\n","ruby":"require \"openai\"\n\nopenai = OpenAI::Client.new(api_key: \"My API Key\")\n\npage = openai.videos.list\n\nputs(page)","java":"package com.openai.example;\n\nimport com.openai.client.OpenAIClient;\nimport com.openai.client.okhttp.OpenAIOkHttpClient;\nimport com.openai.models.videos.VideoListPage;\nimport com.openai.models.videos.VideoListParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n OpenAIClient client = OpenAIOkHttpClient.fromEnv();\n\n VideoListPage page = client.videos().list();\n }\n}","node.js":"import OpenAI from 'openai';\n\nconst client = new OpenAI({\n apiKey: process.env['OPENAI_API_KEY'], // This is the default and can be omitted\n});\n\n// Automatically fetches more pages as needed.\nfor await (const video of client.videos.list()) {\n console.log(video.id);\n}"},"response":"{\n \"data\": [\n {\n \"id\": \"video_123\",\n \"object\": \"video\",\n \"model\": \"sora-2\",\n \"status\": \"completed\"\n }\n ],\n \"object\": \"list\"\n}\n"}}}},"/videos/characters":{"post":{"tags":["Videos"],"summary":"Create a character from an uploaded video.","operationId":"CreateVideoCharacter","parameters":[],"requestBody":{"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/CreateVideoCharacterBody"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VideoCharacterResource"}}}}},"x-oaiMeta":{"examples":{"response":"","request":{"node.js":"import fs from 'fs';\nimport OpenAI from 'openai';\n\nconst client = new OpenAI({\n apiKey: process.env['OPENAI_API_KEY'], // This is the default and can be omitted\n});\n\nconst response = await client.videos.createCharacter({\n name: 'x',\n video: fs.createReadStream('path/to/file'),\n});\n\nconsole.log(response.id);","python":"import os\nfrom openai import OpenAI\n\nclient = OpenAI(\n api_key=os.environ.get(\"OPENAI_API_KEY\"), # This is the default and can be omitted\n)\nresponse = client.videos.create_character(\n name=\"x\",\n video=b\"Example data\",\n)\nprint(response.id)","go":"package main\n\nimport (\n\t\"bytes\"\n\t\"context\"\n\t\"fmt\"\n\t\"io\"\n\n\t\"github.com/openai/openai-go\"\n\t\"github.com/openai/openai-go/option\"\n)\n\nfunc main() {\n\tclient := openai.NewClient(\n\t\toption.WithAPIKey(\"My API Key\"),\n\t)\n\tresponse, err := client.Videos.NewCharacter(context.TODO(), openai.VideoNewCharacterParams{\n\t\tName: \"x\",\n\t\tVideo: io.Reader(bytes.NewBuffer([]byte(\"Example data\"))),\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf(\"%+v\\n\", response.ID)\n}\n","java":"package com.openai.example;\n\nimport com.openai.client.OpenAIClient;\nimport com.openai.client.okhttp.OpenAIOkHttpClient;\nimport com.openai.models.videos.VideoCreateCharacterParams;\nimport com.openai.models.videos.VideoCreateCharacterResponse;\nimport java.io.ByteArrayInputStream;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n OpenAIClient client = OpenAIOkHttpClient.fromEnv();\n\n VideoCreateCharacterParams params = VideoCreateCharacterParams.builder()\n .name(\"x\")\n .video(new ByteArrayInputStream(\"Example data\".getBytes()))\n .build();\n VideoCreateCharacterResponse response = client.videos().createCharacter(params);\n }\n}","ruby":"require \"openai\"\n\nopenai = OpenAI::Client.new(api_key: \"My API Key\")\n\nresponse = openai.videos.create_character(name: \"x\", video: StringIO.new(\"Example data\"))\n\nputs(response)"}}}}},"/videos/characters/{character_id}":{"get":{"tags":["Videos"],"summary":"Fetch a character.","operationId":"GetVideoCharacter","parameters":[{"name":"character_id","in":"path","description":"The identifier of the character to retrieve.","required":true,"schema":{"example":"char_123","type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VideoCharacterResource"}}}}},"x-oaiMeta":{"examples":{"response":"","request":{"node.js":"import OpenAI from 'openai';\n\nconst client = new OpenAI({\n apiKey: process.env['OPENAI_API_KEY'], // This is the default and can be omitted\n});\n\nconst response = await client.videos.getCharacter('char_123');\n\nconsole.log(response.id);","python":"import os\nfrom openai import OpenAI\n\nclient = OpenAI(\n api_key=os.environ.get(\"OPENAI_API_KEY\"), # This is the default and can be omitted\n)\nresponse = client.videos.get_character(\n \"char_123\",\n)\nprint(response.id)","go":"package main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\n\t\"github.com/openai/openai-go\"\n\t\"github.com/openai/openai-go/option\"\n)\n\nfunc main() {\n\tclient := openai.NewClient(\n\t\toption.WithAPIKey(\"My API Key\"),\n\t)\n\tresponse, err := client.Videos.GetCharacter(context.TODO(), \"char_123\")\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf(\"%+v\\n\", response.ID)\n}\n","java":"package com.openai.example;\n\nimport com.openai.client.OpenAIClient;\nimport com.openai.client.okhttp.OpenAIOkHttpClient;\nimport com.openai.models.videos.VideoGetCharacterParams;\nimport com.openai.models.videos.VideoGetCharacterResponse;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n OpenAIClient client = OpenAIOkHttpClient.fromEnv();\n\n VideoGetCharacterResponse response = client.videos().getCharacter(\"char_123\");\n }\n}","ruby":"require \"openai\"\n\nopenai = OpenAI::Client.new(api_key: \"My API Key\")\n\nresponse = openai.videos.get_character(\"char_123\")\n\nputs(response)"}}}}},"/videos/edits":{"post":{"tags":["Videos"],"summary":"Create a new video generation job by editing a source video or existing generated video.","operationId":"CreateVideoEdit","parameters":[],"requestBody":{"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/CreateVideoEditMultipartBody"}},"application/json":{"schema":{"$ref":"#/components/schemas/CreateVideoEditJsonBody"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VideoResource"}}}}},"x-oaiMeta":{"examples":{"response":"","request":{"node.js":"import OpenAI from 'openai';\n\nconst client = new OpenAI({\n apiKey: process.env['OPENAI_API_KEY'], // This is the default and can be omitted\n});\n\nconst video = await client.videos.edit({ prompt: 'x', video: fs.createReadStream('path/to/file') });\n\nconsole.log(video.id);","python":"import os\nfrom openai import OpenAI\n\nclient = OpenAI(\n api_key=os.environ.get(\"OPENAI_API_KEY\"), # This is the default and can be omitted\n)\nvideo = client.videos.edit(\n prompt=\"x\",\n video=b\"Example data\",\n)\nprint(video.id)","go":"package main\n\nimport (\n\t\"bytes\"\n\t\"context\"\n\t\"fmt\"\n\t\"io\"\n\n\t\"github.com/openai/openai-go\"\n\t\"github.com/openai/openai-go/option\"\n)\n\nfunc main() {\n\tclient := openai.NewClient(\n\t\toption.WithAPIKey(\"My API Key\"),\n\t)\n\tvideo, err := client.Videos.Edit(context.TODO(), openai.VideoEditParams{\n\t\tPrompt: \"x\",\n\t\tVideo: openai.VideoEditParamsVideoUnion{\n\t\t\tOfFile: io.Reader(bytes.NewBuffer([]byte(\"Example data\"))),\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf(\"%+v\\n\", video.ID)\n}\n","java":"package com.openai.example;\n\nimport com.openai.client.OpenAIClient;\nimport com.openai.client.okhttp.OpenAIOkHttpClient;\nimport com.openai.models.videos.Video;\nimport com.openai.models.videos.VideoEditParams;\nimport java.io.ByteArrayInputStream;\nimport java.io.InputStream;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n OpenAIClient client = OpenAIOkHttpClient.fromEnv();\n\n VideoEditParams params = VideoEditParams.builder()\n .prompt(\"x\")\n .video(new ByteArrayInputStream(\"Example data\".getBytes()))\n .build();\n Video video = client.videos().edit(params);\n }\n}","ruby":"require \"openai\"\n\nopenai = OpenAI::Client.new(api_key: \"My API Key\")\n\nvideo = openai.videos.edit(prompt: \"x\", video: StringIO.new(\"Example data\"))\n\nputs(video)"}}}}},"/videos/extensions":{"post":{"tags":["Videos"],"summary":"Create an extension of a completed video.","operationId":"CreateVideoExtend","parameters":[],"requestBody":{"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/CreateVideoExtendMultipartBody"}},"application/json":{"schema":{"$ref":"#/components/schemas/CreateVideoExtendJsonBody"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VideoResource"}}}}},"x-oaiMeta":{"examples":{"response":"","request":{"node.js":"import OpenAI from 'openai';\n\nconst client = new OpenAI({\n apiKey: process.env['OPENAI_API_KEY'], // This is the default and can be omitted\n});\n\nconst video = await client.videos.extend({\n prompt: 'x',\n seconds: '4',\n video: fs.createReadStream('path/to/file'),\n});\n\nconsole.log(video.id);","python":"import os\nfrom openai import OpenAI\n\nclient = OpenAI(\n api_key=os.environ.get(\"OPENAI_API_KEY\"), # This is the default and can be omitted\n)\nvideo = client.videos.extend(\n prompt=\"x\",\n seconds=\"4\",\n video=b\"Example data\",\n)\nprint(video.id)","go":"package main\n\nimport (\n\t\"bytes\"\n\t\"context\"\n\t\"fmt\"\n\t\"io\"\n\n\t\"github.com/openai/openai-go\"\n\t\"github.com/openai/openai-go/option\"\n)\n\nfunc main() {\n\tclient := openai.NewClient(\n\t\toption.WithAPIKey(\"My API Key\"),\n\t)\n\tvideo, err := client.Videos.Extend(context.TODO(), openai.VideoExtendParams{\n\t\tPrompt: \"x\",\n\t\tSeconds: openai.VideoSeconds4,\n\t\tVideo: openai.VideoExtendParamsVideoUnion{\n\t\t\tOfFile: io.Reader(bytes.NewBuffer([]byte(\"Example data\"))),\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf(\"%+v\\n\", video.ID)\n}\n","java":"package com.openai.example;\n\nimport com.openai.client.OpenAIClient;\nimport com.openai.client.okhttp.OpenAIOkHttpClient;\nimport com.openai.models.videos.Video;\nimport com.openai.models.videos.VideoExtendParams;\nimport com.openai.models.videos.VideoSeconds;\nimport java.io.ByteArrayInputStream;\nimport java.io.InputStream;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n OpenAIClient client = OpenAIOkHttpClient.fromEnv();\n\n VideoExtendParams params = VideoExtendParams.builder()\n .prompt(\"x\")\n .seconds(VideoSeconds._4)\n .video(new ByteArrayInputStream(\"Example data\".getBytes()))\n .build();\n Video video = client.videos().extend(params);\n }\n}","ruby":"require \"openai\"\n\nopenai = OpenAI::Client.new(api_key: \"My API Key\")\n\nvideo = openai.videos.extend_(prompt: \"x\", seconds: :\"4\", video: StringIO.new(\"Example data\"))\n\nputs(video)"}}}}},"/videos/{video_id}":{"get":{"tags":["Videos"],"summary":"Fetch the latest metadata for a generated video.","operationId":"GetVideo","parameters":[{"name":"video_id","in":"path","description":"The identifier of the video to retrieve.","required":true,"schema":{"example":"video_123","type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VideoResource"}}}}},"x-oaiMeta":{"name":"Retrieve video","group":"videos","path":"retrieve matching the provided identifier.","examples":{"response":"","request":{"javascript":"import OpenAI from 'openai';\n\nconst client = new OpenAI();\n\nconst video = await client.videos.retrieve('video_123');\n\nconsole.log(video.id);\n","python":"import os\nfrom openai import OpenAI\n\nclient = OpenAI(\n api_key=os.environ.get(\"OPENAI_API_KEY\"), # This is the default and can be omitted\n)\nvideo = client.videos.retrieve(\n \"video_123\",\n)\nprint(video.id)","go":"package main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\n\t\"github.com/openai/openai-go\"\n\t\"github.com/openai/openai-go/option\"\n)\n\nfunc main() {\n\tclient := openai.NewClient(\n\t\toption.WithAPIKey(\"My API Key\"),\n\t)\n\tvideo, err := client.Videos.Get(context.TODO(), \"video_123\")\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf(\"%+v\\n\", video.ID)\n}\n","ruby":"require \"openai\"\n\nopenai = OpenAI::Client.new(api_key: \"My API Key\")\n\nvideo = openai.videos.retrieve(\"video_123\")\n\nputs(video)","java":"package com.openai.example;\n\nimport com.openai.client.OpenAIClient;\nimport com.openai.client.okhttp.OpenAIOkHttpClient;\nimport com.openai.models.videos.Video;\nimport com.openai.models.videos.VideoRetrieveParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n OpenAIClient client = OpenAIOkHttpClient.fromEnv();\n\n Video video = client.videos().retrieve(\"video_123\");\n }\n}","node.js":"import OpenAI from 'openai';\n\nconst client = new OpenAI({\n apiKey: process.env['OPENAI_API_KEY'], // This is the default and can be omitted\n});\n\nconst video = await client.videos.retrieve('video_123');\n\nconsole.log(video.id);"}}}},"delete":{"tags":["Videos"],"summary":"Permanently delete a completed or failed video and its stored assets.","operationId":"DeleteVideo","parameters":[{"name":"video_id","in":"path","description":"The identifier of the video to delete.","required":true,"schema":{"example":"video_123","type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeletedVideoResource"}}}}},"x-oaiMeta":{"name":"Delete video","group":"videos","path":"delete","examples":{"response":"","request":{"javascript":"import OpenAI from 'openai';\n\nconst client = new OpenAI();\n\nconst video = await client.videos.delete('video_123');\n\nconsole.log(video.id);\n","python":"import os\nfrom openai import OpenAI\n\nclient = OpenAI(\n api_key=os.environ.get(\"OPENAI_API_KEY\"), # This is the default and can be omitted\n)\nvideo = client.videos.delete(\n \"video_123\",\n)\nprint(video.id)","go":"package main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\n\t\"github.com/openai/openai-go\"\n\t\"github.com/openai/openai-go/option\"\n)\n\nfunc main() {\n\tclient := openai.NewClient(\n\t\toption.WithAPIKey(\"My API Key\"),\n\t)\n\tvideo, err := client.Videos.Delete(context.TODO(), \"video_123\")\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf(\"%+v\\n\", video.ID)\n}\n","ruby":"require \"openai\"\n\nopenai = OpenAI::Client.new(api_key: \"My API Key\")\n\nvideo = openai.videos.delete(\"video_123\")\n\nputs(video)","java":"package com.openai.example;\n\nimport com.openai.client.OpenAIClient;\nimport com.openai.client.okhttp.OpenAIOkHttpClient;\nimport com.openai.models.videos.VideoDeleteParams;\nimport com.openai.models.videos.VideoDeleteResponse;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n OpenAIClient client = OpenAIOkHttpClient.fromEnv();\n\n VideoDeleteResponse video = client.videos().delete(\"video_123\");\n }\n}","node.js":"import OpenAI from 'openai';\n\nconst client = new OpenAI({\n apiKey: process.env['OPENAI_API_KEY'], // This is the default and can be omitted\n});\n\nconst video = await client.videos.delete('video_123');\n\nconsole.log(video.id);"}}}}},"/videos/{video_id}/content":{"get":{"tags":["Videos"],"summary":"Download the generated video bytes or a derived preview asset.\n\nStreams the rendered video content for the specified video job.","operationId":"RetrieveVideoContent","parameters":[{"name":"video_id","in":"path","description":"The identifier of the video whose media to download.","required":true,"schema":{"example":"video_123","type":"string"}},{"name":"variant","in":"query","description":"Which downloadable asset to return. Defaults to the MP4 video.","required":false,"schema":{"$ref":"#/components/schemas/VideoContentVariant"}}],"responses":{"200":{"description":"The video bytes or preview asset that matches the requested variant.","content":{"video/mp4":{"schema":{"type":"string","format":"binary"}},"image/webp":{"schema":{"type":"string","format":"binary"}},"application/json":{"schema":{"type":"string"}}}}},"x-oaiMeta":{"name":"Retrieve video content","group":"videos","path":"content","examples":{"response":"","request":{"javascript":"import OpenAI from 'openai';\n\nconst client = new OpenAI();\n\nconst response = await client.videos.downloadContent('video_123');\n\nconsole.log(response);\n\nconst content = await response.blob();\nconsole.log(content);\n","python":"import os\nfrom openai import OpenAI\n\nclient = OpenAI(\n api_key=os.environ.get(\"OPENAI_API_KEY\"), # This is the default and can be omitted\n)\nresponse = client.videos.download_content(\n video_id=\"video_123\",\n)\nprint(response)\ncontent = response.read()\nprint(content)","go":"package main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\n\t\"github.com/openai/openai-go\"\n\t\"github.com/openai/openai-go/option\"\n)\n\nfunc main() {\n\tclient := openai.NewClient(\n\t\toption.WithAPIKey(\"My API Key\"),\n\t)\n\tresponse, err := client.Videos.DownloadContent(\n\t\tcontext.TODO(),\n\t\t\"video_123\",\n\t\topenai.VideoDownloadContentParams{},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf(\"%+v\\n\", response)\n}\n","ruby":"require \"openai\"\n\nopenai = OpenAI::Client.new(api_key: \"My API Key\")\n\nresponse = openai.videos.download_content(\"video_123\")\n\nputs(response)","java":"package com.openai.example;\n\nimport com.openai.client.OpenAIClient;\nimport com.openai.client.okhttp.OpenAIOkHttpClient;\nimport com.openai.core.http.HttpResponse;\nimport com.openai.models.videos.VideoDownloadContentParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n OpenAIClient client = OpenAIOkHttpClient.fromEnv();\n\n HttpResponse response = client.videos().downloadContent(\"video_123\");\n }\n}","node.js":"import OpenAI from 'openai';\n\nconst client = new OpenAI({\n apiKey: process.env['OPENAI_API_KEY'], // This is the default and can be omitted\n});\n\nconst response = await client.videos.downloadContent('video_123');\n\nconsole.log(response);\n\nconst content = await response.blob();\nconsole.log(content);"}}}}},"/videos/{video_id}/remix":{"post":{"tags":["Videos"],"summary":"Create a remix of a completed video using a refreshed prompt.","operationId":"CreateVideoRemix","parameters":[{"name":"video_id","in":"path","description":"The identifier of the completed video to remix.","required":true,"schema":{"example":"video_123","type":"string"}}],"requestBody":{"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/CreateVideoRemixBody"}},"application/json":{"schema":{"$ref":"#/components/schemas/CreateVideoRemixBody"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VideoResource"}}}}},"x-oaiMeta":{"name":"Remix video","group":"videos","path":"remix using the provided prompt.","examples":{"request":{"curl":"curl -X POST https://api.openai.com/v1/videos/video_123/remix \\\n -H \"Authorization: Bearer $OPENAI_API_KEY\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"prompt\": \"Extend the scene with the cat taking a bow to the cheering audience\"\n }'\n","javascript":"import OpenAI from 'openai';\n\nconst client = new OpenAI();\n\nconst video = await client.videos.remix('video_123', { prompt: 'Extend the scene with the cat taking a bow to the cheering audience' });\n\nconsole.log(video.id);\n","python":"import os\nfrom openai import OpenAI\n\nclient = OpenAI(\n api_key=os.environ.get(\"OPENAI_API_KEY\"), # This is the default and can be omitted\n)\nvideo = client.videos.remix(\n video_id=\"video_123\",\n prompt=\"x\",\n)\nprint(video.id)","go":"package main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\n\t\"github.com/openai/openai-go\"\n\t\"github.com/openai/openai-go/option\"\n)\n\nfunc main() {\n\tclient := openai.NewClient(\n\t\toption.WithAPIKey(\"My API Key\"),\n\t)\n\tvideo, err := client.Videos.Remix(\n\t\tcontext.TODO(),\n\t\t\"video_123\",\n\t\topenai.VideoRemixParams{\n\t\t\tPrompt: \"x\",\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf(\"%+v\\n\", video.ID)\n}\n","ruby":"require \"openai\"\n\nopenai = OpenAI::Client.new(api_key: \"My API Key\")\n\nvideo = openai.videos.remix(\"video_123\", prompt: \"x\")\n\nputs(video)","java":"package com.openai.example;\n\nimport com.openai.client.OpenAIClient;\nimport com.openai.client.okhttp.OpenAIOkHttpClient;\nimport com.openai.models.videos.Video;\nimport com.openai.models.videos.VideoRemixParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n OpenAIClient client = OpenAIOkHttpClient.fromEnv();\n\n VideoRemixParams params = VideoRemixParams.builder()\n .videoId(\"video_123\")\n .prompt(\"x\")\n .build();\n Video video = client.videos().remix(params);\n }\n}","node.js":"import OpenAI from 'openai';\n\nconst client = new OpenAI({\n apiKey: process.env['OPENAI_API_KEY'], // This is the default and can be omitted\n});\n\nconst video = await client.videos.remix('video_123', { prompt: 'x' });\n\nconsole.log(video.id);"},"response":"{\n \"id\": \"video_456\",\n \"object\": \"video\",\n \"model\": \"sora-2\",\n \"status\": \"queued\",\n \"progress\": 0,\n \"created_at\": 1712698600,\n \"size\": \"720x1280\",\n \"seconds\": \"8\",\n \"remixed_from_video_id\": \"video_123\"\n}\n"}}}},"/responses/input_tokens":{"post":{"summary":"Returns input token counts of the request.\n\nReturns an object with `object` set to `response.input_tokens` and an `input_tokens` count.","operationId":"Getinputtokencounts","parameters":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TokenCountsBody"}},"application/x-www-form-urlencoded":{"schema":{"$ref":"#/components/schemas/TokenCountsBody"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TokenCountsResource"}}}}},"x-oaiMeta":{"name":"Get input token counts","group":"responses","examples":{"request":{"curl":"curl -X POST https://api.openai.com/v1/responses/input_tokens \\\n -H \"Content-Type: application/json\" \\\n -H \"Authorization: Bearer $OPENAI_API_KEY\" \\\n -d '{\n \"model\": \"gpt-5\",\n \"input\": \"Tell me a joke.\"\n }'\n","javascript":"import OpenAI from \"openai\";\n\nconst client = new OpenAI();\n\nconst response = await client.responses.inputTokens.count({\n model: \"gpt-5\",\n input: \"Tell me a joke.\",\n});\n\nconsole.log(response.input_tokens);\n","python":"import os\nfrom openai import OpenAI\n\nclient = OpenAI(\n api_key=os.environ.get(\"OPENAI_API_KEY\"), # This is the default and can be omitted\n)\nresponse = client.responses.input_tokens.count()\nprint(response.input_tokens)","go":"package main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\n\t\"github.com/openai/openai-go\"\n\t\"github.com/openai/openai-go/option\"\n\t\"github.com/openai/openai-go/responses\"\n)\n\nfunc main() {\n\tclient := openai.NewClient(\n\t\toption.WithAPIKey(\"My API Key\"),\n\t)\n\tresponse, err := client.Responses.InputTokens.Count(context.TODO(), responses.InputTokenCountParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf(\"%+v\\n\", response.InputTokens)\n}\n","ruby":"require \"openai\"\n\nopenai = OpenAI::Client.new(api_key: \"My API Key\")\n\nresponse = openai.responses.input_tokens.count\n\nputs(response)","java":"package com.openai.example;\n\nimport com.openai.client.OpenAIClient;\nimport com.openai.client.okhttp.OpenAIOkHttpClient;\nimport com.openai.models.responses.inputtokens.InputTokenCountParams;\nimport com.openai.models.responses.inputtokens.InputTokenCountResponse;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n OpenAIClient client = OpenAIOkHttpClient.fromEnv();\n\n InputTokenCountResponse response = client.responses().inputTokens().count();\n }\n}","node.js":"import OpenAI from 'openai';\n\nconst client = new OpenAI({\n apiKey: process.env['OPENAI_API_KEY'], // This is the default and can be omitted\n});\n\nconst response = await client.responses.inputTokens.count();\n\nconsole.log(response.input_tokens);"},"response":"{\n \"object\": \"response.input_tokens\",\n \"input_tokens\": 11\n}\n"}}}},"/responses/compact":{"post":{"summary":"Compact a conversation. Returns a compacted response object.\n\nLearn when and how to compact long-running conversations in the [conversation state guide](/docs/guides/conversation-state#managing-the-context-window). For ZDR-compatible compaction details, see [Compaction (advanced)](/docs/guides/conversation-state#compaction-advanced).","operationId":"Compactconversation","parameters":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CompactResponseMethodPublicBody"}},"application/x-www-form-urlencoded":{"schema":{"$ref":"#/components/schemas/CompactResponseMethodPublicBody"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CompactResource"}}}}},"x-oaiMeta":{"name":"Compact a response","group":"responses","examples":{"request":{"curl":"curl -X POST https://api.openai.com/v1/responses/compact \\\n -H \"Content-Type: application/json\" \\\n -H \"Authorization: Bearer $OPENAI_API_KEY\" \\\n -d '{\n \"model\": \"gpt-5.1-codex-max\",\n \"input\": [\n {\n \"role\": \"user\",\n \"content\": \"Create a simple landing page for a dog petting café.\"\n },\n {\n \"id\": \"msg_001\",\n \"type\": \"message\",\n \"status\": \"completed\",\n \"content\": [\n {\n \"type\": \"output_text\",\n \"annotations\": [],\n \"logprobs\": [],\n \"text\": \"Below is a single file, ready-to-use landing page for a dog petting café:...\"\n }\n ],\n \"role\": \"assistant\"\n }\n ]\n }'\n","javascript":"import OpenAI from \"openai\";\n\nconst openai = new OpenAI();\n\n// Compact the previous response if you are running out of tokens\nconst compactedResponse = await openai.responses.compact({\n model: \"gpt-5.1-codex-max\",\n input: [\n {\n role: \"user\",\n content: \"Create a simple landing page for a dog petting café.\",\n },\n // All items returned from previous requests are included here, like reasoning, message, function call, etc.\n {\n id: \"msg_030d085c0b53e67e0069332e3a72d4819c96c6f2c4adc15d33\",\n type: \"message\",\n status: \"completed\",\n content: [\n {\n type: \"output_text\",\n annotations: [],\n logprobs: [],\n text: \"Below is a single file, ready-to-use landing page for a dog petting café:...\",\n },\n ],\n role: \"assistant\",\n },\n ],\n});\n\n// Pass the compactedResponse.output as input to the next request\nconsole.log(compactedResponse);\n","python":"import os\nfrom openai import OpenAI\n\nclient = OpenAI(\n api_key=os.environ.get(\"OPENAI_API_KEY\"), # This is the default and can be omitted\n)\ncompacted_response = client.responses.compact(\n model=\"gpt-5.4\",\n)\nprint(compacted_response.id)","node.js":"import OpenAI from 'openai';\n\nconst client = new OpenAI({\n apiKey: process.env['OPENAI_API_KEY'], // This is the default and can be omitted\n});\n\nconst compactedResponse = await client.responses.compact({ model: 'gpt-5.4' });\n\nconsole.log(compactedResponse.id);","go":"package main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\n\t\"github.com/openai/openai-go\"\n\t\"github.com/openai/openai-go/option\"\n\t\"github.com/openai/openai-go/responses\"\n)\n\nfunc main() {\n\tclient := openai.NewClient(\n\t\toption.WithAPIKey(\"My API Key\"),\n\t)\n\tcompactedResponse, err := client.Responses.Compact(context.TODO(), responses.ResponseCompactParams{\n\t\tModel: responses.ResponseCompactParamsModelGPT5_4,\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf(\"%+v\\n\", compactedResponse.ID)\n}\n","java":"package com.openai.example;\n\nimport com.openai.client.OpenAIClient;\nimport com.openai.client.okhttp.OpenAIOkHttpClient;\nimport com.openai.models.responses.CompactedResponse;\nimport com.openai.models.responses.ResponseCompactParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n OpenAIClient client = OpenAIOkHttpClient.fromEnv();\n\n ResponseCompactParams params = ResponseCompactParams.builder()\n .model(ResponseCompactParams.Model.GPT_5_4)\n .build();\n CompactedResponse compactedResponse = client.responses().compact(params);\n }\n}","ruby":"require \"openai\"\n\nopenai = OpenAI::Client.new(api_key: \"My API Key\")\n\ncompacted_response = openai.responses.compact(model: :\"gpt-5.4\")\n\nputs(compacted_response)"},"response":"{\n \"id\": \"resp_001\",\n \"object\": \"response.compaction\",\n \"created_at\": 1764967971,\n \"output\": [\n {\n \"id\": \"msg_000\",\n \"type\": \"message\",\n \"status\": \"completed\",\n \"content\": [\n {\n \"type\": \"input_text\",\n \"text\": \"Create a simple landing page for a dog petting cafe.\"\n }\n ],\n \"role\": \"user\"\n },\n {\n \"id\": \"cmp_001\",\n \"type\": \"compaction\",\n \"encrypted_content\": \"gAAAAABpM0Yj-...=\"\n }\n ],\n \"usage\": {\n \"input_tokens\": 139,\n \"input_tokens_details\": {\n \"cached_tokens\": 0\n },\n \"output_tokens\": 438,\n \"output_tokens_details\": {\n \"reasoning_tokens\": 64\n },\n \"total_tokens\": 577\n }\n}\n"}}}},"/skills":{"post":{"tags":["Skills"],"summary":"Create a new skill.","operationId":"CreateSkill","parameters":[],"requestBody":{"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/CreateSkillBody"}},"application/json":{"schema":{"$ref":"#/components/schemas/CreateSkillBody"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SkillResource"}}}}},"x-oaiMeta":{"examples":{"response":"","request":{"node.js":"import OpenAI from 'openai';\n\nconst client = new OpenAI({\n apiKey: process.env['OPENAI_API_KEY'], // This is the default and can be omitted\n});\n\nconst skill = await client.skills.create();\n\nconsole.log(skill.id);","python":"import os\nfrom openai import OpenAI\n\nclient = OpenAI(\n api_key=os.environ.get(\"OPENAI_API_KEY\"), # This is the default and can be omitted\n)\nskill = client.skills.create()\nprint(skill.id)","go":"package main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\n\t\"github.com/openai/openai-go\"\n\t\"github.com/openai/openai-go/option\"\n)\n\nfunc main() {\n\tclient := openai.NewClient(\n\t\toption.WithAPIKey(\"My API Key\"),\n\t)\n\tskill, err := client.Skills.New(context.TODO(), openai.SkillNewParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf(\"%+v\\n\", skill.ID)\n}\n","java":"package com.openai.example;\n\nimport com.openai.client.OpenAIClient;\nimport com.openai.client.okhttp.OpenAIOkHttpClient;\nimport com.openai.models.skills.Skill;\nimport com.openai.models.skills.SkillCreateParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n OpenAIClient client = OpenAIOkHttpClient.fromEnv();\n\n Skill skill = client.skills().create();\n }\n}","ruby":"require \"openai\"\n\nopenai = OpenAI::Client.new(api_key: \"My API Key\")\n\nskill = openai.skills.create\n\nputs(skill)"}}}},"get":{"tags":["Skills"],"summary":"List all skills for the current project.","operationId":"ListSkills","parameters":[{"name":"limit","in":"query","description":"Number of items to retrieve","required":false,"schema":{"type":"integer","minimum":0,"maximum":100}},{"name":"order","in":"query","description":"Sort order of results by timestamp. Use `asc` for ascending order or `desc` for descending order.","required":false,"schema":{"$ref":"#/components/schemas/OrderEnum"}},{"name":"after","in":"query","description":"Identifier for the last item from the previous pagination request","required":false,"schema":{"description":"Identifier for the last item from the previous pagination request","type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SkillListResource"}}}}},"x-oaiMeta":{"examples":{"response":"","request":{"node.js":"import OpenAI from 'openai';\n\nconst client = new OpenAI({\n apiKey: process.env['OPENAI_API_KEY'], // This is the default and can be omitted\n});\n\n// Automatically fetches more pages as needed.\nfor await (const skill of client.skills.list()) {\n console.log(skill.id);\n}","python":"import os\nfrom openai import OpenAI\n\nclient = OpenAI(\n api_key=os.environ.get(\"OPENAI_API_KEY\"), # This is the default and can be omitted\n)\npage = client.skills.list()\npage = page.data[0]\nprint(page.id)","go":"package main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\n\t\"github.com/openai/openai-go\"\n\t\"github.com/openai/openai-go/option\"\n)\n\nfunc main() {\n\tclient := openai.NewClient(\n\t\toption.WithAPIKey(\"My API Key\"),\n\t)\n\tpage, err := client.Skills.List(context.TODO(), openai.SkillListParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf(\"%+v\\n\", page)\n}\n","java":"package com.openai.example;\n\nimport com.openai.client.OpenAIClient;\nimport com.openai.client.okhttp.OpenAIOkHttpClient;\nimport com.openai.models.skills.SkillListPage;\nimport com.openai.models.skills.SkillListParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n OpenAIClient client = OpenAIOkHttpClient.fromEnv();\n\n SkillListPage page = client.skills().list();\n }\n}","ruby":"require \"openai\"\n\nopenai = OpenAI::Client.new(api_key: \"My API Key\")\n\npage = openai.skills.list\n\nputs(page)"}}}}},"/skills/{skill_id}":{"delete":{"tags":["Skills"],"summary":"Delete a skill by its ID.","operationId":"DeleteSkill","parameters":[{"name":"skill_id","in":"path","description":"The identifier of the skill to delete.","required":true,"schema":{"example":"skill_123","type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeletedSkillResource"}}}}},"x-oaiMeta":{"examples":{"response":"","request":{"node.js":"import OpenAI from 'openai';\n\nconst client = new OpenAI({\n apiKey: process.env['OPENAI_API_KEY'], // This is the default and can be omitted\n});\n\nconst deletedSkill = await client.skills.delete('skill_123');\n\nconsole.log(deletedSkill.id);","python":"import os\nfrom openai import OpenAI\n\nclient = OpenAI(\n api_key=os.environ.get(\"OPENAI_API_KEY\"), # This is the default and can be omitted\n)\ndeleted_skill = client.skills.delete(\n \"skill_123\",\n)\nprint(deleted_skill.id)","go":"package main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\n\t\"github.com/openai/openai-go\"\n\t\"github.com/openai/openai-go/option\"\n)\n\nfunc main() {\n\tclient := openai.NewClient(\n\t\toption.WithAPIKey(\"My API Key\"),\n\t)\n\tdeletedSkill, err := client.Skills.Delete(context.TODO(), \"skill_123\")\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf(\"%+v\\n\", deletedSkill.ID)\n}\n","java":"package com.openai.example;\n\nimport com.openai.client.OpenAIClient;\nimport com.openai.client.okhttp.OpenAIOkHttpClient;\nimport com.openai.models.skills.DeletedSkill;\nimport com.openai.models.skills.SkillDeleteParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n OpenAIClient client = OpenAIOkHttpClient.fromEnv();\n\n DeletedSkill deletedSkill = client.skills().delete(\"skill_123\");\n }\n}","ruby":"require \"openai\"\n\nopenai = OpenAI::Client.new(api_key: \"My API Key\")\n\ndeleted_skill = openai.skills.delete(\"skill_123\")\n\nputs(deleted_skill)"}}}},"get":{"tags":["Skills"],"summary":"Get a skill by its ID.","operationId":"GetSkill","parameters":[{"name":"skill_id","in":"path","description":"The identifier of the skill to retrieve.","required":true,"schema":{"example":"skill_123","type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SkillResource"}}}}},"x-oaiMeta":{"examples":{"response":"","request":{"node.js":"import OpenAI from 'openai';\n\nconst client = new OpenAI({\n apiKey: process.env['OPENAI_API_KEY'], // This is the default and can be omitted\n});\n\nconst skill = await client.skills.retrieve('skill_123');\n\nconsole.log(skill.id);","python":"import os\nfrom openai import OpenAI\n\nclient = OpenAI(\n api_key=os.environ.get(\"OPENAI_API_KEY\"), # This is the default and can be omitted\n)\nskill = client.skills.retrieve(\n \"skill_123\",\n)\nprint(skill.id)","go":"package main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\n\t\"github.com/openai/openai-go\"\n\t\"github.com/openai/openai-go/option\"\n)\n\nfunc main() {\n\tclient := openai.NewClient(\n\t\toption.WithAPIKey(\"My API Key\"),\n\t)\n\tskill, err := client.Skills.Get(context.TODO(), \"skill_123\")\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf(\"%+v\\n\", skill.ID)\n}\n","java":"package com.openai.example;\n\nimport com.openai.client.OpenAIClient;\nimport com.openai.client.okhttp.OpenAIOkHttpClient;\nimport com.openai.models.skills.Skill;\nimport com.openai.models.skills.SkillRetrieveParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n OpenAIClient client = OpenAIOkHttpClient.fromEnv();\n\n Skill skill = client.skills().retrieve(\"skill_123\");\n }\n}","ruby":"require \"openai\"\n\nopenai = OpenAI::Client.new(api_key: \"My API Key\")\n\nskill = openai.skills.retrieve(\"skill_123\")\n\nputs(skill)"}}}},"post":{"tags":["Skills"],"summary":"Update the default version pointer for a skill.","operationId":"UpdateSkillDefaultVersion","parameters":[{"name":"skill_id","in":"path","description":"The identifier of the skill.","required":true,"schema":{"example":"skill_123","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SetDefaultSkillVersionBody"}},"application/x-www-form-urlencoded":{"schema":{"$ref":"#/components/schemas/SetDefaultSkillVersionBody"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SkillResource"}}}}},"x-oaiMeta":{"examples":{"response":"","request":{"node.js":"import OpenAI from 'openai';\n\nconst client = new OpenAI({\n apiKey: process.env['OPENAI_API_KEY'], // This is the default and can be omitted\n});\n\nconst skill = await client.skills.update('skill_123', { default_version: 'default_version' });\n\nconsole.log(skill.id);","python":"import os\nfrom openai import OpenAI\n\nclient = OpenAI(\n api_key=os.environ.get(\"OPENAI_API_KEY\"), # This is the default and can be omitted\n)\nskill = client.skills.update(\n skill_id=\"skill_123\",\n default_version=\"default_version\",\n)\nprint(skill.id)","go":"package main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\n\t\"github.com/openai/openai-go\"\n\t\"github.com/openai/openai-go/option\"\n)\n\nfunc main() {\n\tclient := openai.NewClient(\n\t\toption.WithAPIKey(\"My API Key\"),\n\t)\n\tskill, err := client.Skills.Update(\n\t\tcontext.TODO(),\n\t\t\"skill_123\",\n\t\topenai.SkillUpdateParams{\n\t\t\tDefaultVersion: \"default_version\",\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf(\"%+v\\n\", skill.ID)\n}\n","java":"package com.openai.example;\n\nimport com.openai.client.OpenAIClient;\nimport com.openai.client.okhttp.OpenAIOkHttpClient;\nimport com.openai.models.skills.Skill;\nimport com.openai.models.skills.SkillUpdateParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n OpenAIClient client = OpenAIOkHttpClient.fromEnv();\n\n SkillUpdateParams params = SkillUpdateParams.builder()\n .skillId(\"skill_123\")\n .defaultVersion(\"default_version\")\n .build();\n Skill skill = client.skills().update(params);\n }\n}","ruby":"require \"openai\"\n\nopenai = OpenAI::Client.new(api_key: \"My API Key\")\n\nskill = openai.skills.update(\"skill_123\", default_version: \"default_version\")\n\nputs(skill)"}}}}},"/skills/{skill_id}/content":{"get":{"tags":["Skills"],"summary":"Download a skill zip bundle by its ID.","operationId":"GetSkillContent","parameters":[{"name":"skill_id","in":"path","description":"The identifier of the skill to download.","required":true,"schema":{"example":"skill_123","type":"string"}}],"responses":{"200":{"description":"The skill zip bundle.","content":{"application/zip":{"schema":{"type":"string","format":"binary"}},"application/json":{"schema":{"type":"string"}}}}},"x-oaiMeta":{"examples":{"response":"","request":{"node.js":"import OpenAI from 'openai';\n\nconst client = new OpenAI({\n apiKey: process.env['OPENAI_API_KEY'], // This is the default and can be omitted\n});\n\nconst content = await client.skills.content.retrieve('skill_123');\n\nconsole.log(content);\n\nconst data = await content.blob();\nconsole.log(data);","python":"import os\nfrom openai import OpenAI\n\nclient = OpenAI(\n api_key=os.environ.get(\"OPENAI_API_KEY\"), # This is the default and can be omitted\n)\ncontent = client.skills.content.retrieve(\n \"skill_123\",\n)\nprint(content)\ndata = content.read()\nprint(data)","go":"package main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\n\t\"github.com/openai/openai-go\"\n\t\"github.com/openai/openai-go/option\"\n)\n\nfunc main() {\n\tclient := openai.NewClient(\n\t\toption.WithAPIKey(\"My API Key\"),\n\t)\n\tcontent, err := client.Skills.Content.Get(context.TODO(), \"skill_123\")\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf(\"%+v\\n\", content)\n}\n","java":"package com.openai.example;\n\nimport com.openai.client.OpenAIClient;\nimport com.openai.client.okhttp.OpenAIOkHttpClient;\nimport com.openai.core.http.HttpResponse;\nimport com.openai.models.skills.content.ContentRetrieveParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n OpenAIClient client = OpenAIOkHttpClient.fromEnv();\n\n HttpResponse content = client.skills().content().retrieve(\"skill_123\");\n }\n}","ruby":"require \"openai\"\n\nopenai = OpenAI::Client.new(api_key: \"My API Key\")\n\ncontent = openai.skills.content.retrieve(\"skill_123\")\n\nputs(content)"}}}}},"/skills/{skill_id}/versions":{"post":{"tags":["Skills"],"summary":"Create a new immutable skill version.","operationId":"CreateSkillVersion","parameters":[{"name":"skill_id","in":"path","description":"The identifier of the skill to version.","required":true,"schema":{"example":"skill_123","type":"string"}}],"requestBody":{"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/CreateSkillVersionBody"}},"application/json":{"schema":{"$ref":"#/components/schemas/CreateSkillVersionBody"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SkillVersionResource"}}}}},"x-oaiMeta":{"examples":{"response":"","request":{"node.js":"import OpenAI from 'openai';\n\nconst client = new OpenAI({\n apiKey: process.env['OPENAI_API_KEY'], // This is the default and can be omitted\n});\n\nconst skillVersion = await client.skills.versions.create('skill_123');\n\nconsole.log(skillVersion.id);","python":"import os\nfrom openai import OpenAI\n\nclient = OpenAI(\n api_key=os.environ.get(\"OPENAI_API_KEY\"), # This is the default and can be omitted\n)\nskill_version = client.skills.versions.create(\n skill_id=\"skill_123\",\n)\nprint(skill_version.id)","go":"package main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\n\t\"github.com/openai/openai-go\"\n\t\"github.com/openai/openai-go/option\"\n)\n\nfunc main() {\n\tclient := openai.NewClient(\n\t\toption.WithAPIKey(\"My API Key\"),\n\t)\n\tskillVersion, err := client.Skills.Versions.New(\n\t\tcontext.TODO(),\n\t\t\"skill_123\",\n\t\topenai.SkillVersionNewParams{},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf(\"%+v\\n\", skillVersion.ID)\n}\n","java":"package com.openai.example;\n\nimport com.openai.client.OpenAIClient;\nimport com.openai.client.okhttp.OpenAIOkHttpClient;\nimport com.openai.models.skills.versions.SkillVersion;\nimport com.openai.models.skills.versions.VersionCreateParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n OpenAIClient client = OpenAIOkHttpClient.fromEnv();\n\n SkillVersion skillVersion = client.skills().versions().create(\"skill_123\");\n }\n}","ruby":"require \"openai\"\n\nopenai = OpenAI::Client.new(api_key: \"My API Key\")\n\nskill_version = openai.skills.versions.create(\"skill_123\")\n\nputs(skill_version)"}}}},"get":{"tags":["Skills"],"summary":"List skill versions for a skill.","operationId":"ListSkillVersions","parameters":[{"name":"skill_id","in":"path","description":"The identifier of the skill.","required":true,"schema":{"example":"skill_123","type":"string"}},{"name":"limit","in":"query","description":"Number of versions to retrieve.","required":false,"schema":{"type":"integer","minimum":0,"maximum":100}},{"name":"order","in":"query","description":"Sort order of results by version number.","required":false,"schema":{"$ref":"#/components/schemas/OrderEnum"}},{"name":"after","in":"query","description":"The skill version ID to start after.","required":false,"schema":{"example":"skillver_123","type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SkillVersionListResource"}}}}},"x-oaiMeta":{"examples":{"response":"","request":{"node.js":"import OpenAI from 'openai';\n\nconst client = new OpenAI({\n apiKey: process.env['OPENAI_API_KEY'], // This is the default and can be omitted\n});\n\n// Automatically fetches more pages as needed.\nfor await (const skillVersion of client.skills.versions.list('skill_123')) {\n console.log(skillVersion.id);\n}","python":"import os\nfrom openai import OpenAI\n\nclient = OpenAI(\n api_key=os.environ.get(\"OPENAI_API_KEY\"), # This is the default and can be omitted\n)\npage = client.skills.versions.list(\n skill_id=\"skill_123\",\n)\npage = page.data[0]\nprint(page.id)","go":"package main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\n\t\"github.com/openai/openai-go\"\n\t\"github.com/openai/openai-go/option\"\n)\n\nfunc main() {\n\tclient := openai.NewClient(\n\t\toption.WithAPIKey(\"My API Key\"),\n\t)\n\tpage, err := client.Skills.Versions.List(\n\t\tcontext.TODO(),\n\t\t\"skill_123\",\n\t\topenai.SkillVersionListParams{},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf(\"%+v\\n\", page)\n}\n","java":"package com.openai.example;\n\nimport com.openai.client.OpenAIClient;\nimport com.openai.client.okhttp.OpenAIOkHttpClient;\nimport com.openai.models.skills.versions.VersionListPage;\nimport com.openai.models.skills.versions.VersionListParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n OpenAIClient client = OpenAIOkHttpClient.fromEnv();\n\n VersionListPage page = client.skills().versions().list(\"skill_123\");\n }\n}","ruby":"require \"openai\"\n\nopenai = OpenAI::Client.new(api_key: \"My API Key\")\n\npage = openai.skills.versions.list(\"skill_123\")\n\nputs(page)"}}}}},"/skills/{skill_id}/versions/{version}":{"get":{"tags":["Skills"],"summary":"Get a specific skill version.","operationId":"GetSkillVersion","parameters":[{"name":"skill_id","in":"path","description":"The identifier of the skill.","required":true,"schema":{"example":"skill_123","type":"string"}},{"name":"version","in":"path","description":"The version number to retrieve.","required":true,"schema":{"description":"The version number to retrieve.","type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SkillVersionResource"}}}}},"x-oaiMeta":{"examples":{"response":"","request":{"node.js":"import OpenAI from 'openai';\n\nconst client = new OpenAI({\n apiKey: process.env['OPENAI_API_KEY'], // This is the default and can be omitted\n});\n\nconst skillVersion = await client.skills.versions.retrieve('version', { skill_id: 'skill_123' });\n\nconsole.log(skillVersion.id);","python":"import os\nfrom openai import OpenAI\n\nclient = OpenAI(\n api_key=os.environ.get(\"OPENAI_API_KEY\"), # This is the default and can be omitted\n)\nskill_version = client.skills.versions.retrieve(\n version=\"version\",\n skill_id=\"skill_123\",\n)\nprint(skill_version.id)","go":"package main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\n\t\"github.com/openai/openai-go\"\n\t\"github.com/openai/openai-go/option\"\n)\n\nfunc main() {\n\tclient := openai.NewClient(\n\t\toption.WithAPIKey(\"My API Key\"),\n\t)\n\tskillVersion, err := client.Skills.Versions.Get(\n\t\tcontext.TODO(),\n\t\t\"skill_123\",\n\t\t\"version\",\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf(\"%+v\\n\", skillVersion.ID)\n}\n","java":"package com.openai.example;\n\nimport com.openai.client.OpenAIClient;\nimport com.openai.client.okhttp.OpenAIOkHttpClient;\nimport com.openai.models.skills.versions.SkillVersion;\nimport com.openai.models.skills.versions.VersionRetrieveParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n OpenAIClient client = OpenAIOkHttpClient.fromEnv();\n\n VersionRetrieveParams params = VersionRetrieveParams.builder()\n .skillId(\"skill_123\")\n .version(\"version\")\n .build();\n SkillVersion skillVersion = client.skills().versions().retrieve(params);\n }\n}","ruby":"require \"openai\"\n\nopenai = OpenAI::Client.new(api_key: \"My API Key\")\n\nskill_version = openai.skills.versions.retrieve(\"version\", skill_id: \"skill_123\")\n\nputs(skill_version)"}}}},"delete":{"tags":["Skills"],"summary":"Delete a skill version.","operationId":"DeleteSkillVersion","parameters":[{"name":"skill_id","in":"path","description":"The identifier of the skill.","required":true,"schema":{"example":"skill_123","type":"string"}},{"name":"version","in":"path","description":"The skill version number.","required":true,"schema":{"description":"The skill version number.","type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeletedSkillVersionResource"}}}}},"x-oaiMeta":{"examples":{"response":"","request":{"node.js":"import OpenAI from 'openai';\n\nconst client = new OpenAI({\n apiKey: process.env['OPENAI_API_KEY'], // This is the default and can be omitted\n});\n\nconst deletedSkillVersion = await client.skills.versions.delete('version', {\n skill_id: 'skill_123',\n});\n\nconsole.log(deletedSkillVersion.id);","python":"import os\nfrom openai import OpenAI\n\nclient = OpenAI(\n api_key=os.environ.get(\"OPENAI_API_KEY\"), # This is the default and can be omitted\n)\ndeleted_skill_version = client.skills.versions.delete(\n version=\"version\",\n skill_id=\"skill_123\",\n)\nprint(deleted_skill_version.id)","go":"package main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\n\t\"github.com/openai/openai-go\"\n\t\"github.com/openai/openai-go/option\"\n)\n\nfunc main() {\n\tclient := openai.NewClient(\n\t\toption.WithAPIKey(\"My API Key\"),\n\t)\n\tdeletedSkillVersion, err := client.Skills.Versions.Delete(\n\t\tcontext.TODO(),\n\t\t\"skill_123\",\n\t\t\"version\",\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf(\"%+v\\n\", deletedSkillVersion.ID)\n}\n","java":"package com.openai.example;\n\nimport com.openai.client.OpenAIClient;\nimport com.openai.client.okhttp.OpenAIOkHttpClient;\nimport com.openai.models.skills.versions.DeletedSkillVersion;\nimport com.openai.models.skills.versions.VersionDeleteParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n OpenAIClient client = OpenAIOkHttpClient.fromEnv();\n\n VersionDeleteParams params = VersionDeleteParams.builder()\n .skillId(\"skill_123\")\n .version(\"version\")\n .build();\n DeletedSkillVersion deletedSkillVersion = client.skills().versions().delete(params);\n }\n}","ruby":"require \"openai\"\n\nopenai = OpenAI::Client.new(api_key: \"My API Key\")\n\ndeleted_skill_version = openai.skills.versions.delete(\"version\", skill_id: \"skill_123\")\n\nputs(deleted_skill_version)"}}}}},"/skills/{skill_id}/versions/{version}/content":{"get":{"tags":["Skills"],"summary":"Download a skill version zip bundle.","operationId":"GetSkillVersionContent","parameters":[{"name":"skill_id","in":"path","description":"The identifier of the skill.","required":true,"schema":{"example":"skill_123","type":"string"}},{"name":"version","in":"path","description":"The skill version number.","required":true,"schema":{"description":"The skill version number.","type":"string"}}],"responses":{"200":{"description":"The skill zip bundle.","content":{"application/zip":{"schema":{"type":"string","format":"binary"}},"application/json":{"schema":{"type":"string"}}}}},"x-oaiMeta":{"examples":{"response":"","request":{"node.js":"import OpenAI from 'openai';\n\nconst client = new OpenAI({\n apiKey: process.env['OPENAI_API_KEY'], // This is the default and can be omitted\n});\n\nconst content = await client.skills.versions.content.retrieve('version', { skill_id: 'skill_123' });\n\nconsole.log(content);\n\nconst data = await content.blob();\nconsole.log(data);","python":"import os\nfrom openai import OpenAI\n\nclient = OpenAI(\n api_key=os.environ.get(\"OPENAI_API_KEY\"), # This is the default and can be omitted\n)\ncontent = client.skills.versions.content.retrieve(\n version=\"version\",\n skill_id=\"skill_123\",\n)\nprint(content)\ndata = content.read()\nprint(data)","go":"package main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\n\t\"github.com/openai/openai-go\"\n\t\"github.com/openai/openai-go/option\"\n)\n\nfunc main() {\n\tclient := openai.NewClient(\n\t\toption.WithAPIKey(\"My API Key\"),\n\t)\n\tcontent, err := client.Skills.Versions.Content.Get(\n\t\tcontext.TODO(),\n\t\t\"skill_123\",\n\t\t\"version\",\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf(\"%+v\\n\", content)\n}\n","java":"package com.openai.example;\n\nimport com.openai.client.OpenAIClient;\nimport com.openai.client.okhttp.OpenAIOkHttpClient;\nimport com.openai.core.http.HttpResponse;\nimport com.openai.models.skills.versions.content.ContentRetrieveParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n OpenAIClient client = OpenAIOkHttpClient.fromEnv();\n\n ContentRetrieveParams params = ContentRetrieveParams.builder()\n .skillId(\"skill_123\")\n .version(\"version\")\n .build();\n HttpResponse content = client.skills().versions().content().retrieve(params);\n }\n}","ruby":"require \"openai\"\n\nopenai = OpenAI::Client.new(api_key: \"My API Key\")\n\ncontent = openai.skills.versions.content.retrieve(\"version\", skill_id: \"skill_123\")\n\nputs(content)"}}}}},"/chatkit/sessions/{session_id}/cancel":{"post":{"summary":"Cancel an active ChatKit session and return its most recent metadata.\n\nCancelling prevents new requests from using the issued client secret.","operationId":"CancelChatSessionMethod","parameters":[{"name":"session_id","in":"path","description":"Unique identifier for the ChatKit session to cancel.","required":true,"schema":{"example":"cksess_123","type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChatSessionResource"}}}}},"x-oaiMeta":{"name":"Cancel chat session","group":"chatkit","beta":true,"path":"cancel-session new requests from using the issued client secret.","examples":{"request":{"curl":"curl -X POST \\\n https://api.openai.com/v1/chatkit/sessions/cksess_123/cancel \\\n -H \"OpenAI-Beta: chatkit_beta=v1\" \\\n -H \"Authorization: Bearer $OPENAI_API_KEY\"\n","javascript":"import OpenAI from 'openai';\n\nconst client = new OpenAI();\n\nconst chatSession = await client.beta.chatkit.sessions.cancel('cksess_123');\n\nconsole.log(chatSession.id);\n","python":"import os\nfrom openai import OpenAI\n\nclient = OpenAI(\n api_key=os.environ.get(\"OPENAI_API_KEY\"), # This is the default and can be omitted\n)\nchat_session = client.beta.chatkit.sessions.cancel(\n \"cksess_123\",\n)\nprint(chat_session.id)","go":"package main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\n\t\"github.com/openai/openai-go\"\n\t\"github.com/openai/openai-go/option\"\n)\n\nfunc main() {\n\tclient := openai.NewClient(\n\t\toption.WithAPIKey(\"My API Key\"),\n\t)\n\tchatSession, err := client.Beta.ChatKit.Sessions.Cancel(context.TODO(), \"cksess_123\")\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf(\"%+v\\n\", chatSession.ID)\n}\n","ruby":"require \"openai\"\n\nopenai = OpenAI::Client.new(api_key: \"My API Key\")\n\nchat_session = openai.beta.chatkit.sessions.cancel(\"cksess_123\")\n\nputs(chat_session)","java":"package com.openai.example;\n\nimport com.openai.client.OpenAIClient;\nimport com.openai.client.okhttp.OpenAIOkHttpClient;\nimport com.openai.models.beta.chatkit.sessions.SessionCancelParams;\nimport com.openai.models.beta.chatkit.threads.ChatSession;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n OpenAIClient client = OpenAIOkHttpClient.fromEnv();\n\n ChatSession chatSession = client.beta().chatkit().sessions().cancel(\"cksess_123\");\n }\n}","node.js":"import OpenAI from 'openai';\n\nconst client = new OpenAI({\n apiKey: process.env['OPENAI_API_KEY'], // This is the default and can be omitted\n});\n\nconst chatSession = await client.beta.chatkit.sessions.cancel('cksess_123');\n\nconsole.log(chatSession.id);"},"response":"{\n \"id\": \"cksess_123\",\n \"object\": \"chatkit.session\",\n \"workflow\": {\n \"id\": \"workflow_alpha\",\n \"version\": \"1\"\n },\n \"scope\": {\n \"customer_id\": \"cust_456\"\n },\n \"max_requests_per_1_minute\": 30,\n \"ttl_seconds\": 900,\n \"status\": \"cancelled\",\n \"cancelled_at\": 1712345678\n}\n"}}}},"/chatkit/sessions":{"post":{"summary":"Create a ChatKit session.","operationId":"CreateChatSessionMethod","parameters":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateChatSessionBody"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChatSessionResource"}}}}},"x-oaiMeta":{"name":"Create ChatKit session","group":"chatkit","beta":true,"path":"sessions/create object.","examples":{"request":{"curl":"curl https://api.openai.com/v1/chatkit/sessions \\\n -H \"Content-Type: application/json\" \\\n -H \"Authorization: Bearer $OPENAI_API_KEY\" \\\n -H \"OpenAI-Beta: chatkit_beta=v1\" \\\n -d '{\n \"workflow\": {\n \"id\": \"workflow_alpha\",\n \"version\": \"2024-10-01\"\n },\n \"scope\": {\n \"project\": \"alpha\",\n \"environment\": \"staging\"\n },\n \"expires_after\": 1800,\n \"max_requests_per_1_minute\": 60,\n \"max_requests_per_session\": 500\n }'\n","javascript":"import OpenAI from 'openai';\n\nconst client = new OpenAI();\n\nconst chatSession = await client.beta.chatkit.sessions.create({ user: 'user', workflow: { id: 'id' } });\n\nconsole.log(chatSession.id);\n","python":"import os\nfrom openai import OpenAI\n\nclient = OpenAI(\n api_key=os.environ.get(\"OPENAI_API_KEY\"), # This is the default and can be omitted\n)\nchat_session = client.beta.chatkit.sessions.create(\n user=\"x\",\n workflow={\n \"id\": \"id\"\n },\n)\nprint(chat_session.id)","go":"package main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\n\t\"github.com/openai/openai-go\"\n\t\"github.com/openai/openai-go/option\"\n)\n\nfunc main() {\n\tclient := openai.NewClient(\n\t\toption.WithAPIKey(\"My API Key\"),\n\t)\n\tchatSession, err := client.Beta.ChatKit.Sessions.New(context.TODO(), openai.BetaChatKitSessionNewParams{\n\t\tUser: \"x\",\n\t\tWorkflow: openai.ChatSessionWorkflowParam{\n\t\t\tID: \"id\",\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf(\"%+v\\n\", chatSession.ID)\n}\n","ruby":"require \"openai\"\n\nopenai = OpenAI::Client.new(api_key: \"My API Key\")\n\nchat_session = openai.beta.chatkit.sessions.create(user: \"x\", workflow: {id: \"id\"})\n\nputs(chat_session)","java":"package com.openai.example;\n\nimport com.openai.client.OpenAIClient;\nimport com.openai.client.okhttp.OpenAIOkHttpClient;\nimport com.openai.models.beta.chatkit.sessions.SessionCreateParams;\nimport com.openai.models.beta.chatkit.threads.ChatSession;\nimport com.openai.models.beta.chatkit.threads.ChatSessionWorkflowParam;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n OpenAIClient client = OpenAIOkHttpClient.fromEnv();\n\n SessionCreateParams params = SessionCreateParams.builder()\n .user(\"x\")\n .workflow(ChatSessionWorkflowParam.builder()\n .id(\"id\")\n .build())\n .build();\n ChatSession chatSession = client.beta().chatkit().sessions().create(params);\n }\n}","node.js":"import OpenAI from 'openai';\n\nconst client = new OpenAI({\n apiKey: process.env['OPENAI_API_KEY'], // This is the default and can be omitted\n});\n\nconst chatSession = await client.beta.chatkit.sessions.create({\n user: 'x',\n workflow: { id: 'id' },\n});\n\nconsole.log(chatSession.id);"},"response":"{\n \"client_secret\": \"chatkit_token_123\",\n \"expires_at\": 1735689600,\n \"workflow\": {\n \"id\": \"workflow_alpha\",\n \"version\": \"2024-10-01\"\n },\n \"scope\": {\n \"project\": \"alpha\",\n \"environment\": \"staging\"\n },\n \"max_requests_per_1_minute\": 60,\n \"max_requests_per_session\": 500,\n \"status\": \"active\"\n}\n"}}}},"/chatkit/threads/{thread_id}/items":{"get":{"summary":"List items that belong to a ChatKit thread.","operationId":"ListThreadItemsMethod","parameters":[{"name":"thread_id","in":"path","description":"Identifier of the ChatKit thread whose items are requested.","required":true,"schema":{"example":"cthr_123","type":"string"}},{"name":"limit","in":"query","description":"Maximum number of thread items to return. Defaults to 20.","required":false,"schema":{"type":"integer","minimum":0,"maximum":100}},{"name":"order","in":"query","description":"Sort order for results by creation time. Defaults to `desc`.","required":false,"schema":{"$ref":"#/components/schemas/OrderEnum"}},{"name":"after","in":"query","description":"List items created after this thread item ID. Defaults to null for the first page.","required":false,"schema":{"description":"List items created after this thread item ID. Defaults to null for the first page.","type":"string"}},{"name":"before","in":"query","description":"List items created before this thread item ID. Defaults to null for the newest results.","required":false,"schema":{"description":"List items created before this thread item ID. Defaults to null for the newest results.","type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThreadItemListResource"}}}}},"x-oaiMeta":{"name":"List ChatKit thread items","group":"chatkit","beta":true,"path":"threads/list-items for the specified thread.","examples":{"request":{"curl":"curl \"https://api.openai.com/v1/chatkit/threads/cthr_abc123/items?limit=3\" \\\n -H \"OpenAI-Beta: chatkit_beta=v1\" \\\n -H \"Authorization: Bearer $OPENAI_API_KEY\"\n","javascript":"import OpenAI from 'openai';\n\nconst client = new OpenAI();\n\n// Automatically fetches more pages as needed.\nfor await (const thread of client.beta.chatkit.threads.listItems('cthr_123')) {\n console.log(thread);\n}\n","python":"import os\nfrom openai import OpenAI\n\nclient = OpenAI(\n api_key=os.environ.get(\"OPENAI_API_KEY\"), # This is the default and can be omitted\n)\npage = client.beta.chatkit.threads.list_items(\n thread_id=\"cthr_123\",\n)\npage = page.data[0]\nprint(page)","go":"package main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\n\t\"github.com/openai/openai-go\"\n\t\"github.com/openai/openai-go/option\"\n)\n\nfunc main() {\n\tclient := openai.NewClient(\n\t\toption.WithAPIKey(\"My API Key\"),\n\t)\n\tpage, err := client.Beta.ChatKit.Threads.ListItems(\n\t\tcontext.TODO(),\n\t\t\"cthr_123\",\n\t\topenai.BetaChatKitThreadListItemsParams{},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf(\"%+v\\n\", page)\n}\n","ruby":"require \"openai\"\n\nopenai = OpenAI::Client.new(api_key: \"My API Key\")\n\npage = openai.beta.chatkit.threads.list_items(\"cthr_123\")\n\nputs(page)","java":"package com.openai.example;\n\nimport com.openai.client.OpenAIClient;\nimport com.openai.client.okhttp.OpenAIOkHttpClient;\nimport com.openai.models.beta.chatkit.threads.ThreadListItemsPage;\nimport com.openai.models.beta.chatkit.threads.ThreadListItemsParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n OpenAIClient client = OpenAIOkHttpClient.fromEnv();\n\n ThreadListItemsPage page = client.beta().chatkit().threads().listItems(\"cthr_123\");\n }\n}","node.js":"import OpenAI from 'openai';\n\nconst client = new OpenAI({\n apiKey: process.env['OPENAI_API_KEY'], // This is the default and can be omitted\n});\n\n// Automatically fetches more pages as needed.\nfor await (const thread of client.beta.chatkit.threads.listItems('cthr_123')) {\n console.log(thread);\n}"},"response":"{\n \"data\": [\n {\n \"id\": \"cthi_user_001\",\n \"object\": \"chatkit.thread_item\",\n \"type\": \"user_message\",\n \"content\": [\n {\n \"type\": \"input_text\",\n \"text\": \"I need help debugging an onboarding issue.\"\n }\n ],\n \"attachments\": []\n },\n {\n \"id\": \"cthi_assistant_002\",\n \"object\": \"chatkit.thread_item\",\n \"type\": \"assistant_message\",\n \"content\": [\n {\n \"type\": \"output_text\",\n \"text\": \"Let's start by confirming the workflow version you deployed.\"\n }\n ]\n }\n ],\n \"has_more\": false,\n \"object\": \"list\"\n}\n"}}}},"/chatkit/threads/{thread_id}":{"get":{"summary":"Retrieve a ChatKit thread by its identifier.","operationId":"GetThreadMethod","parameters":[{"name":"thread_id","in":"path","description":"Identifier of the ChatKit thread to retrieve.","required":true,"schema":{"example":"cthr_123","type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThreadResource"}}}}},"x-oaiMeta":{"name":"Retrieve ChatKit thread","group":"chatkit","beta":true,"path":"threads/retrieve","examples":{"request":{"curl":"curl https://api.openai.com/v1/chatkit/threads/cthr_abc123 \\\n -H \"OpenAI-Beta: chatkit_beta=v1\" \\\n -H \"Authorization: Bearer $OPENAI_API_KEY\"\n","javascript":"import OpenAI from 'openai';\n\nconst client = new OpenAI();\n\nconst chatkitThread = await client.beta.chatkit.threads.retrieve('cthr_123');\n\nconsole.log(chatkitThread.id);\n","python":"import os\nfrom openai import OpenAI\n\nclient = OpenAI(\n api_key=os.environ.get(\"OPENAI_API_KEY\"), # This is the default and can be omitted\n)\nchatkit_thread = client.beta.chatkit.threads.retrieve(\n \"cthr_123\",\n)\nprint(chatkit_thread.id)","go":"package main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\n\t\"github.com/openai/openai-go\"\n\t\"github.com/openai/openai-go/option\"\n)\n\nfunc main() {\n\tclient := openai.NewClient(\n\t\toption.WithAPIKey(\"My API Key\"),\n\t)\n\tchatkitThread, err := client.Beta.ChatKit.Threads.Get(context.TODO(), \"cthr_123\")\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf(\"%+v\\n\", chatkitThread.ID)\n}\n","ruby":"require \"openai\"\n\nopenai = OpenAI::Client.new(api_key: \"My API Key\")\n\nchatkit_thread = openai.beta.chatkit.threads.retrieve(\"cthr_123\")\n\nputs(chatkit_thread)","java":"package com.openai.example;\n\nimport com.openai.client.OpenAIClient;\nimport com.openai.client.okhttp.OpenAIOkHttpClient;\nimport com.openai.models.beta.chatkit.threads.ChatKitThread;\nimport com.openai.models.beta.chatkit.threads.ThreadRetrieveParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n OpenAIClient client = OpenAIOkHttpClient.fromEnv();\n\n ChatKitThread chatkitThread = client.beta().chatkit().threads().retrieve(\"cthr_123\");\n }\n}","node.js":"import OpenAI from 'openai';\n\nconst client = new OpenAI({\n apiKey: process.env['OPENAI_API_KEY'], // This is the default and can be omitted\n});\n\nconst chatkitThread = await client.beta.chatkit.threads.retrieve('cthr_123');\n\nconsole.log(chatkitThread.id);"},"response":"{\n \"id\": \"cthr_abc123\",\n \"object\": \"chatkit.thread\",\n \"title\": \"Customer escalation\",\n \"items\": {\n \"data\": [\n {\n \"id\": \"cthi_user_001\",\n \"object\": \"chatkit.thread_item\",\n \"type\": \"user_message\",\n \"content\": [\n {\n \"type\": \"input_text\",\n \"text\": \"I need help debugging an onboarding issue.\"\n }\n ],\n \"attachments\": []\n },\n {\n \"id\": \"cthi_assistant_002\",\n \"object\": \"chatkit.thread_item\",\n \"type\": \"assistant_message\",\n \"content\": [\n {\n \"type\": \"output_text\",\n \"text\": \"Let's start by confirming the workflow version you deployed.\"\n }\n ]\n }\n ],\n \"has_more\": false\n }\n}\n"}}},"delete":{"summary":"Delete a ChatKit thread along with its items and stored attachments.","operationId":"DeleteThreadMethod","parameters":[{"name":"thread_id","in":"path","description":"Identifier of the ChatKit thread to delete.","required":true,"schema":{"example":"cthr_123","type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeletedThreadResource"}}}}},"x-oaiMeta":{"beta":true,"examples":{"response":"","request":{"javascript":"import OpenAI from 'openai';\n\nconst client = new OpenAI();\n\nconst thread = await client.beta.chat_kit.threads.delete('cthr_123');\n\nconsole.log(thread.id);\n","python":"import os\nfrom openai import OpenAI\n\nclient = OpenAI(\n api_key=os.environ.get(\"OPENAI_API_KEY\"), # This is the default and can be omitted\n)\nthread = client.beta.chatkit.threads.delete(\n \"cthr_123\",\n)\nprint(thread.id)","go":"package main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\n\t\"github.com/openai/openai-go\"\n\t\"github.com/openai/openai-go/option\"\n)\n\nfunc main() {\n\tclient := openai.NewClient(\n\t\toption.WithAPIKey(\"My API Key\"),\n\t)\n\tthread, err := client.Beta.ChatKit.Threads.Delete(context.TODO(), \"cthr_123\")\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf(\"%+v\\n\", thread.ID)\n}\n","ruby":"require \"openai\"\n\nopenai = OpenAI::Client.new(api_key: \"My API Key\")\n\nthread = openai.beta.chatkit.threads.delete(\"cthr_123\")\n\nputs(thread)","java":"package com.openai.example;\n\nimport com.openai.client.OpenAIClient;\nimport com.openai.client.okhttp.OpenAIOkHttpClient;\nimport com.openai.models.beta.chatkit.threads.ThreadDeleteParams;\nimport com.openai.models.beta.chatkit.threads.ThreadDeleteResponse;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n OpenAIClient client = OpenAIOkHttpClient.fromEnv();\n\n ThreadDeleteResponse thread = client.beta().chatkit().threads().delete(\"cthr_123\");\n }\n}","node.js":"import OpenAI from 'openai';\n\nconst client = new OpenAI({\n apiKey: process.env['OPENAI_API_KEY'], // This is the default and can be omitted\n});\n\nconst thread = await client.beta.chatkit.threads.delete('cthr_123');\n\nconsole.log(thread.id);"}},"name":"Delete ChatKit thread","group":"chatkit","path":"threads/delete"}}},"/chatkit/threads":{"get":{"summary":"List ChatKit threads with optional pagination and user filters.","operationId":"ListThreadsMethod","parameters":[{"name":"limit","in":"query","description":"Maximum number of thread items to return. Defaults to 20.","required":false,"schema":{"type":"integer","minimum":0,"maximum":100}},{"name":"order","in":"query","description":"Sort order for results by creation time. Defaults to `desc`.","required":false,"schema":{"$ref":"#/components/schemas/OrderEnum"}},{"name":"after","in":"query","description":"List items created after this thread item ID. Defaults to null for the first page.","required":false,"schema":{"description":"List items created after this thread item ID. Defaults to null for the first page.","type":"string"}},{"name":"before","in":"query","description":"List items created before this thread item ID. Defaults to null for the newest results.","required":false,"schema":{"description":"List items created before this thread item ID. Defaults to null for the newest results.","type":"string"}},{"name":"user","in":"query","description":"Filter threads that belong to this user identifier. Defaults to null to return all users.","required":false,"schema":{"description":"Filter threads that belong to this user identifier. Defaults to null to return all users.","type":"string","minLength":1,"maxLength":512}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThreadListResource"}}}}},"x-oaiMeta":{"name":"List ChatKit threads","group":"chatkit","beta":true,"path":"list-threads scope.","examples":{"request":{"curl":"curl \"https://api.openai.com/v1/chatkit/threads?limit=2&order=desc\" \\\n -H \"OpenAI-Beta: chatkit_beta=v1\" \\\n -H \"Authorization: Bearer $OPENAI_API_KEY\"\n","javascript":"import OpenAI from 'openai';\n\nconst client = new OpenAI();\n\n// Automatically fetches more pages as needed.\nfor await (const chatkitThread of client.beta.chatkit.threads.list()) {\n console.log(chatkitThread.id);\n}\n","python":"import os\nfrom openai import OpenAI\n\nclient = OpenAI(\n api_key=os.environ.get(\"OPENAI_API_KEY\"), # This is the default and can be omitted\n)\npage = client.beta.chatkit.threads.list()\npage = page.data[0]\nprint(page.id)","go":"package main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\n\t\"github.com/openai/openai-go\"\n\t\"github.com/openai/openai-go/option\"\n)\n\nfunc main() {\n\tclient := openai.NewClient(\n\t\toption.WithAPIKey(\"My API Key\"),\n\t)\n\tpage, err := client.Beta.ChatKit.Threads.List(context.TODO(), openai.BetaChatKitThreadListParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf(\"%+v\\n\", page)\n}\n","ruby":"require \"openai\"\n\nopenai = OpenAI::Client.new(api_key: \"My API Key\")\n\npage = openai.beta.chatkit.threads.list\n\nputs(page)","java":"package com.openai.example;\n\nimport com.openai.client.OpenAIClient;\nimport com.openai.client.okhttp.OpenAIOkHttpClient;\nimport com.openai.models.beta.chatkit.threads.ThreadListPage;\nimport com.openai.models.beta.chatkit.threads.ThreadListParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n OpenAIClient client = OpenAIOkHttpClient.fromEnv();\n\n ThreadListPage page = client.beta().chatkit().threads().list();\n }\n}","node.js":"import OpenAI from 'openai';\n\nconst client = new OpenAI({\n apiKey: process.env['OPENAI_API_KEY'], // This is the default and can be omitted\n});\n\n// Automatically fetches more pages as needed.\nfor await (const chatkitThread of client.beta.chatkit.threads.list()) {\n console.log(chatkitThread.id);\n}"},"response":"{\n \"data\": [\n {\n \"id\": \"cthr_abc123\",\n \"object\": \"chatkit.thread\",\n \"title\": \"Customer escalation\"\n },\n {\n \"id\": \"cthr_def456\",\n \"object\": \"chatkit.thread\",\n \"title\": \"Demo feedback\"\n }\n ],\n \"has_more\": false,\n \"object\": \"list\"\n}\n"}}}}},"webhooks":{"batch_cancelled":{"post":{"description":"Sent when a batch has been cancelled.\n","requestBody":{"description":"The event payload sent by the API.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookBatchCancelled"}}}},"responses":{"200":{"description":"Return a 200 status code to acknowledge receipt of the event. Non-200 \nstatus codes will be retried.\n"}}}},"batch_completed":{"post":{"description":"Sent when a batch has completed processing.\n","requestBody":{"description":"The event payload sent by the API.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookBatchCompleted"}}}},"responses":{"200":{"description":"Return a 200 status code to acknowledge receipt of the event. Non-200 \nstatus codes will be retried.\n"}}}},"batch_expired":{"post":{"description":"Sent when a batch has expired before completion.\n","requestBody":{"description":"The event payload sent by the API.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookBatchExpired"}}}},"responses":{"200":{"description":"Return a 200 status code to acknowledge receipt of the event. Non-200 \nstatus codes will be retried.\n"}}}},"batch_failed":{"post":{"description":"Sent when a batch has failed.\n","requestBody":{"description":"The event payload sent by the API.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookBatchFailed"}}}},"responses":{"200":{"description":"Return a 200 status code to acknowledge receipt of the event. Non-200 \nstatus codes will be retried.\n"}}}},"eval_run_canceled":{"post":{"description":"Sent when an eval run has been canceled.\n","requestBody":{"description":"The event payload sent by the API.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookEvalRunCanceled"}}}},"responses":{"200":{"description":"Return a 200 status code to acknowledge receipt of the event. Non-200 \nstatus codes will be retried. \n"}}}},"eval_run_failed":{"post":{"description":"Sent when an eval run has failed.\n","requestBody":{"description":"The event payload sent by the API.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookEvalRunFailed"}}}},"responses":{"200":{"description":"Return a 200 status code to acknowledge receipt of the event. Non-200 \nstatus codes will be retried. \n"}}}},"eval_run_succeeded":{"post":{"description":"Sent when an eval run has succeeded.\n","requestBody":{"description":"The event payload sent by the API.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookEvalRunSucceeded"}}}},"responses":{"200":{"description":"Return a 200 status code to acknowledge receipt of the event. Non-200 \nstatus codes will be retried. \n"}}}},"fine_tuning_job_cancelled":{"post":{"description":"Sent when a fine-tuning job has been cancelled.\n","requestBody":{"description":"The event payload sent by the API.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookFineTuningJobCancelled"}}}},"responses":{"200":{"description":"Return a 200 status code to acknowledge receipt of the event. Non-200 \nstatus codes will be retried. \n"}}}},"fine_tuning_job_failed":{"post":{"description":"Sent when a fine-tuning job has failed.\n","requestBody":{"description":"The event payload sent by the API.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookFineTuningJobFailed"}}}},"responses":{"200":{"description":"Return a 200 status code to acknowledge receipt of the event. Non-200 \nstatus codes will be retried. \n"}}}},"fine_tuning_job_succeeded":{"post":{"description":"Sent when a fine-tuning job has succeeded.\n","requestBody":{"description":"The event payload sent by the API.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookFineTuningJobSucceeded"}}}},"responses":{"200":{"description":"Return a 200 status code to acknowledge receipt of the event. Non-200 \nstatus codes will be retried. \n"}}}},"realtime_call_incoming":{"post":{"description":"Sent when Realtime API Receives a incoming SIP call.\n","requestBody":{"description":"The event payload sent by the API.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookRealtimeCallIncoming"}}}},"responses":{"200":{"description":"Return a 200 status code to acknowledge receipt of the event. Non-200\nstatus codes will be retried.\n"}}}},"response_cancelled":{"post":{"description":"Sent when a background response has been cancelled.\n","requestBody":{"description":"The event payload sent by the API.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookResponseCancelled"}}}},"responses":{"200":{"description":"Return a 200 status code to acknowledge receipt of the event. Non-200 \nstatus codes will be retried.\n"}}}},"response_completed":{"post":{"description":"Sent when a background response has completed successfully.\n","requestBody":{"description":"The event payload sent by the API.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookResponseCompleted"}}}},"responses":{"200":{"description":"Return a 200 status code to acknowledge receipt of the event. Non-200 \nstatus codes will be retried. \n"}}}},"response_failed":{"post":{"description":"Sent when a background response has failed.\n","requestBody":{"description":"The event payload sent by the API.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookResponseFailed"}}}},"responses":{"200":{"description":"Return a 200 status code to acknowledge receipt of the event. Non-200 \nstatus codes will be retried.\n"}}}},"response_incomplete":{"post":{"description":"Sent when a background response is incomplete.\n","requestBody":{"description":"The event payload sent by the API.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookResponseIncomplete"}}}},"responses":{"200":{"description":"Return a 200 status code to acknowledge receipt of the event. Non-200 \nstatus codes will be retried.\n"}}}}},"components":{"schemas":{"AddUploadPartRequest":{"type":"object","additionalProperties":false,"properties":{"data":{"description":"The chunk of bytes for this Part.\n","type":"string","format":"binary"}},"required":["data"]},"AdminApiKey":{"type":"object","description":"Represents an individual Admin API key in an org.","properties":{"object":{"type":"string","example":"organization.admin_api_key","description":"The object type, which is always `organization.admin_api_key`","x-stainless-const":true},"id":{"type":"string","example":"key_abc","description":"The identifier, which can be referenced in API endpoints"},"name":{"type":"string","example":"Administration Key","description":"The name of the API key"},"redacted_value":{"type":"string","example":"sk-admin...def","description":"The redacted value of the API key"},"value":{"type":"string","example":"sk-admin-1234abcd","description":"The value of the API key. Only shown on create."},"created_at":{"type":"integer","format":"int64","example":1711471533,"description":"The Unix timestamp (in seconds) of when the API key was created"},"last_used_at":{"anyOf":[{"type":"integer","format":"int64","example":1711471534,"description":"The Unix timestamp (in seconds) of when the API key was last used"},{"type":"null"}]},"owner":{"type":"object","properties":{"type":{"type":"string","example":"user","description":"Always `user`"},"object":{"type":"string","example":"organization.user","description":"The object type, which is always organization.user"},"id":{"type":"string","example":"sa_456","description":"The identifier, which can be referenced in API endpoints"},"name":{"type":"string","example":"My Service Account","description":"The name of the user"},"created_at":{"type":"integer","format":"int64","example":1711471533,"description":"The Unix timestamp (in seconds) of when the user was created"},"role":{"type":"string","example":"owner","description":"Always `owner`"}}}},"required":["object","redacted_value","name","created_at","last_used_at","id","owner"],"x-oaiMeta":{"name":"The admin API key object","example":"{\n \"object\": \"organization.admin_api_key\",\n \"id\": \"key_abc\",\n \"name\": \"Main Admin Key\",\n \"redacted_value\": \"sk-admin...xyz\",\n \"created_at\": 1711471533,\n \"last_used_at\": 1711471534,\n \"owner\": {\n \"type\": \"user\",\n \"object\": \"organization.user\",\n \"id\": \"user_123\",\n \"name\": \"John Doe\",\n \"created_at\": 1711471533,\n \"role\": \"owner\"\n }\n}\n"}},"ApiKeyList":{"type":"object","properties":{"object":{"type":"string","example":"list"},"data":{"type":"array","items":{"$ref":"#/components/schemas/AdminApiKey"}},"has_more":{"type":"boolean","example":false},"first_id":{"type":"string","example":"key_abc"},"last_id":{"type":"string","example":"key_xyz"}}},"AssignedRoleDetails":{"type":"object","description":"Detailed information about a role assignment entry returned when listing assignments.","properties":{"id":{"type":"string","description":"Identifier for the role."},"name":{"type":"string","description":"Name of the role."},"permissions":{"type":"array","description":"Permissions associated with the role.","items":{"type":"string"}},"resource_type":{"type":"string","description":"Resource type the role applies to."},"predefined_role":{"type":"boolean","description":"Whether the role is predefined by OpenAI."},"description":{"description":"Description of the role.","anyOf":[{"type":"string"},{"type":"null"}]},"created_at":{"description":"When the role was created.","anyOf":[{"type":"integer","format":"int64"},{"type":"null"}]},"updated_at":{"description":"When the role was last updated.","anyOf":[{"type":"integer","format":"int64"},{"type":"null"}]},"created_by":{"description":"Identifier of the actor who created the role.","anyOf":[{"type":"string"},{"type":"null"}]},"created_by_user_obj":{"description":"User details for the actor that created the role, when available.","anyOf":[{"type":"object","additionalProperties":true},{"type":"null"}]},"metadata":{"description":"Arbitrary metadata stored on the role.","anyOf":[{"type":"object","additionalProperties":true},{"type":"null"}]}},"required":["id","name","permissions","resource_type","predefined_role","description","created_at","updated_at","created_by","created_by_user_obj","metadata"]},"AssistantObject":{"type":"object","title":"Assistant","description":"Represents an `assistant` that can call the model and use tools.","properties":{"id":{"description":"The identifier, which can be referenced in API endpoints.","type":"string"},"object":{"description":"The object type, which is always `assistant`.","type":"string","enum":["assistant"],"x-stainless-const":true},"created_at":{"description":"The Unix timestamp (in seconds) for when the assistant was created.","type":"integer"},"name":{"anyOf":[{"description":"The name of the assistant. The maximum length is 256 characters.\n","type":"string","maxLength":256},{"type":"null"}]},"description":{"anyOf":[{"description":"The description of the assistant. The maximum length is 512 characters.\n","type":"string","maxLength":512},{"type":"null"}]},"model":{"description":"ID of the model to use. You can use the [List models](/docs/api-reference/models/list) API to see all of your available models, or see our [Model overview](/docs/models) for descriptions of them.\n","type":"string"},"instructions":{"anyOf":[{"description":"The system instructions that the assistant uses. The maximum length is 256,000 characters.\n","type":"string","maxLength":256000},{"type":"null"}]},"tools":{"description":"A list of tool enabled on the assistant. There can be a maximum of 128 tools per assistant. Tools can be of types `code_interpreter`, `file_search`, or `function`.\n","default":[],"type":"array","maxItems":128,"items":{"oneOf":[{"$ref":"#/components/schemas/AssistantToolsCode"},{"$ref":"#/components/schemas/AssistantToolsFileSearch"},{"$ref":"#/components/schemas/AssistantToolsFunction"}]}},"tool_resources":{"anyOf":[{"type":"object","description":"A set of resources that are used by the assistant's tools. The resources are specific to the type of tool. For example, the `code_interpreter` tool requires a list of file IDs, while the `file_search` tool requires a list of vector store IDs.\n","properties":{"code_interpreter":{"type":"object","properties":{"file_ids":{"type":"array","description":"A list of [file](/docs/api-reference/files) IDs made available to the `code_interpreter`` tool. There can be a maximum of 20 files associated with the tool.\n","default":[],"maxItems":20,"items":{"type":"string"}}}},"file_search":{"type":"object","properties":{"vector_store_ids":{"type":"array","description":"The ID of the [vector store](/docs/api-reference/vector-stores/object) attached to this assistant. There can be a maximum of 1 vector store attached to the assistant.\n","maxItems":1,"items":{"type":"string"}}}}}},{"type":"null"}]},"metadata":{"$ref":"#/components/schemas/Metadata"},"temperature":{"anyOf":[{"description":"What sampling temperature to use, between 0 and 2. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic.\n","type":"number","minimum":0,"maximum":2,"default":1,"example":1},{"type":"null"}]},"top_p":{"anyOf":[{"type":"number","minimum":0,"maximum":1,"default":1,"example":1,"description":"An alternative to sampling with temperature, called nucleus sampling, where the model considers the results of the tokens with top_p probability mass. So 0.1 means only the tokens comprising the top 10% probability mass are considered.\n\nWe generally recommend altering this or temperature but not both.\n"},{"type":"null"}]},"response_format":{"anyOf":[{"$ref":"#/components/schemas/AssistantsApiResponseFormatOption"},{"type":"null"}]}},"required":["id","object","created_at","name","description","model","instructions","tools","metadata"],"x-oaiMeta":{"name":"The assistant object","example":"{\n \"id\": \"asst_abc123\",\n \"object\": \"assistant\",\n \"created_at\": 1698984975,\n \"name\": \"Math Tutor\",\n \"description\": null,\n \"model\": \"gpt-4o\",\n \"instructions\": \"You are a personal math tutor. When asked a question, write and run Python code to answer the question.\",\n \"tools\": [\n {\n \"type\": \"code_interpreter\"\n }\n ],\n \"metadata\": {},\n \"top_p\": 1.0,\n \"temperature\": 1.0,\n \"response_format\": \"auto\"\n}\n"},"deprecated":true},"AssistantStreamEvent":{"description":"Represents an event emitted when streaming a Run.\n\nEach event in a server-sent events stream has an `event` and `data` property:\n\n```\nevent: thread.created\ndata: {\"id\": \"thread_123\", \"object\": \"thread\", ...}\n```\n\nWe emit events whenever a new object is created, transitions to a new state, or is being\nstreamed in parts (deltas). For example, we emit `thread.run.created` when a new run\nis created, `thread.run.completed` when a run completes, and so on. When an Assistant chooses\nto create a message during a run, we emit a `thread.message.created event`, a\n`thread.message.in_progress` event, many `thread.message.delta` events, and finally a\n`thread.message.completed` event.\n\nWe may add additional events over time, so we recommend handling unknown events gracefully\nin your code. See the [Assistants API quickstart](/docs/assistants/overview) to learn how to\nintegrate the Assistants API with streaming.\n","oneOf":[{"$ref":"#/components/schemas/ThreadStreamEvent"},{"$ref":"#/components/schemas/RunStreamEvent"},{"$ref":"#/components/schemas/RunStepStreamEvent"},{"$ref":"#/components/schemas/MessageStreamEvent"},{"$ref":"#/components/schemas/ErrorEvent"},{"$ref":"#/components/schemas/DoneEvent"}],"x-oaiMeta":{"name":"Assistant stream events","beta":true}},"AssistantSupportedModels":{"type":"string","enum":["gpt-5","gpt-5-mini","gpt-5-nano","gpt-5-2025-08-07","gpt-5-mini-2025-08-07","gpt-5-nano-2025-08-07","gpt-4.1","gpt-4.1-mini","gpt-4.1-nano","gpt-4.1-2025-04-14","gpt-4.1-mini-2025-04-14","gpt-4.1-nano-2025-04-14","o3-mini","o3-mini-2025-01-31","o1","o1-2024-12-17","gpt-4o","gpt-4o-2024-11-20","gpt-4o-2024-08-06","gpt-4o-2024-05-13","gpt-4o-mini","gpt-4o-mini-2024-07-18","gpt-4.5-preview","gpt-4.5-preview-2025-02-27","gpt-4-turbo","gpt-4-turbo-2024-04-09","gpt-4-0125-preview","gpt-4-turbo-preview","gpt-4-1106-preview","gpt-4-vision-preview","gpt-4","gpt-4-0314","gpt-4-0613","gpt-4-32k","gpt-4-32k-0314","gpt-4-32k-0613","gpt-3.5-turbo","gpt-3.5-turbo-16k","gpt-3.5-turbo-0613","gpt-3.5-turbo-1106","gpt-3.5-turbo-0125","gpt-3.5-turbo-16k-0613"]},"AssistantToolsCode":{"type":"object","title":"Code interpreter tool","properties":{"type":{"type":"string","description":"The type of tool being defined: `code_interpreter`","enum":["code_interpreter"],"x-stainless-const":true}},"required":["type"]},"AssistantToolsFileSearch":{"type":"object","title":"FileSearch tool","properties":{"type":{"type":"string","description":"The type of tool being defined: `file_search`","enum":["file_search"],"x-stainless-const":true},"file_search":{"type":"object","description":"Overrides for the file search tool.","properties":{"max_num_results":{"type":"integer","minimum":1,"maximum":50,"description":"The maximum number of results the file search tool should output. The default is 20 for `gpt-4*` models and 5 for `gpt-3.5-turbo`. This number should be between 1 and 50 inclusive.\n\nNote that the file search tool may output fewer than `max_num_results` results. See the [file search tool documentation](/docs/assistants/tools/file-search#customizing-file-search-settings) for more information.\n"},"ranking_options":{"$ref":"#/components/schemas/FileSearchRankingOptions"}}}},"required":["type"]},"AssistantToolsFileSearchTypeOnly":{"type":"object","title":"FileSearch tool","properties":{"type":{"type":"string","description":"The type of tool being defined: `file_search`","enum":["file_search"],"x-stainless-const":true}},"required":["type"]},"AssistantToolsFunction":{"type":"object","title":"Function tool","properties":{"type":{"type":"string","description":"The type of tool being defined: `function`","enum":["function"],"x-stainless-const":true},"function":{"$ref":"#/components/schemas/FunctionObject"}},"required":["type","function"]},"AssistantsApiResponseFormatOption":{"description":"Specifies the format that the model must output. Compatible with [GPT-4o](/docs/models#gpt-4o), [GPT-4 Turbo](/docs/models#gpt-4-turbo-and-gpt-4), and all GPT-3.5 Turbo models since `gpt-3.5-turbo-1106`.\n\nSetting to `{ \"type\": \"json_schema\", \"json_schema\": {...} }` enables Structured Outputs which ensures the model will match your supplied JSON schema. Learn more in the [Structured Outputs guide](/docs/guides/structured-outputs).\n\nSetting to `{ \"type\": \"json_object\" }` enables JSON mode, which ensures the message the model generates is valid JSON.\n\n**Important:** when using JSON mode, you **must** also instruct the model to produce JSON yourself via a system or user message. Without this, the model may generate an unending stream of whitespace until the generation reaches the token limit, resulting in a long-running and seemingly \"stuck\" request. Also note that the message content may be partially cut off if `finish_reason=\"length\"`, which indicates the generation exceeded `max_tokens` or the conversation exceeded the max context length.\n","oneOf":[{"type":"string","description":"`auto` is the default value\n","enum":["auto"],"x-stainless-const":true},{"$ref":"#/components/schemas/ResponseFormatText"},{"$ref":"#/components/schemas/ResponseFormatJsonObject"},{"$ref":"#/components/schemas/ResponseFormatJsonSchema"}]},"AssistantsApiToolChoiceOption":{"description":"Controls which (if any) tool is called by the model.\n`none` means the model will not call any tools and instead generates a message.\n`auto` is the default value and means the model can pick between generating a message or calling one or more tools.\n`required` means the model must call one or more tools before responding to the user.\nSpecifying a particular tool like `{\"type\": \"file_search\"}` or `{\"type\": \"function\", \"function\": {\"name\": \"my_function\"}}` forces the model to call that tool.\n","oneOf":[{"type":"string","description":"`none` means the model will not call any tools and instead generates a message. `auto` means the model can pick between generating a message or calling one or more tools. `required` means the model must call one or more tools before responding to the user.\n","enum":["none","auto","required"]},{"$ref":"#/components/schemas/AssistantsNamedToolChoice"}]},"AssistantsNamedToolChoice":{"type":"object","description":"Specifies a tool the model should use. Use to force the model to call a specific tool.","properties":{"type":{"type":"string","enum":["function","code_interpreter","file_search"],"description":"The type of the tool. If type is `function`, the function name must be set"},"function":{"type":"object","properties":{"name":{"type":"string","description":"The name of the function to call."}},"required":["name"]}},"required":["type"]},"AudioResponseFormat":{"description":"The format of the output, in one of these options: `json`, `text`, `srt`, `verbose_json`, `vtt`, or `diarized_json`. For `gpt-4o-transcribe` and `gpt-4o-mini-transcribe`, the only supported format is `json`. For `gpt-4o-transcribe-diarize`, the supported formats are `json`, `text`, and `diarized_json`, with `diarized_json` required to receive speaker annotations.\n","type":"string","enum":["json","text","srt","verbose_json","vtt","diarized_json"],"default":"json"},"AudioTranscription":{"type":"object","properties":{"model":{"description":"The model to use for transcription. Current options are `whisper-1`, `gpt-4o-mini-transcribe`, `gpt-4o-mini-transcribe-2025-12-15`, `gpt-4o-transcribe`, and `gpt-4o-transcribe-diarize`. Use `gpt-4o-transcribe-diarize` when you need diarization with speaker labels.\n","anyOf":[{"type":"string"},{"type":"string","enum":["whisper-1","gpt-4o-mini-transcribe","gpt-4o-mini-transcribe-2025-12-15","gpt-4o-transcribe","gpt-4o-transcribe-diarize"]}]},"language":{"type":"string","description":"The language of the input audio. Supplying the input language in\n[ISO-639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) (e.g. `en`) format\nwill improve accuracy and latency.\n"},"prompt":{"type":"string","description":"An optional text to guide the model's style or continue a previous audio\nsegment.\nFor `whisper-1`, the [prompt is a list of keywords](/docs/guides/speech-to-text#prompting).\nFor `gpt-4o-transcribe` models (excluding `gpt-4o-transcribe-diarize`), the prompt is a free text string, for example \"expect words related to technology\".\n"}}},"AuditLog":{"type":"object","description":"A log of a user action or configuration change within this organization.","properties":{"id":{"type":"string","description":"The ID of this log."},"type":{"$ref":"#/components/schemas/AuditLogEventType"},"effective_at":{"type":"integer","description":"The Unix timestamp (in seconds) of the event."},"project":{"type":"object","description":"The project that the action was scoped to. Absent for actions not scoped to projects. Note that any admin actions taken via Admin API keys are associated with the default project.","properties":{"id":{"type":"string","description":"The project ID."},"name":{"type":"string","description":"The project title."}}},"actor":{"$ref":"#/components/schemas/AuditLogActor"},"api_key.created":{"type":"object","description":"The details for events with this `type`.","properties":{"id":{"type":"string","description":"The tracking ID of the API key."},"data":{"type":"object","description":"The payload used to create the API key.","properties":{"scopes":{"type":"array","items":{"type":"string"},"description":"A list of scopes allowed for the API key, e.g. `[\"api.model.request\"]`"}}}}},"api_key.updated":{"type":"object","description":"The details for events with this `type`.","properties":{"id":{"type":"string","description":"The tracking ID of the API key."},"changes_requested":{"type":"object","description":"The payload used to update the API key.","properties":{"scopes":{"type":"array","items":{"type":"string"},"description":"A list of scopes allowed for the API key, e.g. `[\"api.model.request\"]`"}}}}},"api_key.deleted":{"type":"object","description":"The details for events with this `type`.","properties":{"id":{"type":"string","description":"The tracking ID of the API key."}}},"checkpoint.permission.created":{"type":"object","description":"The project and fine-tuned model checkpoint that the checkpoint permission was created for.","properties":{"id":{"type":"string","description":"The ID of the checkpoint permission."},"data":{"type":"object","description":"The payload used to create the checkpoint permission.","properties":{"project_id":{"type":"string","description":"The ID of the project that the checkpoint permission was created for."},"fine_tuned_model_checkpoint":{"type":"string","description":"The ID of the fine-tuned model checkpoint."}}}}},"checkpoint.permission.deleted":{"type":"object","description":"The details for events with this `type`.","properties":{"id":{"type":"string","description":"The ID of the checkpoint permission."}}},"external_key.registered":{"type":"object","description":"The details for events with this `type`.","properties":{"id":{"type":"string","description":"The ID of the external key configuration."},"data":{"type":"object","description":"The configuration for the external key."}}},"external_key.removed":{"type":"object","description":"The details for events with this `type`.","properties":{"id":{"type":"string","description":"The ID of the external key configuration."}}},"group.created":{"type":"object","description":"The details for events with this `type`.","properties":{"id":{"type":"string","description":"The ID of the group."},"data":{"type":"object","description":"Information about the created group.","properties":{"group_name":{"type":"string","description":"The group name."}}}}},"group.updated":{"type":"object","description":"The details for events with this `type`.","properties":{"id":{"type":"string","description":"The ID of the group."},"changes_requested":{"type":"object","description":"The payload used to update the group.","properties":{"group_name":{"type":"string","description":"The updated group name."}}}}},"group.deleted":{"type":"object","description":"The details for events with this `type`.","properties":{"id":{"type":"string","description":"The ID of the group."}}},"scim.enabled":{"type":"object","description":"The details for events with this `type`.","properties":{"id":{"type":"string","description":"The ID of the SCIM was enabled for."}}},"scim.disabled":{"type":"object","description":"The details for events with this `type`.","properties":{"id":{"type":"string","description":"The ID of the SCIM was disabled for."}}},"invite.sent":{"type":"object","description":"The details for events with this `type`.","properties":{"id":{"type":"string","description":"The ID of the invite."},"data":{"type":"object","description":"The payload used to create the invite.","properties":{"email":{"type":"string","description":"The email invited to the organization."},"role":{"type":"string","description":"The role the email was invited to be. Is either `owner` or `member`."}}}}},"invite.accepted":{"type":"object","description":"The details for events with this `type`.","properties":{"id":{"type":"string","description":"The ID of the invite."}}},"invite.deleted":{"type":"object","description":"The details for events with this `type`.","properties":{"id":{"type":"string","description":"The ID of the invite."}}},"ip_allowlist.created":{"type":"object","description":"The details for events with this `type`.","properties":{"id":{"type":"string","description":"The ID of the IP allowlist configuration."},"name":{"type":"string","description":"The name of the IP allowlist configuration."},"allowed_ips":{"type":"array","description":"The IP addresses or CIDR ranges included in the configuration.","items":{"type":"string"}}}},"ip_allowlist.updated":{"type":"object","description":"The details for events with this `type`.","properties":{"id":{"type":"string","description":"The ID of the IP allowlist configuration."},"allowed_ips":{"type":"array","description":"The updated set of IP addresses or CIDR ranges in the configuration.","items":{"type":"string"}}}},"ip_allowlist.deleted":{"type":"object","description":"The details for events with this `type`.","properties":{"id":{"type":"string","description":"The ID of the IP allowlist configuration."},"name":{"type":"string","description":"The name of the IP allowlist configuration."},"allowed_ips":{"type":"array","description":"The IP addresses or CIDR ranges that were in the configuration.","items":{"type":"string"}}}},"ip_allowlist.config.activated":{"type":"object","description":"The details for events with this `type`.","properties":{"configs":{"type":"array","description":"The configurations that were activated.","items":{"type":"object","properties":{"id":{"type":"string","description":"The ID of the IP allowlist configuration."},"name":{"type":"string","description":"The name of the IP allowlist configuration."}}}}}},"ip_allowlist.config.deactivated":{"type":"object","description":"The details for events with this `type`.","properties":{"configs":{"type":"array","description":"The configurations that were deactivated.","items":{"type":"object","properties":{"id":{"type":"string","description":"The ID of the IP allowlist configuration."},"name":{"type":"string","description":"The name of the IP allowlist configuration."}}}}}},"login.succeeded":{"type":"object","description":"This event has no additional fields beyond the standard audit log attributes."},"login.failed":{"type":"object","description":"The details for events with this `type`.","properties":{"error_code":{"type":"string","description":"The error code of the failure."},"error_message":{"type":"string","description":"The error message of the failure."}}},"logout.succeeded":{"type":"object","description":"This event has no additional fields beyond the standard audit log attributes."},"logout.failed":{"type":"object","description":"The details for events with this `type`.","properties":{"error_code":{"type":"string","description":"The error code of the failure."},"error_message":{"type":"string","description":"The error message of the failure."}}},"organization.updated":{"type":"object","description":"The details for events with this `type`.","properties":{"id":{"type":"string","description":"The organization ID."},"changes_requested":{"type":"object","description":"The payload used to update the organization settings.","properties":{"title":{"type":"string","description":"The organization title."},"description":{"type":"string","description":"The organization description."},"name":{"type":"string","description":"The organization name."},"threads_ui_visibility":{"type":"string","description":"Visibility of the threads page which shows messages created with the Assistants API and Playground. One of `ANY_ROLE`, `OWNERS`, or `NONE`."},"usage_dashboard_visibility":{"type":"string","description":"Visibility of the usage dashboard which shows activity and costs for your organization. One of `ANY_ROLE` or `OWNERS`."},"api_call_logging":{"type":"string","description":"How your organization logs data from supported API calls. One of `disabled`, `enabled_per_call`, `enabled_for_all_projects`, or `enabled_for_selected_projects`"},"api_call_logging_project_ids":{"type":"string","description":"The list of project ids if api_call_logging is set to `enabled_for_selected_projects`"}}}}},"project.created":{"type":"object","description":"The details for events with this `type`.","properties":{"id":{"type":"string","description":"The project ID."},"data":{"type":"object","description":"The payload used to create the project.","properties":{"name":{"type":"string","description":"The project name."},"title":{"type":"string","description":"The title of the project as seen on the dashboard."}}}}},"project.updated":{"type":"object","description":"The details for events with this `type`.","properties":{"id":{"type":"string","description":"The project ID."},"changes_requested":{"type":"object","description":"The payload used to update the project.","properties":{"title":{"type":"string","description":"The title of the project as seen on the dashboard."}}}}},"project.archived":{"type":"object","description":"The details for events with this `type`.","properties":{"id":{"type":"string","description":"The project ID."}}},"project.deleted":{"type":"object","description":"The details for events with this `type`.","properties":{"id":{"type":"string","description":"The project ID."}}},"rate_limit.updated":{"type":"object","description":"The details for events with this `type`.","properties":{"id":{"type":"string","description":"The rate limit ID"},"changes_requested":{"type":"object","description":"The payload used to update the rate limits.","properties":{"max_requests_per_1_minute":{"type":"integer","description":"The maximum requests per minute."},"max_tokens_per_1_minute":{"type":"integer","description":"The maximum tokens per minute."},"max_images_per_1_minute":{"type":"integer","description":"The maximum images per minute. Only relevant for certain models."},"max_audio_megabytes_per_1_minute":{"type":"integer","description":"The maximum audio megabytes per minute. Only relevant for certain models."},"max_requests_per_1_day":{"type":"integer","description":"The maximum requests per day. Only relevant for certain models."},"batch_1_day_max_input_tokens":{"type":"integer","description":"The maximum batch input tokens per day. Only relevant for certain models."}}}}},"rate_limit.deleted":{"type":"object","description":"The details for events with this `type`.","properties":{"id":{"type":"string","description":"The rate limit ID"}}},"role.created":{"type":"object","description":"The details for events with this `type`.","properties":{"id":{"type":"string","description":"The role ID."},"role_name":{"type":"string","description":"The name of the role."},"permissions":{"type":"array","items":{"type":"string"},"description":"The permissions granted by the role."},"resource_type":{"type":"string","description":"The type of resource the role belongs to."},"resource_id":{"type":"string","description":"The resource the role is scoped to."}}},"role.updated":{"type":"object","description":"The details for events with this `type`.","properties":{"id":{"type":"string","description":"The role ID."},"changes_requested":{"type":"object","description":"The payload used to update the role.","properties":{"role_name":{"type":"string","description":"The updated role name, when provided."},"resource_id":{"type":"string","description":"The resource the role is scoped to."},"resource_type":{"type":"string","description":"The type of resource the role belongs to."},"permissions_added":{"type":"array","items":{"type":"string"},"description":"The permissions added to the role."},"permissions_removed":{"type":"array","items":{"type":"string"},"description":"The permissions removed from the role."},"description":{"type":"string","description":"The updated role description, when provided."},"metadata":{"type":"object","description":"Additional metadata stored on the role."}}}}},"role.deleted":{"type":"object","description":"The details for events with this `type`.","properties":{"id":{"type":"string","description":"The role ID."}}},"role.assignment.created":{"type":"object","description":"The details for events with this `type`.","properties":{"id":{"type":"string","description":"The identifier of the role assignment."},"principal_id":{"type":"string","description":"The principal (user or group) that received the role."},"principal_type":{"type":"string","description":"The type of principal (user or group) that received the role."},"resource_id":{"type":"string","description":"The resource the role assignment is scoped to."},"resource_type":{"type":"string","description":"The type of resource the role assignment is scoped to."}}},"role.assignment.deleted":{"type":"object","description":"The details for events with this `type`.","properties":{"id":{"type":"string","description":"The identifier of the role assignment."},"principal_id":{"type":"string","description":"The principal (user or group) that had the role removed."},"principal_type":{"type":"string","description":"The type of principal (user or group) that had the role removed."},"resource_id":{"type":"string","description":"The resource the role assignment was scoped to."},"resource_type":{"type":"string","description":"The type of resource the role assignment was scoped to."}}},"service_account.created":{"type":"object","description":"The details for events with this `type`.","properties":{"id":{"type":"string","description":"The service account ID."},"data":{"type":"object","description":"The payload used to create the service account.","properties":{"role":{"type":"string","description":"The role of the service account. Is either `owner` or `member`."}}}}},"service_account.updated":{"type":"object","description":"The details for events with this `type`.","properties":{"id":{"type":"string","description":"The service account ID."},"changes_requested":{"type":"object","description":"The payload used to updated the service account.","properties":{"role":{"type":"string","description":"The role of the service account. Is either `owner` or `member`."}}}}},"service_account.deleted":{"type":"object","description":"The details for events with this `type`.","properties":{"id":{"type":"string","description":"The service account ID."}}},"user.added":{"type":"object","description":"The details for events with this `type`.","properties":{"id":{"type":"string","description":"The user ID."},"data":{"type":"object","description":"The payload used to add the user to the project.","properties":{"role":{"type":"string","description":"The role of the user. Is either `owner` or `member`."}}}}},"user.updated":{"type":"object","description":"The details for events with this `type`.","properties":{"id":{"type":"string","description":"The project ID."},"changes_requested":{"type":"object","description":"The payload used to update the user.","properties":{"role":{"type":"string","description":"The role of the user. Is either `owner` or `member`."}}}}},"user.deleted":{"type":"object","description":"The details for events with this `type`.","properties":{"id":{"type":"string","description":"The user ID."}}},"certificate.created":{"type":"object","description":"The details for events with this `type`.","properties":{"id":{"type":"string","description":"The certificate ID."},"name":{"type":"string","description":"The name of the certificate."}}},"certificate.updated":{"type":"object","description":"The details for events with this `type`.","properties":{"id":{"type":"string","description":"The certificate ID."},"name":{"type":"string","description":"The name of the certificate."}}},"certificate.deleted":{"type":"object","description":"The details for events with this `type`.","properties":{"id":{"type":"string","description":"The certificate ID."},"name":{"type":"string","description":"The name of the certificate."},"certificate":{"type":"string","description":"The certificate content in PEM format."}}},"certificates.activated":{"type":"object","description":"The details for events with this `type`.","properties":{"certificates":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The certificate ID."},"name":{"type":"string","description":"The name of the certificate."}}}}}},"certificates.deactivated":{"type":"object","description":"The details for events with this `type`.","properties":{"certificates":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The certificate ID."},"name":{"type":"string","description":"The name of the certificate."}}}}}}},"required":["id","type","effective_at","actor"],"x-oaiMeta":{"name":"The audit log object","example":"{\n \"id\": \"req_xxx_20240101\",\n \"type\": \"api_key.created\",\n \"effective_at\": 1720804090,\n \"actor\": {\n \"type\": \"session\",\n \"session\": {\n \"user\": {\n \"id\": \"user-xxx\",\n \"email\": \"user@example.com\"\n },\n \"ip_address\": \"127.0.0.1\",\n \"user_agent\": \"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/91.0.4472.124 Safari/537.36\"\n }\n },\n \"api_key.created\": {\n \"id\": \"key_xxxx\",\n \"data\": {\n \"scopes\": [\"resource.operation\"]\n }\n }\n}\n"}},"AuditLogActor":{"type":"object","description":"The actor who performed the audit logged action.","properties":{"type":{"type":"string","description":"The type of actor. Is either `session` or `api_key`.","enum":["session","api_key"]},"session":{"$ref":"#/components/schemas/AuditLogActorSession"},"api_key":{"$ref":"#/components/schemas/AuditLogActorApiKey"}}},"AuditLogActorApiKey":{"type":"object","description":"The API Key used to perform the audit logged action.","properties":{"id":{"type":"string","description":"The tracking id of the API key."},"type":{"type":"string","description":"The type of API key. Can be either `user` or `service_account`.","enum":["user","service_account"]},"user":{"$ref":"#/components/schemas/AuditLogActorUser"},"service_account":{"$ref":"#/components/schemas/AuditLogActorServiceAccount"}}},"AuditLogActorServiceAccount":{"type":"object","description":"The service account that performed the audit logged action.","properties":{"id":{"type":"string","description":"The service account id."}}},"AuditLogActorSession":{"type":"object","description":"The session in which the audit logged action was performed.","properties":{"user":{"$ref":"#/components/schemas/AuditLogActorUser"},"ip_address":{"type":"string","description":"The IP address from which the action was performed."}}},"AuditLogActorUser":{"type":"object","description":"The user who performed the audit logged action.","properties":{"id":{"type":"string","description":"The user id."},"email":{"type":"string","description":"The user email."}}},"AuditLogEventType":{"type":"string","description":"The event type.","enum":["api_key.created","api_key.updated","api_key.deleted","certificate.created","certificate.updated","certificate.deleted","certificates.activated","certificates.deactivated","checkpoint.permission.created","checkpoint.permission.deleted","external_key.registered","external_key.removed","group.created","group.updated","group.deleted","invite.sent","invite.accepted","invite.deleted","ip_allowlist.created","ip_allowlist.updated","ip_allowlist.deleted","ip_allowlist.config.activated","ip_allowlist.config.deactivated","login.succeeded","login.failed","logout.succeeded","logout.failed","organization.updated","project.created","project.updated","project.archived","project.deleted","rate_limit.updated","rate_limit.deleted","resource.deleted","tunnel.created","tunnel.updated","tunnel.deleted","role.created","role.updated","role.deleted","role.assignment.created","role.assignment.deleted","scim.enabled","scim.disabled","service_account.created","service_account.updated","service_account.deleted","user.added","user.updated","user.deleted"]},"AutoChunkingStrategyRequestParam":{"type":"object","title":"Auto Chunking Strategy","description":"The default strategy. This strategy currently uses a `max_chunk_size_tokens` of `800` and `chunk_overlap_tokens` of `400`.","additionalProperties":false,"properties":{"type":{"type":"string","description":"Always `auto`.","enum":["auto"],"x-stainless-const":true}},"required":["type"]},"Batch":{"type":"object","properties":{"id":{"type":"string"},"object":{"type":"string","enum":["batch"],"description":"The object type, which is always `batch`.","x-stainless-const":true},"endpoint":{"type":"string","description":"The OpenAI API endpoint used by the batch."},"model":{"type":"string","description":"Model ID used to process the batch, like `gpt-5-2025-08-07`. OpenAI\noffers a wide range of models with different capabilities, performance\ncharacteristics, and price points. Refer to the [model\nguide](/docs/models) to browse and compare available models.\n"},"errors":{"type":"object","properties":{"object":{"type":"string","description":"The object type, which is always `list`."},"data":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","description":"An error code identifying the error type."},"message":{"type":"string","description":"A human-readable message providing more details about the error."},"param":{"anyOf":[{"type":"string","description":"The name of the parameter that caused the error, if applicable."},{"type":"null"}]},"line":{"anyOf":[{"type":"integer","description":"The line number of the input file where the error occurred, if applicable."},{"type":"null"}]}}}}}},"input_file_id":{"type":"string","description":"The ID of the input file for the batch."},"completion_window":{"type":"string","description":"The time frame within which the batch should be processed."},"status":{"type":"string","description":"The current status of the batch.","enum":["validating","failed","in_progress","finalizing","completed","expired","cancelling","cancelled"]},"output_file_id":{"type":"string","description":"The ID of the file containing the outputs of successfully executed requests."},"error_file_id":{"type":"string","description":"The ID of the file containing the outputs of requests with errors."},"created_at":{"type":"integer","description":"The Unix timestamp (in seconds) for when the batch was created."},"in_progress_at":{"type":"integer","description":"The Unix timestamp (in seconds) for when the batch started processing."},"expires_at":{"type":"integer","description":"The Unix timestamp (in seconds) for when the batch will expire."},"finalizing_at":{"type":"integer","description":"The Unix timestamp (in seconds) for when the batch started finalizing."},"completed_at":{"type":"integer","description":"The Unix timestamp (in seconds) for when the batch was completed."},"failed_at":{"type":"integer","description":"The Unix timestamp (in seconds) for when the batch failed."},"expired_at":{"type":"integer","description":"The Unix timestamp (in seconds) for when the batch expired."},"cancelling_at":{"type":"integer","description":"The Unix timestamp (in seconds) for when the batch started cancelling."},"cancelled_at":{"type":"integer","description":"The Unix timestamp (in seconds) for when the batch was cancelled."},"request_counts":{"type":"object","properties":{"total":{"type":"integer","description":"Total number of requests in the batch."},"completed":{"type":"integer","description":"Number of requests that have been completed successfully."},"failed":{"type":"integer","description":"Number of requests that have failed."}},"required":["total","completed","failed"],"description":"The request counts for different statuses within the batch."},"usage":{"type":"object","description":"Represents token usage details including input tokens, output tokens, a\nbreakdown of output tokens, and the total tokens used. Only populated on\nbatches created after September 7, 2025.\n","properties":{"input_tokens":{"type":"integer","description":"The number of input tokens."},"input_tokens_details":{"type":"object","description":"A detailed breakdown of the input tokens.","properties":{"cached_tokens":{"type":"integer","description":"The number of tokens that were retrieved from the cache. [More on\nprompt caching](/docs/guides/prompt-caching).\n"}},"required":["cached_tokens"]},"output_tokens":{"type":"integer","description":"The number of output tokens."},"output_tokens_details":{"type":"object","description":"A detailed breakdown of the output tokens.","properties":{"reasoning_tokens":{"type":"integer","description":"The number of reasoning tokens."}},"required":["reasoning_tokens"]},"total_tokens":{"type":"integer","description":"The total number of tokens used."}},"required":["input_tokens","input_tokens_details","output_tokens","output_tokens_details","total_tokens"]},"metadata":{"$ref":"#/components/schemas/Metadata"}},"required":["id","object","endpoint","input_file_id","completion_window","status","created_at"],"x-oaiMeta":{"name":"The batch object","example":"{\n \"id\": \"batch_abc123\",\n \"object\": \"batch\",\n \"endpoint\": \"/v1/completions\",\n \"model\": \"gpt-5-2025-08-07\",\n \"errors\": null,\n \"input_file_id\": \"file-abc123\",\n \"completion_window\": \"24h\",\n \"status\": \"completed\",\n \"output_file_id\": \"file-cvaTdG\",\n \"error_file_id\": \"file-HOWS94\",\n \"created_at\": 1711471533,\n \"in_progress_at\": 1711471538,\n \"expires_at\": 1711557933,\n \"finalizing_at\": 1711493133,\n \"completed_at\": 1711493163,\n \"failed_at\": null,\n \"expired_at\": null,\n \"cancelling_at\": null,\n \"cancelled_at\": null,\n \"request_counts\": {\n \"total\": 100,\n \"completed\": 95,\n \"failed\": 5\n },\n \"usage\": {\n \"input_tokens\": 1500,\n \"input_tokens_details\": {\n \"cached_tokens\": 1024\n },\n \"output_tokens\": 500,\n \"output_tokens_details\": {\n \"reasoning_tokens\": 300\n },\n \"total_tokens\": 2000\n },\n \"metadata\": {\n \"customer_id\": \"user_123456789\",\n \"batch_description\": \"Nightly eval job\",\n }\n}\n"}},"BatchFileExpirationAfter":{"type":"object","title":"File expiration policy","description":"The expiration policy for the output and/or error file that are generated for a batch.","properties":{"anchor":{"description":"Anchor timestamp after which the expiration policy applies. Supported anchors: `created_at`. Note that the anchor is the file creation time, not the time the batch is created.","type":"string","enum":["created_at"],"x-stainless-const":true},"seconds":{"description":"The number of seconds after the anchor time that the file will expire. Must be between 3600 (1 hour) and 2592000 (30 days).","type":"integer","minimum":3600,"maximum":2592000}},"required":["anchor","seconds"]},"Certificate":{"type":"object","description":"Represents an individual `certificate` uploaded to the organization.","properties":{"object":{"type":"string","enum":["certificate","organization.certificate","organization.project.certificate"],"description":"The object type.\n\n- If creating, updating, or getting a specific certificate, the object type is `certificate`.\n- If listing, activating, or deactivating certificates for the organization, the object type is `organization.certificate`.\n- If listing, activating, or deactivating certificates for a project, the object type is `organization.project.certificate`.\n","x-stainless-const":true},"id":{"type":"string","description":"The identifier, which can be referenced in API endpoints"},"name":{"type":"string","description":"The name of the certificate."},"created_at":{"type":"integer","description":"The Unix timestamp (in seconds) of when the certificate was uploaded."},"certificate_details":{"type":"object","properties":{"valid_at":{"type":"integer","description":"The Unix timestamp (in seconds) of when the certificate becomes valid."},"expires_at":{"type":"integer","description":"The Unix timestamp (in seconds) of when the certificate expires."},"content":{"type":"string","description":"The content of the certificate in PEM format."}}},"active":{"type":"boolean","description":"Whether the certificate is currently active at the specified scope. Not returned when getting details for a specific certificate."}},"required":["object","id","name","created_at","certificate_details"],"x-oaiMeta":{"name":"The certificate object","example":"{\n \"object\": \"certificate\",\n \"id\": \"cert_abc\",\n \"name\": \"My Certificate\",\n \"created_at\": 1234567,\n \"certificate_details\": {\n \"valid_at\": 1234567,\n \"expires_at\": 12345678,\n \"content\": \"-----BEGIN CERTIFICATE----- MIIGAjCCA...6znFlOW+ -----END CERTIFICATE-----\"\n }\n}\n"}},"ChatCompletionAllowedTools":{"type":"object","title":"Allowed tools","description":"Constrains the tools available to the model to a pre-defined set.\n","properties":{"mode":{"type":"string","enum":["auto","required"],"description":"Constrains the tools available to the model to a pre-defined set.\n\n`auto` allows the model to pick from among the allowed tools and generate a\nmessage.\n\n`required` requires the model to call one or more of the allowed tools.\n"},"tools":{"type":"array","description":"A list of tool definitions that the model should be allowed to call.\n\nFor the Chat Completions API, the list of tool definitions might look like:\n```json\n[\n { \"type\": \"function\", \"function\": { \"name\": \"get_weather\" } },\n { \"type\": \"function\", \"function\": { \"name\": \"get_time\" } }\n]\n```\n","items":{"type":"object","x-oaiExpandable":false,"description":"A tool definition that the model should be allowed to call.\n","additionalProperties":true}}},"required":["mode","tools"]},"ChatCompletionAllowedToolsChoice":{"type":"object","title":"Allowed tools","description":"Constrains the tools available to the model to a pre-defined set.\n","properties":{"type":{"type":"string","enum":["allowed_tools"],"description":"Allowed tool configuration type. Always `allowed_tools`.","x-stainless-const":true},"allowed_tools":{"$ref":"#/components/schemas/ChatCompletionAllowedTools"}},"required":["type","allowed_tools"]},"ChatCompletionDeleted":{"type":"object","properties":{"object":{"type":"string","description":"The type of object being deleted.","enum":["chat.completion.deleted"],"x-stainless-const":true},"id":{"type":"string","description":"The ID of the chat completion that was deleted."},"deleted":{"type":"boolean","description":"Whether the chat completion was deleted."}},"required":["object","id","deleted"]},"ChatCompletionFunctionCallOption":{"type":"object","description":"Specifying a particular function via `{\"name\": \"my_function\"}` forces the model to call that function.\n","properties":{"name":{"type":"string","description":"The name of the function to call."}},"required":["name"]},"ChatCompletionFunctions":{"type":"object","deprecated":true,"properties":{"description":{"type":"string","description":"A description of what the function does, used by the model to choose when and how to call the function."},"name":{"type":"string","description":"The name of the function to be called. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64."},"parameters":{"$ref":"#/components/schemas/FunctionParameters"}},"required":["name"]},"ChatCompletionList":{"type":"object","title":"ChatCompletionList","description":"An object representing a list of Chat Completions.\n","properties":{"object":{"type":"string","enum":["list"],"default":"list","description":"The type of this object. It is always set to \"list\".\n","x-stainless-const":true},"data":{"type":"array","description":"An array of chat completion objects.\n","items":{"$ref":"#/components/schemas/CreateChatCompletionResponse"}},"first_id":{"type":"string","description":"The identifier of the first chat completion in the data array."},"last_id":{"type":"string","description":"The identifier of the last chat completion in the data array."},"has_more":{"type":"boolean","description":"Indicates whether there are more Chat Completions available."}},"required":["object","data","first_id","last_id","has_more"],"x-oaiMeta":{"name":"The chat completion list object","group":"chat","example":"{\n \"object\": \"list\",\n \"data\": [\n {\n \"object\": \"chat.completion\",\n \"id\": \"chatcmpl-AyPNinnUqUDYo9SAdA52NobMflmj2\",\n \"model\": \"gpt-4o-2024-08-06\",\n \"created\": 1738960610,\n \"request_id\": \"req_ded8ab984ec4bf840f37566c1011c417\",\n \"tool_choice\": null,\n \"usage\": {\n \"total_tokens\": 31,\n \"completion_tokens\": 18,\n \"prompt_tokens\": 13\n },\n \"seed\": 4944116822809979520,\n \"top_p\": 1.0,\n \"temperature\": 1.0,\n \"presence_penalty\": 0.0,\n \"frequency_penalty\": 0.0,\n \"system_fingerprint\": \"fp_50cad350e4\",\n \"input_user\": null,\n \"service_tier\": \"default\",\n \"tools\": null,\n \"metadata\": {},\n \"choices\": [\n {\n \"index\": 0,\n \"message\": {\n \"content\": \"Mind of circuits hum, \\nLearning patterns in silence— \\nFuture's quiet spark.\",\n \"role\": \"assistant\",\n \"tool_calls\": null,\n \"function_call\": null\n },\n \"finish_reason\": \"stop\",\n \"logprobs\": null\n }\n ],\n \"response_format\": null\n }\n ],\n \"first_id\": \"chatcmpl-AyPNinnUqUDYo9SAdA52NobMflmj2\",\n \"last_id\": \"chatcmpl-AyPNinnUqUDYo9SAdA52NobMflmj2\",\n \"has_more\": false\n}\n"}},"ChatCompletionMessageCustomToolCall":{"type":"object","title":"Custom tool call","description":"A call to a custom tool created by the model.\n","properties":{"id":{"type":"string","description":"The ID of the tool call."},"type":{"type":"string","enum":["custom"],"description":"The type of the tool. Always `custom`.","x-stainless-const":true},"custom":{"type":"object","description":"The custom tool that the model called.","properties":{"name":{"type":"string","description":"The name of the custom tool to call."},"input":{"type":"string","description":"The input for the custom tool call generated by the model."}},"required":["name","input"]}},"required":["id","type","custom"]},"ChatCompletionMessageList":{"type":"object","title":"ChatCompletionMessageList","description":"An object representing a list of chat completion messages.\n","properties":{"object":{"type":"string","enum":["list"],"default":"list","description":"The type of this object. It is always set to \"list\".\n","x-stainless-const":true},"data":{"type":"array","description":"An array of chat completion message objects.\n","items":{"allOf":[{"$ref":"#/components/schemas/ChatCompletionResponseMessage"},{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"The identifier of the chat message."},"content_parts":{"anyOf":[{"type":"array","description":"If a content parts array was provided, this is an array of `text` and `image_url` parts.\nOtherwise, null.\n","items":{"oneOf":[{"$ref":"#/components/schemas/ChatCompletionRequestMessageContentPartText"},{"$ref":"#/components/schemas/ChatCompletionRequestMessageContentPartImage"}]}},{"type":"null"}]}}}]}},"first_id":{"type":"string","description":"The identifier of the first chat message in the data array."},"last_id":{"type":"string","description":"The identifier of the last chat message in the data array."},"has_more":{"type":"boolean","description":"Indicates whether there are more chat messages available."}},"required":["object","data","first_id","last_id","has_more"],"x-oaiMeta":{"name":"The chat completion message list object","group":"chat","example":"{\n \"object\": \"list\",\n \"data\": [\n {\n \"id\": \"chatcmpl-AyPNinnUqUDYo9SAdA52NobMflmj2-0\",\n \"role\": \"user\",\n \"content\": \"write a haiku about ai\",\n \"name\": null,\n \"content_parts\": null\n }\n ],\n \"first_id\": \"chatcmpl-AyPNinnUqUDYo9SAdA52NobMflmj2-0\",\n \"last_id\": \"chatcmpl-AyPNinnUqUDYo9SAdA52NobMflmj2-0\",\n \"has_more\": false\n}\n"}},"ChatCompletionMessageToolCall":{"type":"object","title":"Function tool call","description":"A call to a function tool created by the model.\n","properties":{"id":{"type":"string","description":"The ID of the tool call."},"type":{"type":"string","enum":["function"],"description":"The type of the tool. Currently, only `function` is supported.","x-stainless-const":true},"function":{"type":"object","description":"The function that the model called.","properties":{"name":{"type":"string","description":"The name of the function to call."},"arguments":{"type":"string","description":"The arguments to call the function with, as generated by the model in JSON format. Note that the model does not always generate valid JSON, and may hallucinate parameters not defined by your function schema. Validate the arguments in your code before calling your function."}},"required":["name","arguments"]}},"required":["id","type","function"]},"ChatCompletionMessageToolCallChunk":{"type":"object","properties":{"index":{"type":"integer"},"id":{"type":"string","description":"The ID of the tool call."},"type":{"type":"string","enum":["function"],"description":"The type of the tool. Currently, only `function` is supported.","x-stainless-const":true},"function":{"type":"object","properties":{"name":{"type":"string","description":"The name of the function to call."},"arguments":{"type":"string","description":"The arguments to call the function with, as generated by the model in JSON format. Note that the model does not always generate valid JSON, and may hallucinate parameters not defined by your function schema. Validate the arguments in your code before calling your function."}}}},"required":["index"]},"ChatCompletionMessageToolCalls":{"type":"array","description":"The tool calls generated by the model, such as function calls.","items":{"oneOf":[{"$ref":"#/components/schemas/ChatCompletionMessageToolCall"},{"$ref":"#/components/schemas/ChatCompletionMessageCustomToolCall"}],"discriminator":{"propertyName":"type"}}},"ChatCompletionModalities":{"anyOf":[{"type":"array","description":"Output types that you would like the model to generate for this request.\nMost models are capable of generating text, which is the default:\n\n`[\"text\"]`\n\nThe `gpt-4o-audio-preview` model can also be used to [generate audio](/docs/guides/audio). To\nrequest that this model generate both text and audio responses, you can\nuse:\n\n`[\"text\", \"audio\"]`\n","items":{"type":"string","enum":["text","audio"]}},{"type":"null"}]},"ChatCompletionNamedToolChoice":{"type":"object","title":"Function tool choice","description":"Specifies a tool the model should use. Use to force the model to call a specific function.","properties":{"type":{"type":"string","enum":["function"],"description":"For function calling, the type is always `function`.","x-stainless-const":true},"function":{"type":"object","properties":{"name":{"type":"string","description":"The name of the function to call."}},"required":["name"]}},"required":["type","function"]},"ChatCompletionNamedToolChoiceCustom":{"type":"object","title":"Custom tool choice","description":"Specifies a tool the model should use. Use to force the model to call a specific custom tool.","properties":{"type":{"type":"string","enum":["custom"],"description":"For custom tool calling, the type is always `custom`.","x-stainless-const":true},"custom":{"type":"object","properties":{"name":{"type":"string","description":"The name of the custom tool to call."}},"required":["name"]}},"required":["type","custom"]},"ChatCompletionRequestAssistantMessage":{"type":"object","title":"Assistant message","description":"Messages sent by the model in response to user messages.\n","properties":{"content":{"anyOf":[{"oneOf":[{"type":"string","description":"The contents of the assistant message.","title":"Text content"},{"type":"array","description":"An array of content parts with a defined type. Can be one or more of type `text`, or exactly one of type `refusal`.","title":"Array of content parts","items":{"$ref":"#/components/schemas/ChatCompletionRequestAssistantMessageContentPart"},"minItems":1}],"description":"The contents of the assistant message. Required unless `tool_calls` or `function_call` is specified.\n"},{"type":"null"}]},"refusal":{"anyOf":[{"type":"string","description":"The refusal message by the assistant."},{"type":"null"}]},"role":{"type":"string","enum":["assistant"],"description":"The role of the messages author, in this case `assistant`.","x-stainless-const":true},"name":{"type":"string","description":"An optional name for the participant. Provides the model information to differentiate between participants of the same role."},"audio":{"anyOf":[{"type":"object","description":"Data about a previous audio response from the model.\n[Learn more](/docs/guides/audio).\n","required":["id"],"properties":{"id":{"type":"string","description":"Unique identifier for a previous audio response from the model.\n"}}},{"type":"null"}]},"tool_calls":{"$ref":"#/components/schemas/ChatCompletionMessageToolCalls"},"function_call":{"anyOf":[{"type":"object","deprecated":true,"description":"Deprecated and replaced by `tool_calls`. The name and arguments of a function that should be called, as generated by the model.","properties":{"arguments":{"type":"string","description":"The arguments to call the function with, as generated by the model in JSON format. Note that the model does not always generate valid JSON, and may hallucinate parameters not defined by your function schema. Validate the arguments in your code before calling your function."},"name":{"type":"string","description":"The name of the function to call."}},"required":["arguments","name"]},{"type":"null"}]}},"required":["role"]},"ChatCompletionRequestAssistantMessageContentPart":{"oneOf":[{"$ref":"#/components/schemas/ChatCompletionRequestMessageContentPartText"},{"$ref":"#/components/schemas/ChatCompletionRequestMessageContentPartRefusal"}],"discriminator":{"propertyName":"type"}},"ChatCompletionRequestDeveloperMessage":{"type":"object","title":"Developer message","description":"Developer-provided instructions that the model should follow, regardless of\nmessages sent by the user. With o1 models and newer, `developer` messages\nreplace the previous `system` messages.\n","properties":{"content":{"description":"The contents of the developer message.","oneOf":[{"type":"string","description":"The contents of the developer message.","title":"Text content"},{"type":"array","description":"An array of content parts with a defined type. For developer messages, only type `text` is supported.","title":"Array of content parts","items":{"$ref":"#/components/schemas/ChatCompletionRequestMessageContentPartText"},"minItems":1}]},"role":{"type":"string","enum":["developer"],"description":"The role of the messages author, in this case `developer`.","x-stainless-const":true},"name":{"type":"string","description":"An optional name for the participant. Provides the model information to differentiate between participants of the same role."}},"required":["content","role"]},"ChatCompletionRequestFunctionMessage":{"type":"object","title":"Function message","deprecated":true,"properties":{"role":{"type":"string","enum":["function"],"description":"The role of the messages author, in this case `function`.","x-stainless-const":true},"content":{"anyOf":[{"type":"string","description":"The contents of the function message."},{"type":"null"}]},"name":{"type":"string","description":"The name of the function to call."}},"required":["role","content","name"]},"ChatCompletionRequestMessage":{"oneOf":[{"$ref":"#/components/schemas/ChatCompletionRequestDeveloperMessage"},{"$ref":"#/components/schemas/ChatCompletionRequestSystemMessage"},{"$ref":"#/components/schemas/ChatCompletionRequestUserMessage"},{"$ref":"#/components/schemas/ChatCompletionRequestAssistantMessage"},{"$ref":"#/components/schemas/ChatCompletionRequestToolMessage"},{"$ref":"#/components/schemas/ChatCompletionRequestFunctionMessage"}],"discriminator":{"propertyName":"role"}},"ChatCompletionRequestMessageContentPartAudio":{"type":"object","title":"Audio content part","description":"Learn about [audio inputs](/docs/guides/audio).\n","properties":{"type":{"type":"string","enum":["input_audio"],"description":"The type of the content part. Always `input_audio`.","x-stainless-const":true},"input_audio":{"type":"object","properties":{"data":{"type":"string","description":"Base64 encoded audio data."},"format":{"type":"string","enum":["wav","mp3"],"description":"The format of the encoded audio data. Currently supports \"wav\" and \"mp3\".\n"}},"required":["data","format"]}},"required":["type","input_audio"]},"ChatCompletionRequestMessageContentPartFile":{"type":"object","title":"File content part","description":"Learn about [file inputs](/docs/guides/text) for text generation.\n","properties":{"type":{"type":"string","enum":["file"],"description":"The type of the content part. Always `file`.","x-stainless-const":true},"file":{"type":"object","properties":{"filename":{"type":"string","description":"The name of the file, used when passing the file to the model as a \nstring.\n"},"file_data":{"type":"string","description":"The base64 encoded file data, used when passing the file to the model \nas a string.\n"},"file_id":{"type":"string","description":"The ID of an uploaded file to use as input.\n"}}}},"required":["type","file"]},"ChatCompletionRequestMessageContentPartImage":{"type":"object","title":"Image content part","description":"Learn about [image inputs](/docs/guides/vision).\n","properties":{"type":{"type":"string","enum":["image_url"],"description":"The type of the content part.","x-stainless-const":true},"image_url":{"type":"object","properties":{"url":{"type":"string","description":"Either a URL of the image or the base64 encoded image data.","format":"uri"},"detail":{"type":"string","description":"Specifies the detail level of the image. Learn more in the [Vision guide](/docs/guides/vision#low-or-high-fidelity-image-understanding).","enum":["auto","low","high"],"default":"auto"}},"required":["url"]}},"required":["type","image_url"]},"ChatCompletionRequestMessageContentPartRefusal":{"type":"object","title":"Refusal content part","properties":{"type":{"type":"string","enum":["refusal"],"description":"The type of the content part.","x-stainless-const":true},"refusal":{"type":"string","description":"The refusal message generated by the model."}},"required":["type","refusal"]},"ChatCompletionRequestMessageContentPartText":{"type":"object","title":"Text content part","description":"Learn about [text inputs](/docs/guides/text-generation).\n","properties":{"type":{"type":"string","enum":["text"],"description":"The type of the content part.","x-stainless-const":true},"text":{"type":"string","description":"The text content."}},"required":["type","text"]},"ChatCompletionRequestSystemMessage":{"type":"object","title":"System message","description":"Developer-provided instructions that the model should follow, regardless of\nmessages sent by the user. With o1 models and newer, use `developer` messages\nfor this purpose instead.\n","properties":{"content":{"description":"The contents of the system message.","oneOf":[{"type":"string","description":"The contents of the system message.","title":"Text content"},{"type":"array","description":"An array of content parts with a defined type. For system messages, only type `text` is supported.","title":"Array of content parts","items":{"$ref":"#/components/schemas/ChatCompletionRequestSystemMessageContentPart"},"minItems":1}]},"role":{"type":"string","enum":["system"],"description":"The role of the messages author, in this case `system`.","x-stainless-const":true},"name":{"type":"string","description":"An optional name for the participant. Provides the model information to differentiate between participants of the same role."}},"required":["content","role"]},"ChatCompletionRequestSystemMessageContentPart":{"oneOf":[{"$ref":"#/components/schemas/ChatCompletionRequestMessageContentPartText"}]},"ChatCompletionRequestToolMessage":{"type":"object","title":"Tool message","properties":{"role":{"type":"string","enum":["tool"],"description":"The role of the messages author, in this case `tool`.","x-stainless-const":true},"content":{"oneOf":[{"type":"string","description":"The contents of the tool message.","title":"Text content"},{"type":"array","description":"An array of content parts with a defined type. For tool messages, only type `text` is supported.","title":"Array of content parts","items":{"$ref":"#/components/schemas/ChatCompletionRequestToolMessageContentPart"},"minItems":1}],"description":"The contents of the tool message."},"tool_call_id":{"type":"string","description":"Tool call that this message is responding to."}},"required":["role","content","tool_call_id"]},"ChatCompletionRequestToolMessageContentPart":{"oneOf":[{"$ref":"#/components/schemas/ChatCompletionRequestMessageContentPartText"}]},"ChatCompletionRequestUserMessage":{"type":"object","title":"User message","description":"Messages sent by an end user, containing prompts or additional context\ninformation.\n","properties":{"content":{"description":"The contents of the user message.\n","oneOf":[{"type":"string","description":"The text contents of the message.","title":"Text content"},{"type":"array","description":"An array of content parts with a defined type. Supported options differ based on the [model](/docs/models) being used to generate the response. Can contain text, image, or audio inputs.","title":"Array of content parts","items":{"$ref":"#/components/schemas/ChatCompletionRequestUserMessageContentPart"},"minItems":1}]},"role":{"type":"string","enum":["user"],"description":"The role of the messages author, in this case `user`.","x-stainless-const":true},"name":{"type":"string","description":"An optional name for the participant. Provides the model information to differentiate between participants of the same role."}},"required":["content","role"]},"ChatCompletionRequestUserMessageContentPart":{"oneOf":[{"$ref":"#/components/schemas/ChatCompletionRequestMessageContentPartText"},{"$ref":"#/components/schemas/ChatCompletionRequestMessageContentPartImage"},{"$ref":"#/components/schemas/ChatCompletionRequestMessageContentPartAudio"},{"$ref":"#/components/schemas/ChatCompletionRequestMessageContentPartFile"}]},"ChatCompletionResponseMessage":{"type":"object","description":"A chat completion message generated by the model.","properties":{"content":{"anyOf":[{"type":"string","description":"The contents of the message."},{"type":"null"}]},"refusal":{"anyOf":[{"type":"string","description":"The refusal message generated by the model."},{"type":"null"}]},"tool_calls":{"$ref":"#/components/schemas/ChatCompletionMessageToolCalls"},"annotations":{"type":"array","description":"Annotations for the message, when applicable, as when using the\n[web search tool](/docs/guides/tools-web-search?api-mode=chat).\n","items":{"type":"object","description":"A URL citation when using web search.\n","required":["type","url_citation"],"properties":{"type":{"type":"string","description":"The type of the URL citation. Always `url_citation`.","enum":["url_citation"],"x-stainless-const":true},"url_citation":{"type":"object","description":"A URL citation when using web search.","required":["end_index","start_index","url","title"],"properties":{"end_index":{"type":"integer","description":"The index of the last character of the URL citation in the message."},"start_index":{"type":"integer","description":"The index of the first character of the URL citation in the message."},"url":{"type":"string","description":"The URL of the web resource."},"title":{"type":"string","description":"The title of the web resource."}}}}}},"role":{"type":"string","enum":["assistant"],"description":"The role of the author of this message.","x-stainless-const":true},"function_call":{"type":"object","deprecated":true,"description":"Deprecated and replaced by `tool_calls`. The name and arguments of a function that should be called, as generated by the model.","properties":{"arguments":{"type":"string","description":"The arguments to call the function with, as generated by the model in JSON format. Note that the model does not always generate valid JSON, and may hallucinate parameters not defined by your function schema. Validate the arguments in your code before calling your function."},"name":{"type":"string","description":"The name of the function to call."}},"required":["name","arguments"]},"audio":{"anyOf":[{"type":"object","description":"If the audio output modality is requested, this object contains data\nabout the audio response from the model. [Learn more](/docs/guides/audio).\n","required":["id","expires_at","data","transcript"],"properties":{"id":{"type":"string","description":"Unique identifier for this audio response."},"expires_at":{"type":"integer","description":"The Unix timestamp (in seconds) for when this audio response will\nno longer be accessible on the server for use in multi-turn\nconversations.\n"},"data":{"type":"string","description":"Base64 encoded audio bytes generated by the model, in the format\nspecified in the request.\n"},"transcript":{"type":"string","description":"Transcript of the audio generated by the model."}}},{"type":"null"}]}},"required":["role","content","refusal"]},"ChatCompletionRole":{"type":"string","description":"The role of the author of a message","enum":["developer","system","user","assistant","tool","function"]},"ChatCompletionStreamOptions":{"anyOf":[{"description":"Options for streaming response. Only set this when you set `stream: true`.\n","type":"object","default":null,"properties":{"include_usage":{"type":"boolean","description":"If set, an additional chunk will be streamed before the `data: [DONE]`\nmessage. The `usage` field on this chunk shows the token usage statistics\nfor the entire request, and the `choices` field will always be an empty\narray.\n\nAll other chunks will also include a `usage` field, but with a null\nvalue. **NOTE:** If the stream is interrupted, you may not receive the\nfinal usage chunk which contains the total token usage for the request.\n"},"include_obfuscation":{"type":"boolean","description":"When true, stream obfuscation will be enabled. Stream obfuscation adds\nrandom characters to an `obfuscation` field on streaming delta events to\nnormalize payload sizes as a mitigation to certain side-channel attacks.\nThese obfuscation fields are included by default, but add a small amount\nof overhead to the data stream. You can set `include_obfuscation` to\nfalse to optimize for bandwidth if you trust the network links between\nyour application and the OpenAI API.\n"}}},{"type":"null"}]},"ChatCompletionStreamResponseDelta":{"type":"object","description":"A chat completion delta generated by streamed model responses.","properties":{"content":{"anyOf":[{"type":"string","description":"The contents of the chunk message."},{"type":"null"}]},"function_call":{"deprecated":true,"type":"object","description":"Deprecated and replaced by `tool_calls`. The name and arguments of a function that should be called, as generated by the model.","properties":{"arguments":{"type":"string","description":"The arguments to call the function with, as generated by the model in JSON format. Note that the model does not always generate valid JSON, and may hallucinate parameters not defined by your function schema. Validate the arguments in your code before calling your function."},"name":{"type":"string","description":"The name of the function to call."}}},"tool_calls":{"type":"array","items":{"$ref":"#/components/schemas/ChatCompletionMessageToolCallChunk"}},"role":{"type":"string","enum":["developer","system","user","assistant","tool"],"description":"The role of the author of this message."},"refusal":{"anyOf":[{"type":"string","description":"The refusal message generated by the model."},{"type":"null"}]}}},"ChatCompletionTokenLogprob":{"type":"object","properties":{"token":{"description":"The token.","type":"string"},"logprob":{"description":"The log probability of this token, if it is within the top 20 most likely tokens. Otherwise, the value `-9999.0` is used to signify that the token is very unlikely.","type":"number"},"bytes":{"anyOf":[{"description":"A list of integers representing the UTF-8 bytes representation of the token. Useful in instances where characters are represented by multiple tokens and their byte representations must be combined to generate the correct text representation. Can be `null` if there is no bytes representation for the token.","type":"array","items":{"type":"integer"}},{"type":"null"}]},"top_logprobs":{"description":"List of the most likely tokens and their log probability, at this token position. In rare cases, there may be fewer than the number of requested `top_logprobs` returned.","type":"array","items":{"type":"object","properties":{"token":{"description":"The token.","type":"string"},"logprob":{"description":"The log probability of this token, if it is within the top 20 most likely tokens. Otherwise, the value `-9999.0` is used to signify that the token is very unlikely.","type":"number"},"bytes":{"anyOf":[{"description":"A list of integers representing the UTF-8 bytes representation of the token. Useful in instances where characters are represented by multiple tokens and their byte representations must be combined to generate the correct text representation. Can be `null` if there is no bytes representation for the token.","type":"array","items":{"type":"integer"}},{"type":"null"}]}},"required":["token","logprob","bytes"]}}},"required":["token","logprob","bytes","top_logprobs"]},"ChatCompletionTool":{"type":"object","title":"Function tool","description":"A function tool that can be used to generate a response.\n","properties":{"type":{"type":"string","enum":["function"],"description":"The type of the tool. Currently, only `function` is supported.","x-stainless-const":true},"function":{"$ref":"#/components/schemas/FunctionObject"}},"required":["type","function"]},"ChatCompletionToolChoiceOption":{"description":"Controls which (if any) tool is called by the model.\n`none` means the model will not call any tool and instead generates a message.\n`auto` means the model can pick between generating a message or calling one or more tools.\n`required` means the model must call one or more tools.\nSpecifying a particular tool via `{\"type\": \"function\", \"function\": {\"name\": \"my_function\"}}` forces the model to call that tool.\n\n`none` is the default when no tools are present. `auto` is the default if tools are present.\n","oneOf":[{"type":"string","title":"Tool choice mode","description":"`none` means the model will not call any tool and instead generates a message. `auto` means the model can pick between generating a message or calling one or more tools. `required` means the model must call one or more tools.\n","enum":["none","auto","required"]},{"$ref":"#/components/schemas/ChatCompletionAllowedToolsChoice"},{"$ref":"#/components/schemas/ChatCompletionNamedToolChoice"},{"$ref":"#/components/schemas/ChatCompletionNamedToolChoiceCustom"}]},"ChunkingStrategyRequestParam":{"type":"object","description":"The chunking strategy used to chunk the file(s). If not set, will use the `auto` strategy.","oneOf":[{"$ref":"#/components/schemas/AutoChunkingStrategyRequestParam"},{"$ref":"#/components/schemas/StaticChunkingStrategyRequestParam"}],"discriminator":{"propertyName":"type"}},"CodeInterpreterFileOutput":{"type":"object","title":"Code interpreter file output","description":"The output of a code interpreter tool call that is a file.\n","properties":{"type":{"type":"string","enum":["files"],"description":"The type of the code interpreter file output. Always `files`.\n","x-stainless-const":true},"files":{"type":"array","items":{"type":"object","properties":{"mime_type":{"type":"string","description":"The MIME type of the file.\n"},"file_id":{"type":"string","description":"The ID of the file.\n"}},"required":["mime_type","file_id"]}}},"required":["type","files"]},"CodeInterpreterTextOutput":{"type":"object","title":"Code interpreter text output","description":"The output of a code interpreter tool call that is text.\n","properties":{"type":{"type":"string","enum":["logs"],"description":"The type of the code interpreter text output. Always `logs`.\n","x-stainless-const":true},"logs":{"type":"string","description":"The logs of the code interpreter tool call.\n"}},"required":["type","logs"]},"CodeInterpreterTool":{"type":"object","title":"Code interpreter","description":"A tool that runs Python code to help generate a response to a prompt.\n","properties":{"type":{"type":"string","enum":["code_interpreter"],"description":"The type of the code interpreter tool. Always `code_interpreter`.\n","x-stainless-const":true},"container":{"description":"The code interpreter container. Can be a container ID or an object that\nspecifies uploaded file IDs to make available to your code, along with an\noptional `memory_limit` setting.\n","oneOf":[{"type":"string","description":"The container ID."},{"$ref":"#/components/schemas/AutoCodeInterpreterToolParam"}]}},"required":["type","container"]},"CodeInterpreterToolCall":{"type":"object","title":"Code interpreter tool call","description":"A tool call to run code.\n","properties":{"type":{"type":"string","enum":["code_interpreter_call"],"default":"code_interpreter_call","x-stainless-const":true,"description":"The type of the code interpreter tool call. Always `code_interpreter_call`.\n"},"id":{"type":"string","description":"The unique ID of the code interpreter tool call.\n"},"status":{"type":"string","enum":["in_progress","completed","incomplete","interpreting","failed"],"description":"The status of the code interpreter tool call. Valid values are `in_progress`, `completed`, `incomplete`, `interpreting`, and `failed`.\n"},"container_id":{"type":"string","description":"The ID of the container used to run the code.\n"},"code":{"anyOf":[{"type":"string","description":"The code to run, or null if not available.\n"},{"type":"null"}]},"outputs":{"anyOf":[{"type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/CodeInterpreterOutputLogs"},{"$ref":"#/components/schemas/CodeInterpreterOutputImage"}],"discriminator":{"propertyName":"type"}},"discriminator":{"propertyName":"type"},"description":"The outputs generated by the code interpreter, such as logs or images.\nCan be null if no outputs are available.\n"},{"type":"null"}]}},"required":["type","id","status","container_id","code","outputs"]},"ComparisonFilter":{"type":"object","additionalProperties":false,"title":"Comparison Filter","description":"A filter used to compare a specified attribute key to a given value using a defined comparison operation.\n","properties":{"type":{"type":"string","default":"eq","enum":["eq","ne","gt","gte","lt","lte","in","nin"],"description":"Specifies the comparison operator: `eq`, `ne`, `gt`, `gte`, `lt`, `lte`, `in`, `nin`.\n- `eq`: equals\n- `ne`: not equal\n- `gt`: greater than\n- `gte`: greater than or equal\n- `lt`: less than\n- `lte`: less than or equal\n- `in`: in\n- `nin`: not in\n"},"key":{"type":"string","description":"The key to compare against the value."},"value":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"oneOf":[{"type":"string"},{"type":"number"}]}}],"description":"The value to compare against the attribute key; supports string, number, or boolean types."}},"required":["type","key","value"],"x-oaiMeta":{"name":"ComparisonFilter"}},"CompleteUploadRequest":{"type":"object","additionalProperties":false,"properties":{"part_ids":{"type":"array","description":"The ordered list of Part IDs.\n","items":{"type":"string"}},"md5":{"description":"The optional md5 checksum for the file contents to verify if the bytes uploaded matches what you expect.\n","type":"string"}},"required":["part_ids"]},"CompletionUsage":{"type":"object","description":"Usage statistics for the completion request.","properties":{"completion_tokens":{"type":"integer","default":0,"description":"Number of tokens in the generated completion."},"prompt_tokens":{"type":"integer","default":0,"description":"Number of tokens in the prompt."},"total_tokens":{"type":"integer","default":0,"description":"Total number of tokens used in the request (prompt + completion)."},"completion_tokens_details":{"type":"object","description":"Breakdown of tokens used in a completion.","properties":{"accepted_prediction_tokens":{"type":"integer","default":0,"description":"When using Predicted Outputs, the number of tokens in the\nprediction that appeared in the completion.\n"},"audio_tokens":{"type":"integer","default":0,"description":"Audio input tokens generated by the model."},"reasoning_tokens":{"type":"integer","default":0,"description":"Tokens generated by the model for reasoning."},"rejected_prediction_tokens":{"type":"integer","default":0,"description":"When using Predicted Outputs, the number of tokens in the\nprediction that did not appear in the completion. However, like\nreasoning tokens, these tokens are still counted in the total\ncompletion tokens for purposes of billing, output, and context window\nlimits.\n"}}},"prompt_tokens_details":{"type":"object","description":"Breakdown of tokens used in the prompt.","properties":{"audio_tokens":{"type":"integer","default":0,"description":"Audio input tokens present in the prompt."},"cached_tokens":{"type":"integer","default":0,"description":"Cached tokens present in the prompt."}}}},"required":["prompt_tokens","completion_tokens","total_tokens"]},"CompoundFilter":{"$recursiveAnchor":true,"type":"object","additionalProperties":false,"title":"Compound Filter","description":"Combine multiple filters using `and` or `or`.","properties":{"type":{"type":"string","description":"Type of operation: `and` or `or`.","enum":["and","or"]},"filters":{"type":"array","description":"Array of filters to combine. Items can be `ComparisonFilter` or `CompoundFilter`.","items":{"oneOf":[{"$ref":"#/components/schemas/ComparisonFilter"},{"$recursiveRef":"#"}],"discriminator":{"propertyName":"type"}}}},"required":["type","filters"],"x-oaiMeta":{"name":"CompoundFilter"}},"ComputerAction":{"oneOf":[{"$ref":"#/components/schemas/ClickParam"},{"$ref":"#/components/schemas/DoubleClickAction"},{"$ref":"#/components/schemas/DragParam"},{"$ref":"#/components/schemas/KeyPressAction"},{"$ref":"#/components/schemas/MoveParam"},{"$ref":"#/components/schemas/ScreenshotParam"},{"$ref":"#/components/schemas/ScrollParam"},{"$ref":"#/components/schemas/TypeParam"},{"$ref":"#/components/schemas/WaitParam"}],"discriminator":{"propertyName":"type"}},"ComputerActionList":{"title":"Computer Action List","type":"array","description":"Flattened batched actions for `computer_use`. Each action includes an\n`type` discriminator and action-specific fields.\n","items":{"$ref":"#/components/schemas/ComputerAction"}},"ComputerScreenshotImage":{"type":"object","description":"A computer screenshot image used with the computer use tool.\n","properties":{"type":{"type":"string","enum":["computer_screenshot"],"default":"computer_screenshot","description":"Specifies the event type. For a computer screenshot, this property is \nalways set to `computer_screenshot`.\n","x-stainless-const":true},"image_url":{"type":"string","description":"The URL of the screenshot image."},"file_id":{"type":"string","description":"The identifier of an uploaded file that contains the screenshot."}},"required":["type"]},"ComputerToolCall":{"type":"object","title":"Computer tool call","description":"A tool call to a computer use tool. See the\n[computer use guide](/docs/guides/tools-computer-use) for more information.\n","properties":{"type":{"type":"string","description":"The type of the computer call. Always `computer_call`.","enum":["computer_call"],"default":"computer_call"},"id":{"type":"string","description":"The unique ID of the computer call."},"call_id":{"type":"string","description":"An identifier used when responding to the tool call with output.\n"},"action":{"$ref":"#/components/schemas/ComputerAction"},"actions":{"$ref":"#/components/schemas/ComputerActionList"},"pending_safety_checks":{"type":"array","items":{"$ref":"#/components/schemas/ComputerCallSafetyCheckParam"},"description":"The pending safety checks for the computer call.\n"},"status":{"type":"string","description":"The status of the item. One of `in_progress`, `completed`, or\n`incomplete`. Populated when items are returned via API.\n","enum":["in_progress","completed","incomplete"]}},"required":["type","id","call_id","pending_safety_checks","status"]},"ComputerToolCallOutput":{"type":"object","title":"Computer tool call output","description":"The output of a computer tool call.\n","properties":{"type":{"type":"string","description":"The type of the computer tool call output. Always `computer_call_output`.\n","enum":["computer_call_output"],"default":"computer_call_output","x-stainless-const":true},"id":{"type":"string","description":"The ID of the computer tool call output.\n"},"call_id":{"type":"string","description":"The ID of the computer tool call that produced the output.\n"},"acknowledged_safety_checks":{"type":"array","description":"The safety checks reported by the API that have been acknowledged by the\ndeveloper.\n","items":{"$ref":"#/components/schemas/ComputerCallSafetyCheckParam"}},"output":{"$ref":"#/components/schemas/ComputerScreenshotImage"},"status":{"type":"string","description":"The status of the message input. One of `in_progress`, `completed`, or\n`incomplete`. Populated when input items are returned via API.\n","enum":["in_progress","completed","incomplete"]}},"required":["type","call_id","output"]},"ComputerToolCallOutputResource":{"allOf":[{"$ref":"#/components/schemas/ComputerToolCallOutput"},{"type":"object","properties":{"id":{"type":"string","description":"The unique ID of the computer call tool output.\n"},"status":{"description":"The status of the message input. One of `in_progress`, `completed`, or\n`incomplete`. Populated when input items are returned via API.\n","$ref":"#/components/schemas/ComputerCallOutputStatus"},"created_by":{"type":"string","description":"The identifier of the actor that created the item.\n"}},"required":["id","status"]}]},"ContainerFileListResource":{"type":"object","properties":{"object":{"type":"string","enum":["list"],"description":"The type of object returned, must be 'list'."},"data":{"type":"array","description":"A list of container files.","items":{"$ref":"#/components/schemas/ContainerFileResource"}},"first_id":{"type":"string","description":"The ID of the first file in the list."},"last_id":{"type":"string","description":"The ID of the last file in the list."},"has_more":{"type":"boolean","description":"Whether there are more files available."}},"required":["object","data","first_id","last_id","has_more"]},"ContainerFileResource":{"type":"object","title":"The container file object","properties":{"id":{"type":"string","description":"Unique identifier for the file."},"object":{"type":"string","description":"The type of this object (`container.file`)."},"container_id":{"type":"string","description":"The container this file belongs to."},"created_at":{"type":"integer","description":"Unix timestamp (in seconds) when the file was created."},"bytes":{"type":"integer","description":"Size of the file in bytes."},"path":{"type":"string","description":"Path of the file in the container."},"source":{"type":"string","description":"Source of the file (e.g., `user`, `assistant`)."}},"required":["id","object","created_at","bytes","container_id","path","source"],"x-oaiMeta":{"name":"The container file object","example":"{\n \"id\": \"cfile_682e0e8a43c88191a7978f477a09bdf5\",\n \"object\": \"container.file\",\n \"created_at\": 1747848842,\n \"bytes\": 880,\n \"container_id\": \"cntr_682e0e7318108198aa783fd921ff305e08e78805b9fdbb04\",\n \"path\": \"/mnt/data/88e12fa445d32636f190a0b33daed6cb-tsconfig.json\",\n \"source\": \"user\"\n}\n"}},"ContainerListResource":{"type":"object","properties":{"object":{"type":"string","enum":["list"],"description":"The type of object returned, must be 'list'."},"data":{"type":"array","description":"A list of containers.","items":{"$ref":"#/components/schemas/ContainerResource"}},"first_id":{"type":"string","description":"The ID of the first container in the list."},"last_id":{"type":"string","description":"The ID of the last container in the list."},"has_more":{"type":"boolean","description":"Whether there are more containers available."}},"required":["object","data","first_id","last_id","has_more"]},"ContainerResource":{"type":"object","title":"The container object","properties":{"id":{"type":"string","description":"Unique identifier for the container."},"object":{"type":"string","description":"The type of this object."},"name":{"type":"string","description":"Name of the container."},"created_at":{"type":"integer","description":"Unix timestamp (in seconds) when the container was created."},"status":{"type":"string","description":"Status of the container (e.g., active, deleted)."},"last_active_at":{"type":"integer","description":"Unix timestamp (in seconds) when the container was last active."},"expires_after":{"type":"object","description":"The container will expire after this time period.\nThe anchor is the reference point for the expiration.\nThe minutes is the number of minutes after the anchor before the container expires.\n","properties":{"anchor":{"type":"string","description":"The reference point for the expiration.","enum":["last_active_at"]},"minutes":{"type":"integer","description":"The number of minutes after the anchor before the container expires."}}},"memory_limit":{"type":"string","description":"The memory limit configured for the container.","enum":["1g","4g","16g","64g"]},"network_policy":{"description":"Network access policy for the container.","type":"object","properties":{"type":{"type":"string","description":"The network policy mode.","enum":["allowlist","disabled"]},"allowed_domains":{"type":"array","description":"Allowed outbound domains when `type` is `allowlist`.","items":{"type":"string"}}},"required":["type"]}},"required":["id","object","name","created_at","status","id","name","created_at","status"],"x-oaiMeta":{"name":"The container object","example":"{\n \"id\": \"cntr_682dfebaacac8198bbfe9c2474fb6f4a085685cbe3cb5863\",\n \"object\": \"container\",\n \"created_at\": 1747844794,\n \"status\": \"running\",\n \"expires_after\": {\n \"anchor\": \"last_active_at\",\n \"minutes\": 20\n },\n \"last_active_at\": 1747844794,\n \"memory_limit\": \"1g\",\n \"name\": \"My Container\"\n}\n"}},"Content":{"description":"Multi-modal input and output contents.\n","oneOf":[{"title":"Input content types","$ref":"#/components/schemas/InputContent"},{"title":"Output content types","$ref":"#/components/schemas/OutputContent"}]},"ConversationItem":{"title":"Conversation item","description":"A single item within a conversation. The set of possible types are the same as the `output` type of a [Response object](/docs/api-reference/responses/object#responses/object-output).","oneOf":[{"$ref":"#/components/schemas/Message"},{"$ref":"#/components/schemas/FunctionToolCallResource"},{"$ref":"#/components/schemas/FunctionToolCallOutputResource"},{"$ref":"#/components/schemas/FileSearchToolCall"},{"$ref":"#/components/schemas/WebSearchToolCall"},{"$ref":"#/components/schemas/ImageGenToolCall"},{"$ref":"#/components/schemas/ComputerToolCall"},{"$ref":"#/components/schemas/ComputerToolCallOutputResource"},{"$ref":"#/components/schemas/ToolSearchCall"},{"$ref":"#/components/schemas/ToolSearchOutput"},{"$ref":"#/components/schemas/ReasoningItem"},{"$ref":"#/components/schemas/CompactionBody"},{"$ref":"#/components/schemas/CodeInterpreterToolCall"},{"$ref":"#/components/schemas/LocalShellToolCall"},{"$ref":"#/components/schemas/LocalShellToolCallOutput"},{"$ref":"#/components/schemas/FunctionShellCall"},{"$ref":"#/components/schemas/FunctionShellCallOutput"},{"$ref":"#/components/schemas/ApplyPatchToolCall"},{"$ref":"#/components/schemas/ApplyPatchToolCallOutput"},{"$ref":"#/components/schemas/MCPListTools"},{"$ref":"#/components/schemas/MCPApprovalRequest"},{"$ref":"#/components/schemas/MCPApprovalResponseResource"},{"$ref":"#/components/schemas/MCPToolCall"},{"$ref":"#/components/schemas/CustomToolCall"},{"$ref":"#/components/schemas/CustomToolCallOutput"}],"discriminator":{"propertyName":"type"}},"ConversationItemList":{"type":"object","title":"The conversation item list","description":"A list of Conversation items.","properties":{"object":{"type":"string","description":"The type of object returned, must be `list`.","enum":["list"],"x-stainless-const":true},"data":{"type":"array","description":"A list of conversation items.","items":{"$ref":"#/components/schemas/ConversationItem"}},"has_more":{"type":"boolean","description":"Whether there are more items available."},"first_id":{"type":"string","description":"The ID of the first item in the list."},"last_id":{"type":"string","description":"The ID of the last item in the list."}},"required":["object","data","has_more","first_id","last_id"],"x-oaiMeta":{"name":"The item list","group":"conversations"}},"ConversationParam":{"description":"The conversation that this response belongs to. Items from this conversation are prepended to `input_items` for this response request.\nInput items and output items from this response are automatically added to this conversation after this response completes.\n","default":null,"oneOf":[{"type":"string","title":"Conversation ID","description":"The unique ID of the conversation.\n"},{"$ref":"#/components/schemas/ConversationParam-2"}]},"CostsResult":{"type":"object","description":"The aggregated costs details of the specific time bucket.","properties":{"object":{"type":"string","enum":["organization.costs.result"],"x-stainless-const":true},"amount":{"type":"object","description":"The monetary value in its associated currency.","properties":{"value":{"type":"number","description":"The numeric value of the cost."},"currency":{"type":"string","description":"Lowercase ISO-4217 currency e.g. \"usd\""}}},"line_item":{"anyOf":[{"type":"string","description":"When `group_by=line_item`, this field provides the line item of the grouped costs result."},{"type":"null"}]},"project_id":{"anyOf":[{"type":"string","description":"When `group_by=project_id`, this field provides the project ID of the grouped costs result."},{"type":"null"}]}},"required":["object"],"x-oaiMeta":{"name":"Costs object","example":"{\n \"object\": \"organization.costs.result\",\n \"amount\": {\n \"value\": 0.06,\n \"currency\": \"usd\"\n },\n \"line_item\": \"Image models\",\n \"project_id\": \"proj_abc\"\n}\n"}},"CreateAssistantRequest":{"type":"object","additionalProperties":false,"properties":{"model":{"description":"ID of the model to use. You can use the [List models](/docs/api-reference/models/list) API to see all of your available models, or see our [Model overview](/docs/models) for descriptions of them.\n","example":"gpt-4o","anyOf":[{"type":"string"},{"$ref":"#/components/schemas/AssistantSupportedModels"}],"x-oaiTypeLabel":"string"},"name":{"anyOf":[{"description":"The name of the assistant. The maximum length is 256 characters.\n","type":"string","maxLength":256},{"type":"null"}]},"description":{"anyOf":[{"description":"The description of the assistant. The maximum length is 512 characters.\n","type":"string","maxLength":512},{"type":"null"}]},"instructions":{"anyOf":[{"description":"The system instructions that the assistant uses. The maximum length is 256,000 characters.\n","type":"string","maxLength":256000},{"type":"null"}]},"reasoning_effort":{"$ref":"#/components/schemas/ReasoningEffort"},"tools":{"description":"A list of tool enabled on the assistant. There can be a maximum of 128 tools per assistant. Tools can be of types `code_interpreter`, `file_search`, or `function`.\n","default":[],"type":"array","maxItems":128,"items":{"oneOf":[{"$ref":"#/components/schemas/AssistantToolsCode"},{"$ref":"#/components/schemas/AssistantToolsFileSearch"},{"$ref":"#/components/schemas/AssistantToolsFunction"}]}},"tool_resources":{"anyOf":[{"type":"object","description":"A set of resources that are used by the assistant's tools. The resources are specific to the type of tool. For example, the `code_interpreter` tool requires a list of file IDs, while the `file_search` tool requires a list of vector store IDs.\n","properties":{"code_interpreter":{"type":"object","properties":{"file_ids":{"type":"array","description":"A list of [file](/docs/api-reference/files) IDs made available to the `code_interpreter` tool. There can be a maximum of 20 files associated with the tool.\n","default":[],"maxItems":20,"items":{"type":"string"}}}},"file_search":{"type":"object","properties":{"vector_store_ids":{"type":"array","description":"The [vector store](/docs/api-reference/vector-stores/object) attached to this assistant. There can be a maximum of 1 vector store attached to the assistant.\n","maxItems":1,"items":{"type":"string"}},"vector_stores":{"type":"array","description":"A helper to create a [vector store](/docs/api-reference/vector-stores/object) with file_ids and attach it to this assistant. There can be a maximum of 1 vector store attached to the assistant.\n","maxItems":1,"items":{"type":"object","properties":{"file_ids":{"type":"array","description":"A list of [file](/docs/api-reference/files) IDs to add to the vector store. For vector stores created before Nov 2025, there can be a maximum of 10,000 files in a vector store. For vector stores created starting in Nov 2025, the limit is 100,000,000 files.\n","maxItems":100000000,"items":{"type":"string"}},"chunking_strategy":{"type":"object","description":"The chunking strategy used to chunk the file(s). If not set, will use the `auto` strategy.","oneOf":[{"type":"object","title":"Auto Chunking Strategy","description":"The default strategy. This strategy currently uses a `max_chunk_size_tokens` of `800` and `chunk_overlap_tokens` of `400`.","additionalProperties":false,"properties":{"type":{"type":"string","description":"Always `auto`.","enum":["auto"],"x-stainless-const":true}},"required":["type"]},{"type":"object","title":"Static Chunking Strategy","additionalProperties":false,"properties":{"type":{"type":"string","description":"Always `static`.","enum":["static"],"x-stainless-const":true},"static":{"type":"object","additionalProperties":false,"properties":{"max_chunk_size_tokens":{"type":"integer","minimum":100,"maximum":4096,"description":"The maximum number of tokens in each chunk. The default value is `800`. The minimum value is `100` and the maximum value is `4096`."},"chunk_overlap_tokens":{"type":"integer","description":"The number of tokens that overlap between chunks. The default value is `400`.\n\nNote that the overlap must not exceed half of `max_chunk_size_tokens`.\n"}},"required":["max_chunk_size_tokens","chunk_overlap_tokens"]}},"required":["type","static"]}]},"metadata":{"$ref":"#/components/schemas/Metadata"}}}}},"oneOf":[{"required":["vector_store_ids"]},{"required":["vector_stores"]}]}}},{"type":"null"}]},"metadata":{"$ref":"#/components/schemas/Metadata"},"temperature":{"anyOf":[{"description":"What sampling temperature to use, between 0 and 2. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic.\n","type":"number","minimum":0,"maximum":2,"default":1,"example":1},{"type":"null"}]},"top_p":{"anyOf":[{"type":"number","minimum":0,"maximum":1,"default":1,"example":1,"description":"An alternative to sampling with temperature, called nucleus sampling, where the model considers the results of the tokens with top_p probability mass. So 0.1 means only the tokens comprising the top 10% probability mass are considered.\n\nWe generally recommend altering this or temperature but not both.\n"},{"type":"null"}]},"response_format":{"anyOf":[{"$ref":"#/components/schemas/AssistantsApiResponseFormatOption"},{"type":"null"}]}},"required":["model"]},"CreateChatCompletionRequest":{"allOf":[{"$ref":"#/components/schemas/CreateModelResponseProperties"},{"type":"object","properties":{"messages":{"description":"A list of messages comprising the conversation so far. Depending on the\n[model](/docs/models) you use, different message types (modalities) are\nsupported, like [text](/docs/guides/text-generation),\n[images](/docs/guides/vision), and [audio](/docs/guides/audio).\n","type":"array","minItems":1,"items":{"$ref":"#/components/schemas/ChatCompletionRequestMessage"}},"model":{"description":"Model ID used to generate the response, like `gpt-4o` or `o3`. OpenAI\noffers a wide range of models with different capabilities, performance\ncharacteristics, and price points. Refer to the [model guide](/docs/models)\nto browse and compare available models.\n","$ref":"#/components/schemas/ModelIdsShared"},"modalities":{"$ref":"#/components/schemas/ResponseModalities"},"verbosity":{"$ref":"#/components/schemas/Verbosity"},"reasoning_effort":{"$ref":"#/components/schemas/ReasoningEffort"},"max_completion_tokens":{"description":"An upper bound for the number of tokens that can be generated for a completion, including visible output tokens and [reasoning tokens](/docs/guides/reasoning).\n","type":"integer","nullable":true},"frequency_penalty":{"type":"number","default":0,"minimum":-2,"maximum":2,"nullable":true,"description":"Number between -2.0 and 2.0. Positive values penalize new tokens based on\ntheir existing frequency in the text so far, decreasing the model's\nlikelihood to repeat the same line verbatim.\n"},"presence_penalty":{"type":"number","default":0,"minimum":-2,"maximum":2,"nullable":true,"description":"Number between -2.0 and 2.0. Positive values penalize new tokens based on\nwhether they appear in the text so far, increasing the model's likelihood\nto talk about new topics.\n"},"web_search_options":{"type":"object","title":"Web search","description":"This tool searches the web for relevant results to use in a response.\nLearn more about the [web search tool](/docs/guides/tools-web-search?api-mode=chat).\n","properties":{"user_location":{"type":"object","nullable":true,"required":["type","approximate"],"description":"Approximate location parameters for the search.\n","properties":{"type":{"type":"string","description":"The type of location approximation. Always `approximate`.\n","enum":["approximate"],"x-stainless-const":true},"approximate":{"$ref":"#/components/schemas/WebSearchLocation"}}},"search_context_size":{"$ref":"#/components/schemas/WebSearchContextSize"}}},"top_logprobs":{"description":"An integer between 0 and 20 specifying the number of most likely tokens to\nreturn at each token position, each with an associated log probability.\n`logprobs` must be set to `true` if this parameter is used.\n","type":"integer","minimum":0,"maximum":20,"nullable":true},"response_format":{"description":"An object specifying the format that the model must output.\n\nSetting to `{ \"type\": \"json_schema\", \"json_schema\": {...} }` enables\nStructured Outputs which ensures the model will match your supplied JSON\nschema. Learn more in the [Structured Outputs\nguide](/docs/guides/structured-outputs).\n\nSetting to `{ \"type\": \"json_object\" }` enables the older JSON mode, which\nensures the message the model generates is valid JSON. Using `json_schema`\nis preferred for models that support it.\n","oneOf":[{"$ref":"#/components/schemas/ResponseFormatText"},{"$ref":"#/components/schemas/ResponseFormatJsonSchema"},{"$ref":"#/components/schemas/ResponseFormatJsonObject"}],"discriminator":{"propertyName":"type"}},"audio":{"type":"object","nullable":true,"description":"Parameters for audio output. Required when audio output is requested with\n`modalities: [\"audio\"]`. [Learn more](/docs/guides/audio).\n","required":["voice","format"],"properties":{"voice":{"$ref":"#/components/schemas/VoiceIdsOrCustomVoice","description":"The voice the model uses to respond. Supported built-in voices are\n`alloy`, `ash`, `ballad`, `coral`, `echo`, `fable`, `nova`, `onyx`,\n`sage`, `shimmer`, `marin`, and `cedar`. You may also provide a\ncustom voice object with an `id`, for example `{ \"id\": \"voice_1234\" }`.\n"},"format":{"type":"string","enum":["wav","aac","mp3","flac","opus","pcm16"],"description":"Specifies the output audio format. Must be one of `wav`, `mp3`, `flac`,\n`opus`, or `pcm16`.\n"}}},"store":{"type":"boolean","default":false,"nullable":true,"description":"Whether or not to store the output of this chat completion request for\nuse in our [model distillation](/docs/guides/distillation) or\n[evals](/docs/guides/evals) products.\n\nSupports text and image inputs. Note: image inputs over 8MB will be dropped.\n"},"stream":{"description":"If set to true, the model response data will be streamed to the client\nas it is generated using [server-sent events](https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events/Using_server-sent_events#Event_stream_format).\nSee the [Streaming section below](/docs/api-reference/chat/streaming)\nfor more information, along with the [streaming responses](/docs/guides/streaming-responses)\nguide for more information on how to handle the streaming events.\n","type":"boolean","nullable":true,"default":false},"stop":{"$ref":"#/components/schemas/StopConfiguration"},"logit_bias":{"type":"object","x-oaiTypeLabel":"map","default":null,"nullable":true,"additionalProperties":{"type":"integer"},"description":"Modify the likelihood of specified tokens appearing in the completion.\n\nAccepts a JSON object that maps tokens (specified by their token ID in the\ntokenizer) to an associated bias value from -100 to 100. Mathematically,\nthe bias is added to the logits generated by the model prior to sampling.\nThe exact effect will vary per model, but values between -1 and 1 should\ndecrease or increase likelihood of selection; values like -100 or 100\nshould result in a ban or exclusive selection of the relevant token.\n"},"logprobs":{"description":"Whether to return log probabilities of the output tokens or not. If true,\nreturns the log probabilities of each output token returned in the\n`content` of `message`.\n","type":"boolean","default":false,"nullable":true},"max_tokens":{"description":"The maximum number of [tokens](/tokenizer) that can be generated in the\nchat completion. This value can be used to control\n[costs](https://openai.com/api/pricing/) for text generated via API.\n\nThis value is now deprecated in favor of `max_completion_tokens`, and is\nnot compatible with [o-series models](/docs/guides/reasoning).\n","type":"integer","nullable":true,"deprecated":true},"n":{"type":"integer","minimum":1,"maximum":128,"default":1,"example":1,"nullable":true,"description":"How many chat completion choices to generate for each input message. Note that you will be charged based on the number of generated tokens across all of the choices. Keep `n` as `1` to minimize costs."},"prediction":{"nullable":true,"description":"Configuration for a [Predicted Output](/docs/guides/predicted-outputs),\nwhich can greatly improve response times when large parts of the model\nresponse are known ahead of time. This is most common when you are\nregenerating a file with only minor changes to most of the content.\n","oneOf":[{"$ref":"#/components/schemas/PredictionContent"}]},"seed":{"type":"integer","minimum":-9223372036854776000,"maximum":9223372036854776000,"nullable":true,"deprecated":true,"description":"This feature is in Beta.\nIf specified, our system will make a best effort to sample deterministically, such that repeated requests with the same `seed` and parameters should return the same result.\nDeterminism is not guaranteed, and you should refer to the `system_fingerprint` response parameter to monitor changes in the backend.\n","x-oaiMeta":{"beta":true}},"stream_options":{"$ref":"#/components/schemas/ChatCompletionStreamOptions"},"tools":{"type":"array","description":"A list of tools the model may call. You can provide either\n[custom tools](/docs/guides/function-calling#custom-tools) or\n[function tools](/docs/guides/function-calling).\n","items":{"oneOf":[{"$ref":"#/components/schemas/ChatCompletionTool"},{"$ref":"#/components/schemas/CustomToolChatCompletions"}]}},"tool_choice":{"$ref":"#/components/schemas/ChatCompletionToolChoiceOption"},"parallel_tool_calls":{"$ref":"#/components/schemas/ParallelToolCalls"},"function_call":{"deprecated":true,"description":"Deprecated in favor of `tool_choice`.\n\nControls which (if any) function is called by the model.\n\n`none` means the model will not call a function and instead generates a\nmessage.\n\n`auto` means the model can pick between generating a message or calling a\nfunction.\n\nSpecifying a particular function via `{\"name\": \"my_function\"}` forces the\nmodel to call that function.\n\n`none` is the default when no functions are present. `auto` is the default\nif functions are present.\n","oneOf":[{"type":"string","description":"`none` means the model will not call a function and instead generates a message. `auto` means the model can pick between generating a message or calling a function.\n","enum":["none","auto"]},{"$ref":"#/components/schemas/ChatCompletionFunctionCallOption"}]},"functions":{"deprecated":true,"description":"Deprecated in favor of `tools`.\n\nA list of functions the model may generate JSON inputs for.\n","type":"array","minItems":1,"maxItems":128,"items":{"$ref":"#/components/schemas/ChatCompletionFunctions"}}},"required":["model","messages"]}]},"CreateChatCompletionResponse":{"type":"object","description":"Represents a chat completion response returned by model, based on the provided input.","properties":{"id":{"type":"string","description":"A unique identifier for the chat completion."},"choices":{"type":"array","description":"A list of chat completion choices. Can be more than one if `n` is greater than 1.","items":{"type":"object","required":["finish_reason","index","message","logprobs"],"properties":{"finish_reason":{"type":"string","description":"The reason the model stopped generating tokens. This will be `stop` if the model hit a natural stop point or a provided stop sequence,\n`length` if the maximum number of tokens specified in the request was reached,\n`content_filter` if content was omitted due to a flag from our content filters,\n`tool_calls` if the model called a tool, or `function_call` (deprecated) if the model called a function.\n","enum":["stop","length","tool_calls","content_filter","function_call"]},"index":{"type":"integer","description":"The index of the choice in the list of choices."},"message":{"$ref":"#/components/schemas/ChatCompletionResponseMessage"},"logprobs":{"anyOf":[{"description":"Log probability information for the choice.","type":"object","properties":{"content":{"anyOf":[{"description":"A list of message content tokens with log probability information.","type":"array","items":{"$ref":"#/components/schemas/ChatCompletionTokenLogprob"}},{"type":"null"}]},"refusal":{"anyOf":[{"description":"A list of message refusal tokens with log probability information.","type":"array","items":{"$ref":"#/components/schemas/ChatCompletionTokenLogprob"}},{"type":"null"}]}},"required":["content","refusal"]},{"type":"null"}]}}}},"created":{"type":"integer","description":"The Unix timestamp (in seconds) of when the chat completion was created."},"model":{"type":"string","description":"The model used for the chat completion."},"service_tier":{"$ref":"#/components/schemas/ServiceTier"},"system_fingerprint":{"type":"string","deprecated":true,"description":"This fingerprint represents the backend configuration that the model runs with.\n\nCan be used in conjunction with the `seed` request parameter to understand when backend changes have been made that might impact determinism.\n"},"object":{"type":"string","description":"The object type, which is always `chat.completion`.","enum":["chat.completion"],"x-stainless-const":true},"usage":{"$ref":"#/components/schemas/CompletionUsage"}},"required":["choices","created","id","model","object"],"x-oaiMeta":{"name":"The chat completion object","group":"chat","example":"{\n \"id\": \"chatcmpl-B9MHDbslfkBeAs8l4bebGdFOJ6PeG\",\n \"object\": \"chat.completion\",\n \"created\": 1741570283,\n \"model\": \"gpt-4o-2024-08-06\",\n \"choices\": [\n {\n \"index\": 0,\n \"message\": {\n \"role\": \"assistant\",\n \"content\": \"The image shows a wooden boardwalk path running through a lush green field or meadow. The sky is bright blue with some scattered clouds, giving the scene a serene and peaceful atmosphere. Trees and shrubs are visible in the background.\",\n \"refusal\": null,\n \"annotations\": []\n },\n \"logprobs\": null,\n \"finish_reason\": \"stop\"\n }\n ],\n \"usage\": {\n \"prompt_tokens\": 1117,\n \"completion_tokens\": 46,\n \"total_tokens\": 1163,\n \"prompt_tokens_details\": {\n \"cached_tokens\": 0,\n \"audio_tokens\": 0\n },\n \"completion_tokens_details\": {\n \"reasoning_tokens\": 0,\n \"audio_tokens\": 0,\n \"accepted_prediction_tokens\": 0,\n \"rejected_prediction_tokens\": 0\n }\n },\n \"service_tier\": \"default\",\n \"system_fingerprint\": \"fp_fc9f1d7035\"\n}\n"}},"CreateChatCompletionStreamResponse":{"type":"object","description":"Represents a streamed chunk of a chat completion response returned\nby the model, based on the provided input. \n[Learn more](/docs/guides/streaming-responses).\n","properties":{"id":{"type":"string","description":"A unique identifier for the chat completion. Each chunk has the same ID."},"choices":{"type":"array","description":"A list of chat completion choices. Can contain more than one elements if `n` is greater than 1. Can also be empty for the\nlast chunk if you set `stream_options: {\"include_usage\": true}`.\n","items":{"type":"object","required":["delta","finish_reason","index"],"properties":{"delta":{"$ref":"#/components/schemas/ChatCompletionStreamResponseDelta"},"logprobs":{"description":"Log probability information for the choice.","type":"object","nullable":true,"properties":{"content":{"description":"A list of message content tokens with log probability information.","type":"array","items":{"$ref":"#/components/schemas/ChatCompletionTokenLogprob"},"nullable":true},"refusal":{"description":"A list of message refusal tokens with log probability information.","type":"array","items":{"$ref":"#/components/schemas/ChatCompletionTokenLogprob"},"nullable":true}},"required":["content","refusal"]},"finish_reason":{"type":"string","description":"The reason the model stopped generating tokens. This will be `stop` if the model hit a natural stop point or a provided stop sequence,\n`length` if the maximum number of tokens specified in the request was reached,\n`content_filter` if content was omitted due to a flag from our content filters,\n`tool_calls` if the model called a tool, or `function_call` (deprecated) if the model called a function.\n","enum":["stop","length","tool_calls","content_filter","function_call"],"nullable":true},"index":{"type":"integer","description":"The index of the choice in the list of choices."}}}},"created":{"type":"integer","description":"The Unix timestamp (in seconds) of when the chat completion was created. Each chunk has the same timestamp."},"model":{"type":"string","description":"The model to generate the completion."},"service_tier":{"$ref":"#/components/schemas/ServiceTier"},"system_fingerprint":{"type":"string","deprecated":true,"description":"This fingerprint represents the backend configuration that the model runs with.\nCan be used in conjunction with the `seed` request parameter to understand when backend changes have been made that might impact determinism.\n"},"object":{"type":"string","description":"The object type, which is always `chat.completion.chunk`.","enum":["chat.completion.chunk"],"x-stainless-const":true},"usage":{"$ref":"#/components/schemas/CompletionUsage","nullable":true,"description":"An optional field that will only be present when you set\n`stream_options: {\"include_usage\": true}` in your request. When present, it\ncontains a null value **except for the last chunk** which contains the\ntoken usage statistics for the entire request.\n\n**NOTE:** If the stream is interrupted or cancelled, you may not\nreceive the final usage chunk which contains the total token usage for\nthe request.\n"}},"required":["choices","created","id","model","object"],"x-oaiMeta":{"name":"The chat completion chunk object","group":"chat","example":"{\"id\":\"chatcmpl-123\",\"object\":\"chat.completion.chunk\",\"created\":1694268190,\"model\":\"gpt-4o-mini\", \"system_fingerprint\": \"fp_44709d6fcb\", \"choices\":[{\"index\":0,\"delta\":{\"role\":\"assistant\",\"content\":\"\"},\"logprobs\":null,\"finish_reason\":null}]}\n\n{\"id\":\"chatcmpl-123\",\"object\":\"chat.completion.chunk\",\"created\":1694268190,\"model\":\"gpt-4o-mini\", \"system_fingerprint\": \"fp_44709d6fcb\", \"choices\":[{\"index\":0,\"delta\":{\"content\":\"Hello\"},\"logprobs\":null,\"finish_reason\":null}]}\n\n....\n\n{\"id\":\"chatcmpl-123\",\"object\":\"chat.completion.chunk\",\"created\":1694268190,\"model\":\"gpt-4o-mini\", \"system_fingerprint\": \"fp_44709d6fcb\", \"choices\":[{\"index\":0,\"delta\":{},\"logprobs\":null,\"finish_reason\":\"stop\"}]}\n"}},"CreateCompletionRequest":{"type":"object","properties":{"model":{"description":"ID of the model to use. You can use the [List models](/docs/api-reference/models/list) API to see all of your available models, or see our [Model overview](/docs/models) for descriptions of them.\n","anyOf":[{"type":"string"},{"type":"string","enum":["gpt-3.5-turbo-instruct","davinci-002","babbage-002"]}],"x-oaiTypeLabel":"string"},"prompt":{"description":"The prompt(s) to generate completions for, encoded as a string, array of strings, array of tokens, or array of token arrays.\n\nNote that <|endoftext|> is the document separator that the model sees during training, so if a prompt is not specified the model will generate as if from the beginning of a new document.\n","default":"<|endoftext|>","nullable":true,"oneOf":[{"type":"string","default":"","example":"This is a test."},{"type":"array","items":{"type":"string","default":"","example":"This is a test."}},{"type":"array","minItems":1,"items":{"type":"integer"},"example":"[1212, 318, 257, 1332, 13]"},{"type":"array","minItems":1,"items":{"type":"array","minItems":1,"items":{"type":"integer"}},"example":"[[1212, 318, 257, 1332, 13]]"}]},"best_of":{"type":"integer","default":1,"minimum":0,"maximum":20,"nullable":true,"description":"Generates `best_of` completions server-side and returns the \"best\" (the one with the highest log probability per token). Results cannot be streamed.\n\nWhen used with `n`, `best_of` controls the number of candidate completions and `n` specifies how many to return – `best_of` must be greater than `n`.\n\n**Note:** Because this parameter generates many completions, it can quickly consume your token quota. Use carefully and ensure that you have reasonable settings for `max_tokens` and `stop`.\n"},"echo":{"type":"boolean","default":false,"nullable":true,"description":"Echo back the prompt in addition to the completion\n"},"frequency_penalty":{"type":"number","default":0,"minimum":-2,"maximum":2,"nullable":true,"description":"Number between -2.0 and 2.0. Positive values penalize new tokens based on their existing frequency in the text so far, decreasing the model's likelihood to repeat the same line verbatim.\n\n[See more information about frequency and presence penalties.](/docs/guides/text-generation)\n"},"logit_bias":{"type":"object","x-oaiTypeLabel":"map","default":null,"nullable":true,"additionalProperties":{"type":"integer"},"description":"Modify the likelihood of specified tokens appearing in the completion.\n\nAccepts a JSON object that maps tokens (specified by their token ID in the GPT tokenizer) to an associated bias value from -100 to 100. You can use this [tokenizer tool](/tokenizer?view=bpe) to convert text to token IDs. Mathematically, the bias is added to the logits generated by the model prior to sampling. The exact effect will vary per model, but values between -1 and 1 should decrease or increase likelihood of selection; values like -100 or 100 should result in a ban or exclusive selection of the relevant token.\n\nAs an example, you can pass `{\"50256\": -100}` to prevent the <|endoftext|> token from being generated.\n"},"logprobs":{"type":"integer","minimum":0,"maximum":5,"default":null,"nullable":true,"description":"Include the log probabilities on the `logprobs` most likely output tokens, as well the chosen tokens. For example, if `logprobs` is 5, the API will return a list of the 5 most likely tokens. The API will always return the `logprob` of the sampled token, so there may be up to `logprobs+1` elements in the response.\n\nThe maximum value for `logprobs` is 5.\n"},"max_tokens":{"type":"integer","minimum":0,"default":16,"example":16,"nullable":true,"description":"The maximum number of [tokens](/tokenizer) that can be generated in the completion.\n\nThe token count of your prompt plus `max_tokens` cannot exceed the model's context length. [Example Python code](https://cookbook.openai.com/examples/how_to_count_tokens_with_tiktoken) for counting tokens.\n"},"n":{"type":"integer","minimum":1,"maximum":128,"default":1,"example":1,"nullable":true,"description":"How many completions to generate for each prompt.\n\n**Note:** Because this parameter generates many completions, it can quickly consume your token quota. Use carefully and ensure that you have reasonable settings for `max_tokens` and `stop`.\n"},"presence_penalty":{"type":"number","default":0,"minimum":-2,"maximum":2,"nullable":true,"description":"Number between -2.0 and 2.0. Positive values penalize new tokens based on whether they appear in the text so far, increasing the model's likelihood to talk about new topics.\n\n[See more information about frequency and presence penalties.](/docs/guides/text-generation)\n"},"seed":{"type":"integer","format":"int64","nullable":true,"description":"If specified, our system will make a best effort to sample deterministically, such that repeated requests with the same `seed` and parameters should return the same result.\n\nDeterminism is not guaranteed, and you should refer to the `system_fingerprint` response parameter to monitor changes in the backend.\n"},"stop":{"$ref":"#/components/schemas/StopConfiguration"},"stream":{"description":"Whether to stream back partial progress. If set, tokens will be sent as data-only [server-sent events](https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events/Using_server-sent_events#Event_stream_format) as they become available, with the stream terminated by a `data: [DONE]` message. [Example Python code](https://cookbook.openai.com/examples/how_to_stream_completions).\n","type":"boolean","nullable":true,"default":false},"stream_options":{"$ref":"#/components/schemas/ChatCompletionStreamOptions"},"suffix":{"description":"The suffix that comes after a completion of inserted text.\n\nThis parameter is only supported for `gpt-3.5-turbo-instruct`.\n","default":null,"nullable":true,"type":"string","example":"test."},"temperature":{"type":"number","minimum":0,"maximum":2,"default":1,"example":1,"nullable":true,"description":"What sampling temperature to use, between 0 and 2. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic.\n\nWe generally recommend altering this or `top_p` but not both.\n"},"top_p":{"type":"number","minimum":0,"maximum":1,"default":1,"example":1,"nullable":true,"description":"An alternative to sampling with temperature, called nucleus sampling, where the model considers the results of the tokens with top_p probability mass. So 0.1 means only the tokens comprising the top 10% probability mass are considered.\n\nWe generally recommend altering this or `temperature` but not both.\n"},"user":{"type":"string","example":"user-1234","description":"A unique identifier representing your end-user, which can help OpenAI to monitor and detect abuse. [Learn more](/docs/guides/safety-best-practices#end-user-ids).\n"}},"required":["model","prompt"]},"CreateCompletionResponse":{"type":"object","description":"Represents a completion response from the API. Note: both the streamed and non-streamed response objects share the same shape (unlike the chat endpoint).\n","properties":{"id":{"type":"string","description":"A unique identifier for the completion."},"choices":{"type":"array","description":"The list of completion choices the model generated for the input prompt.","items":{"type":"object","required":["finish_reason","index","logprobs","text"],"properties":{"finish_reason":{"type":"string","description":"The reason the model stopped generating tokens. This will be `stop` if the model hit a natural stop point or a provided stop sequence,\n`length` if the maximum number of tokens specified in the request was reached,\nor `content_filter` if content was omitted due to a flag from our content filters.\n","enum":["stop","length","content_filter"]},"index":{"type":"integer"},"logprobs":{"anyOf":[{"type":"object","properties":{"text_offset":{"type":"array","items":{"type":"integer"}},"token_logprobs":{"type":"array","items":{"type":"number"}},"tokens":{"type":"array","items":{"type":"string"}},"top_logprobs":{"type":"array","items":{"type":"object","additionalProperties":{"type":"number"}}}}},{"type":"null"}]},"text":{"type":"string"}}}},"created":{"type":"integer","description":"The Unix timestamp (in seconds) of when the completion was created."},"model":{"type":"string","description":"The model used for completion."},"system_fingerprint":{"type":"string","description":"This fingerprint represents the backend configuration that the model runs with.\n\nCan be used in conjunction with the `seed` request parameter to understand when backend changes have been made that might impact determinism.\n"},"object":{"type":"string","description":"The object type, which is always \"text_completion\"","enum":["text_completion"],"x-stainless-const":true},"usage":{"$ref":"#/components/schemas/CompletionUsage"}},"required":["id","object","created","model","choices"],"x-oaiMeta":{"name":"The completion object","legacy":true,"example":"{\n \"id\": \"cmpl-uqkvlQyYK7bGYrRHQ0eXlWi7\",\n \"object\": \"text_completion\",\n \"created\": 1589478378,\n \"model\": \"gpt-4-turbo\",\n \"choices\": [\n {\n \"text\": \"\\n\\nThis is indeed a test\",\n \"index\": 0,\n \"logprobs\": null,\n \"finish_reason\": \"length\"\n }\n ],\n \"usage\": {\n \"prompt_tokens\": 5,\n \"completion_tokens\": 7,\n \"total_tokens\": 12\n }\n}\n"}},"CreateContainerBody":{"type":"object","properties":{"name":{"type":"string","description":"Name of the container to create."},"file_ids":{"type":"array","description":"IDs of files to copy to the container.","items":{"type":"string"}},"expires_after":{"type":"object","description":"Container expiration time in seconds relative to the 'anchor' time.","properties":{"anchor":{"type":"string","enum":["last_active_at"],"description":"Time anchor for the expiration time. Currently only 'last_active_at' is supported."},"minutes":{"type":"integer"}},"required":["anchor","minutes"]},"skills":{"type":"array","description":"An optional list of skills referenced by id or inline data.","items":{"oneOf":[{"$ref":"#/components/schemas/SkillReferenceParam"},{"$ref":"#/components/schemas/InlineSkillParam"}],"discriminator":{"propertyName":"type"}}},"memory_limit":{"type":"string","enum":["1g","4g","16g","64g"],"description":"Optional memory limit for the container. Defaults to \"1g\"."},"network_policy":{"description":"Network access policy for the container.","oneOf":[{"$ref":"#/components/schemas/ContainerNetworkPolicyDisabledParam"},{"$ref":"#/components/schemas/ContainerNetworkPolicyAllowlistParam"}],"discriminator":{"propertyName":"type"}}},"required":["name"]},"CreateContainerFileBody":{"type":"object","properties":{"file_id":{"type":"string","description":"Name of the file to create."},"file":{"description":"The File object (not file name) to be uploaded.\n","type":"string","format":"binary"}},"required":[]},"CreateEmbeddingRequest":{"type":"object","additionalProperties":false,"properties":{"input":{"description":"Input text to embed, encoded as a string or array of tokens. To embed multiple inputs in a single request, pass an array of strings or array of token arrays. The input must not exceed the max input tokens for the model (8192 tokens for all embedding models), cannot be an empty string, and any array must be 2048 dimensions or less. [Example Python code](https://cookbook.openai.com/examples/how_to_count_tokens_with_tiktoken) for counting tokens. In addition to the per-input token limit, all embedding models enforce a maximum of 300,000 tokens summed across all inputs in a single request.\n","example":"The quick brown fox jumped over the lazy dog","oneOf":[{"type":"string","title":"string","description":"The string that will be turned into an embedding.","default":"","example":"This is a test."},{"type":"array","title":"array","description":"The array of strings that will be turned into an embedding.","minItems":1,"maxItems":2048,"items":{"type":"string","default":"","example":"['This is a test.']"}},{"type":"array","title":"array","description":"The array of integers that will be turned into an embedding.","minItems":1,"maxItems":2048,"items":{"type":"integer"},"example":"[1212, 318, 257, 1332, 13]"},{"type":"array","title":"array","description":"The array of arrays containing integers that will be turned into an embedding.","minItems":1,"maxItems":2048,"items":{"type":"array","minItems":1,"items":{"type":"integer"}},"example":"[[1212, 318, 257, 1332, 13]]"}]},"model":{"description":"ID of the model to use. You can use the [List models](/docs/api-reference/models/list) API to see all of your available models, or see our [Model overview](/docs/models) for descriptions of them.\n","example":"text-embedding-3-small","anyOf":[{"type":"string"},{"type":"string","enum":["text-embedding-ada-002","text-embedding-3-small","text-embedding-3-large"]}],"x-oaiTypeLabel":"string"},"encoding_format":{"description":"The format to return the embeddings in. Can be either `float` or [`base64`](https://pypi.org/project/pybase64/).","example":"float","default":"float","type":"string","enum":["float","base64"]},"dimensions":{"description":"The number of dimensions the resulting output embeddings should have. Only supported in `text-embedding-3` and later models.\n","type":"integer","minimum":1},"user":{"type":"string","example":"user-1234","description":"A unique identifier representing your end-user, which can help OpenAI to monitor and detect abuse. [Learn more](/docs/guides/safety-best-practices#end-user-ids).\n"}},"required":["model","input"]},"CreateEmbeddingResponse":{"type":"object","properties":{"data":{"type":"array","description":"The list of embeddings generated by the model.","items":{"$ref":"#/components/schemas/Embedding"}},"model":{"type":"string","description":"The name of the model used to generate the embedding."},"object":{"type":"string","description":"The object type, which is always \"list\".","enum":["list"],"x-stainless-const":true},"usage":{"type":"object","description":"The usage information for the request.","properties":{"prompt_tokens":{"type":"integer","description":"The number of tokens used by the prompt."},"total_tokens":{"type":"integer","description":"The total number of tokens used by the request."}},"required":["prompt_tokens","total_tokens"]}},"required":["object","model","data","usage"]},"CreateEvalCompletionsRunDataSource":{"type":"object","title":"CompletionsRunDataSource","description":"A CompletionsRunDataSource object describing a model sampling configuration.\n","properties":{"type":{"type":"string","enum":["completions"],"default":"completions","description":"The type of run data source. Always `completions`."},"input_messages":{"description":"Used when sampling from a model. Dictates the structure of the messages passed into the model. Can either be a reference to a prebuilt trajectory (ie, `item.input_trajectory`), or a template with variable references to the `item` namespace.","oneOf":[{"type":"object","title":"TemplateInputMessages","properties":{"type":{"type":"string","enum":["template"],"description":"The type of input messages. Always `template`."},"template":{"type":"array","description":"A list of chat messages forming the prompt or context. May include variable references to the `item` namespace, ie {{item.name}}.","items":{"oneOf":[{"$ref":"#/components/schemas/EasyInputMessage"},{"$ref":"#/components/schemas/EvalItem"}]}}},"required":["type","template"]},{"type":"object","title":"ItemReferenceInputMessages","properties":{"type":{"type":"string","enum":["item_reference"],"description":"The type of input messages. Always `item_reference`."},"item_reference":{"type":"string","description":"A reference to a variable in the `item` namespace. Ie, \"item.input_trajectory\""}},"required":["type","item_reference"]}]},"sampling_params":{"type":"object","properties":{"reasoning_effort":{"$ref":"#/components/schemas/ReasoningEffort"},"temperature":{"type":"number","description":"A higher temperature increases randomness in the outputs.","default":1},"max_completion_tokens":{"type":"integer","description":"The maximum number of tokens in the generated output."},"top_p":{"type":"number","description":"An alternative to temperature for nucleus sampling; 1.0 includes all tokens.","default":1},"seed":{"type":"integer","description":"A seed value to initialize the randomness, during sampling.","default":42},"response_format":{"description":"An object specifying the format that the model must output.\n\nSetting to `{ \"type\": \"json_schema\", \"json_schema\": {...} }` enables\nStructured Outputs which ensures the model will match your supplied JSON\nschema. Learn more in the [Structured Outputs\nguide](/docs/guides/structured-outputs).\n\nSetting to `{ \"type\": \"json_object\" }` enables the older JSON mode, which\nensures the message the model generates is valid JSON. Using `json_schema`\nis preferred for models that support it.\n","oneOf":[{"$ref":"#/components/schemas/ResponseFormatText"},{"$ref":"#/components/schemas/ResponseFormatJsonSchema"},{"$ref":"#/components/schemas/ResponseFormatJsonObject"}]},"tools":{"type":"array","description":"A list of tools the model may call. Currently, only functions are supported as a tool. Use this to provide a list of functions the model may generate JSON inputs for. A max of 128 functions are supported.\n","items":{"$ref":"#/components/schemas/ChatCompletionTool"}}}},"model":{"type":"string","description":"The name of the model to use for generating completions (e.g. \"o3-mini\")."},"source":{"description":"Determines what populates the `item` namespace in this run's data source.","oneOf":[{"$ref":"#/components/schemas/EvalJsonlFileContentSource"},{"$ref":"#/components/schemas/EvalJsonlFileIdSource"},{"$ref":"#/components/schemas/EvalStoredCompletionsSource"}]}},"required":["type","source"],"x-oaiMeta":{"name":"The completions data source object used to configure an individual run","group":"eval runs","example":"{\n \"name\": \"gpt-4o-mini-2024-07-18\",\n \"data_source\": {\n \"type\": \"completions\",\n \"input_messages\": {\n \"type\": \"item_reference\",\n \"item_reference\": \"item.input\"\n },\n \"model\": \"gpt-4o-mini-2024-07-18\",\n \"source\": {\n \"type\": \"stored_completions\",\n \"model\": \"gpt-4o-mini-2024-07-18\"\n }\n }\n}\n"}},"CreateEvalCustomDataSourceConfig":{"type":"object","title":"CustomDataSourceConfig","description":"A CustomDataSourceConfig object that defines the schema for the data source used for the evaluation runs.\nThis schema is used to define the shape of the data that will be:\n- Used to define your testing criteria and\n- What data is required when creating a run\n","properties":{"type":{"type":"string","enum":["custom"],"default":"custom","description":"The type of data source. Always `custom`.","x-stainless-const":true},"item_schema":{"type":"object","description":"The json schema for each row in the data source.","additionalProperties":true,"example":"{\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\"type\": \"string\"},\n \"age\": {\"type\": \"integer\"}\n },\n \"required\": [\"name\", \"age\"]\n}\n"},"include_sample_schema":{"type":"boolean","default":false,"description":"Whether the eval should expect you to populate the sample namespace (ie, by generating responses off of your data source)"}},"required":["item_schema","type"],"x-oaiMeta":{"name":"The eval file data source config object","group":"evals","example":"{\n \"type\": \"custom\",\n \"item_schema\": {\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\"type\": \"string\"},\n \"age\": {\"type\": \"integer\"}\n },\n \"required\": [\"name\", \"age\"]\n },\n \"include_sample_schema\": true\n}\n"}},"CreateEvalItem":{"title":"CreateEvalItem","description":"A chat message that makes up the prompt or context. May include variable references to the `item` namespace, ie {{item.name}}.","type":"object","oneOf":[{"type":"object","title":"SimpleInputMessage","properties":{"role":{"type":"string","description":"The role of the message (e.g. \"system\", \"assistant\", \"user\")."},"content":{"type":"string","description":"The content of the message."}},"required":["role","content"]},{"$ref":"#/components/schemas/EvalItem"}],"x-oaiMeta":{"name":"The chat message object used to configure an individual run"}},"CreateEvalJsonlRunDataSource":{"type":"object","title":"JsonlRunDataSource","description":"A JsonlRunDataSource object with that specifies a JSONL file that matches the eval \n","properties":{"type":{"type":"string","enum":["jsonl"],"default":"jsonl","description":"The type of data source. Always `jsonl`.","x-stainless-const":true},"source":{"description":"Determines what populates the `item` namespace in the data source.","oneOf":[{"$ref":"#/components/schemas/EvalJsonlFileContentSource"},{"$ref":"#/components/schemas/EvalJsonlFileIdSource"}]}},"required":["type","source"],"x-oaiMeta":{"name":"The file data source object for the eval run configuration","group":"evals","example":"{\n \"type\": \"jsonl\",\n \"source\": {\n \"type\": \"file_id\",\n \"id\": \"file-9GYS6xbkWgWhmE7VoLUWFg\"\n }\n}\n"}},"CreateEvalLabelModelGrader":{"type":"object","title":"LabelModelGrader","description":"A LabelModelGrader object which uses a model to assign labels to each item\nin the evaluation.\n","properties":{"type":{"description":"The object type, which is always `label_model`.","type":"string","enum":["label_model"],"x-stainless-const":true},"name":{"type":"string","description":"The name of the grader."},"model":{"type":"string","description":"The model to use for the evaluation. Must support structured outputs."},"input":{"type":"array","description":"A list of chat messages forming the prompt or context. May include variable references to the `item` namespace, ie {{item.name}}.","items":{"$ref":"#/components/schemas/CreateEvalItem"}},"labels":{"type":"array","items":{"type":"string"},"description":"The labels to classify to each item in the evaluation."},"passing_labels":{"type":"array","items":{"type":"string"},"description":"The labels that indicate a passing result. Must be a subset of labels."}},"required":["type","model","input","passing_labels","labels","name"],"x-oaiMeta":{"name":"The eval label model grader object","group":"evals","example":"{\n \"type\": \"label_model\",\n \"model\": \"gpt-4o-2024-08-06\",\n \"input\": [\n {\n \"role\": \"system\",\n \"content\": \"Classify the sentiment of the following statement as one of 'positive', 'neutral', or 'negative'\"\n },\n {\n \"role\": \"user\",\n \"content\": \"Statement: {{item.response}}\"\n }\n ],\n \"passing_labels\": [\"positive\"],\n \"labels\": [\"positive\", \"neutral\", \"negative\"],\n \"name\": \"Sentiment label grader\"\n}\n"}},"CreateEvalLogsDataSourceConfig":{"type":"object","title":"LogsDataSourceConfig","description":"A data source config which specifies the metadata property of your logs query.\nThis is usually metadata like `usecase=chatbot` or `prompt-version=v2`, etc.\n","properties":{"type":{"type":"string","enum":["logs"],"default":"logs","description":"The type of data source. Always `logs`.","x-stainless-const":true},"metadata":{"type":"object","description":"Metadata filters for the logs data source.","additionalProperties":true,"example":"{\n \"use_case\": \"customer_support_agent\"\n}\n"}},"required":["type"],"x-oaiMeta":{"name":"The logs data source object for evals","group":"evals","example":"{\n \"type\": \"logs\",\n \"metadata\": {\n \"use_case\": \"customer_support_agent\"\n }\n}\n"}},"CreateEvalRequest":{"type":"object","title":"CreateEvalRequest","properties":{"name":{"type":"string","description":"The name of the evaluation."},"metadata":{"$ref":"#/components/schemas/Metadata"},"data_source_config":{"type":"object","description":"The configuration for the data source used for the evaluation runs. Dictates the schema of the data used in the evaluation.","oneOf":[{"$ref":"#/components/schemas/CreateEvalCustomDataSourceConfig"},{"$ref":"#/components/schemas/CreateEvalLogsDataSourceConfig"},{"$ref":"#/components/schemas/CreateEvalStoredCompletionsDataSourceConfig"}]},"testing_criteria":{"type":"array","description":"A list of graders for all eval runs in this group. Graders can reference variables in the data source using double curly braces notation, like `{{item.variable_name}}`. To reference the model's output, use the `sample` namespace (ie, `{{sample.output_text}}`).","items":{"oneOf":[{"$ref":"#/components/schemas/CreateEvalLabelModelGrader"},{"$ref":"#/components/schemas/EvalGraderStringCheck"},{"$ref":"#/components/schemas/EvalGraderTextSimilarity"},{"$ref":"#/components/schemas/EvalGraderPython"},{"$ref":"#/components/schemas/EvalGraderScoreModel"}]}}},"required":["data_source_config","testing_criteria"]},"CreateEvalResponsesRunDataSource":{"type":"object","title":"ResponsesRunDataSource","description":"A ResponsesRunDataSource object describing a model sampling configuration.\n","properties":{"type":{"type":"string","enum":["responses"],"default":"responses","description":"The type of run data source. Always `responses`."},"input_messages":{"description":"Used when sampling from a model. Dictates the structure of the messages passed into the model. Can either be a reference to a prebuilt trajectory (ie, `item.input_trajectory`), or a template with variable references to the `item` namespace.","oneOf":[{"type":"object","title":"InputMessagesTemplate","properties":{"type":{"type":"string","enum":["template"],"description":"The type of input messages. Always `template`."},"template":{"type":"array","description":"A list of chat messages forming the prompt or context. May include variable references to the `item` namespace, ie {{item.name}}.","items":{"oneOf":[{"type":"object","title":"ChatMessage","properties":{"role":{"type":"string","description":"The role of the message (e.g. \"system\", \"assistant\", \"user\")."},"content":{"type":"string","description":"The content of the message."}},"required":["role","content"]},{"$ref":"#/components/schemas/EvalItem"}]}}},"required":["type","template"]},{"type":"object","title":"InputMessagesItemReference","properties":{"type":{"type":"string","enum":["item_reference"],"description":"The type of input messages. Always `item_reference`."},"item_reference":{"type":"string","description":"A reference to a variable in the `item` namespace. Ie, \"item.name\""}},"required":["type","item_reference"]}]},"sampling_params":{"type":"object","properties":{"reasoning_effort":{"$ref":"#/components/schemas/ReasoningEffort"},"temperature":{"type":"number","description":"A higher temperature increases randomness in the outputs.","default":1},"max_completion_tokens":{"type":"integer","description":"The maximum number of tokens in the generated output."},"top_p":{"type":"number","description":"An alternative to temperature for nucleus sampling; 1.0 includes all tokens.","default":1},"seed":{"type":"integer","description":"A seed value to initialize the randomness, during sampling.","default":42},"tools":{"type":"array","description":"An array of tools the model may call while generating a response. You\ncan specify which tool to use by setting the `tool_choice` parameter.\n\nThe two categories of tools you can provide the model are:\n\n- **Built-in tools**: Tools that are provided by OpenAI that extend the\n model's capabilities, like [web search](/docs/guides/tools-web-search)\n or [file search](/docs/guides/tools-file-search). Learn more about\n [built-in tools](/docs/guides/tools).\n- **Function calls (custom tools)**: Functions that are defined by you,\n enabling the model to call your own code. Learn more about\n [function calling](/docs/guides/function-calling).\n","items":{"$ref":"#/components/schemas/Tool"}},"text":{"type":"object","description":"Configuration options for a text response from the model. Can be plain\ntext or structured JSON data. Learn more:\n- [Text inputs and outputs](/docs/guides/text)\n- [Structured Outputs](/docs/guides/structured-outputs)\n","properties":{"format":{"$ref":"#/components/schemas/TextResponseFormatConfiguration"}}}}},"model":{"type":"string","description":"The name of the model to use for generating completions (e.g. \"o3-mini\")."},"source":{"description":"Determines what populates the `item` namespace in this run's data source.","oneOf":[{"$ref":"#/components/schemas/EvalJsonlFileContentSource"},{"$ref":"#/components/schemas/EvalJsonlFileIdSource"},{"$ref":"#/components/schemas/EvalResponsesSource"}]}},"required":["type","source"],"x-oaiMeta":{"name":"The completions data source object used to configure an individual run","group":"eval runs","example":"{\n \"name\": \"gpt-4o-mini-2024-07-18\",\n \"data_source\": {\n \"type\": \"responses\",\n \"input_messages\": {\n \"type\": \"item_reference\",\n \"item_reference\": \"item.input\"\n },\n \"model\": \"gpt-4o-mini-2024-07-18\",\n \"source\": {\n \"type\": \"responses\",\n \"model\": \"gpt-4o-mini-2024-07-18\"\n }\n }\n}\n"}},"CreateEvalRunRequest":{"type":"object","title":"CreateEvalRunRequest","properties":{"name":{"type":"string","description":"The name of the run."},"metadata":{"$ref":"#/components/schemas/Metadata"},"data_source":{"type":"object","description":"Details about the run's data source.","oneOf":[{"$ref":"#/components/schemas/CreateEvalJsonlRunDataSource"},{"$ref":"#/components/schemas/CreateEvalCompletionsRunDataSource"},{"$ref":"#/components/schemas/CreateEvalResponsesRunDataSource"}]}},"required":["data_source"]},"CreateEvalStoredCompletionsDataSourceConfig":{"type":"object","title":"StoredCompletionsDataSourceConfig","description":"Deprecated in favor of LogsDataSourceConfig.\n","properties":{"type":{"type":"string","enum":["stored_completions"],"default":"stored_completions","description":"The type of data source. Always `stored_completions`.","x-stainless-const":true},"metadata":{"type":"object","description":"Metadata filters for the stored completions data source.","additionalProperties":true,"example":"{\n \"use_case\": \"customer_support_agent\"\n}\n"}},"required":["type"],"deprecated":true,"x-oaiMeta":{"name":"The stored completions data source object for evals","group":"evals","example":"{\n \"type\": \"stored_completions\",\n \"metadata\": {\n \"use_case\": \"customer_support_agent\"\n }\n}\n"}},"CreateFileRequest":{"type":"object","additionalProperties":false,"properties":{"file":{"description":"The File object (not file name) to be uploaded.\n","type":"string","format":"binary"},"purpose":{"description":"The intended purpose of the uploaded file. One of:\n- `assistants`: Used in the Assistants API\n- `batch`: Used in the Batch API\n- `fine-tune`: Used for fine-tuning\n- `vision`: Images used for vision fine-tuning\n- `user_data`: Flexible file type for any purpose\n- `evals`: Used for eval data sets\n","type":"string","enum":["assistants","batch","fine-tune","vision","user_data","evals"]},"expires_after":{"$ref":"#/components/schemas/FileExpirationAfter"}},"required":["file","purpose"]},"CreateFineTuningCheckpointPermissionRequest":{"type":"object","additionalProperties":false,"properties":{"project_ids":{"type":"array","description":"The project identifiers to grant access to.","items":{"type":"string"}}},"required":["project_ids"]},"CreateFineTuningJobRequest":{"type":"object","properties":{"model":{"description":"The name of the model to fine-tune. You can select one of the\n[supported models](/docs/guides/fine-tuning#which-models-can-be-fine-tuned).\n","example":"gpt-4o-mini","anyOf":[{"type":"string"},{"type":"string","enum":["babbage-002","davinci-002","gpt-3.5-turbo","gpt-4o-mini"]}],"x-oaiTypeLabel":"string"},"training_file":{"description":"The ID of an uploaded file that contains training data.\n\nSee [upload file](/docs/api-reference/files/create) for how to upload a file.\n\nYour dataset must be formatted as a JSONL file. Additionally, you must upload your file with the purpose `fine-tune`.\n\nThe contents of the file should differ depending on if the model uses the [chat](/docs/api-reference/fine-tuning/chat-input), [completions](/docs/api-reference/fine-tuning/completions-input) format, or if the fine-tuning method uses the [preference](/docs/api-reference/fine-tuning/preference-input) format.\n\nSee the [fine-tuning guide](/docs/guides/model-optimization) for more details.\n","type":"string","example":"file-abc123"},"hyperparameters":{"type":"object","description":"The hyperparameters used for the fine-tuning job.\nThis value is now deprecated in favor of `method`, and should be passed in under the `method` parameter.\n","properties":{"batch_size":{"description":"Number of examples in each batch. A larger batch size means that model parameters\nare updated less frequently, but with lower variance.\n","oneOf":[{"type":"string","enum":["auto"],"x-stainless-const":true},{"type":"integer","minimum":1,"maximum":256}],"default":"auto"},"learning_rate_multiplier":{"description":"Scaling factor for the learning rate. A smaller learning rate may be useful to avoid\noverfitting.\n","oneOf":[{"type":"string","enum":["auto"],"x-stainless-const":true},{"type":"number","minimum":0,"exclusiveMinimum":true}],"default":"auto"},"n_epochs":{"description":"The number of epochs to train the model for. An epoch refers to one full cycle\nthrough the training dataset.\n","oneOf":[{"type":"string","enum":["auto"],"x-stainless-const":true},{"type":"integer","minimum":1,"maximum":50}],"default":"auto"}},"deprecated":true},"suffix":{"description":"A string of up to 64 characters that will be added to your fine-tuned model name.\n\nFor example, a `suffix` of \"custom-model-name\" would produce a model name like `ft:gpt-4o-mini:openai:custom-model-name:7p4lURel`.\n","type":"string","minLength":1,"maxLength":64,"default":null,"nullable":true},"validation_file":{"description":"The ID of an uploaded file that contains validation data.\n\nIf you provide this file, the data is used to generate validation\nmetrics periodically during fine-tuning. These metrics can be viewed in\nthe fine-tuning results file.\nThe same data should not be present in both train and validation files.\n\nYour dataset must be formatted as a JSONL file. You must upload your file with the purpose `fine-tune`.\n\nSee the [fine-tuning guide](/docs/guides/model-optimization) for more details.\n","type":"string","nullable":true,"example":"file-abc123"},"integrations":{"type":"array","description":"A list of integrations to enable for your fine-tuning job.","nullable":true,"items":{"type":"object","required":["type","wandb"],"properties":{"type":{"description":"The type of integration to enable. Currently, only \"wandb\" (Weights and Biases) is supported.\n","oneOf":[{"type":"string","enum":["wandb"],"x-stainless-const":true}]},"wandb":{"type":"object","description":"The settings for your integration with Weights and Biases. This payload specifies the project that\nmetrics will be sent to. Optionally, you can set an explicit display name for your run, add tags\nto your run, and set a default entity (team, username, etc) to be associated with your run.\n","required":["project"],"properties":{"project":{"description":"The name of the project that the new run will be created under.\n","type":"string","example":"my-wandb-project"},"name":{"description":"A display name to set for the run. If not set, we will use the Job ID as the name.\n","nullable":true,"type":"string"},"entity":{"description":"The entity to use for the run. This allows you to set the team or username of the WandB user that you would\nlike associated with the run. If not set, the default entity for the registered WandB API key is used.\n","nullable":true,"type":"string"},"tags":{"description":"A list of tags to be attached to the newly created run. These tags are passed through directly to WandB. Some\ndefault tags are generated by OpenAI: \"openai/finetune\", \"openai/{base-model}\", \"openai/{ftjob-abcdef}\".\n","type":"array","items":{"type":"string","example":"custom-tag"}}}}}}},"seed":{"description":"The seed controls the reproducibility of the job. Passing in the same seed and job parameters should produce the same results, but may differ in rare cases.\nIf a seed is not specified, one will be generated for you.\n","type":"integer","nullable":true,"minimum":0,"maximum":2147483647,"example":42},"method":{"$ref":"#/components/schemas/FineTuneMethod"},"metadata":{"$ref":"#/components/schemas/Metadata"}},"required":["model","training_file"]},"CreateGroupBody":{"type":"object","description":"Request payload for creating a new group in the organization.","properties":{"name":{"type":"string","description":"Human readable name for the group.","minLength":1,"maxLength":255}},"required":["name"],"x-oaiMeta":{"example":"{\n \"name\": \"Support Team\"\n}\n"}},"CreateGroupUserBody":{"type":"object","description":"Request payload for adding a user to a group.","properties":{"user_id":{"type":"string","description":"Identifier of the user to add to the group."}},"required":["user_id"],"x-oaiMeta":{"example":"{\n \"user_id\": \"user_abc123\"\n}\n"}},"CreateImageEditRequest":{"type":"object","properties":{"image":{"anyOf":[{"type":"string","format":"binary"},{"type":"array","maxItems":16,"items":{"type":"string","format":"binary"}}],"description":"The image(s) to edit. Must be a supported image file or an array of images.\n\nFor the GPT image models (`gpt-image-1`, `gpt-image-1-mini`, and `gpt-image-1.5`), each image should be a `png`, `webp`, or `jpg`\nfile less than 50MB. You can provide up to 16 images.\n`chatgpt-image-latest` follows the same input constraints as GPT image models.\n\nFor `dall-e-2`, you can only provide one image, and it should be a square\n`png` file less than 4MB.\n"},"prompt":{"description":"A text description of the desired image(s). The maximum length is 1000 characters for `dall-e-2`, and 32000 characters for the GPT image models.","type":"string","example":"A cute baby sea otter wearing a beret"},"mask":{"description":"An additional image whose fully transparent areas (e.g. where alpha is zero) indicate where `image` should be edited. If there are multiple images provided, the mask will be applied on the first image. Must be a valid PNG file, less than 4MB, and have the same dimensions as `image`.","type":"string","format":"binary"},"background":{"type":"string","enum":["transparent","opaque","auto"],"default":"auto","example":"transparent","nullable":true,"description":"Allows to set transparency for the background of the generated image(s).\nThis parameter is only supported for the GPT image models. Must be one of\n`transparent`, `opaque` or `auto` (default value). When `auto` is used, the\nmodel will automatically determine the best background for the image.\n\nIf `transparent`, the output format needs to support transparency, so it\nshould be set to either `png` (default value) or `webp`.\n"},"model":{"anyOf":[{"type":"string"},{"type":"string","enum":["gpt-image-1.5","dall-e-2","gpt-image-1","gpt-image-1-mini","chatgpt-image-latest"],"x-stainless-const":true}],"x-oaiTypeLabel":"string","default":"gpt-image-1.5","example":"gpt-image-1.5","nullable":true,"description":"The model to use for image generation. Defaults to `gpt-image-1.5`."},"n":{"type":"integer","minimum":1,"maximum":10,"default":1,"example":1,"nullable":true,"description":"The number of images to generate. Must be between 1 and 10."},"size":{"type":"string","enum":["256x256","512x512","1024x1024","1536x1024","1024x1536","auto"],"default":"1024x1024","example":"1024x1024","nullable":true,"description":"The size of the generated images. Must be one of `1024x1024`, `1536x1024` (landscape), `1024x1536` (portrait), or `auto` (default value) for the GPT image models, and one of `256x256`, `512x512`, or `1024x1024` for `dall-e-2`."},"response_format":{"type":"string","enum":["url","b64_json"],"example":"url","nullable":true,"description":"The format in which the generated images are returned. Must be one of `url` or `b64_json`. URLs are only valid for 60 minutes after the image has been generated. This parameter is only supported for `dall-e-2` (default is `url` for `dall-e-2`), as GPT image models always return base64-encoded images."},"output_format":{"type":"string","enum":["png","jpeg","webp"],"default":"png","example":"png","nullable":true,"description":"The format in which the generated images are returned. This parameter is\nonly supported for the GPT image models. Must be one of `png`, `jpeg`, or `webp`.\nThe default value is `png`.\n"},"output_compression":{"type":"integer","default":100,"example":100,"nullable":true,"description":"The compression level (0-100%) for the generated images. This parameter\nis only supported for the GPT image models with the `webp` or `jpeg` output\nformats, and defaults to 100.\n"},"user":{"type":"string","example":"user-1234","description":"A unique identifier representing your end-user, which can help OpenAI to monitor and detect abuse. [Learn more](/docs/guides/safety-best-practices#end-user-ids).\n"},"input_fidelity":{"anyOf":[{"$ref":"#/components/schemas/InputFidelity"},{"type":"null"}]},"stream":{"type":"boolean","default":false,"example":false,"nullable":true,"description":"Edit the image in streaming mode. Defaults to `false`. See the\n[Image generation guide](/docs/guides/image-generation) for more information.\n"},"partial_images":{"$ref":"#/components/schemas/PartialImages"},"quality":{"type":"string","enum":["standard","low","medium","high","auto"],"default":"auto","example":"high","nullable":true,"description":"The quality of the image that will be generated for GPT image models. Defaults to `auto`.\n"}},"required":["prompt","image"]},"CreateImageRequest":{"type":"object","properties":{"prompt":{"description":"A text description of the desired image(s). The maximum length is 32000 characters for the GPT image models, 1000 characters for `dall-e-2` and 4000 characters for `dall-e-3`.","type":"string","example":"A cute baby sea otter"},"model":{"anyOf":[{"type":"string"},{"type":"string","enum":["gpt-image-1.5","dall-e-2","dall-e-3","gpt-image-1","gpt-image-1-mini"]}],"x-oaiTypeLabel":"string","default":"dall-e-2","example":"gpt-image-1.5","nullable":true,"description":"The model to use for image generation. One of `dall-e-2`, `dall-e-3`, or a GPT image model (`gpt-image-1`, `gpt-image-1-mini`, `gpt-image-1.5`). Defaults to `dall-e-2` unless a parameter specific to the GPT image models is used."},"n":{"type":"integer","minimum":1,"maximum":10,"default":1,"example":1,"nullable":true,"description":"The number of images to generate. Must be between 1 and 10. For `dall-e-3`, only `n=1` is supported."},"quality":{"type":"string","enum":["standard","hd","low","medium","high","auto"],"default":"auto","example":"medium","nullable":true,"description":"The quality of the image that will be generated.\n\n- `auto` (default value) will automatically select the best quality for the given model.\n- `high`, `medium` and `low` are supported for the GPT image models.\n- `hd` and `standard` are supported for `dall-e-3`.\n- `standard` is the only option for `dall-e-2`.\n"},"response_format":{"type":"string","enum":["url","b64_json"],"default":"url","example":"url","nullable":true,"description":"The format in which generated images with `dall-e-2` and `dall-e-3` are returned. Must be one of `url` or `b64_json`. URLs are only valid for 60 minutes after the image has been generated. This parameter isn't supported for the GPT image models, which always return base64-encoded images."},"output_format":{"type":"string","enum":["png","jpeg","webp"],"default":"png","example":"png","nullable":true,"description":"The format in which the generated images are returned. This parameter is only supported for the GPT image models. Must be one of `png`, `jpeg`, or `webp`."},"output_compression":{"type":"integer","default":100,"example":100,"nullable":true,"description":"The compression level (0-100%) for the generated images. This parameter is only supported for the GPT image models with the `webp` or `jpeg` output formats, and defaults to 100."},"stream":{"type":"boolean","default":false,"example":false,"nullable":true,"description":"Generate the image in streaming mode. Defaults to `false`. See the\n[Image generation guide](/docs/guides/image-generation) for more information.\nThis parameter is only supported for the GPT image models.\n"},"partial_images":{"$ref":"#/components/schemas/PartialImages"},"size":{"type":"string","enum":["auto","1024x1024","1536x1024","1024x1536","256x256","512x512","1792x1024","1024x1792"],"default":"auto","example":"1024x1024","nullable":true,"description":"The size of the generated images. Must be one of `1024x1024`, `1536x1024` (landscape), `1024x1536` (portrait), or `auto` (default value) for the GPT image models, one of `256x256`, `512x512`, or `1024x1024` for `dall-e-2`, and one of `1024x1024`, `1792x1024`, or `1024x1792` for `dall-e-3`."},"moderation":{"type":"string","enum":["low","auto"],"default":"auto","example":"low","nullable":true,"description":"Control the content-moderation level for images generated by the GPT image models. Must be either `low` for less restrictive filtering or `auto` (default value)."},"background":{"type":"string","enum":["transparent","opaque","auto"],"default":"auto","example":"transparent","nullable":true,"description":"Allows to set transparency for the background of the generated image(s).\nThis parameter is only supported for the GPT image models. Must be one of\n`transparent`, `opaque` or `auto` (default value). When `auto` is used, the\nmodel will automatically determine the best background for the image.\n\nIf `transparent`, the output format needs to support transparency, so it\nshould be set to either `png` (default value) or `webp`.\n"},"style":{"type":"string","enum":["vivid","natural"],"default":"vivid","example":"vivid","nullable":true,"description":"The style of the generated images. This parameter is only supported for `dall-e-3`. Must be one of `vivid` or `natural`. Vivid causes the model to lean towards generating hyper-real and dramatic images. Natural causes the model to produce more natural, less hyper-real looking images."},"user":{"type":"string","example":"user-1234","description":"A unique identifier representing your end-user, which can help OpenAI to monitor and detect abuse. [Learn more](/docs/guides/safety-best-practices#end-user-ids).\n"}},"required":["prompt"]},"CreateImageVariationRequest":{"type":"object","properties":{"image":{"description":"The image to use as the basis for the variation(s). Must be a valid PNG file, less than 4MB, and square.","type":"string","format":"binary"},"model":{"anyOf":[{"type":"string"},{"type":"string","enum":["dall-e-2"],"x-stainless-const":true}],"x-oaiTypeLabel":"string","default":"dall-e-2","example":"dall-e-2","nullable":true,"description":"The model to use for image generation. Only `dall-e-2` is supported at this time."},"n":{"type":"integer","minimum":1,"maximum":10,"default":1,"example":1,"nullable":true,"description":"The number of images to generate. Must be between 1 and 10."},"response_format":{"type":"string","enum":["url","b64_json"],"default":"url","example":"url","nullable":true,"description":"The format in which the generated images are returned. Must be one of `url` or `b64_json`. URLs are only valid for 60 minutes after the image has been generated."},"size":{"type":"string","enum":["256x256","512x512","1024x1024"],"default":"1024x1024","example":"1024x1024","nullable":true,"description":"The size of the generated images. Must be one of `256x256`, `512x512`, or `1024x1024`."},"user":{"type":"string","example":"user-1234","description":"A unique identifier representing your end-user, which can help OpenAI to monitor and detect abuse. [Learn more](/docs/guides/safety-best-practices#end-user-ids).\n"}},"required":["image"]},"CreateMessageRequest":{"type":"object","additionalProperties":false,"required":["role","content"],"properties":{"role":{"type":"string","enum":["user","assistant"],"description":"The role of the entity that is creating the message. Allowed values include:\n- `user`: Indicates the message is sent by an actual user and should be used in most cases to represent user-generated messages.\n- `assistant`: Indicates the message is generated by the assistant. Use this value to insert messages from the assistant into the conversation.\n"},"content":{"oneOf":[{"type":"string","description":"The text contents of the message.","title":"Text content"},{"type":"array","description":"An array of content parts with a defined type, each can be of type `text` or images can be passed with `image_url` or `image_file`. Image types are only supported on [Vision-compatible models](/docs/models).","title":"Array of content parts","items":{"oneOf":[{"$ref":"#/components/schemas/MessageContentImageFileObject"},{"$ref":"#/components/schemas/MessageContentImageUrlObject"},{"$ref":"#/components/schemas/MessageRequestContentTextObject"}]},"minItems":1}]},"attachments":{"anyOf":[{"type":"array","items":{"type":"object","properties":{"file_id":{"type":"string","description":"The ID of the file to attach to the message."},"tools":{"description":"The tools to add this file to.","type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/AssistantToolsCode"},{"$ref":"#/components/schemas/AssistantToolsFileSearchTypeOnly"}]}}}},"description":"A list of files attached to the message, and the tools they should be added to.","required":["file_id","tools"]},{"type":"null"}]},"metadata":{"$ref":"#/components/schemas/Metadata"}}},"CreateModelResponseProperties":{"allOf":[{"$ref":"#/components/schemas/ModelResponseProperties"},{"type":"object","properties":{"top_logprobs":{"description":"An integer between 0 and 20 specifying the number of most likely tokens to\nreturn at each token position, each with an associated log probability.\n","type":"integer","minimum":0,"maximum":20}}}]},"CreateModerationRequest":{"type":"object","properties":{"input":{"description":"Input (or inputs) to classify. Can be a single string, an array of strings, or\nan array of multi-modal input objects similar to other models.\n","oneOf":[{"type":"string","description":"A string of text to classify for moderation.","default":"","example":"I want to kill them."},{"type":"array","description":"An array of strings to classify for moderation.","items":{"type":"string","default":"","example":"I want to kill them."}},{"type":"array","description":"An array of multi-modal inputs to the moderation model.","items":{"oneOf":[{"type":"object","description":"An object describing an image to classify.","properties":{"type":{"description":"Always `image_url`.","type":"string","enum":["image_url"],"x-stainless-const":true},"image_url":{"type":"object","description":"Contains either an image URL or a data URL for a base64 encoded image.","properties":{"url":{"type":"string","description":"Either a URL of the image or the base64 encoded image data.","format":"uri","example":"https://example.com/image.jpg"}},"required":["url"]}},"required":["type","image_url"]},{"type":"object","description":"An object describing text to classify.","properties":{"type":{"description":"Always `text`.","type":"string","enum":["text"],"x-stainless-const":true},"text":{"description":"A string of text to classify.","type":"string","example":"I want to kill them"}},"required":["type","text"]}]}}]},"model":{"description":"The content moderation model you would like to use. Learn more in\n[the moderation guide](/docs/guides/moderation), and learn about\navailable models [here](/docs/models#moderation).\n","nullable":false,"default":"omni-moderation-latest","example":"omni-moderation-2024-09-26","anyOf":[{"type":"string"},{"type":"string","enum":["omni-moderation-latest","omni-moderation-2024-09-26","text-moderation-latest","text-moderation-stable"]}],"x-oaiTypeLabel":"string"}},"required":["input"]},"CreateModerationResponse":{"type":"object","description":"Represents if a given text input is potentially harmful.","properties":{"id":{"type":"string","description":"The unique identifier for the moderation request."},"model":{"type":"string","description":"The model used to generate the moderation results."},"results":{"type":"array","description":"A list of moderation objects.","items":{"type":"object","properties":{"flagged":{"type":"boolean","description":"Whether any of the below categories are flagged."},"categories":{"type":"object","description":"A list of the categories, and whether they are flagged or not.","properties":{"hate":{"type":"boolean","description":"Content that expresses, incites, or promotes hate based on race, gender, ethnicity, religion, nationality, sexual orientation, disability status, or caste. Hateful content aimed at non-protected groups (e.g., chess players) is harassment."},"hate/threatening":{"type":"boolean","description":"Hateful content that also includes violence or serious harm towards the targeted group based on race, gender, ethnicity, religion, nationality, sexual orientation, disability status, or caste."},"harassment":{"type":"boolean","description":"Content that expresses, incites, or promotes harassing language towards any target."},"harassment/threatening":{"type":"boolean","description":"Harassment content that also includes violence or serious harm towards any target."},"illicit":{"anyOf":[{"type":"boolean","description":"Content that includes instructions or advice that facilitate the planning or execution of wrongdoing, or that gives advice or instruction on how to commit illicit acts. For example, \"how to shoplift\" would fit this category."},{"type":"null"}]},"illicit/violent":{"anyOf":[{"type":"boolean","description":"Content that includes instructions or advice that facilitate the planning or execution of wrongdoing that also includes violence, or that gives advice or instruction on the procurement of any weapon."},{"type":"null"}]},"self-harm":{"type":"boolean","description":"Content that promotes, encourages, or depicts acts of self-harm, such as suicide, cutting, and eating disorders."},"self-harm/intent":{"type":"boolean","description":"Content where the speaker expresses that they are engaging or intend to engage in acts of self-harm, such as suicide, cutting, and eating disorders."},"self-harm/instructions":{"type":"boolean","description":"Content that encourages performing acts of self-harm, such as suicide, cutting, and eating disorders, or that gives instructions or advice on how to commit such acts."},"sexual":{"type":"boolean","description":"Content meant to arouse sexual excitement, such as the description of sexual activity, or that promotes sexual services (excluding sex education and wellness)."},"sexual/minors":{"type":"boolean","description":"Sexual content that includes an individual who is under 18 years old."},"violence":{"type":"boolean","description":"Content that depicts death, violence, or physical injury."},"violence/graphic":{"type":"boolean","description":"Content that depicts death, violence, or physical injury in graphic detail."}},"required":["hate","hate/threatening","harassment","harassment/threatening","illicit","illicit/violent","self-harm","self-harm/intent","self-harm/instructions","sexual","sexual/minors","violence","violence/graphic"]},"category_scores":{"type":"object","description":"A list of the categories along with their scores as predicted by model.","properties":{"hate":{"type":"number","description":"The score for the category 'hate'."},"hate/threatening":{"type":"number","description":"The score for the category 'hate/threatening'."},"harassment":{"type":"number","description":"The score for the category 'harassment'."},"harassment/threatening":{"type":"number","description":"The score for the category 'harassment/threatening'."},"illicit":{"type":"number","description":"The score for the category 'illicit'."},"illicit/violent":{"type":"number","description":"The score for the category 'illicit/violent'."},"self-harm":{"type":"number","description":"The score for the category 'self-harm'."},"self-harm/intent":{"type":"number","description":"The score for the category 'self-harm/intent'."},"self-harm/instructions":{"type":"number","description":"The score for the category 'self-harm/instructions'."},"sexual":{"type":"number","description":"The score for the category 'sexual'."},"sexual/minors":{"type":"number","description":"The score for the category 'sexual/minors'."},"violence":{"type":"number","description":"The score for the category 'violence'."},"violence/graphic":{"type":"number","description":"The score for the category 'violence/graphic'."}},"required":["hate","hate/threatening","harassment","harassment/threatening","illicit","illicit/violent","self-harm","self-harm/intent","self-harm/instructions","sexual","sexual/minors","violence","violence/graphic"]},"category_applied_input_types":{"type":"object","description":"A list of the categories along with the input type(s) that the score applies to.","properties":{"hate":{"type":"array","description":"The applied input type(s) for the category 'hate'.","items":{"type":"string","enum":["text"],"x-stainless-const":true}},"hate/threatening":{"type":"array","description":"The applied input type(s) for the category 'hate/threatening'.","items":{"type":"string","enum":["text"],"x-stainless-const":true}},"harassment":{"type":"array","description":"The applied input type(s) for the category 'harassment'.","items":{"type":"string","enum":["text"],"x-stainless-const":true}},"harassment/threatening":{"type":"array","description":"The applied input type(s) for the category 'harassment/threatening'.","items":{"type":"string","enum":["text"],"x-stainless-const":true}},"illicit":{"type":"array","description":"The applied input type(s) for the category 'illicit'.","items":{"type":"string","enum":["text"],"x-stainless-const":true}},"illicit/violent":{"type":"array","description":"The applied input type(s) for the category 'illicit/violent'.","items":{"type":"string","enum":["text"],"x-stainless-const":true}},"self-harm":{"type":"array","description":"The applied input type(s) for the category 'self-harm'.","items":{"type":"string","enum":["text","image"]}},"self-harm/intent":{"type":"array","description":"The applied input type(s) for the category 'self-harm/intent'.","items":{"type":"string","enum":["text","image"]}},"self-harm/instructions":{"type":"array","description":"The applied input type(s) for the category 'self-harm/instructions'.","items":{"type":"string","enum":["text","image"]}},"sexual":{"type":"array","description":"The applied input type(s) for the category 'sexual'.","items":{"type":"string","enum":["text","image"]}},"sexual/minors":{"type":"array","description":"The applied input type(s) for the category 'sexual/minors'.","items":{"type":"string","enum":["text"],"x-stainless-const":true}},"violence":{"type":"array","description":"The applied input type(s) for the category 'violence'.","items":{"type":"string","enum":["text","image"]}},"violence/graphic":{"type":"array","description":"The applied input type(s) for the category 'violence/graphic'.","items":{"type":"string","enum":["text","image"]}}},"required":["hate","hate/threatening","harassment","harassment/threatening","illicit","illicit/violent","self-harm","self-harm/intent","self-harm/instructions","sexual","sexual/minors","violence","violence/graphic"]}},"required":["flagged","categories","category_scores","category_applied_input_types"]}}},"required":["id","model","results"],"x-oaiMeta":{"name":"The moderation object","example":"{\n \"id\": \"modr-0d9740456c391e43c445bf0f010940c7\",\n \"model\": \"omni-moderation-latest\",\n \"results\": [\n {\n \"flagged\": true,\n \"categories\": {\n \"harassment\": true,\n \"harassment/threatening\": true,\n \"sexual\": false,\n \"hate\": false,\n \"hate/threatening\": false,\n \"illicit\": false,\n \"illicit/violent\": false,\n \"self-harm/intent\": false,\n \"self-harm/instructions\": false,\n \"self-harm\": false,\n \"sexual/minors\": false,\n \"violence\": true,\n \"violence/graphic\": true\n },\n \"category_scores\": {\n \"harassment\": 0.8189693396524255,\n \"harassment/threatening\": 0.804985420696006,\n \"sexual\": 1.573112165348997e-6,\n \"hate\": 0.007562942636942845,\n \"hate/threatening\": 0.004208854591835476,\n \"illicit\": 0.030535955153511665,\n \"illicit/violent\": 0.008925306722380033,\n \"self-harm/intent\": 0.00023023930975076432,\n \"self-harm/instructions\": 0.0002293869201073356,\n \"self-harm\": 0.012598046106750154,\n \"sexual/minors\": 2.212566909570261e-8,\n \"violence\": 0.9999992735124786,\n \"violence/graphic\": 0.843064871157054\n },\n \"category_applied_input_types\": {\n \"harassment\": [\n \"text\"\n ],\n \"harassment/threatening\": [\n \"text\"\n ],\n \"sexual\": [\n \"text\",\n \"image\"\n ],\n \"hate\": [\n \"text\"\n ],\n \"hate/threatening\": [\n \"text\"\n ],\n \"illicit\": [\n \"text\"\n ],\n \"illicit/violent\": [\n \"text\"\n ],\n \"self-harm/intent\": [\n \"text\",\n \"image\"\n ],\n \"self-harm/instructions\": [\n \"text\",\n \"image\"\n ],\n \"self-harm\": [\n \"text\",\n \"image\"\n ],\n \"sexual/minors\": [\n \"text\"\n ],\n \"violence\": [\n \"text\",\n \"image\"\n ],\n \"violence/graphic\": [\n \"text\",\n \"image\"\n ]\n }\n }\n ]\n}\n"}},"CreateResponse":{"allOf":[{"$ref":"#/components/schemas/CreateModelResponseProperties"},{"$ref":"#/components/schemas/ResponseProperties"},{"type":"object","properties":{"input":{"$ref":"#/components/schemas/InputParam"},"include":{"anyOf":[{"type":"array","description":"Specify additional output data to include in the model response. Currently supported values are:\n- `web_search_call.action.sources`: Include the sources of the web search tool call.\n- `code_interpreter_call.outputs`: Includes the outputs of python code execution in code interpreter tool call items.\n- `computer_call_output.output.image_url`: Include image urls from the computer call output.\n- `file_search_call.results`: Include the search results of the file search tool call.\n- `message.input_image.image_url`: Include image urls from the input message.\n- `message.output_text.logprobs`: Include logprobs with assistant messages.\n- `reasoning.encrypted_content`: Includes an encrypted version of reasoning tokens in reasoning item outputs. This enables reasoning items to be used in multi-turn conversations when using the Responses API statelessly (like when the `store` parameter is set to `false`, or when an organization is enrolled in the zero data retention program).","items":{"$ref":"#/components/schemas/IncludeEnum"}},{"type":"null"}]},"parallel_tool_calls":{"anyOf":[{"type":"boolean","description":"Whether to allow the model to run tool calls in parallel.\n","default":true},{"type":"null"}]},"store":{"anyOf":[{"type":"boolean","description":"Whether to store the generated model response for later retrieval via\nAPI.\n","default":true},{"type":"null"}]},"instructions":{"anyOf":[{"type":"string","description":"A system (or developer) message inserted into the model's context.\n\nWhen using along with `previous_response_id`, the instructions from a previous\nresponse will not be carried over to the next response. This makes it simple\nto swap out system (or developer) messages in new responses.\n"},{"type":"null"}]},"stream":{"anyOf":[{"description":"If set to true, the model response data will be streamed to the client\nas it is generated using [server-sent events](https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events/Using_server-sent_events#Event_stream_format).\nSee the [Streaming section below](/docs/api-reference/responses-streaming)\nfor more information.\n","type":"boolean","default":false},{"type":"null"}]},"stream_options":{"$ref":"#/components/schemas/ResponseStreamOptions"},"conversation":{"anyOf":[{"$ref":"#/components/schemas/ConversationParam"},{"type":"null"}]},"context_management":{"anyOf":[{"type":"array","description":"Context management configuration for this request.\n","minItems":1,"items":{"$ref":"#/components/schemas/ContextManagementParam"}},{"type":"null"}]},"max_output_tokens":{"anyOf":[{"description":"An upper bound for the number of tokens that can be generated for a response, including visible output tokens and [reasoning tokens](/docs/guides/reasoning).\n","type":"integer","minimum":16},{"type":"null"}]}}}]},"CreateRunRequest":{"type":"object","additionalProperties":false,"properties":{"assistant_id":{"description":"The ID of the [assistant](/docs/api-reference/assistants) to use to execute this run.","type":"string"},"model":{"description":"The ID of the [Model](/docs/api-reference/models) to be used to execute this run. If a value is provided here, it will override the model associated with the assistant. If not, the model associated with the assistant will be used.","example":"gpt-4o","anyOf":[{"type":"string"},{"$ref":"#/components/schemas/AssistantSupportedModels"}],"x-oaiTypeLabel":"string","nullable":true},"reasoning_effort":{"$ref":"#/components/schemas/ReasoningEffort"},"instructions":{"description":"Overrides the [instructions](/docs/api-reference/assistants/createAssistant) of the assistant. This is useful for modifying the behavior on a per-run basis.","type":"string","nullable":true},"additional_instructions":{"description":"Appends additional instructions at the end of the instructions for the run. This is useful for modifying the behavior on a per-run basis without overriding other instructions.","type":"string","nullable":true},"additional_messages":{"description":"Adds additional messages to the thread before creating the run.","type":"array","items":{"$ref":"#/components/schemas/CreateMessageRequest"},"nullable":true},"tools":{"description":"Override the tools the assistant can use for this run. This is useful for modifying the behavior on a per-run basis.","nullable":true,"type":"array","maxItems":20,"items":{"oneOf":[{"$ref":"#/components/schemas/AssistantToolsCode"},{"$ref":"#/components/schemas/AssistantToolsFileSearch"},{"$ref":"#/components/schemas/AssistantToolsFunction"}]}},"metadata":{"$ref":"#/components/schemas/Metadata"},"temperature":{"type":"number","minimum":0,"maximum":2,"default":1,"example":1,"nullable":true,"description":"What sampling temperature to use, between 0 and 2. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic.\n"},"top_p":{"type":"number","minimum":0,"maximum":1,"default":1,"example":1,"nullable":true,"description":"An alternative to sampling with temperature, called nucleus sampling, where the model considers the results of the tokens with top_p probability mass. So 0.1 means only the tokens comprising the top 10% probability mass are considered.\n\nWe generally recommend altering this or temperature but not both.\n"},"stream":{"type":"boolean","nullable":true,"description":"If `true`, returns a stream of events that happen during the Run as server-sent events, terminating when the Run enters a terminal state with a `data: [DONE]` message.\n"},"max_prompt_tokens":{"type":"integer","nullable":true,"description":"The maximum number of prompt tokens that may be used over the course of the run. The run will make a best effort to use only the number of prompt tokens specified, across multiple turns of the run. If the run exceeds the number of prompt tokens specified, the run will end with status `incomplete`. See `incomplete_details` for more info.\n","minimum":256},"max_completion_tokens":{"type":"integer","nullable":true,"description":"The maximum number of completion tokens that may be used over the course of the run. The run will make a best effort to use only the number of completion tokens specified, across multiple turns of the run. If the run exceeds the number of completion tokens specified, the run will end with status `incomplete`. See `incomplete_details` for more info.\n","minimum":256},"truncation_strategy":{"allOf":[{"$ref":"#/components/schemas/TruncationObject"},{"nullable":true}]},"tool_choice":{"allOf":[{"$ref":"#/components/schemas/AssistantsApiToolChoiceOption"},{"nullable":true}]},"parallel_tool_calls":{"$ref":"#/components/schemas/ParallelToolCalls"},"response_format":{"$ref":"#/components/schemas/AssistantsApiResponseFormatOption","nullable":true}},"required":["assistant_id"]},"CreateSpeechRequest":{"type":"object","additionalProperties":false,"properties":{"model":{"description":"One of the available [TTS models](/docs/models#tts): `tts-1`, `tts-1-hd`, `gpt-4o-mini-tts`, or `gpt-4o-mini-tts-2025-12-15`.\n","anyOf":[{"type":"string"},{"type":"string","enum":["tts-1","tts-1-hd","gpt-4o-mini-tts","gpt-4o-mini-tts-2025-12-15"]}],"x-oaiTypeLabel":"string"},"input":{"type":"string","description":"The text to generate audio for. The maximum length is 4096 characters.","maxLength":4096},"instructions":{"type":"string","description":"Control the voice of your generated audio with additional instructions. Does not work with `tts-1` or `tts-1-hd`.","maxLength":4096},"voice":{"description":"The voice to use when generating the audio. Supported built-in voices are `alloy`, `ash`, `ballad`, `coral`, `echo`, `fable`, `onyx`, `nova`, `sage`, `shimmer`, `verse`, `marin`, and `cedar`. You may also provide a custom voice object with an `id`, for example `{ \"id\": \"voice_1234\" }`. Previews of the voices are available in the [Text to speech guide](/docs/guides/text-to-speech#voice-options).","$ref":"#/components/schemas/VoiceIdsOrCustomVoice"},"response_format":{"description":"The format to audio in. Supported formats are `mp3`, `opus`, `aac`, `flac`, `wav`, and `pcm`.","default":"mp3","type":"string","enum":["mp3","opus","aac","flac","wav","pcm"]},"speed":{"description":"The speed of the generated audio. Select a value from `0.25` to `4.0`. `1.0` is the default.","type":"number","default":1,"minimum":0.25,"maximum":4},"stream_format":{"description":"The format to stream the audio in. Supported formats are `sse` and `audio`. `sse` is not supported for `tts-1` or `tts-1-hd`.","type":"string","default":"audio","enum":["sse","audio"]}},"required":["model","input","voice"]},"CreateSpeechResponseStreamEvent":{"anyOf":[{"$ref":"#/components/schemas/SpeechAudioDeltaEvent"},{"$ref":"#/components/schemas/SpeechAudioDoneEvent"}],"discriminator":{"propertyName":"type"}},"CreateThreadAndRunRequest":{"type":"object","additionalProperties":false,"properties":{"assistant_id":{"description":"The ID of the [assistant](/docs/api-reference/assistants) to use to execute this run.","type":"string"},"thread":{"$ref":"#/components/schemas/CreateThreadRequest"},"model":{"description":"The ID of the [Model](/docs/api-reference/models) to be used to execute this run. If a value is provided here, it will override the model associated with the assistant. If not, the model associated with the assistant will be used.","example":"gpt-4o","anyOf":[{"type":"string"},{"type":"string","enum":["gpt-5","gpt-5-mini","gpt-5-nano","gpt-5-2025-08-07","gpt-5-mini-2025-08-07","gpt-5-nano-2025-08-07","gpt-4.1","gpt-4.1-mini","gpt-4.1-nano","gpt-4.1-2025-04-14","gpt-4.1-mini-2025-04-14","gpt-4.1-nano-2025-04-14","gpt-4o","gpt-4o-2024-11-20","gpt-4o-2024-08-06","gpt-4o-2024-05-13","gpt-4o-mini","gpt-4o-mini-2024-07-18","gpt-4.5-preview","gpt-4.5-preview-2025-02-27","gpt-4-turbo","gpt-4-turbo-2024-04-09","gpt-4-0125-preview","gpt-4-turbo-preview","gpt-4-1106-preview","gpt-4-vision-preview","gpt-4","gpt-4-0314","gpt-4-0613","gpt-4-32k","gpt-4-32k-0314","gpt-4-32k-0613","gpt-3.5-turbo","gpt-3.5-turbo-16k","gpt-3.5-turbo-0613","gpt-3.5-turbo-1106","gpt-3.5-turbo-0125","gpt-3.5-turbo-16k-0613"]}],"x-oaiTypeLabel":"string","nullable":true},"instructions":{"description":"Override the default system message of the assistant. This is useful for modifying the behavior on a per-run basis.","type":"string","nullable":true},"tools":{"description":"Override the tools the assistant can use for this run. This is useful for modifying the behavior on a per-run basis.","nullable":true,"type":"array","maxItems":20,"items":{"oneOf":[{"$ref":"#/components/schemas/AssistantToolsCode"},{"$ref":"#/components/schemas/AssistantToolsFileSearch"},{"$ref":"#/components/schemas/AssistantToolsFunction"}]}},"tool_resources":{"type":"object","description":"A set of resources that are used by the assistant's tools. The resources are specific to the type of tool. For example, the `code_interpreter` tool requires a list of file IDs, while the `file_search` tool requires a list of vector store IDs.\n","properties":{"code_interpreter":{"type":"object","properties":{"file_ids":{"type":"array","description":"A list of [file](/docs/api-reference/files) IDs made available to the `code_interpreter` tool. There can be a maximum of 20 files associated with the tool.\n","default":[],"maxItems":20,"items":{"type":"string"}}}},"file_search":{"type":"object","properties":{"vector_store_ids":{"type":"array","description":"The ID of the [vector store](/docs/api-reference/vector-stores/object) attached to this assistant. There can be a maximum of 1 vector store attached to the assistant.\n","maxItems":1,"items":{"type":"string"}}}}},"nullable":true},"metadata":{"$ref":"#/components/schemas/Metadata"},"temperature":{"type":"number","minimum":0,"maximum":2,"default":1,"example":1,"nullable":true,"description":"What sampling temperature to use, between 0 and 2. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic.\n"},"top_p":{"type":"number","minimum":0,"maximum":1,"default":1,"example":1,"nullable":true,"description":"An alternative to sampling with temperature, called nucleus sampling, where the model considers the results of the tokens with top_p probability mass. So 0.1 means only the tokens comprising the top 10% probability mass are considered.\n\nWe generally recommend altering this or temperature but not both.\n"},"stream":{"type":"boolean","nullable":true,"description":"If `true`, returns a stream of events that happen during the Run as server-sent events, terminating when the Run enters a terminal state with a `data: [DONE]` message.\n"},"max_prompt_tokens":{"type":"integer","nullable":true,"description":"The maximum number of prompt tokens that may be used over the course of the run. The run will make a best effort to use only the number of prompt tokens specified, across multiple turns of the run. If the run exceeds the number of prompt tokens specified, the run will end with status `incomplete`. See `incomplete_details` for more info.\n","minimum":256},"max_completion_tokens":{"type":"integer","nullable":true,"description":"The maximum number of completion tokens that may be used over the course of the run. The run will make a best effort to use only the number of completion tokens specified, across multiple turns of the run. If the run exceeds the number of completion tokens specified, the run will end with status `incomplete`. See `incomplete_details` for more info.\n","minimum":256},"truncation_strategy":{"allOf":[{"$ref":"#/components/schemas/TruncationObject"},{"nullable":true}]},"tool_choice":{"allOf":[{"$ref":"#/components/schemas/AssistantsApiToolChoiceOption"},{"nullable":true}]},"parallel_tool_calls":{"$ref":"#/components/schemas/ParallelToolCalls"},"response_format":{"$ref":"#/components/schemas/AssistantsApiResponseFormatOption","nullable":true}},"required":["assistant_id"]},"CreateThreadRequest":{"type":"object","description":"Options to create a new thread. If no thread is provided when running a\nrequest, an empty thread will be created.\n","additionalProperties":false,"properties":{"messages":{"description":"A list of [messages](/docs/api-reference/messages) to start the thread with.","type":"array","items":{"$ref":"#/components/schemas/CreateMessageRequest"}},"tool_resources":{"anyOf":[{"type":"object","description":"A set of resources that are made available to the assistant's tools in this thread. The resources are specific to the type of tool. For example, the `code_interpreter` tool requires a list of file IDs, while the `file_search` tool requires a list of vector store IDs.\n","properties":{"code_interpreter":{"type":"object","properties":{"file_ids":{"type":"array","description":"A list of [file](/docs/api-reference/files) IDs made available to the `code_interpreter` tool. There can be a maximum of 20 files associated with the tool.\n","default":[],"maxItems":20,"items":{"type":"string"}}}},"file_search":{"type":"object","properties":{"vector_store_ids":{"type":"array","description":"The [vector store](/docs/api-reference/vector-stores/object) attached to this thread. There can be a maximum of 1 vector store attached to the thread.\n","maxItems":1,"items":{"type":"string"}},"vector_stores":{"type":"array","description":"A helper to create a [vector store](/docs/api-reference/vector-stores/object) with file_ids and attach it to this thread. There can be a maximum of 1 vector store attached to the thread.\n","maxItems":1,"items":{"type":"object","properties":{"file_ids":{"type":"array","description":"A list of [file](/docs/api-reference/files) IDs to add to the vector store. For vector stores created before Nov 2025, there can be a maximum of 10,000 files in a vector store. For vector stores created starting in Nov 2025, the limit is 100,000,000 files.\n","maxItems":100000000,"items":{"type":"string"}},"chunking_strategy":{"type":"object","description":"The chunking strategy used to chunk the file(s). If not set, will use the `auto` strategy.","oneOf":[{"type":"object","title":"Auto Chunking Strategy","description":"The default strategy. This strategy currently uses a `max_chunk_size_tokens` of `800` and `chunk_overlap_tokens` of `400`.","additionalProperties":false,"properties":{"type":{"type":"string","description":"Always `auto`.","enum":["auto"],"x-stainless-const":true}},"required":["type"]},{"type":"object","title":"Static Chunking Strategy","additionalProperties":false,"properties":{"type":{"type":"string","description":"Always `static`.","enum":["static"],"x-stainless-const":true},"static":{"type":"object","additionalProperties":false,"properties":{"max_chunk_size_tokens":{"type":"integer","minimum":100,"maximum":4096,"description":"The maximum number of tokens in each chunk. The default value is `800`. The minimum value is `100` and the maximum value is `4096`."},"chunk_overlap_tokens":{"type":"integer","description":"The number of tokens that overlap between chunks. The default value is `400`.\n\nNote that the overlap must not exceed half of `max_chunk_size_tokens`.\n"}},"required":["max_chunk_size_tokens","chunk_overlap_tokens"]}},"required":["type","static"]}]},"metadata":{"$ref":"#/components/schemas/Metadata"}}}}},"oneOf":[{"required":["vector_store_ids"]},{"required":["vector_stores"]}]}}},{"type":"null"}]},"metadata":{"$ref":"#/components/schemas/Metadata"}}},"CreateTranscriptionRequest":{"type":"object","additionalProperties":false,"properties":{"file":{"description":"The audio file object (not file name) to transcribe, in one of these formats: flac, mp3, mp4, mpeg, mpga, m4a, ogg, wav, or webm.\n","type":"string","x-oaiTypeLabel":"file","format":"binary"},"model":{"description":"ID of the model to use. The options are `gpt-4o-transcribe`, `gpt-4o-mini-transcribe`, `gpt-4o-mini-transcribe-2025-12-15`, `whisper-1` (which is powered by our open source Whisper V2 model), and `gpt-4o-transcribe-diarize`.\n","example":"gpt-4o-transcribe","anyOf":[{"type":"string"},{"type":"string","enum":["whisper-1","gpt-4o-transcribe","gpt-4o-mini-transcribe","gpt-4o-mini-transcribe-2025-12-15","gpt-4o-transcribe-diarize"],"x-stainless-const":true}],"x-oaiTypeLabel":"string"},"language":{"description":"The language of the input audio. Supplying the input language in [ISO-639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) (e.g. `en`) format will improve accuracy and latency.\n","type":"string"},"prompt":{"description":"An optional text to guide the model's style or continue a previous audio segment. The [prompt](/docs/guides/speech-to-text#prompting) should match the audio language. This field is not supported when using `gpt-4o-transcribe-diarize`.\n","type":"string"},"response_format":{"$ref":"#/components/schemas/AudioResponseFormat"},"temperature":{"description":"The sampling temperature, between 0 and 1. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic. If set to 0, the model will use [log probability](https://en.wikipedia.org/wiki/Log_probability) to automatically increase the temperature until certain thresholds are hit.\n","type":"number","default":0},"include":{"description":"Additional information to include in the transcription response.\n`logprobs` will return the log probabilities of the tokens in the\nresponse to understand the model's confidence in the transcription.\n`logprobs` only works with response_format set to `json` and only with\nthe models `gpt-4o-transcribe`, `gpt-4o-mini-transcribe`, and `gpt-4o-mini-transcribe-2025-12-15`. This field is not supported when using `gpt-4o-transcribe-diarize`.\n","type":"array","items":{"$ref":"#/components/schemas/TranscriptionInclude"}},"timestamp_granularities":{"description":"The timestamp granularities to populate for this transcription. `response_format` must be set `verbose_json` to use timestamp granularities. Either or both of these options are supported: `word`, or `segment`. Note: There is no additional latency for segment timestamps, but generating word timestamps incurs additional latency.\nThis option is not available for `gpt-4o-transcribe-diarize`.\n","type":"array","items":{"type":"string","enum":["word","segment"]},"default":["segment"]},"stream":{"anyOf":[{"description":"If set to true, the model response data will be streamed to the client\nas it is generated using [server-sent events](https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events/Using_server-sent_events#Event_stream_format).\nSee the [Streaming section of the Speech-to-Text guide](/docs/guides/speech-to-text?lang=curl#streaming-transcriptions)\nfor more information.\n\nNote: Streaming is not supported for the `whisper-1` model and will be ignored.\n","type":"boolean","default":false},{"type":"null"}]},"chunking_strategy":{"anyOf":[{"description":"Controls how the audio is cut into chunks. When set to `\"auto\"`, the server first normalizes loudness and then uses voice activity detection (VAD) to choose boundaries. `server_vad` object can be provided to tweak VAD detection parameters manually. If unset, the audio is transcribed as a single block. Required when using `gpt-4o-transcribe-diarize` for inputs longer than 30 seconds. ","anyOf":[{"type":"string","enum":["auto"],"default":"auto","description":"Automatically set chunking parameters based on the audio. Must be set to `\"auto\"`.\n","x-stainless-const":true},{"$ref":"#/components/schemas/VadConfig"}],"x-oaiTypeLabel":"string"},{"type":"null"}]},"known_speaker_names":{"description":"Optional list of speaker names that correspond to the audio samples provided in `known_speaker_references[]`. Each entry should be a short identifier (for example `customer` or `agent`). Up to 4 speakers are supported.\n","type":"array","maxItems":4,"items":{"type":"string"}},"known_speaker_references":{"description":"Optional list of audio samples (as [data URLs](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/Data_URLs)) that contain known speaker references matching `known_speaker_names[]`. Each sample must be between 2 and 10 seconds, and can use any of the same input audio formats supported by `file`.\n","type":"array","maxItems":4,"items":{"type":"string"}}},"required":["file","model"]},"CreateTranscriptionResponseDiarizedJson":{"type":"object","description":"Represents a diarized transcription response returned by the model, including the combined transcript and speaker-segment annotations.\n","properties":{"task":{"type":"string","description":"The type of task that was run. Always `transcribe`.","enum":["transcribe"],"x-stainless-const":true},"duration":{"type":"number","description":"Duration of the input audio in seconds."},"text":{"type":"string","description":"The concatenated transcript text for the entire audio input."},"segments":{"type":"array","description":"Segments of the transcript annotated with timestamps and speaker labels.","items":{"$ref":"#/components/schemas/TranscriptionDiarizedSegment"}},"usage":{"type":"object","description":"Token or duration usage statistics for the request.","oneOf":[{"$ref":"#/components/schemas/TranscriptTextUsageTokens","title":"Token Usage"},{"$ref":"#/components/schemas/TranscriptTextUsageDuration","title":"Duration Usage"}],"discriminator":{"propertyName":"type"}}},"required":["task","duration","text","segments"],"x-oaiMeta":{"name":"The transcription object (Diarized JSON)","group":"audio","example":"{\n \"task\": \"transcribe\",\n \"duration\": 42.7,\n \"text\": \"Agent: Thanks for calling OpenAI support.\\nCustomer: Hi, I need help with diarization.\",\n \"segments\": [\n {\n \"type\": \"transcript.text.segment\",\n \"id\": \"seg_001\",\n \"start\": 0.0,\n \"end\": 5.2,\n \"text\": \"Thanks for calling OpenAI support.\",\n \"speaker\": \"agent\"\n },\n {\n \"type\": \"transcript.text.segment\",\n \"id\": \"seg_002\",\n \"start\": 5.2,\n \"end\": 12.8,\n \"text\": \"Hi, I need help with diarization.\",\n \"speaker\": \"A\"\n }\n ],\n \"usage\": {\n \"type\": \"duration\",\n \"seconds\": 43\n }\n}\n"}},"CreateTranscriptionResponseJson":{"type":"object","description":"Represents a transcription response returned by model, based on the provided input.","properties":{"text":{"type":"string","description":"The transcribed text."},"logprobs":{"type":"array","optional":true,"description":"The log probabilities of the tokens in the transcription. Only returned with the models `gpt-4o-transcribe` and `gpt-4o-mini-transcribe` if `logprobs` is added to the `include` array.\n","items":{"type":"object","properties":{"token":{"type":"string","description":"The token in the transcription."},"logprob":{"type":"number","description":"The log probability of the token."},"bytes":{"type":"array","items":{"type":"number"},"description":"The bytes of the token."}}}},"usage":{"type":"object","description":"Token usage statistics for the request.","oneOf":[{"$ref":"#/components/schemas/TranscriptTextUsageTokens","title":"Token Usage"},{"$ref":"#/components/schemas/TranscriptTextUsageDuration","title":"Duration Usage"}]}},"required":["text"],"x-oaiMeta":{"name":"The transcription object (JSON)","group":"audio","example":"{\n \"text\": \"Imagine the wildest idea that you've ever had, and you're curious about how it might scale to something that's a 100, a 1,000 times bigger. This is a place where you can get to do that.\",\n \"usage\": {\n \"type\": \"tokens\",\n \"input_tokens\": 14,\n \"input_token_details\": {\n \"text_tokens\": 10,\n \"audio_tokens\": 4\n },\n \"output_tokens\": 101,\n \"total_tokens\": 115\n }\n}\n"}},"CreateTranscriptionResponseStreamEvent":{"anyOf":[{"$ref":"#/components/schemas/TranscriptTextSegmentEvent"},{"$ref":"#/components/schemas/TranscriptTextDeltaEvent"},{"$ref":"#/components/schemas/TranscriptTextDoneEvent"}],"discriminator":{"propertyName":"type"}},"CreateTranscriptionResponseVerboseJson":{"type":"object","description":"Represents a verbose json transcription response returned by model, based on the provided input.","properties":{"language":{"type":"string","description":"The language of the input audio."},"duration":{"type":"number","description":"The duration of the input audio."},"text":{"type":"string","description":"The transcribed text."},"words":{"type":"array","description":"Extracted words and their corresponding timestamps.","items":{"$ref":"#/components/schemas/TranscriptionWord"}},"segments":{"type":"array","description":"Segments of the transcribed text and their corresponding details.","items":{"$ref":"#/components/schemas/TranscriptionSegment"}},"usage":{"$ref":"#/components/schemas/TranscriptTextUsageDuration"}},"required":["language","duration","text"],"x-oaiMeta":{"name":"The transcription object (Verbose JSON)","group":"audio","example":"{\n \"task\": \"transcribe\",\n \"language\": \"english\",\n \"duration\": 8.470000267028809,\n \"text\": \"The beach was a popular spot on a hot summer day. People were swimming in the ocean, building sandcastles, and playing beach volleyball.\",\n \"segments\": [\n {\n \"id\": 0,\n \"seek\": 0,\n \"start\": 0.0,\n \"end\": 3.319999933242798,\n \"text\": \" The beach was a popular spot on a hot summer day.\",\n \"tokens\": [\n 50364, 440, 7534, 390, 257, 3743, 4008, 322, 257, 2368, 4266, 786, 13, 50530\n ],\n \"temperature\": 0.0,\n \"avg_logprob\": -0.2860786020755768,\n \"compression_ratio\": 1.2363636493682861,\n \"no_speech_prob\": 0.00985979475080967\n },\n ...\n ],\n \"usage\": {\n \"type\": \"duration\",\n \"seconds\": 9\n }\n}\n"}},"CreateTranslationRequest":{"type":"object","additionalProperties":false,"properties":{"file":{"description":"The audio file object (not file name) translate, in one of these formats: flac, mp3, mp4, mpeg, mpga, m4a, ogg, wav, or webm.\n","type":"string","x-oaiTypeLabel":"file","format":"binary"},"model":{"description":"ID of the model to use. Only `whisper-1` (which is powered by our open source Whisper V2 model) is currently available.\n","example":"whisper-1","anyOf":[{"type":"string"},{"type":"string","enum":["whisper-1"],"x-stainless-const":true}],"x-oaiTypeLabel":"string"},"prompt":{"description":"An optional text to guide the model's style or continue a previous audio segment. The [prompt](/docs/guides/speech-to-text#prompting) should be in English.\n","type":"string"},"response_format":{"description":"The format of the output, in one of these options: `json`, `text`, `srt`, `verbose_json`, or `vtt`.\n","type":"string","enum":["json","text","srt","verbose_json","vtt"],"default":"json"},"temperature":{"description":"The sampling temperature, between 0 and 1. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic. If set to 0, the model will use [log probability](https://en.wikipedia.org/wiki/Log_probability) to automatically increase the temperature until certain thresholds are hit.\n","type":"number","default":0}},"required":["file","model"]},"CreateTranslationResponseJson":{"type":"object","properties":{"text":{"type":"string"}},"required":["text"]},"CreateTranslationResponseVerboseJson":{"type":"object","properties":{"language":{"type":"string","description":"The language of the output translation (always `english`)."},"duration":{"type":"number","description":"The duration of the input audio."},"text":{"type":"string","description":"The translated text."},"segments":{"type":"array","description":"Segments of the translated text and their corresponding details.","items":{"$ref":"#/components/schemas/TranscriptionSegment"}}},"required":["language","duration","text"]},"CreateUploadRequest":{"type":"object","additionalProperties":false,"properties":{"filename":{"description":"The name of the file to upload.\n","type":"string"},"purpose":{"description":"The intended purpose of the uploaded file.\n\nSee the [documentation on File\npurposes](/docs/api-reference/files/create#files-create-purpose).\n","type":"string","enum":["assistants","batch","fine-tune","vision"]},"bytes":{"description":"The number of bytes in the file you are uploading.\n","type":"integer"},"mime_type":{"description":"The MIME type of the file.\n\n\nThis must fall within the supported MIME types for your file purpose. See\nthe supported MIME types for assistants and vision.\n","type":"string"},"expires_after":{"$ref":"#/components/schemas/FileExpirationAfter"}},"required":["filename","purpose","bytes","mime_type"]},"CreateVectorStoreFileBatchRequest":{"type":"object","additionalProperties":false,"properties":{"file_ids":{"description":"A list of [File](/docs/api-reference/files) IDs that the vector store should use. Useful for tools like `file_search` that can access files. If `attributes` or `chunking_strategy` are provided, they will be applied to all files in the batch. The maximum batch size is 2000 files. This endpoint is recommended for multi-file ingestion and helps reduce per-vector-store write request pressure. Mutually exclusive with `files`.","type":"array","minItems":1,"maxItems":2000,"items":{"type":"string"}},"files":{"description":"A list of objects that each include a `file_id` plus optional `attributes` or `chunking_strategy`. Use this when you need to override metadata for specific files. The global `attributes` or `chunking_strategy` will be ignored and must be specified for each file. The maximum batch size is 2000 files. This endpoint is recommended for multi-file ingestion and helps reduce per-vector-store write request pressure. Mutually exclusive with `file_ids`.","type":"array","minItems":1,"maxItems":2000,"items":{"$ref":"#/components/schemas/CreateVectorStoreFileRequest"}},"chunking_strategy":{"$ref":"#/components/schemas/ChunkingStrategyRequestParam"},"attributes":{"$ref":"#/components/schemas/VectorStoreFileAttributes"}},"anyOf":[{"required":["file_ids"]},{"required":["files"]}]},"CreateVectorStoreFileRequest":{"type":"object","additionalProperties":false,"properties":{"file_id":{"description":"A [File](/docs/api-reference/files) ID that the vector store should use. Useful for tools like `file_search` that can access files. For multi-file ingestion, we recommend [`file_batches`](/docs/api-reference/vector-stores-file-batches/createBatch) to minimize per-vector-store write requests.","type":"string"},"chunking_strategy":{"$ref":"#/components/schemas/ChunkingStrategyRequestParam"},"attributes":{"$ref":"#/components/schemas/VectorStoreFileAttributes"}},"required":["file_id"]},"CreateVectorStoreRequest":{"type":"object","additionalProperties":false,"properties":{"file_ids":{"description":"A list of [File](/docs/api-reference/files) IDs that the vector store should use. Useful for tools like `file_search` that can access files.","type":"array","maxItems":500,"items":{"type":"string"}},"name":{"description":"The name of the vector store.","type":"string"},"description":{"description":"A description for the vector store. Can be used to describe the vector store's purpose.","type":"string"},"expires_after":{"$ref":"#/components/schemas/VectorStoreExpirationAfter"},"chunking_strategy":{"type":"object","description":"The chunking strategy used to chunk the file(s). If not set, will use the `auto` strategy. Only applicable if `file_ids` is non-empty.","oneOf":[{"$ref":"#/components/schemas/AutoChunkingStrategyRequestParam"},{"$ref":"#/components/schemas/StaticChunkingStrategyRequestParam"}]},"metadata":{"$ref":"#/components/schemas/Metadata"}}},"CreateVoiceConsentRequest":{"type":"object","additionalProperties":false,"properties":{"name":{"type":"string","description":"The label to use for this consent recording."},"recording":{"type":"string","format":"binary","x-oaiTypeLabel":"file","description":"The consent audio recording file. Maximum size is 10 MiB.\n\nSupported MIME types:\n`audio/mpeg`, `audio/wav`, `audio/x-wav`, `audio/ogg`, `audio/aac`, `audio/flac`, `audio/webm`, `audio/mp4`.\n"},"language":{"type":"string","description":"The BCP 47 language tag for the consent phrase (for example, `en-US`)."}},"required":["name","recording","language"]},"CreateVoiceRequest":{"type":"object","additionalProperties":false,"properties":{"name":{"type":"string","description":"The name of the new voice."},"audio_sample":{"type":"string","format":"binary","x-oaiTypeLabel":"file","description":"The sample audio recording file. Maximum size is 10 MiB.\n\nSupported MIME types:\n`audio/mpeg`, `audio/wav`, `audio/x-wav`, `audio/ogg`, `audio/aac`, `audio/flac`, `audio/webm`, `audio/mp4`.\n"},"consent":{"type":"string","description":"The consent recording ID (for example, `cons_1234`)."}},"required":["name","audio_sample","consent"]},"CustomToolCall":{"type":"object","title":"Custom tool call","description":"A call to a custom tool created by the model.\n","properties":{"type":{"type":"string","enum":["custom_tool_call"],"x-stainless-const":true,"description":"The type of the custom tool call. Always `custom_tool_call`.\n"},"id":{"type":"string","description":"The unique ID of the custom tool call in the OpenAI platform.\n"},"call_id":{"type":"string","description":"An identifier used to map this custom tool call to a tool call output.\n"},"namespace":{"type":"string","description":"The namespace of the custom tool being called.\n"},"name":{"type":"string","description":"The name of the custom tool being called.\n"},"input":{"type":"string","description":"The input for the custom tool call generated by the model.\n"}},"required":["type","call_id","name","input"]},"CustomToolCallOutput":{"type":"object","title":"Custom tool call output","description":"The output of a custom tool call from your code, being sent back to the model.\n","properties":{"type":{"type":"string","enum":["custom_tool_call_output"],"x-stainless-const":true,"description":"The type of the custom tool call output. Always `custom_tool_call_output`.\n"},"id":{"type":"string","description":"The unique ID of the custom tool call output in the OpenAI platform.\n"},"call_id":{"type":"string","description":"The call ID, used to map this custom tool call output to a custom tool call.\n"},"output":{"description":"The output from the custom tool call generated by your code.\nCan be a string or an list of output content.\n","oneOf":[{"type":"string","description":"A string of the output of the custom tool call.\n","title":"string output"},{"type":"array","items":{"$ref":"#/components/schemas/FunctionAndCustomToolCallOutput"},"title":"output content list","description":"Text, image, or file output of the custom tool call.\n"}]}},"required":["type","call_id","output"]},"CustomToolCallOutputResource":{"title":"ResponseCustomToolCallOutputItem","allOf":[{"$ref":"#/components/schemas/CustomToolCallOutput"},{"type":"object","properties":{"id":{"type":"string","description":"The unique ID of the custom tool call output item.\n"},"status":{"description":"The status of the item. One of `in_progress`, `completed`, or\n`incomplete`. Populated when items are returned via API.\n","$ref":"#/components/schemas/FunctionCallOutputStatusEnum"},"created_by":{"type":"string","description":"The identifier of the actor that created the item.\n"}},"required":["id","status"]}]},"CustomToolCallResource":{"title":"ResponseCustomToolCallItem","allOf":[{"$ref":"#/components/schemas/CustomToolCall"},{"type":"object","properties":{"id":{"type":"string","description":"The unique ID of the custom tool call item.\n"},"status":{"description":"The status of the item. One of `in_progress`, `completed`, or\n`incomplete`. Populated when items are returned via API.\n","$ref":"#/components/schemas/FunctionCallStatus"},"created_by":{"type":"string","description":"The identifier of the actor that created the item.\n"}},"required":["id","status"]}]},"CustomToolChatCompletions":{"type":"object","title":"Custom tool","description":"A custom tool that processes input using a specified format.\n","properties":{"type":{"type":"string","enum":["custom"],"description":"The type of the custom tool. Always `custom`.","x-stainless-const":true},"custom":{"type":"object","title":"Custom tool properties","description":"Properties of the custom tool.\n","properties":{"name":{"type":"string","description":"The name of the custom tool, used to identify it in tool calls."},"description":{"type":"string","description":"Optional description of the custom tool, used to provide more context.\n"},"format":{"description":"The input format for the custom tool. Default is unconstrained text.\n","oneOf":[{"type":"object","title":"Text format","description":"Unconstrained free-form text.","properties":{"type":{"type":"string","enum":["text"],"description":"Unconstrained text format. Always `text`.","x-stainless-const":true}},"required":["type"],"additionalProperties":false},{"type":"object","title":"Grammar format","description":"A grammar defined by the user.","properties":{"type":{"type":"string","enum":["grammar"],"description":"Grammar format. Always `grammar`.","x-stainless-const":true},"grammar":{"type":"object","title":"Grammar format","description":"Your chosen grammar.","properties":{"definition":{"type":"string","description":"The grammar definition."},"syntax":{"type":"string","description":"The syntax of the grammar definition. One of `lark` or `regex`.","enum":["lark","regex"]}},"required":["definition","syntax"]}},"required":["type","grammar"],"additionalProperties":false}]}},"required":["name"]}},"required":["type","custom"]},"DeleteAssistantResponse":{"type":"object","properties":{"id":{"type":"string"},"deleted":{"type":"boolean"},"object":{"type":"string","enum":["assistant.deleted"],"x-stainless-const":true}},"required":["id","object","deleted"]},"DeleteCertificateResponse":{"type":"object","properties":{"object":{"type":"string","description":"The object type, must be `certificate.deleted`.","enum":["certificate.deleted"],"x-stainless-const":true},"id":{"type":"string","description":"The ID of the certificate that was deleted."}},"required":["object","id"]},"DeleteFileResponse":{"type":"object","properties":{"id":{"type":"string"},"object":{"type":"string","enum":["file"],"x-stainless-const":true},"deleted":{"type":"boolean"}},"required":["id","object","deleted"]},"DeleteFineTuningCheckpointPermissionResponse":{"type":"object","properties":{"id":{"type":"string","description":"The ID of the fine-tuned model checkpoint permission that was deleted."},"object":{"type":"string","description":"The object type, which is always \"checkpoint.permission\".","enum":["checkpoint.permission"],"x-stainless-const":true},"deleted":{"type":"boolean","description":"Whether the fine-tuned model checkpoint permission was successfully deleted."}},"required":["id","object","deleted"]},"DeleteMessageResponse":{"type":"object","properties":{"id":{"type":"string"},"deleted":{"type":"boolean"},"object":{"type":"string","enum":["thread.message.deleted"],"x-stainless-const":true}},"required":["id","object","deleted"]},"DeleteModelResponse":{"type":"object","properties":{"id":{"type":"string"},"deleted":{"type":"boolean"},"object":{"type":"string"}},"required":["id","object","deleted"]},"DeleteThreadResponse":{"type":"object","properties":{"id":{"type":"string"},"deleted":{"type":"boolean"},"object":{"type":"string","enum":["thread.deleted"],"x-stainless-const":true}},"required":["id","object","deleted"]},"DeleteVectorStoreFileResponse":{"type":"object","properties":{"id":{"type":"string"},"deleted":{"type":"boolean"},"object":{"type":"string","enum":["vector_store.file.deleted"],"x-stainless-const":true}},"required":["id","object","deleted"]},"DeleteVectorStoreResponse":{"type":"object","properties":{"id":{"type":"string"},"deleted":{"type":"boolean"},"object":{"type":"string","enum":["vector_store.deleted"],"x-stainless-const":true}},"required":["id","object","deleted"]},"DeletedConversation":{"title":"The deleted conversation object","allOf":[{"$ref":"#/components/schemas/DeletedConversationResource"}],"x-oaiMeta":{"name":"The deleted conversation object","group":"conversations"}},"DeletedRoleAssignmentResource":{"type":"object","description":"Confirmation payload returned after unassigning a role.","properties":{"object":{"type":"string","description":"Identifier for the deleted assignment, such as `group.role.deleted` or `user.role.deleted`."},"deleted":{"type":"boolean","description":"Whether the assignment was removed."}},"required":["object","deleted"],"x-oaiMeta":{"name":"Role assignment deletion confirmation","example":"{\n \"object\": \"group.role.deleted\",\n \"deleted\": true\n}\n"}},"DoneEvent":{"type":"object","properties":{"event":{"type":"string","enum":["done"],"x-stainless-const":true},"data":{"type":"string","enum":["[DONE]"],"x-stainless-const":true}},"required":["event","data"],"description":"Occurs when a stream ends.","x-oaiMeta":{"dataDescription":"`data` is `[DONE]`"}},"EasyInputMessage":{"type":"object","title":"Input message","description":"A message input to the model with a role indicating instruction following\nhierarchy. Instructions given with the `developer` or `system` role take\nprecedence over instructions given with the `user` role. Messages with the\n`assistant` role are presumed to have been generated by the model in previous\ninteractions.\n","properties":{"role":{"type":"string","description":"The role of the message input. One of `user`, `assistant`, `system`, or\n`developer`.\n","enum":["user","assistant","system","developer"]},"content":{"description":"Text, image, or audio input to the model, used to generate a response.\nCan also contain previous assistant responses.\n","oneOf":[{"type":"string","title":"Text input","description":"A text input to the model.\n"},{"$ref":"#/components/schemas/InputMessageContentList"}]},"phase":{"anyOf":[{"$ref":"#/components/schemas/MessagePhase"},{"type":"null"}]},"type":{"type":"string","description":"The type of the message input. Always `message`.\n","enum":["message"],"x-stainless-const":true}},"required":["role","content"]},"EditImageBodyJsonParam":{"type":"object","description":"JSON request body for image edits.\n\nUse `images` (array of `ImageRefParam`) instead of multipart `image` uploads.\nYou can reference images via external URLs, data URLs, or uploaded file IDs.\nJSON edits support GPT image models only; DALL-E edits require multipart (`dall-e-2` only).\n","properties":{"model":{"anyOf":[{"type":"string"},{"type":"string","enum":["gpt-image-1.5","gpt-image-1","gpt-image-1-mini","chatgpt-image-latest"]},{"type":"null"}],"x-oaiTypeLabel":"string","default":"gpt-image-1.5","example":"gpt-image-1.5","description":"The model to use for image editing."},"images":{"type":"array","minItems":1,"maxItems":16,"description":"Input image references to edit.\nFor GPT image models, you can provide up to 16 images.\n","items":{"$ref":"#/components/schemas/ImageRefParam"}},"mask":{"$ref":"#/components/schemas/ImageRefParam"},"prompt":{"type":"string","minLength":1,"maxLength":32000,"example":"Add a watercolor effect and keep the subject centered","description":"A text description of the desired image edit."},"n":{"anyOf":[{"type":"integer","minimum":1,"maximum":10},{"type":"null"}],"default":1,"example":1,"description":"The number of edited images to generate."},"quality":{"anyOf":[{"type":"string","enum":["low","medium","high","auto"]},{"type":"null"}],"default":"auto","example":"high","description":"Output quality for GPT image models.\n"},"input_fidelity":{"anyOf":[{"type":"string","enum":["high","low"]},{"type":"null"}],"description":"Controls fidelity to the original input image(s)."},"size":{"anyOf":[{"type":"string","enum":["auto","1024x1024","1536x1024","1024x1536"]},{"type":"null"}],"default":"auto","example":"1024x1024","description":"Requested output image size."},"user":{"type":"string","example":"user-1234","description":"A unique identifier representing your end-user, which can help OpenAI\nmonitor and detect abuse.\n"},"output_format":{"anyOf":[{"type":"string","enum":["png","jpeg","webp"]},{"type":"null"}],"default":"png","example":"png","description":"Output image format. Supported for GPT image models."},"output_compression":{"anyOf":[{"type":"integer","minimum":0,"maximum":100},{"type":"null"}],"example":100,"description":"Compression level for `jpeg` or `webp` output."},"moderation":{"anyOf":[{"type":"string","enum":["low","auto"]},{"type":"null"}],"default":"auto","example":"auto","description":"Moderation level for GPT image models."},"background":{"anyOf":[{"type":"string","enum":["transparent","opaque","auto"]},{"type":"null"}],"default":"auto","example":"transparent","description":"Background behavior for generated image output."},"stream":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":false,"example":false,"description":"Stream partial image results as events."},"partial_images":{"$ref":"#/components/schemas/PartialImages"}},"required":["images","prompt"]},"Embedding":{"type":"object","description":"Represents an embedding vector returned by embedding endpoint.\n","properties":{"index":{"type":"integer","description":"The index of the embedding in the list of embeddings."},"embedding":{"type":"array","description":"The embedding vector, which is a list of floats. The length of vector depends on the model as listed in the [embedding guide](/docs/guides/embeddings).\n","items":{"type":"number","format":"float"}},"object":{"type":"string","description":"The object type, which is always \"embedding\".","enum":["embedding"],"x-stainless-const":true}},"required":["index","object","embedding"],"x-oaiMeta":{"name":"The embedding object","example":"{\n \"object\": \"embedding\",\n \"embedding\": [\n 0.0023064255,\n -0.009327292,\n .... (1536 floats total for ada-002)\n -0.0028842222,\n ],\n \"index\": 0\n}\n"}},"Error":{"type":"object","properties":{"code":{"anyOf":[{"type":"string"},{"type":"null"}]},"message":{"type":"string"},"param":{"anyOf":[{"type":"string"},{"type":"null"}]},"type":{"type":"string"}},"required":["type","message","param","code"]},"ErrorEvent":{"type":"object","properties":{"event":{"type":"string","enum":["error"],"x-stainless-const":true},"data":{"$ref":"#/components/schemas/Error"}},"required":["event","data"],"description":"Occurs when an [error](/docs/guides/error-codes#api-errors) occurs. This can happen due to an internal server error or a timeout.","x-oaiMeta":{"dataDescription":"`data` is an [error](/docs/guides/error-codes#api-errors)"}},"ErrorResponse":{"type":"object","properties":{"error":{"$ref":"#/components/schemas/Error"}},"required":["error"]},"Eval":{"type":"object","title":"Eval","description":"An Eval object with a data source config and testing criteria.\nAn Eval represents a task to be done for your LLM integration.\nLike:\n - Improve the quality of my chatbot\n - See how well my chatbot handles customer support\n - Check if o4-mini is better at my usecase than gpt-4o\n","properties":{"object":{"type":"string","enum":["eval"],"default":"eval","description":"The object type.","x-stainless-const":true},"id":{"type":"string","description":"Unique identifier for the evaluation."},"name":{"type":"string","description":"The name of the evaluation.","example":"Chatbot effectiveness Evaluation"},"data_source_config":{"type":"object","description":"Configuration of data sources used in runs of the evaluation.","oneOf":[{"$ref":"#/components/schemas/EvalCustomDataSourceConfig"},{"$ref":"#/components/schemas/EvalLogsDataSourceConfig"},{"$ref":"#/components/schemas/EvalStoredCompletionsDataSourceConfig"}]},"testing_criteria":{"default":"eval","description":"A list of testing criteria.","type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/EvalGraderLabelModel"},{"$ref":"#/components/schemas/EvalGraderStringCheck"},{"$ref":"#/components/schemas/EvalGraderTextSimilarity"},{"$ref":"#/components/schemas/EvalGraderPython"},{"$ref":"#/components/schemas/EvalGraderScoreModel"}]}},"created_at":{"type":"integer","description":"The Unix timestamp (in seconds) for when the eval was created."},"metadata":{"$ref":"#/components/schemas/Metadata"}},"required":["id","data_source_config","object","testing_criteria","name","created_at","metadata"],"x-oaiMeta":{"name":"The eval object","group":"evals","example":"{\n \"object\": \"eval\",\n \"id\": \"eval_67abd54d9b0081909a86353f6fb9317a\",\n \"data_source_config\": {\n \"type\": \"custom\",\n \"item_schema\": {\n \"type\": \"object\",\n \"properties\": {\n \"label\": {\"type\": \"string\"},\n },\n \"required\": [\"label\"]\n },\n \"include_sample_schema\": true\n },\n \"testing_criteria\": [\n {\n \"name\": \"My string check grader\",\n \"type\": \"string_check\",\n \"input\": \"{{sample.output_text}}\",\n \"reference\": \"{{item.label}}\",\n \"operation\": \"eq\",\n }\n ],\n \"name\": \"External Data Eval\",\n \"created_at\": 1739314509,\n \"metadata\": {\n \"test\": \"synthetics\",\n }\n}\n"}},"EvalApiError":{"type":"object","title":"EvalApiError","description":"An object representing an error response from the Eval API.\n","properties":{"code":{"type":"string","description":"The error code."},"message":{"type":"string","description":"The error message."}},"required":["code","message"],"x-oaiMeta":{"name":"The API error object","group":"evals","example":"{\n \"code\": \"internal_error\",\n \"message\": \"The eval run failed due to an internal error.\"\n}\n"}},"EvalCustomDataSourceConfig":{"type":"object","title":"CustomDataSourceConfig","description":"A CustomDataSourceConfig which specifies the schema of your `item` and optionally `sample` namespaces.\nThe response schema defines the shape of the data that will be:\n- Used to define your testing criteria and\n- What data is required when creating a run\n","properties":{"type":{"type":"string","enum":["custom"],"default":"custom","description":"The type of data source. Always `custom`.","x-stainless-const":true},"schema":{"type":"object","description":"The json schema for the run data source items.\nLearn how to build JSON schemas [here](https://json-schema.org/).\n","additionalProperties":true,"example":"{\n \"type\": \"object\",\n \"properties\": {\n \"item\": {\n \"type\": \"object\",\n \"properties\": {\n \"label\": {\"type\": \"string\"},\n },\n \"required\": [\"label\"]\n }\n },\n \"required\": [\"item\"]\n}\n"}},"required":["type","schema"],"x-oaiMeta":{"name":"The eval custom data source config object","group":"evals","example":"{\n \"type\": \"custom\",\n \"schema\": {\n \"type\": \"object\",\n \"properties\": {\n \"item\": {\n \"type\": \"object\",\n \"properties\": {\n \"label\": {\"type\": \"string\"},\n },\n \"required\": [\"label\"]\n }\n },\n \"required\": [\"item\"]\n }\n}\n"}},"EvalGraderLabelModel":{"type":"object","title":"LabelModelGrader","allOf":[{"$ref":"#/components/schemas/GraderLabelModel"}]},"EvalGraderPython":{"type":"object","title":"PythonGrader","allOf":[{"$ref":"#/components/schemas/GraderPython"},{"type":"object","properties":{"pass_threshold":{"type":"number","description":"The threshold for the score."}},"x-oaiMeta":{"name":"Eval Python Grader","group":"graders","example":"{\n \"type\": \"python\",\n \"name\": \"Example python grader\",\n \"image_tag\": \"2025-05-08\",\n \"source\": \"\"\"\ndef grade(sample: dict, item: dict) -> float:\n \\\"\"\"\n Returns 1.0 if `output_text` equals `label`, otherwise 0.0.\n \\\"\"\"\n output = sample.get(\"output_text\")\n label = item.get(\"label\")\n return 1.0 if output == label else 0.0\n\"\"\",\n \"pass_threshold\": 0.8\n}\n"}}]},"EvalGraderScoreModel":{"type":"object","title":"ScoreModelGrader","allOf":[{"$ref":"#/components/schemas/GraderScoreModel"},{"type":"object","properties":{"pass_threshold":{"type":"number","description":"The threshold for the score."}}}]},"EvalGraderStringCheck":{"type":"object","title":"StringCheckGrader","allOf":[{"$ref":"#/components/schemas/GraderStringCheck"}]},"EvalGraderTextSimilarity":{"type":"object","title":"TextSimilarityGrader","allOf":[{"$ref":"#/components/schemas/GraderTextSimilarity"},{"type":"object","properties":{"pass_threshold":{"type":"number","description":"The threshold for the score."}},"required":["pass_threshold"],"x-oaiMeta":{"name":"Text Similarity Grader","group":"graders","example":"{\n \"type\": \"text_similarity\",\n \"name\": \"Example text similarity grader\",\n \"input\": \"{{sample.output_text}}\",\n \"reference\": \"{{item.label}}\",\n \"pass_threshold\": 0.8,\n \"evaluation_metric\": \"fuzzy_match\"\n}\n"}}]},"EvalItem":{"type":"object","title":"Eval message object","description":"A message input to the model with a role indicating instruction following\nhierarchy. Instructions given with the `developer` or `system` role take\nprecedence over instructions given with the `user` role. Messages with the\n`assistant` role are presumed to have been generated by the model in previous\ninteractions.\n","properties":{"role":{"type":"string","description":"The role of the message input. One of `user`, `assistant`, `system`, or\n`developer`.\n","enum":["user","assistant","system","developer"]},"content":{"$ref":"#/components/schemas/EvalItemContent"},"type":{"type":"string","description":"The type of the message input. Always `message`.\n","enum":["message"],"x-stainless-const":true}},"required":["role","content"]},"EvalItemContent":{"title":"Eval content","description":"Inputs to the model - can contain template strings. Supports text, output text, input images, and input audio, either as a single item or an array of items.\n","oneOf":[{"$ref":"#/components/schemas/EvalItemContentItem"},{"$ref":"#/components/schemas/EvalItemContentArray"}]},"EvalItemContentArray":{"type":"array","title":"An array of Input text, Output text, Input image, and Input audio","description":"A list of inputs, each of which may be either an input text, output text, input\nimage, or input audio object.\n","items":{"$ref":"#/components/schemas/EvalItemContentItem"}},"EvalItemContentItem":{"title":"Eval content item","description":"A single content item: input text, output text, input image, or input audio.\n","oneOf":[{"$ref":"#/components/schemas/EvalItemContentText"},{"$ref":"#/components/schemas/InputTextContent"},{"$ref":"#/components/schemas/EvalItemContentOutputText"},{"$ref":"#/components/schemas/EvalItemInputImage"},{"$ref":"#/components/schemas/InputAudio"}]},"EvalItemContentOutputText":{"type":"object","title":"Output text","description":"A text output from the model.\n","properties":{"type":{"type":"string","description":"The type of the output text. Always `output_text`.\n","enum":["output_text"],"x-stainless-const":true},"text":{"type":"string","description":"The text output from the model.\n"}},"required":["type","text"]},"EvalItemContentText":{"type":"string","title":"Text input","description":"A text input to the model.\n"},"EvalItemInputImage":{"title":"Input image","description":"An image input block used within EvalItem content arrays.","type":"object","properties":{"type":{"type":"string","description":"The type of the image input. Always `input_image`.\n","enum":["input_image"],"x-stainless-const":true},"image_url":{"type":"string","description":"The URL of the image input.\n"},"detail":{"type":"string","description":"The detail level of the image to be sent to the model. One of `high`, `low`, or `auto`. Defaults to `auto`.\n"}},"required":["type","image_url"]},"EvalJsonlFileContentSource":{"type":"object","title":"EvalJsonlFileContentSource","properties":{"type":{"type":"string","enum":["file_content"],"default":"file_content","description":"The type of jsonl source. Always `file_content`.","x-stainless-const":true},"content":{"type":"array","items":{"type":"object","properties":{"item":{"type":"object","additionalProperties":true},"sample":{"type":"object","additionalProperties":true}},"required":["item"]},"description":"The content of the jsonl file."}},"required":["type","content"]},"EvalJsonlFileIdSource":{"type":"object","title":"EvalJsonlFileIdSource","properties":{"type":{"type":"string","enum":["file_id"],"default":"file_id","description":"The type of jsonl source. Always `file_id`.","x-stainless-const":true},"id":{"type":"string","description":"The identifier of the file."}},"required":["type","id"]},"EvalList":{"type":"object","title":"EvalList","description":"An object representing a list of evals.\n","properties":{"object":{"type":"string","enum":["list"],"default":"list","description":"The type of this object. It is always set to \"list\".\n","x-stainless-const":true},"data":{"type":"array","description":"An array of eval objects.\n","items":{"$ref":"#/components/schemas/Eval"}},"first_id":{"type":"string","description":"The identifier of the first eval in the data array."},"last_id":{"type":"string","description":"The identifier of the last eval in the data array."},"has_more":{"type":"boolean","description":"Indicates whether there are more evals available."}},"required":["object","data","first_id","last_id","has_more"],"x-oaiMeta":{"name":"The eval list object","group":"evals","example":"{\n \"object\": \"list\",\n \"data\": [\n {\n \"object\": \"eval\",\n \"id\": \"eval_67abd54d9b0081909a86353f6fb9317a\",\n \"data_source_config\": {\n \"type\": \"custom\",\n \"schema\": {\n \"type\": \"object\",\n \"properties\": {\n \"item\": {\n \"type\": \"object\",\n \"properties\": {\n \"input\": {\n \"type\": \"string\"\n },\n \"ground_truth\": {\n \"type\": \"string\"\n }\n },\n \"required\": [\n \"input\",\n \"ground_truth\"\n ]\n }\n },\n \"required\": [\n \"item\"\n ]\n }\n },\n \"testing_criteria\": [\n {\n \"name\": \"String check\",\n \"id\": \"String check-2eaf2d8d-d649-4335-8148-9535a7ca73c2\",\n \"type\": \"string_check\",\n \"input\": \"{{item.input}}\",\n \"reference\": \"{{item.ground_truth}}\",\n \"operation\": \"eq\"\n }\n ],\n \"name\": \"External Data Eval\",\n \"created_at\": 1739314509,\n \"metadata\": {},\n }\n ],\n \"first_id\": \"eval_67abd54d9b0081909a86353f6fb9317a\",\n \"last_id\": \"eval_67abd54d9b0081909a86353f6fb9317a\",\n \"has_more\": true\n}\n"}},"EvalLogsDataSourceConfig":{"type":"object","title":"LogsDataSourceConfig","description":"A LogsDataSourceConfig which specifies the metadata property of your logs query.\nThis is usually metadata like `usecase=chatbot` or `prompt-version=v2`, etc.\nThe schema returned by this data source config is used to defined what variables are available in your evals.\n`item` and `sample` are both defined when using this data source config.\n","properties":{"type":{"type":"string","enum":["logs"],"default":"logs","description":"The type of data source. Always `logs`.","x-stainless-const":true},"metadata":{"$ref":"#/components/schemas/Metadata"},"schema":{"type":"object","description":"The json schema for the run data source items.\nLearn how to build JSON schemas [here](https://json-schema.org/).\n","additionalProperties":true}},"required":["type","schema"],"x-oaiMeta":{"name":"The logs data source object for evals","group":"evals","example":"{\n \"type\": \"logs\",\n \"metadata\": {\n \"language\": \"english\"\n },\n \"schema\": {\n \"type\": \"object\",\n \"properties\": {\n \"item\": {\n \"type\": \"object\"\n },\n \"sample\": {\n \"type\": \"object\"\n }\n },\n \"required\": [\n \"item\",\n \"sample\"\n }\n}\n"}},"EvalResponsesSource":{"type":"object","title":"EvalResponsesSource","description":"A EvalResponsesSource object describing a run data source configuration.\n","properties":{"type":{"type":"string","enum":["responses"],"description":"The type of run data source. Always `responses`."},"metadata":{"anyOf":[{"type":"object","description":"Metadata filter for the responses. This is a query parameter used to select responses."},{"type":"null"}]},"model":{"anyOf":[{"type":"string","description":"The name of the model to find responses for. This is a query parameter used to select responses."},{"type":"null"}]},"instructions_search":{"anyOf":[{"type":"string","description":"Optional string to search the 'instructions' field. This is a query parameter used to select responses."},{"type":"null"}]},"created_after":{"anyOf":[{"type":"integer","minimum":0,"description":"Only include items created after this timestamp (inclusive). This is a query parameter used to select responses."},{"type":"null"}]},"created_before":{"anyOf":[{"type":"integer","minimum":0,"description":"Only include items created before this timestamp (inclusive). This is a query parameter used to select responses."},{"type":"null"}]},"reasoning_effort":{"anyOf":[{"$ref":"#/components/schemas/ReasoningEffort","description":"Optional reasoning effort parameter. This is a query parameter used to select responses."},{"type":"null"}]},"temperature":{"anyOf":[{"type":"number","description":"Sampling temperature. This is a query parameter used to select responses."},{"type":"null"}]},"top_p":{"anyOf":[{"type":"number","description":"Nucleus sampling parameter. This is a query parameter used to select responses."},{"type":"null"}]},"users":{"anyOf":[{"type":"array","items":{"type":"string"},"description":"List of user identifiers. This is a query parameter used to select responses."},{"type":"null"}]},"tools":{"anyOf":[{"type":"array","items":{"type":"string"},"description":"List of tool names. This is a query parameter used to select responses."},{"type":"null"}]}},"required":["type"],"x-oaiMeta":{"name":"The run data source object used to configure an individual run","group":"eval runs","example":"{\n \"type\": \"responses\",\n \"model\": \"gpt-4o-mini-2024-07-18\",\n \"temperature\": 0.7,\n \"top_p\": 1.0,\n \"users\": [\"user1\", \"user2\"],\n \"tools\": [\"tool1\", \"tool2\"],\n \"instructions_search\": \"You are a coding assistant\"\n}\n"}},"EvalRun":{"type":"object","title":"EvalRun","description":"A schema representing an evaluation run.\n","properties":{"object":{"type":"string","enum":["eval.run"],"default":"eval.run","description":"The type of the object. Always \"eval.run\".","x-stainless-const":true},"id":{"type":"string","description":"Unique identifier for the evaluation run."},"eval_id":{"type":"string","description":"The identifier of the associated evaluation."},"status":{"type":"string","description":"The status of the evaluation run."},"model":{"type":"string","description":"The model that is evaluated, if applicable."},"name":{"type":"string","description":"The name of the evaluation run."},"created_at":{"type":"integer","description":"Unix timestamp (in seconds) when the evaluation run was created."},"report_url":{"type":"string","description":"The URL to the rendered evaluation run report on the UI dashboard."},"result_counts":{"type":"object","description":"Counters summarizing the outcomes of the evaluation run.","properties":{"total":{"type":"integer","description":"Total number of executed output items."},"errored":{"type":"integer","description":"Number of output items that resulted in an error."},"failed":{"type":"integer","description":"Number of output items that failed to pass the evaluation."},"passed":{"type":"integer","description":"Number of output items that passed the evaluation."}},"required":["total","errored","failed","passed"]},"per_model_usage":{"type":"array","description":"Usage statistics for each model during the evaluation run.","items":{"type":"object","properties":{"model_name":{"type":"string","description":"The name of the model."},"invocation_count":{"type":"integer","description":"The number of invocations."},"prompt_tokens":{"type":"integer","description":"The number of prompt tokens used."},"completion_tokens":{"type":"integer","description":"The number of completion tokens generated."},"total_tokens":{"type":"integer","description":"The total number of tokens used."},"cached_tokens":{"type":"integer","description":"The number of tokens retrieved from cache."}},"required":["model_name","invocation_count","prompt_tokens","completion_tokens","total_tokens","cached_tokens"]}},"per_testing_criteria_results":{"type":"array","description":"Results per testing criteria applied during the evaluation run.","items":{"type":"object","properties":{"testing_criteria":{"type":"string","description":"A description of the testing criteria."},"passed":{"type":"integer","description":"Number of tests passed for this criteria."},"failed":{"type":"integer","description":"Number of tests failed for this criteria."}},"required":["testing_criteria","passed","failed"]}},"data_source":{"type":"object","description":"Information about the run's data source.","oneOf":[{"$ref":"#/components/schemas/CreateEvalJsonlRunDataSource"},{"$ref":"#/components/schemas/CreateEvalCompletionsRunDataSource"},{"$ref":"#/components/schemas/CreateEvalResponsesRunDataSource"}]},"metadata":{"$ref":"#/components/schemas/Metadata"},"error":{"$ref":"#/components/schemas/EvalApiError"}},"required":["object","id","eval_id","status","model","name","created_at","report_url","result_counts","per_model_usage","per_testing_criteria_results","data_source","metadata","error"],"x-oaiMeta":{"name":"The eval run object","group":"evals","example":"{\n \"object\": \"eval.run\",\n \"id\": \"evalrun_67e57965b480819094274e3a32235e4c\",\n \"eval_id\": \"eval_67e579652b548190aaa83ada4b125f47\",\n \"report_url\": \"https://platform.openai.com/evaluations/eval_67e579652b548190aaa83ada4b125f47?run_id=evalrun_67e57965b480819094274e3a32235e4c\",\n \"status\": \"queued\",\n \"model\": \"gpt-4o-mini\",\n \"name\": \"gpt-4o-mini\",\n \"created_at\": 1743092069,\n \"result_counts\": {\n \"total\": 0,\n \"errored\": 0,\n \"failed\": 0,\n \"passed\": 0\n },\n \"per_model_usage\": null,\n \"per_testing_criteria_results\": null,\n \"data_source\": {\n \"type\": \"completions\",\n \"source\": {\n \"type\": \"file_content\",\n \"content\": [\n {\n \"item\": {\n \"input\": \"Tech Company Launches Advanced Artificial Intelligence Platform\",\n \"ground_truth\": \"Technology\"\n }\n },\n {\n \"item\": {\n \"input\": \"Central Bank Increases Interest Rates Amid Inflation Concerns\",\n \"ground_truth\": \"Markets\"\n }\n },\n {\n \"item\": {\n \"input\": \"International Summit Addresses Climate Change Strategies\",\n \"ground_truth\": \"World\"\n }\n },\n {\n \"item\": {\n \"input\": \"Major Retailer Reports Record-Breaking Holiday Sales\",\n \"ground_truth\": \"Business\"\n }\n },\n {\n \"item\": {\n \"input\": \"National Team Qualifies for World Championship Finals\",\n \"ground_truth\": \"Sports\"\n }\n },\n {\n \"item\": {\n \"input\": \"Stock Markets Rally After Positive Economic Data Released\",\n \"ground_truth\": \"Markets\"\n }\n },\n {\n \"item\": {\n \"input\": \"Global Manufacturer Announces Merger with Competitor\",\n \"ground_truth\": \"Business\"\n }\n },\n {\n \"item\": {\n \"input\": \"Breakthrough in Renewable Energy Technology Unveiled\",\n \"ground_truth\": \"Technology\"\n }\n },\n {\n \"item\": {\n \"input\": \"World Leaders Sign Historic Climate Agreement\",\n \"ground_truth\": \"World\"\n }\n },\n {\n \"item\": {\n \"input\": \"Professional Athlete Sets New Record in Championship Event\",\n \"ground_truth\": \"Sports\"\n }\n },\n {\n \"item\": {\n \"input\": \"Financial Institutions Adapt to New Regulatory Requirements\",\n \"ground_truth\": \"Business\"\n }\n },\n {\n \"item\": {\n \"input\": \"Tech Conference Showcases Advances in Artificial Intelligence\",\n \"ground_truth\": \"Technology\"\n }\n },\n {\n \"item\": {\n \"input\": \"Global Markets Respond to Oil Price Fluctuations\",\n \"ground_truth\": \"Markets\"\n }\n },\n {\n \"item\": {\n \"input\": \"International Cooperation Strengthened Through New Treaty\",\n \"ground_truth\": \"World\"\n }\n },\n {\n \"item\": {\n \"input\": \"Sports League Announces Revised Schedule for Upcoming Season\",\n \"ground_truth\": \"Sports\"\n }\n }\n ]\n },\n \"input_messages\": {\n \"type\": \"template\",\n \"template\": [\n {\n \"type\": \"message\",\n \"role\": \"developer\",\n \"content\": {\n \"type\": \"input_text\",\n \"text\": \"Categorize a given news headline into one of the following topics: Technology, Markets, World, Business, or Sports.\\n\\n# Steps\\n\\n1. Analyze the content of the news headline to understand its primary focus.\\n2. Extract the subject matter, identifying any key indicators or keywords.\\n3. Use the identified indicators to determine the most suitable category out of the five options: Technology, Markets, World, Business, or Sports.\\n4. Ensure only one category is selected per headline.\\n\\n# Output Format\\n\\nRespond with the chosen category as a single word. For instance: \\\"Technology\\\", \\\"Markets\\\", \\\"World\\\", \\\"Business\\\", or \\\"Sports\\\".\\n\\n# Examples\\n\\n**Input**: \\\"Apple Unveils New iPhone Model, Featuring Advanced AI Features\\\" \\n**Output**: \\\"Technology\\\"\\n\\n**Input**: \\\"Global Stocks Mixed as Investors Await Central Bank Decisions\\\" \\n**Output**: \\\"Markets\\\"\\n\\n**Input**: \\\"War in Ukraine: Latest Updates on Negotiation Status\\\" \\n**Output**: \\\"World\\\"\\n\\n**Input**: \\\"Microsoft in Talks to Acquire Gaming Company for $2 Billion\\\" \\n**Output**: \\\"Business\\\"\\n\\n**Input**: \\\"Manchester United Secures Win in Premier League Football Match\\\" \\n**Output**: \\\"Sports\\\" \\n\\n# Notes\\n\\n- If the headline appears to fit into more than one category, choose the most dominant theme.\\n- Keywords or phrases such as \\\"stocks\\\", \\\"company acquisition\\\", \\\"match\\\", or technological brands can be good indicators for classification.\\n\"\n }\n },\n {\n \"type\": \"message\",\n \"role\": \"user\",\n \"content\": {\n \"type\": \"input_text\",\n \"text\": \"{{item.input}}\"\n }\n }\n ]\n },\n \"model\": \"gpt-4o-mini\",\n \"sampling_params\": {\n \"seed\": 42,\n \"temperature\": 1.0,\n \"top_p\": 1.0,\n \"max_completions_tokens\": 2048\n }\n },\n \"error\": null,\n \"metadata\": {}\n}\n"}},"EvalRunList":{"type":"object","title":"EvalRunList","description":"An object representing a list of runs for an evaluation.\n","properties":{"object":{"type":"string","enum":["list"],"default":"list","description":"The type of this object. It is always set to \"list\".\n","x-stainless-const":true},"data":{"type":"array","description":"An array of eval run objects.\n","items":{"$ref":"#/components/schemas/EvalRun"}},"first_id":{"type":"string","description":"The identifier of the first eval run in the data array."},"last_id":{"type":"string","description":"The identifier of the last eval run in the data array."},"has_more":{"type":"boolean","description":"Indicates whether there are more evals available."}},"required":["object","data","first_id","last_id","has_more"],"x-oaiMeta":{"name":"The eval run list object","group":"evals","example":"{\n \"object\": \"list\",\n \"data\": [\n {\n \"object\": \"eval.run\",\n \"id\": \"evalrun_67b7fbdad46c819092f6fe7a14189620\",\n \"eval_id\": \"eval_67b7fa9a81a88190ab4aa417e397ea21\",\n \"report_url\": \"https://platform.openai.com/evaluations/eval_67b7fa9a81a88190ab4aa417e397ea21?run_id=evalrun_67b7fbdad46c819092f6fe7a14189620\",\n \"status\": \"completed\",\n \"model\": \"o3-mini\",\n \"name\": \"Academic Assistant\",\n \"created_at\": 1740110812,\n \"result_counts\": {\n \"total\": 171,\n \"errored\": 0,\n \"failed\": 80,\n \"passed\": 91\n },\n \"per_model_usage\": null,\n \"per_testing_criteria_results\": [\n {\n \"testing_criteria\": \"String check grader\",\n \"passed\": 91,\n \"failed\": 80\n }\n ],\n \"run_data_source\": {\n \"type\": \"completions\",\n \"template_messages\": [\n {\n \"type\": \"message\",\n \"role\": \"system\",\n \"content\": {\n \"type\": \"input_text\",\n \"text\": \"You are a helpful assistant.\"\n }\n },\n {\n \"type\": \"message\",\n \"role\": \"user\",\n \"content\": {\n \"type\": \"input_text\",\n \"text\": \"Hello, can you help me with my homework?\"\n }\n }\n ],\n \"datasource_reference\": null,\n \"model\": \"o3-mini\",\n \"max_completion_tokens\": null,\n \"seed\": null,\n \"temperature\": null,\n \"top_p\": null\n },\n \"error\": null,\n \"metadata\": {\"test\": \"synthetics\"}\n }\n ],\n \"first_id\": \"evalrun_67abd54d60ec8190832b46859da808f7\",\n \"last_id\": \"evalrun_67abd54d60ec8190832b46859da808f7\",\n \"has_more\": false\n}\n"}},"EvalRunOutputItem":{"type":"object","title":"EvalRunOutputItem","description":"A schema representing an evaluation run output item.\n","properties":{"object":{"type":"string","enum":["eval.run.output_item"],"default":"eval.run.output_item","description":"The type of the object. Always \"eval.run.output_item\".","x-stainless-const":true},"id":{"type":"string","description":"Unique identifier for the evaluation run output item."},"run_id":{"type":"string","description":"The identifier of the evaluation run associated with this output item."},"eval_id":{"type":"string","description":"The identifier of the evaluation group."},"created_at":{"type":"integer","description":"Unix timestamp (in seconds) when the evaluation run was created."},"status":{"type":"string","description":"The status of the evaluation run."},"datasource_item_id":{"type":"integer","description":"The identifier for the data source item."},"datasource_item":{"type":"object","description":"Details of the input data source item.","additionalProperties":true},"results":{"type":"array","description":"A list of grader results for this output item.","items":{"$ref":"#/components/schemas/EvalRunOutputItemResult"}},"sample":{"type":"object","description":"A sample containing the input and output of the evaluation run.","properties":{"input":{"type":"array","description":"An array of input messages.","items":{"type":"object","description":"An input message.","properties":{"role":{"type":"string","description":"The role of the message sender (e.g., system, user, developer)."},"content":{"type":"string","description":"The content of the message."}},"required":["role","content"]}},"output":{"type":"array","description":"An array of output messages.","items":{"type":"object","properties":{"role":{"type":"string","description":"The role of the message (e.g. \"system\", \"assistant\", \"user\")."},"content":{"type":"string","description":"The content of the message."}}}},"finish_reason":{"type":"string","description":"The reason why the sample generation was finished."},"model":{"type":"string","description":"The model used for generating the sample."},"usage":{"type":"object","description":"Token usage details for the sample.","properties":{"total_tokens":{"type":"integer","description":"The total number of tokens used."},"completion_tokens":{"type":"integer","description":"The number of completion tokens generated."},"prompt_tokens":{"type":"integer","description":"The number of prompt tokens used."},"cached_tokens":{"type":"integer","description":"The number of tokens retrieved from cache."}},"required":["total_tokens","completion_tokens","prompt_tokens","cached_tokens"]},"error":{"$ref":"#/components/schemas/EvalApiError"},"temperature":{"type":"number","description":"The sampling temperature used."},"max_completion_tokens":{"type":"integer","description":"The maximum number of tokens allowed for completion."},"top_p":{"type":"number","description":"The top_p value used for sampling."},"seed":{"type":"integer","description":"The seed used for generating the sample."}},"required":["input","output","finish_reason","model","usage","error","temperature","max_completion_tokens","top_p","seed"]}},"required":["object","id","run_id","eval_id","created_at","status","datasource_item_id","datasource_item","results","sample"],"x-oaiMeta":{"name":"The eval run output item object","group":"evals","example":"{\n \"object\": \"eval.run.output_item\",\n \"id\": \"outputitem_67abd55eb6548190bb580745d5644a33\",\n \"run_id\": \"evalrun_67abd54d60ec8190832b46859da808f7\",\n \"eval_id\": \"eval_67abd54d9b0081909a86353f6fb9317a\",\n \"created_at\": 1739314509,\n \"status\": \"pass\",\n \"datasource_item_id\": 137,\n \"datasource_item\": {\n \"teacher\": \"To grade essays, I only check for style, content, and grammar.\",\n \"student\": \"I am a student who is trying to write the best essay.\"\n },\n \"results\": [\n {\n \"name\": \"String Check Grader\",\n \"type\": \"string-check-grader\",\n \"score\": 1.0,\n \"passed\": true,\n }\n ],\n \"sample\": {\n \"input\": [\n {\n \"role\": \"system\",\n \"content\": \"You are an evaluator bot...\"\n },\n {\n \"role\": \"user\",\n \"content\": \"You are assessing...\"\n }\n ],\n \"output\": [\n {\n \"role\": \"assistant\",\n \"content\": \"The rubric is not clear nor concise.\"\n }\n ],\n \"finish_reason\": \"stop\",\n \"model\": \"gpt-4o-2024-08-06\",\n \"usage\": {\n \"total_tokens\": 521,\n \"completion_tokens\": 2,\n \"prompt_tokens\": 519,\n \"cached_tokens\": 0\n },\n \"error\": null,\n \"temperature\": 1.0,\n \"max_completion_tokens\": 2048,\n \"top_p\": 1.0,\n \"seed\": 42\n }\n}\n"}},"EvalRunOutputItemList":{"type":"object","title":"EvalRunOutputItemList","description":"An object representing a list of output items for an evaluation run.\n","properties":{"object":{"type":"string","enum":["list"],"default":"list","description":"The type of this object. It is always set to \"list\".\n","x-stainless-const":true},"data":{"type":"array","description":"An array of eval run output item objects.\n","items":{"$ref":"#/components/schemas/EvalRunOutputItem"}},"first_id":{"type":"string","description":"The identifier of the first eval run output item in the data array."},"last_id":{"type":"string","description":"The identifier of the last eval run output item in the data array."},"has_more":{"type":"boolean","description":"Indicates whether there are more eval run output items available."}},"required":["object","data","first_id","last_id","has_more"],"x-oaiMeta":{"name":"The eval run output item list object","group":"evals","example":"{\n \"object\": \"list\",\n \"data\": [\n {\n \"object\": \"eval.run.output_item\",\n \"id\": \"outputitem_67abd55eb6548190bb580745d5644a33\",\n \"run_id\": \"evalrun_67abd54d60ec8190832b46859da808f7\",\n \"eval_id\": \"eval_67abd54d9b0081909a86353f6fb9317a\",\n \"created_at\": 1739314509,\n \"status\": \"pass\",\n \"datasource_item_id\": 137,\n \"datasource_item\": {\n \"teacher\": \"To grade essays, I only check for style, content, and grammar.\",\n \"student\": \"I am a student who is trying to write the best essay.\"\n },\n \"results\": [\n {\n \"name\": \"String Check Grader\",\n \"type\": \"string-check-grader\",\n \"score\": 1.0,\n \"passed\": true,\n }\n ],\n \"sample\": {\n \"input\": [\n {\n \"role\": \"system\",\n \"content\": \"You are an evaluator bot...\"\n },\n {\n \"role\": \"user\",\n \"content\": \"You are assessing...\"\n }\n ],\n \"output\": [\n {\n \"role\": \"assistant\",\n \"content\": \"The rubric is not clear nor concise.\"\n }\n ],\n \"finish_reason\": \"stop\",\n \"model\": \"gpt-4o-2024-08-06\",\n \"usage\": {\n \"total_tokens\": 521,\n \"completion_tokens\": 2,\n \"prompt_tokens\": 519,\n \"cached_tokens\": 0\n },\n \"error\": null,\n \"temperature\": 1.0,\n \"max_completion_tokens\": 2048,\n \"top_p\": 1.0,\n \"seed\": 42\n }\n },\n ],\n \"first_id\": \"outputitem_67abd55eb6548190bb580745d5644a33\",\n \"last_id\": \"outputitem_67abd55eb6548190bb580745d5644a33\",\n \"has_more\": false\n}\n"}},"EvalRunOutputItemResult":{"type":"object","title":"EvalRunOutputItemResult","description":"A single grader result for an evaluation run output item.\n","properties":{"name":{"type":"string","description":"The name of the grader."},"type":{"type":"string","description":"The grader type (for example, \"string-check-grader\")."},"score":{"type":"number","description":"The numeric score produced by the grader."},"passed":{"type":"boolean","description":"Whether the grader considered the output a pass."},"sample":{"anyOf":[{"type":"object","additionalProperties":true},{"type":"null"}],"description":"Optional sample or intermediate data produced by the grader."}},"additionalProperties":true,"required":["name","score","passed"]},"EvalStoredCompletionsDataSourceConfig":{"type":"object","title":"StoredCompletionsDataSourceConfig","description":"Deprecated in favor of LogsDataSourceConfig.\n","properties":{"type":{"type":"string","enum":["stored_completions"],"default":"stored_completions","description":"The type of data source. Always `stored_completions`.","x-stainless-const":true},"metadata":{"$ref":"#/components/schemas/Metadata"},"schema":{"type":"object","description":"The json schema for the run data source items.\nLearn how to build JSON schemas [here](https://json-schema.org/).\n","additionalProperties":true}},"required":["type","schema"],"deprecated":true,"x-oaiMeta":{"name":"The stored completions data source object for evals","group":"evals","example":"{\n \"type\": \"stored_completions\",\n \"metadata\": {\n \"language\": \"english\"\n },\n \"schema\": {\n \"type\": \"object\",\n \"properties\": {\n \"item\": {\n \"type\": \"object\"\n },\n \"sample\": {\n \"type\": \"object\"\n }\n },\n \"required\": [\n \"item\",\n \"sample\"\n }\n}\n"}},"EvalStoredCompletionsSource":{"type":"object","title":"StoredCompletionsRunDataSource","description":"A StoredCompletionsRunDataSource configuration describing a set of filters\n","properties":{"type":{"type":"string","enum":["stored_completions"],"default":"stored_completions","description":"The type of source. Always `stored_completions`.","x-stainless-const":true},"metadata":{"$ref":"#/components/schemas/Metadata"},"model":{"anyOf":[{"type":"string","description":"An optional model to filter by (e.g., 'gpt-4o')."},{"type":"null"}]},"created_after":{"anyOf":[{"type":"integer","description":"An optional Unix timestamp to filter items created after this time."},{"type":"null"}]},"created_before":{"anyOf":[{"type":"integer","description":"An optional Unix timestamp to filter items created before this time."},{"type":"null"}]},"limit":{"anyOf":[{"type":"integer","description":"An optional maximum number of items to return."},{"type":"null"}]}},"required":["type"],"x-oaiMeta":{"name":"The stored completions data source object used to configure an individual run","group":"eval runs","example":"{\n \"type\": \"stored_completions\",\n \"model\": \"gpt-4o\",\n \"created_after\": 1668124800,\n \"created_before\": 1668124900,\n \"limit\": 100,\n \"metadata\": {}\n}\n"}},"FileExpirationAfter":{"type":"object","title":"File expiration policy","description":"The expiration policy for a file. By default, files with `purpose=batch` expire after 30 days and all other files are persisted until they are manually deleted.","properties":{"anchor":{"description":"Anchor timestamp after which the expiration policy applies. Supported anchors: `created_at`.","type":"string","enum":["created_at"],"x-stainless-const":true},"seconds":{"description":"The number of seconds after the anchor time that the file will expire. Must be between 3600 (1 hour) and 2592000 (30 days).","type":"integer","minimum":3600,"maximum":2592000}},"required":["anchor","seconds"]},"FilePath":{"type":"object","title":"File path","description":"A path to a file.\n","properties":{"type":{"type":"string","description":"The type of the file path. Always `file_path`.\n","enum":["file_path"],"x-stainless-const":true},"file_id":{"type":"string","description":"The ID of the file.\n"},"index":{"type":"integer","description":"The index of the file in the list of files.\n"}},"required":["type","file_id","index"]},"FileSearchRanker":{"type":"string","description":"The ranker to use for the file search. If not specified will use the `auto` ranker.","enum":["auto","default_2024_08_21"]},"FileSearchRankingOptions":{"title":"File search tool call ranking options","type":"object","description":"The ranking options for the file search. If not specified, the file search tool will use the `auto` ranker and a score_threshold of 0.\n\nSee the [file search tool documentation](/docs/assistants/tools/file-search#customizing-file-search-settings) for more information.\n","properties":{"ranker":{"$ref":"#/components/schemas/FileSearchRanker"},"score_threshold":{"type":"number","description":"The score threshold for the file search. All values must be a floating point number between 0 and 1.","minimum":0,"maximum":1}},"required":["score_threshold"]},"FileSearchToolCall":{"type":"object","title":"File search tool call","description":"The results of a file search tool call. See the\n[file search guide](/docs/guides/tools-file-search) for more information.\n","properties":{"id":{"type":"string","description":"The unique ID of the file search tool call.\n"},"type":{"type":"string","enum":["file_search_call"],"description":"The type of the file search tool call. Always `file_search_call`.\n","x-stainless-const":true},"status":{"type":"string","description":"The status of the file search tool call. One of `in_progress`,\n`searching`, `incomplete` or `failed`,\n","enum":["in_progress","searching","completed","incomplete","failed"]},"queries":{"type":"array","items":{"type":"string"},"description":"The queries used to search for files.\n"},"results":{"anyOf":[{"type":"array","description":"The results of the file search tool call.\n","items":{"type":"object","properties":{"file_id":{"type":"string","description":"The unique ID of the file.\n"},"text":{"type":"string","description":"The text that was retrieved from the file.\n"},"filename":{"type":"string","description":"The name of the file.\n"},"attributes":{"$ref":"#/components/schemas/VectorStoreFileAttributes"},"score":{"type":"number","format":"float","description":"The relevance score of the file - a value between 0 and 1.\n"}}}},{"type":"null"}]}},"required":["id","type","status","queries"]},"FineTuneChatCompletionRequestAssistantMessage":{"allOf":[{"type":"object","title":"Assistant message","deprecated":false,"properties":{"weight":{"type":"integer","enum":[0,1],"description":"Controls whether the assistant message is trained against (0 or 1)"}}},{"$ref":"#/components/schemas/ChatCompletionRequestAssistantMessage"}],"required":["role"]},"FineTuneDPOHyperparameters":{"type":"object","description":"The hyperparameters used for the DPO fine-tuning job.","properties":{"beta":{"description":"The beta value for the DPO method. A higher beta value will increase the weight of the penalty between the policy and reference model.\n","oneOf":[{"type":"string","enum":["auto"],"x-stainless-const":true},{"type":"number","minimum":0,"maximum":2,"exclusiveMinimum":true}],"default":"auto"},"batch_size":{"description":"Number of examples in each batch. A larger batch size means that model parameters are updated less frequently, but with lower variance.\n","oneOf":[{"type":"string","enum":["auto"],"x-stainless-const":true},{"type":"integer","minimum":1,"maximum":256}],"default":"auto"},"learning_rate_multiplier":{"description":"Scaling factor for the learning rate. A smaller learning rate may be useful to avoid overfitting.\n","oneOf":[{"type":"string","enum":["auto"],"x-stainless-const":true},{"type":"number","minimum":0,"exclusiveMinimum":true}],"default":"auto"},"n_epochs":{"description":"The number of epochs to train the model for. An epoch refers to one full cycle through the training dataset.\n","oneOf":[{"type":"string","enum":["auto"],"x-stainless-const":true},{"type":"integer","minimum":1,"maximum":50}],"default":"auto"}}},"FineTuneDPOMethod":{"type":"object","description":"Configuration for the DPO fine-tuning method.","properties":{"hyperparameters":{"$ref":"#/components/schemas/FineTuneDPOHyperparameters"}}},"FineTuneMethod":{"type":"object","description":"The method used for fine-tuning.","properties":{"type":{"type":"string","description":"The type of method. Is either `supervised`, `dpo`, or `reinforcement`.","enum":["supervised","dpo","reinforcement"]},"supervised":{"$ref":"#/components/schemas/FineTuneSupervisedMethod"},"dpo":{"$ref":"#/components/schemas/FineTuneDPOMethod"},"reinforcement":{"$ref":"#/components/schemas/FineTuneReinforcementMethod"}},"required":["type"]},"FineTuneReinforcementHyperparameters":{"type":"object","description":"The hyperparameters used for the reinforcement fine-tuning job.","properties":{"batch_size":{"description":"Number of examples in each batch. A larger batch size means that model parameters are updated less frequently, but with lower variance.\n","oneOf":[{"type":"string","enum":["auto"],"x-stainless-const":true},{"type":"integer","minimum":1,"maximum":256}],"default":"auto"},"learning_rate_multiplier":{"description":"Scaling factor for the learning rate. A smaller learning rate may be useful to avoid overfitting.\n","oneOf":[{"type":"string","enum":["auto"],"x-stainless-const":true},{"type":"number","minimum":0,"exclusiveMinimum":true}],"default":"auto"},"n_epochs":{"description":"The number of epochs to train the model for. An epoch refers to one full cycle through the training dataset.\n","oneOf":[{"type":"string","enum":["auto"],"x-stainless-const":true},{"type":"integer","minimum":1,"maximum":50}],"default":"auto"},"reasoning_effort":{"description":"Level of reasoning effort.\n","type":"string","enum":["default","low","medium","high"],"default":"default"},"compute_multiplier":{"description":"Multiplier on amount of compute used for exploring search space during training.\n","oneOf":[{"type":"string","enum":["auto"],"x-stainless-const":true},{"type":"number","minimum":0.00001,"maximum":10,"exclusiveMinimum":true}],"default":"auto"},"eval_interval":{"description":"The number of training steps between evaluation runs.\n","oneOf":[{"type":"string","enum":["auto"],"x-stainless-const":true},{"type":"integer","minimum":1}],"default":"auto"},"eval_samples":{"description":"Number of evaluation samples to generate per training step.\n","oneOf":[{"type":"string","enum":["auto"],"x-stainless-const":true},{"type":"integer","minimum":1}],"default":"auto"}}},"FineTuneReinforcementMethod":{"type":"object","description":"Configuration for the reinforcement fine-tuning method.","properties":{"grader":{"type":"object","description":"The grader used for the fine-tuning job.","oneOf":[{"$ref":"#/components/schemas/GraderStringCheck"},{"$ref":"#/components/schemas/GraderTextSimilarity"},{"$ref":"#/components/schemas/GraderPython"},{"$ref":"#/components/schemas/GraderScoreModel"},{"$ref":"#/components/schemas/GraderMulti"}]},"hyperparameters":{"$ref":"#/components/schemas/FineTuneReinforcementHyperparameters"}},"required":["grader"]},"FineTuneSupervisedHyperparameters":{"type":"object","description":"The hyperparameters used for the fine-tuning job.","properties":{"batch_size":{"description":"Number of examples in each batch. A larger batch size means that model parameters are updated less frequently, but with lower variance.\n","oneOf":[{"type":"string","enum":["auto"],"x-stainless-const":true},{"type":"integer","minimum":1,"maximum":256}],"default":"auto"},"learning_rate_multiplier":{"description":"Scaling factor for the learning rate. A smaller learning rate may be useful to avoid overfitting.\n","oneOf":[{"type":"string","enum":["auto"],"x-stainless-const":true},{"type":"number","minimum":0,"exclusiveMinimum":true}],"default":"auto"},"n_epochs":{"description":"The number of epochs to train the model for. An epoch refers to one full cycle through the training dataset.\n","oneOf":[{"type":"string","enum":["auto"],"x-stainless-const":true},{"type":"integer","minimum":1,"maximum":50}],"default":"auto"}}},"FineTuneSupervisedMethod":{"type":"object","description":"Configuration for the supervised fine-tuning method.","properties":{"hyperparameters":{"$ref":"#/components/schemas/FineTuneSupervisedHyperparameters"}}},"FineTuningCheckpointPermission":{"type":"object","title":"FineTuningCheckpointPermission","description":"The `checkpoint.permission` object represents a permission for a fine-tuned model checkpoint.\n","properties":{"id":{"type":"string","description":"The permission identifier, which can be referenced in the API endpoints."},"created_at":{"type":"integer","description":"The Unix timestamp (in seconds) for when the permission was created."},"project_id":{"type":"string","description":"The project identifier that the permission is for."},"object":{"type":"string","description":"The object type, which is always \"checkpoint.permission\".","enum":["checkpoint.permission"],"x-stainless-const":true}},"required":["created_at","id","object","project_id"],"x-oaiMeta":{"name":"The fine-tuned model checkpoint permission object","example":"{\n \"object\": \"checkpoint.permission\",\n \"id\": \"cp_zc4Q7MP6XxulcVzj4MZdwsAB\",\n \"created_at\": 1712211699,\n \"project_id\": \"proj_abGMw1llN8IrBb6SvvY5A1iH\"\n}\n"}},"FineTuningIntegration":{"type":"object","title":"Fine-Tuning Job Integration","required":["type","wandb"],"properties":{"type":{"type":"string","description":"The type of the integration being enabled for the fine-tuning job","enum":["wandb"],"x-stainless-const":true},"wandb":{"type":"object","description":"The settings for your integration with Weights and Biases. This payload specifies the project that\nmetrics will be sent to. Optionally, you can set an explicit display name for your run, add tags\nto your run, and set a default entity (team, username, etc) to be associated with your run.\n","required":["project"],"properties":{"project":{"description":"The name of the project that the new run will be created under.\n","type":"string","example":"my-wandb-project"},"name":{"anyOf":[{"description":"A display name to set for the run. If not set, we will use the Job ID as the name.\n","type":"string"},{"type":"null"}]},"entity":{"anyOf":[{"description":"The entity to use for the run. This allows you to set the team or username of the WandB user that you would\nlike associated with the run. If not set, the default entity for the registered WandB API key is used.\n","type":"string"},{"type":"null"}]},"tags":{"description":"A list of tags to be attached to the newly created run. These tags are passed through directly to WandB. Some\ndefault tags are generated by OpenAI: \"openai/finetune\", \"openai/{base-model}\", \"openai/{ftjob-abcdef}\".\n","type":"array","items":{"type":"string","example":"custom-tag"}}}}}},"FineTuningJob":{"type":"object","title":"FineTuningJob","description":"The `fine_tuning.job` object represents a fine-tuning job that has been created through the API.\n","properties":{"id":{"type":"string","description":"The object identifier, which can be referenced in the API endpoints."},"created_at":{"type":"integer","description":"The Unix timestamp (in seconds) for when the fine-tuning job was created."},"error":{"anyOf":[{"type":"object","description":"For fine-tuning jobs that have `failed`, this will contain more information on the cause of the failure.","properties":{"code":{"type":"string","description":"A machine-readable error code."},"message":{"type":"string","description":"A human-readable error message."},"param":{"anyOf":[{"type":"string","description":"The parameter that was invalid, usually `training_file` or `validation_file`. This field will be null if the failure was not parameter-specific."},{"type":"null"}]}},"required":["code","message","param"]},{"type":"null"}]},"fine_tuned_model":{"anyOf":[{"type":"string","description":"The name of the fine-tuned model that is being created. The value will be null if the fine-tuning job is still running."},{"type":"null"}]},"finished_at":{"anyOf":[{"type":"integer","description":"The Unix timestamp (in seconds) for when the fine-tuning job was finished. The value will be null if the fine-tuning job is still running."},{"type":"null"}]},"hyperparameters":{"type":"object","description":"The hyperparameters used for the fine-tuning job. This value will only be returned when running `supervised` jobs.","properties":{"batch_size":{"anyOf":[{"description":"Number of examples in each batch. A larger batch size means that model parameters\nare updated less frequently, but with lower variance.\n","oneOf":[{"type":"string","enum":["auto"],"x-stainless-const":true},{"type":"integer","minimum":1,"maximum":256}],"default":"auto"},{"type":"null"}]},"learning_rate_multiplier":{"description":"Scaling factor for the learning rate. A smaller learning rate may be useful to avoid\noverfitting.\n","oneOf":[{"type":"string","enum":["auto"],"x-stainless-const":true},{"type":"number","minimum":0,"exclusiveMinimum":true}],"default":"auto"},"n_epochs":{"description":"The number of epochs to train the model for. An epoch refers to one full cycle\nthrough the training dataset.\n","oneOf":[{"type":"string","enum":["auto"],"x-stainless-const":true},{"type":"integer","minimum":1,"maximum":50}],"default":"auto"}}},"model":{"type":"string","description":"The base model that is being fine-tuned."},"object":{"type":"string","description":"The object type, which is always \"fine_tuning.job\".","enum":["fine_tuning.job"],"x-stainless-const":true},"organization_id":{"type":"string","description":"The organization that owns the fine-tuning job."},"result_files":{"type":"array","description":"The compiled results file ID(s) for the fine-tuning job. You can retrieve the results with the [Files API](/docs/api-reference/files/retrieve-contents).","items":{"type":"string","example":"file-abc123"}},"status":{"type":"string","description":"The current status of the fine-tuning job, which can be either `validating_files`, `queued`, `running`, `succeeded`, `failed`, or `cancelled`.","enum":["validating_files","queued","running","succeeded","failed","cancelled"]},"trained_tokens":{"anyOf":[{"type":"integer","description":"The total number of billable tokens processed by this fine-tuning job. The value will be null if the fine-tuning job is still running."},{"type":"null"}]},"training_file":{"type":"string","description":"The file ID used for training. You can retrieve the training data with the [Files API](/docs/api-reference/files/retrieve-contents)."},"validation_file":{"anyOf":[{"type":"string","description":"The file ID used for validation. You can retrieve the validation results with the [Files API](/docs/api-reference/files/retrieve-contents)."},{"type":"null"}]},"integrations":{"anyOf":[{"type":"array","description":"A list of integrations to enable for this fine-tuning job.","maxItems":5,"items":{"oneOf":[{"$ref":"#/components/schemas/FineTuningIntegration"}]}},{"type":"null"}]},"seed":{"type":"integer","description":"The seed used for the fine-tuning job."},"estimated_finish":{"anyOf":[{"type":"integer","description":"The Unix timestamp (in seconds) for when the fine-tuning job is estimated to finish. The value will be null if the fine-tuning job is not running."},{"type":"null"}]},"method":{"$ref":"#/components/schemas/FineTuneMethod"},"metadata":{"$ref":"#/components/schemas/Metadata"}},"required":["created_at","error","finished_at","fine_tuned_model","hyperparameters","id","model","object","organization_id","result_files","status","trained_tokens","training_file","validation_file","seed"],"x-oaiMeta":{"name":"The fine-tuning job object","example":"{\n \"object\": \"fine_tuning.job\",\n \"id\": \"ftjob-abc123\",\n \"model\": \"davinci-002\",\n \"created_at\": 1692661014,\n \"finished_at\": 1692661190,\n \"fine_tuned_model\": \"ft:davinci-002:my-org:custom_suffix:7q8mpxmy\",\n \"organization_id\": \"org-123\",\n \"result_files\": [\n \"file-abc123\"\n ],\n \"status\": \"succeeded\",\n \"validation_file\": null,\n \"training_file\": \"file-abc123\",\n \"hyperparameters\": {\n \"n_epochs\": 4,\n \"batch_size\": 1,\n \"learning_rate_multiplier\": 1.0\n },\n \"trained_tokens\": 5768,\n \"integrations\": [],\n \"seed\": 0,\n \"estimated_finish\": 0,\n \"method\": {\n \"type\": \"supervised\",\n \"supervised\": {\n \"hyperparameters\": {\n \"n_epochs\": 4,\n \"batch_size\": 1,\n \"learning_rate_multiplier\": 1.0\n }\n }\n },\n \"metadata\": {\n \"key\": \"value\"\n }\n}\n"}},"FineTuningJobCheckpoint":{"type":"object","title":"FineTuningJobCheckpoint","description":"The `fine_tuning.job.checkpoint` object represents a model checkpoint for a fine-tuning job that is ready to use.\n","properties":{"id":{"type":"string","description":"The checkpoint identifier, which can be referenced in the API endpoints."},"created_at":{"type":"integer","description":"The Unix timestamp (in seconds) for when the checkpoint was created."},"fine_tuned_model_checkpoint":{"type":"string","description":"The name of the fine-tuned checkpoint model that is created."},"step_number":{"type":"integer","description":"The step number that the checkpoint was created at."},"metrics":{"type":"object","description":"Metrics at the step number during the fine-tuning job.","properties":{"step":{"type":"number"},"train_loss":{"type":"number"},"train_mean_token_accuracy":{"type":"number"},"valid_loss":{"type":"number"},"valid_mean_token_accuracy":{"type":"number"},"full_valid_loss":{"type":"number"},"full_valid_mean_token_accuracy":{"type":"number"}}},"fine_tuning_job_id":{"type":"string","description":"The name of the fine-tuning job that this checkpoint was created from."},"object":{"type":"string","description":"The object type, which is always \"fine_tuning.job.checkpoint\".","enum":["fine_tuning.job.checkpoint"],"x-stainless-const":true}},"required":["created_at","fine_tuning_job_id","fine_tuned_model_checkpoint","id","metrics","object","step_number"],"x-oaiMeta":{"name":"The fine-tuning job checkpoint object","example":"{\n \"object\": \"fine_tuning.job.checkpoint\",\n \"id\": \"ftckpt_qtZ5Gyk4BLq1SfLFWp3RtO3P\",\n \"created_at\": 1712211699,\n \"fine_tuned_model_checkpoint\": \"ft:gpt-4o-mini-2024-07-18:my-org:custom_suffix:9ABel2dg:ckpt-step-88\",\n \"fine_tuning_job_id\": \"ftjob-fpbNQ3H1GrMehXRf8cO97xTN\",\n \"metrics\": {\n \"step\": 88,\n \"train_loss\": 0.478,\n \"train_mean_token_accuracy\": 0.924,\n \"valid_loss\": 10.112,\n \"valid_mean_token_accuracy\": 0.145,\n \"full_valid_loss\": 0.567,\n \"full_valid_mean_token_accuracy\": 0.944\n },\n \"step_number\": 88\n}\n"}},"FineTuningJobEvent":{"type":"object","description":"Fine-tuning job event object","properties":{"object":{"type":"string","description":"The object type, which is always \"fine_tuning.job.event\".","enum":["fine_tuning.job.event"],"x-stainless-const":true},"id":{"type":"string","description":"The object identifier."},"created_at":{"type":"integer","description":"The Unix timestamp (in seconds) for when the fine-tuning job was created."},"level":{"type":"string","description":"The log level of the event.","enum":["info","warn","error"]},"message":{"type":"string","description":"The message of the event."},"type":{"type":"string","description":"The type of event.","enum":["message","metrics"]},"data":{"type":"object","description":"The data associated with the event."}},"required":["id","object","created_at","level","message"],"x-oaiMeta":{"name":"The fine-tuning job event object","example":"{\n \"object\": \"fine_tuning.job.event\",\n \"id\": \"ftevent-abc123\"\n \"created_at\": 1677610602,\n \"level\": \"info\",\n \"message\": \"Created fine-tuning job\",\n \"data\": {},\n \"type\": \"message\"\n}\n"}},"FunctionAndCustomToolCallOutput":{"oneOf":[{"$ref":"#/components/schemas/InputTextContent"},{"$ref":"#/components/schemas/InputImageContent"},{"$ref":"#/components/schemas/InputFileContent"}],"discriminator":{"propertyName":"type"}},"FunctionObject":{"type":"object","properties":{"description":{"type":"string","description":"A description of what the function does, used by the model to choose when and how to call the function."},"name":{"type":"string","description":"The name of the function to be called. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64."},"parameters":{"$ref":"#/components/schemas/FunctionParameters"},"strict":{"anyOf":[{"type":"boolean","default":false,"description":"Whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the `parameters` field. Only a subset of JSON Schema is supported when `strict` is `true`. Learn more about Structured Outputs in the [function calling guide](/docs/guides/function-calling)."},{"type":"null"}]}},"required":["name"]},"FunctionParameters":{"type":"object","description":"The parameters the functions accepts, described as a JSON Schema object. See the [guide](/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema/) for documentation about the format. \n\nOmitting `parameters` defines a function with an empty parameter list.","additionalProperties":true},"FunctionToolCall":{"type":"object","title":"Function tool call","description":"A tool call to run a function. See the \n[function calling guide](/docs/guides/function-calling) for more information.\n","properties":{"id":{"type":"string","description":"The unique ID of the function tool call.\n"},"type":{"type":"string","enum":["function_call"],"description":"The type of the function tool call. Always `function_call`.\n","x-stainless-const":true},"call_id":{"type":"string","description":"The unique ID of the function tool call generated by the model.\n"},"namespace":{"type":"string","description":"The namespace of the function to run.\n"},"name":{"type":"string","description":"The name of the function to run.\n"},"arguments":{"type":"string","description":"A JSON string of the arguments to pass to the function.\n"},"status":{"type":"string","description":"The status of the item. One of `in_progress`, `completed`, or\n`incomplete`. Populated when items are returned via API.\n","enum":["in_progress","completed","incomplete"]}},"required":["type","call_id","name","arguments"]},"FunctionToolCallOutput":{"type":"object","title":"Function tool call output","description":"The output of a function tool call.\n","properties":{"id":{"type":"string","description":"The unique ID of the function tool call output. Populated when this item\nis returned via API.\n"},"type":{"type":"string","enum":["function_call_output"],"description":"The type of the function tool call output. Always `function_call_output`.\n","x-stainless-const":true},"call_id":{"type":"string","description":"The unique ID of the function tool call generated by the model.\n"},"output":{"description":"The output from the function call generated by your code.\nCan be a string or an list of output content.\n","oneOf":[{"type":"string","description":"A string of the output of the function call.\n","title":"string output"},{"type":"array","items":{"$ref":"#/components/schemas/FunctionAndCustomToolCallOutput"},"title":"output content list","description":"Text, image, or file output of the function call.\n"}]},"status":{"type":"string","description":"The status of the item. One of `in_progress`, `completed`, or\n`incomplete`. Populated when items are returned via API.\n","enum":["in_progress","completed","incomplete"]}},"required":["type","call_id","output"]},"FunctionToolCallOutputResource":{"allOf":[{"$ref":"#/components/schemas/FunctionToolCallOutput"},{"type":"object","properties":{"id":{"type":"string","description":"The unique ID of the function call tool output.\n"},"status":{"description":"The status of the item. One of `in_progress`, `completed`, or\n`incomplete`. Populated when items are returned via API.\n","$ref":"#/components/schemas/FunctionCallOutputStatusEnum"},"created_by":{"type":"string","description":"The identifier of the actor that created the item.\n"}},"required":["id","status"]}]},"FunctionToolCallResource":{"allOf":[{"$ref":"#/components/schemas/FunctionToolCall"},{"type":"object","properties":{"id":{"type":"string","description":"The unique ID of the function tool call.\n"},"status":{"description":"The status of the item. One of `in_progress`, `completed`, or\n`incomplete`. Populated when items are returned via API.\n","$ref":"#/components/schemas/FunctionCallStatus"},"created_by":{"type":"string","description":"The identifier of the actor that created the item.\n"}},"required":["id","status"]}]},"GraderLabelModel":{"type":"object","title":"LabelModelGrader","description":"A LabelModelGrader object which uses a model to assign labels to each item\nin the evaluation.\n","properties":{"type":{"description":"The object type, which is always `label_model`.","type":"string","enum":["label_model"],"x-stainless-const":true},"name":{"type":"string","description":"The name of the grader."},"model":{"type":"string","description":"The model to use for the evaluation. Must support structured outputs."},"input":{"type":"array","items":{"$ref":"#/components/schemas/EvalItem"}},"labels":{"type":"array","items":{"type":"string"},"description":"The labels to assign to each item in the evaluation."},"passing_labels":{"type":"array","items":{"type":"string"},"description":"The labels that indicate a passing result. Must be a subset of labels."}},"required":["type","model","input","passing_labels","labels","name"],"x-oaiMeta":{"name":"Label Model Grader","group":"graders","example":"{\n \"name\": \"First label grader\",\n \"type\": \"label_model\",\n \"model\": \"gpt-4o-2024-08-06\",\n \"input\": [\n {\n \"type\": \"message\",\n \"role\": \"system\",\n \"content\": {\n \"type\": \"input_text\",\n \"text\": \"Classify the sentiment of the following statement as one of positive, neutral, or negative\"\n }\n },\n {\n \"type\": \"message\",\n \"role\": \"user\",\n \"content\": {\n \"type\": \"input_text\",\n \"text\": \"Statement: {{item.response}}\"\n }\n }\n ],\n \"passing_labels\": [\n \"positive\"\n ],\n \"labels\": [\n \"positive\",\n \"neutral\",\n \"negative\"\n ]\n}\n"}},"GraderMulti":{"type":"object","title":"MultiGrader","description":"A MultiGrader object combines the output of multiple graders to produce a single score.","properties":{"type":{"type":"string","enum":["multi"],"default":"multi","description":"The object type, which is always `multi`.","x-stainless-const":true},"name":{"type":"string","description":"The name of the grader."},"graders":{"oneOf":[{"$ref":"#/components/schemas/GraderStringCheck"},{"$ref":"#/components/schemas/GraderTextSimilarity"},{"$ref":"#/components/schemas/GraderPython"},{"$ref":"#/components/schemas/GraderScoreModel"},{"$ref":"#/components/schemas/GraderLabelModel"}]},"calculate_output":{"type":"string","description":"A formula to calculate the output based on grader results."}},"required":["name","type","graders","calculate_output"],"x-oaiMeta":{"name":"Multi Grader","group":"graders","example":"{\n \"type\": \"multi\",\n \"name\": \"example multi grader\",\n \"graders\": [\n {\n \"type\": \"text_similarity\",\n \"name\": \"example text similarity grader\",\n \"input\": \"The graded text\",\n \"reference\": \"The reference text\",\n \"evaluation_metric\": \"fuzzy_match\"\n },\n {\n \"type\": \"string_check\",\n \"name\": \"Example string check grader\",\n \"input\": \"{{sample.output_text}}\",\n \"reference\": \"{{item.label}}\",\n \"operation\": \"eq\"\n }\n ],\n \"calculate_output\": \"0.5 * text_similarity_score + 0.5 * string_check_score)\"\n}\n"}},"GraderPython":{"type":"object","title":"PythonGrader","description":"A PythonGrader object that runs a python script on the input.\n","properties":{"type":{"type":"string","enum":["python"],"description":"The object type, which is always `python`.","x-stainless-const":true},"name":{"type":"string","description":"The name of the grader."},"source":{"type":"string","description":"The source code of the python script."},"image_tag":{"type":"string","description":"The image tag to use for the python script."}},"required":["type","name","source"],"x-oaiMeta":{"name":"Python Grader","group":"graders","example":"{\n \"type\": \"python\",\n \"name\": \"Example python grader\",\n \"image_tag\": \"2025-05-08\",\n \"source\": \"\"\"\ndef grade(sample: dict, item: dict) -> float:\n \\\"\"\"\n Returns 1.0 if `output_text` equals `label`, otherwise 0.0.\n \\\"\"\"\n output = sample.get(\"output_text\")\n label = item.get(\"label\")\n return 1.0 if output == label else 0.0\n\"\"\",\n}\n"}},"GraderScoreModel":{"type":"object","title":"ScoreModelGrader","description":"A ScoreModelGrader object that uses a model to assign a score to the input.\n","properties":{"type":{"type":"string","enum":["score_model"],"description":"The object type, which is always `score_model`.","x-stainless-const":true},"name":{"type":"string","description":"The name of the grader."},"model":{"type":"string","description":"The model to use for the evaluation."},"sampling_params":{"type":"object","description":"The sampling parameters for the model.","properties":{"seed":{"anyOf":[{"type":"integer","description":"A seed value to initialize the randomness, during sampling.\n"},{"type":"null"}]},"top_p":{"anyOf":[{"type":"number","default":1,"example":1,"description":"An alternative to temperature for nucleus sampling; 1.0 includes all tokens.\n"},{"type":"null"}]},"temperature":{"anyOf":[{"type":"number","description":"A higher temperature increases randomness in the outputs.\n"},{"type":"null"}]},"max_completions_tokens":{"anyOf":[{"type":"integer","minimum":1,"description":"The maximum number of tokens the grader model may generate in its response.\n"},{"type":"null"}]},"reasoning_effort":{"$ref":"#/components/schemas/ReasoningEffort"}}},"input":{"type":"array","items":{"$ref":"#/components/schemas/EvalItem"},"description":"The input messages evaluated by the grader. Supports text, output text, input image, and input audio content blocks, and may include template strings.\n"},"range":{"type":"array","items":{"type":"number","min_items":2,"max_items":2},"description":"The range of the score. Defaults to `[0, 1]`."}},"required":["type","name","input","model"],"x-oaiMeta":{"name":"Score Model Grader","group":"graders","example":"{\n \"type\": \"score_model\",\n \"name\": \"Example score model grader\",\n \"input\": [\n {\n \"role\": \"user\",\n \"content\": [\n {\n \"type\": \"input_text\",\n \"text\": (\n \"Score how close the reference answer is to the model answer. Score 1.0 if they are the same and 0.0 if they are different.\"\n \" Return just a floating point score\\n\\n\"\n \" Reference answer: {{item.label}}\\n\\n\"\n \" Model answer: {{sample.output_text}}\"\n )\n },\n {\n \"type\": \"input_image\",\n \"image_url\": \"https://example.com/reference.png\",\n \"file_id\": null,\n \"detail\": \"auto\"\n }\n ],\n }\n ],\n \"model\": \"gpt-5-mini\",\n \"sampling_params\": {\n \"temperature\": 1,\n \"top_p\": 1,\n \"seed\": 42,\n \"max_completions_tokens\": 32768,\n \"reasoning_effort\": \"medium\"\n },\n}\n"}},"GraderStringCheck":{"type":"object","title":"StringCheckGrader","description":"A StringCheckGrader object that performs a string comparison between input and reference using a specified operation.\n","properties":{"type":{"type":"string","enum":["string_check"],"description":"The object type, which is always `string_check`.","x-stainless-const":true},"name":{"type":"string","description":"The name of the grader."},"input":{"type":"string","description":"The input text. This may include template strings."},"reference":{"type":"string","description":"The reference text. This may include template strings."},"operation":{"type":"string","enum":["eq","ne","like","ilike"],"description":"The string check operation to perform. One of `eq`, `ne`, `like`, or `ilike`."}},"required":["type","name","input","reference","operation"],"x-oaiMeta":{"name":"String Check Grader","group":"graders","example":"{\n \"type\": \"string_check\",\n \"name\": \"Example string check grader\",\n \"input\": \"{{sample.output_text}}\",\n \"reference\": \"{{item.label}}\",\n \"operation\": \"eq\"\n}\n"}},"GraderTextSimilarity":{"type":"object","title":"TextSimilarityGrader","description":"A TextSimilarityGrader object which grades text based on similarity metrics.\n","properties":{"type":{"type":"string","enum":["text_similarity"],"default":"text_similarity","description":"The type of grader.","x-stainless-const":true},"name":{"type":"string","description":"The name of the grader."},"input":{"type":"string","description":"The text being graded."},"reference":{"type":"string","description":"The text being graded against."},"evaluation_metric":{"type":"string","enum":["cosine","fuzzy_match","bleu","gleu","meteor","rouge_1","rouge_2","rouge_3","rouge_4","rouge_5","rouge_l"],"description":"The evaluation metric to use. One of `cosine`, `fuzzy_match`, `bleu`, \n`gleu`, `meteor`, `rouge_1`, `rouge_2`, `rouge_3`, `rouge_4`, `rouge_5`, \nor `rouge_l`.\n"}},"required":["type","name","input","reference","evaluation_metric"],"x-oaiMeta":{"name":"Text Similarity Grader","group":"graders","example":"{\n \"type\": \"text_similarity\",\n \"name\": \"Example text similarity grader\",\n \"input\": \"{{sample.output_text}}\",\n \"reference\": \"{{item.label}}\",\n \"evaluation_metric\": \"fuzzy_match\"\n}\n"}},"Group":{"type":"object","description":"Summary information about a group returned in role assignment responses.","properties":{"object":{"type":"string","enum":["group"],"description":"Always `group`.","x-stainless-const":true},"id":{"type":"string","description":"Identifier for the group."},"name":{"type":"string","description":"Display name of the group."},"created_at":{"type":"integer","format":"int64","description":"Unix timestamp (in seconds) when the group was created."},"scim_managed":{"type":"boolean","description":"Whether the group is managed through SCIM."}},"required":["object","id","name","created_at","scim_managed"],"x-oaiMeta":{"name":"The group object","example":"{\n \"object\": \"group\",\n \"id\": \"group_01J1F8ABCDXYZ\",\n \"name\": \"Support Team\",\n \"created_at\": 1711471533,\n \"scim_managed\": false\n}\n"}},"GroupDeletedResource":{"type":"object","description":"Confirmation payload returned after deleting a group.","properties":{"object":{"type":"string","enum":["group.deleted"],"description":"Always `group.deleted`.","x-stainless-const":true},"id":{"type":"string","description":"Identifier of the deleted group."},"deleted":{"type":"boolean","description":"Whether the group was deleted."}},"required":["object","id","deleted"],"x-oaiMeta":{"example":"{\n \"object\": \"group.deleted\",\n \"id\": \"group_01J1F8ABCDXYZ\",\n \"deleted\": true\n}\n"}},"GroupListResource":{"type":"object","description":"Paginated list of organization groups.","properties":{"object":{"type":"string","enum":["list"],"description":"Always `list`.","x-stainless-const":true},"data":{"type":"array","description":"Groups returned in the current page.","items":{"$ref":"#/components/schemas/GroupResponse"}},"has_more":{"type":"boolean","description":"Whether additional groups are available when paginating."},"next":{"description":"Cursor to fetch the next page of results, or `null` if there are no more results.","anyOf":[{"type":"string"},{"type":"null"}]}},"required":["object","data","has_more","next"],"x-oaiMeta":{"name":"Group list","example":"{\n \"object\": \"list\",\n \"data\": [\n {\n \"id\": \"group_01J1F8ABCDXYZ\",\n \"name\": \"Support Team\",\n \"created_at\": 1711471533,\n \"is_scim_managed\": false\n },\n {\n \"id\": \"group_01J1F8PQRMNO\",\n \"name\": \"Sales\",\n \"created_at\": 1711472599,\n \"is_scim_managed\": true\n }\n ],\n \"has_more\": false,\n \"next\": null\n}\n"}},"GroupResourceWithSuccess":{"type":"object","description":"Response returned after updating a group.","properties":{"id":{"type":"string","description":"Identifier for the group."},"name":{"type":"string","description":"Updated display name for the group."},"created_at":{"type":"integer","format":"int64","description":"Unix timestamp (in seconds) when the group was created."},"is_scim_managed":{"type":"boolean","description":"Whether the group is managed through SCIM and controlled by your identity provider."}},"required":["id","name","created_at","is_scim_managed"],"x-oaiMeta":{"example":"{\n \"id\": \"group_01J1F8ABCDXYZ\",\n \"name\": \"Escalations\",\n \"created_at\": 1711471533,\n \"is_scim_managed\": false\n}\n"}},"GroupResponse":{"type":"object","description":"Details about an organization group.","properties":{"id":{"type":"string","description":"Identifier for the group."},"name":{"type":"string","description":"Display name of the group."},"created_at":{"type":"integer","format":"int64","description":"Unix timestamp (in seconds) when the group was created."},"is_scim_managed":{"type":"boolean","description":"Whether the group is managed through SCIM and controlled by your identity provider."}},"required":["id","name","created_at","is_scim_managed"],"x-oaiMeta":{"name":"Group","example":"{\n \"id\": \"group_01J1F8ABCDXYZ\",\n \"name\": \"Support Team\",\n \"created_at\": 1711471533,\n \"is_scim_managed\": false\n}\n"}},"GroupRoleAssignment":{"type":"object","description":"Role assignment linking a group to a role.","properties":{"object":{"type":"string","enum":["group.role"],"description":"Always `group.role`.","x-stainless-const":true},"group":{"$ref":"#/components/schemas/Group"},"role":{"$ref":"#/components/schemas/Role"}},"required":["object","group","role"],"x-oaiMeta":{"name":"The group role object","example":"{\n \"object\": \"group.role\",\n \"group\": {\n \"object\": \"group\",\n \"id\": \"group_01J1F8ABCDXYZ\",\n \"name\": \"Support Team\",\n \"created_at\": 1711471533,\n \"scim_managed\": false\n },\n \"role\": {\n \"object\": \"role\",\n \"id\": \"role_01J1F8ROLE01\",\n \"name\": \"API Group Manager\",\n \"description\": \"Allows managing organization groups\",\n \"permissions\": [\n \"api.groups.read\",\n \"api.groups.write\"\n ],\n \"resource_type\": \"api.organization\",\n \"predefined_role\": false\n }\n}\n"}},"GroupUserAssignment":{"type":"object","description":"Confirmation payload returned after adding a user to a group.","properties":{"object":{"type":"string","enum":["group.user"],"description":"Always `group.user`.","x-stainless-const":true},"user_id":{"type":"string","description":"Identifier of the user that was added."},"group_id":{"type":"string","description":"Identifier of the group the user was added to."}},"required":["object","user_id","group_id"],"x-oaiMeta":{"name":"The group user object","example":"{\n \"object\": \"group.user\",\n \"user_id\": \"user_abc123\",\n \"group_id\": \"group_01J1F8ABCDXYZ\"\n}\n"}},"GroupUserDeletedResource":{"type":"object","description":"Confirmation payload returned after removing a user from a group.","properties":{"object":{"type":"string","enum":["group.user.deleted"],"description":"Always `group.user.deleted`.","x-stainless-const":true},"deleted":{"type":"boolean","description":"Whether the group membership was removed."}},"required":["object","deleted"],"x-oaiMeta":{"name":"Group user deletion confirmation","example":"{\n \"object\": \"group.user.deleted\",\n \"deleted\": true\n}\n"}},"Image":{"type":"object","description":"Represents the content or the URL of an image generated by the OpenAI API.","properties":{"b64_json":{"type":"string","description":"The base64-encoded JSON of the generated image. Returned by default for the GPT image models, and only present if `response_format` is set to `b64_json` for `dall-e-2` and `dall-e-3`."},"url":{"type":"string","description":"When using `dall-e-2` or `dall-e-3`, the URL of the generated image if `response_format` is set to `url` (default value). Unsupported for the GPT image models."},"revised_prompt":{"type":"string","description":"For `dall-e-3` only, the revised prompt that was used to generate the image."}}},"ImageEditCompletedEvent":{"type":"object","description":"Emitted when image editing has completed and the final image is available.\n","properties":{"type":{"type":"string","description":"The type of the event. Always `image_edit.completed`.\n","enum":["image_edit.completed"],"x-stainless-const":true},"b64_json":{"type":"string","description":"Base64-encoded final edited image data, suitable for rendering as an image.\n"},"created_at":{"type":"integer","description":"The Unix timestamp when the event was created.\n"},"size":{"type":"string","description":"The size of the edited image.\n","enum":["1024x1024","1024x1536","1536x1024","auto"]},"quality":{"type":"string","description":"The quality setting for the edited image.\n","enum":["low","medium","high","auto"]},"background":{"type":"string","description":"The background setting for the edited image.\n","enum":["transparent","opaque","auto"]},"output_format":{"type":"string","description":"The output format for the edited image.\n","enum":["png","webp","jpeg"]},"usage":{"$ref":"#/components/schemas/ImagesUsage"}},"required":["type","b64_json","created_at","size","quality","background","output_format","usage"],"x-oaiMeta":{"name":"image_edit.completed","group":"images","example":"{\n \"type\": \"image_edit.completed\",\n \"b64_json\": \"...\",\n \"created_at\": 1620000000,\n \"size\": \"1024x1024\",\n \"quality\": \"high\",\n \"background\": \"transparent\",\n \"output_format\": \"png\",\n \"usage\": {\n \"total_tokens\": 100,\n \"input_tokens\": 50,\n \"output_tokens\": 50,\n \"input_tokens_details\": {\n \"text_tokens\": 10,\n \"image_tokens\": 40\n }\n }\n}\n"}},"ImageEditPartialImageEvent":{"type":"object","description":"Emitted when a partial image is available during image editing streaming.\n","properties":{"type":{"type":"string","description":"The type of the event. Always `image_edit.partial_image`.\n","enum":["image_edit.partial_image"],"x-stainless-const":true},"b64_json":{"type":"string","description":"Base64-encoded partial image data, suitable for rendering as an image.\n"},"created_at":{"type":"integer","description":"The Unix timestamp when the event was created.\n"},"size":{"type":"string","description":"The size of the requested edited image.\n","enum":["1024x1024","1024x1536","1536x1024","auto"]},"quality":{"type":"string","description":"The quality setting for the requested edited image.\n","enum":["low","medium","high","auto"]},"background":{"type":"string","description":"The background setting for the requested edited image.\n","enum":["transparent","opaque","auto"]},"output_format":{"type":"string","description":"The output format for the requested edited image.\n","enum":["png","webp","jpeg"]},"partial_image_index":{"type":"integer","description":"0-based index for the partial image (streaming).\n"}},"required":["type","b64_json","created_at","size","quality","background","output_format","partial_image_index"],"x-oaiMeta":{"name":"image_edit.partial_image","group":"images","example":"{\n \"type\": \"image_edit.partial_image\",\n \"b64_json\": \"...\",\n \"created_at\": 1620000000,\n \"size\": \"1024x1024\",\n \"quality\": \"high\",\n \"background\": \"transparent\",\n \"output_format\": \"png\",\n \"partial_image_index\": 0\n}\n"}},"ImageEditStreamEvent":{"anyOf":[{"$ref":"#/components/schemas/ImageEditPartialImageEvent"},{"$ref":"#/components/schemas/ImageEditCompletedEvent"}],"discriminator":{"propertyName":"type"}},"ImageGenCompletedEvent":{"type":"object","description":"Emitted when image generation has completed and the final image is available.\n","properties":{"type":{"type":"string","description":"The type of the event. Always `image_generation.completed`.\n","enum":["image_generation.completed"],"x-stainless-const":true},"b64_json":{"type":"string","description":"Base64-encoded image data, suitable for rendering as an image.\n"},"created_at":{"type":"integer","description":"The Unix timestamp when the event was created.\n"},"size":{"type":"string","description":"The size of the generated image.\n","enum":["1024x1024","1024x1536","1536x1024","auto"]},"quality":{"type":"string","description":"The quality setting for the generated image.\n","enum":["low","medium","high","auto"]},"background":{"type":"string","description":"The background setting for the generated image.\n","enum":["transparent","opaque","auto"]},"output_format":{"type":"string","description":"The output format for the generated image.\n","enum":["png","webp","jpeg"]},"usage":{"$ref":"#/components/schemas/ImagesUsage"}},"required":["type","b64_json","created_at","size","quality","background","output_format","usage"],"x-oaiMeta":{"name":"image_generation.completed","group":"images","example":"{\n \"type\": \"image_generation.completed\",\n \"b64_json\": \"...\",\n \"created_at\": 1620000000,\n \"size\": \"1024x1024\",\n \"quality\": \"high\",\n \"background\": \"transparent\",\n \"output_format\": \"png\",\n \"usage\": {\n \"total_tokens\": 100,\n \"input_tokens\": 50,\n \"output_tokens\": 50,\n \"input_tokens_details\": {\n \"text_tokens\": 10,\n \"image_tokens\": 40\n }\n }\n}\n"}},"ImageGenPartialImageEvent":{"type":"object","description":"Emitted when a partial image is available during image generation streaming.\n","properties":{"type":{"type":"string","description":"The type of the event. Always `image_generation.partial_image`.\n","enum":["image_generation.partial_image"],"x-stainless-const":true},"b64_json":{"type":"string","description":"Base64-encoded partial image data, suitable for rendering as an image.\n"},"created_at":{"type":"integer","description":"The Unix timestamp when the event was created.\n"},"size":{"type":"string","description":"The size of the requested image.\n","enum":["1024x1024","1024x1536","1536x1024","auto"]},"quality":{"type":"string","description":"The quality setting for the requested image.\n","enum":["low","medium","high","auto"]},"background":{"type":"string","description":"The background setting for the requested image.\n","enum":["transparent","opaque","auto"]},"output_format":{"type":"string","description":"The output format for the requested image.\n","enum":["png","webp","jpeg"]},"partial_image_index":{"type":"integer","description":"0-based index for the partial image (streaming).\n"}},"required":["type","b64_json","created_at","size","quality","background","output_format","partial_image_index"],"x-oaiMeta":{"name":"image_generation.partial_image","group":"images","example":"{\n \"type\": \"image_generation.partial_image\",\n \"b64_json\": \"...\",\n \"created_at\": 1620000000,\n \"size\": \"1024x1024\",\n \"quality\": \"high\",\n \"background\": \"transparent\",\n \"output_format\": \"png\",\n \"partial_image_index\": 0\n}\n"}},"ImageGenStreamEvent":{"anyOf":[{"$ref":"#/components/schemas/ImageGenPartialImageEvent"},{"$ref":"#/components/schemas/ImageGenCompletedEvent"}],"discriminator":{"propertyName":"type"}},"ImageGenTool":{"type":"object","title":"Image generation tool","description":"A tool that generates images using the GPT image models.\n","properties":{"type":{"type":"string","enum":["image_generation"],"description":"The type of the image generation tool. Always `image_generation`.\n","x-stainless-const":true},"model":{"anyOf":[{"type":"string"},{"type":"string","enum":["gpt-image-1","gpt-image-1-mini","gpt-image-1.5"],"description":"The image generation model to use. Default: `gpt-image-1`.\n","default":"gpt-image-1"}]},"quality":{"type":"string","enum":["low","medium","high","auto"],"description":"The quality of the generated image. One of `low`, `medium`, `high`,\nor `auto`. Default: `auto`.\n","default":"auto"},"size":{"type":"string","enum":["1024x1024","1024x1536","1536x1024","auto"],"description":"The size of the generated image. One of `1024x1024`, `1024x1536`,\n`1536x1024`, or `auto`. Default: `auto`.\n","default":"auto"},"output_format":{"type":"string","enum":["png","webp","jpeg"],"description":"The output format of the generated image. One of `png`, `webp`, or\n`jpeg`. Default: `png`.\n","default":"png"},"output_compression":{"type":"integer","minimum":0,"maximum":100,"description":"Compression level for the output image. Default: 100.\n","default":100},"moderation":{"type":"string","enum":["auto","low"],"description":"Moderation level for the generated image. Default: `auto`.\n","default":"auto"},"background":{"type":"string","enum":["transparent","opaque","auto"],"description":"Background type for the generated image. One of `transparent`,\n`opaque`, or `auto`. Default: `auto`.\n","default":"auto"},"input_fidelity":{"anyOf":[{"$ref":"#/components/schemas/InputFidelity"},{"type":"null"}]},"input_image_mask":{"type":"object","description":"Optional mask for inpainting. Contains `image_url`\n(string, optional) and `file_id` (string, optional).\n","properties":{"image_url":{"type":"string","description":"Base64-encoded mask image.\n"},"file_id":{"type":"string","description":"File ID for the mask image.\n"}},"required":[],"additionalProperties":false},"partial_images":{"type":"integer","minimum":0,"maximum":3,"description":"Number of partial images to generate in streaming mode, from 0 (default value) to 3.\n","default":0},"action":{"description":"Whether to generate a new image or edit an existing image. Default: `auto`.\n","$ref":"#/components/schemas/ImageGenActionEnum"}},"required":["type"]},"ImageGenToolCall":{"type":"object","title":"Image generation call","description":"An image generation request made by the model.\n","properties":{"type":{"type":"string","enum":["image_generation_call"],"description":"The type of the image generation call. Always `image_generation_call`.\n","x-stainless-const":true},"id":{"type":"string","description":"The unique ID of the image generation call.\n"},"status":{"type":"string","enum":["in_progress","completed","generating","failed"],"description":"The status of the image generation call.\n"},"result":{"anyOf":[{"type":"string","description":"The generated image encoded in base64.\n"},{"type":"null"}]}},"required":["type","id","status","result"]},"ImageRefParam":{"type":"object","description":"Reference an input image by either URL or uploaded file ID.\nProvide exactly one of `image_url` or `file_id`.\n","properties":{"image_url":{"type":"string","maxLength":20971520,"description":"A fully qualified URL or base64-encoded data URL.","example":"https://example.com/source-image.png"},"file_id":{"type":"string","description":"The File API ID of an uploaded image to use as input.","example":"file-abc123"}},"anyOf":[{"required":["image_url"]},{"required":["file_id"]}],"not":{"required":["image_url","file_id"]},"additionalProperties":false},"ImagesResponse":{"type":"object","title":"Image generation response","description":"The response from the image generation endpoint.","properties":{"created":{"type":"integer","description":"The Unix timestamp (in seconds) of when the image was created."},"data":{"type":"array","description":"The list of generated images.","items":{"$ref":"#/components/schemas/Image"}},"background":{"type":"string","description":"The background parameter used for the image generation. Either `transparent` or `opaque`.","enum":["transparent","opaque"]},"output_format":{"type":"string","description":"The output format of the image generation. Either `png`, `webp`, or `jpeg`.","enum":["png","webp","jpeg"]},"size":{"type":"string","description":"The size of the image generated. Either `1024x1024`, `1024x1536`, or `1536x1024`.","enum":["1024x1024","1024x1536","1536x1024"]},"quality":{"type":"string","description":"The quality of the image generated. Either `low`, `medium`, or `high`.","enum":["low","medium","high"]},"usage":{"$ref":"#/components/schemas/ImageGenUsage"}},"required":["created"],"x-oaiMeta":{"name":"The image generation response","group":"images","example":"{\n \"created\": 1713833628,\n \"data\": [\n {\n \"b64_json\": \"...\"\n }\n ],\n \"background\": \"transparent\",\n \"output_format\": \"png\",\n \"size\": \"1024x1024\",\n \"quality\": \"high\",\n \"usage\": {\n \"total_tokens\": 100,\n \"input_tokens\": 50,\n \"output_tokens\": 50,\n \"input_tokens_details\": {\n \"text_tokens\": 10,\n \"image_tokens\": 40\n }\n }\n}\n"}},"ImagesUsage":{"type":"object","description":"For the GPT image models only, the token usage information for the image generation.\n","required":["total_tokens","input_tokens","output_tokens","input_tokens_details"],"properties":{"total_tokens":{"type":"integer","description":"The total number of tokens (images and text) used for the image generation.\n"},"input_tokens":{"type":"integer","description":"The number of tokens (images and text) in the input prompt."},"output_tokens":{"type":"integer","description":"The number of image tokens in the output image."},"input_tokens_details":{"type":"object","description":"The input tokens detailed information for the image generation.","required":["text_tokens","image_tokens"],"properties":{"text_tokens":{"type":"integer","description":"The number of text tokens in the input prompt."},"image_tokens":{"type":"integer","description":"The number of image tokens in the input prompt."}}}}},"InputAudio":{"type":"object","title":"Input audio","description":"An audio input to the model.\n","properties":{"type":{"type":"string","description":"The type of the input item. Always `input_audio`.\n","enum":["input_audio"],"x-stainless-const":true},"input_audio":{"type":"object","properties":{"data":{"type":"string","description":"Base64-encoded audio data.\n"},"format":{"type":"string","description":"The format of the audio data. Currently supported formats are `mp3` and\n`wav`.\n","enum":["mp3","wav"]}},"required":["data","format"]}},"required":["type","input_audio"]},"InputContent":{"oneOf":[{"$ref":"#/components/schemas/InputTextContent"},{"$ref":"#/components/schemas/InputImageContent"},{"$ref":"#/components/schemas/InputFileContent"}],"discriminator":{"propertyName":"type"}},"InputItem":{"oneOf":[{"$ref":"#/components/schemas/EasyInputMessage"},{"type":"object","title":"Item","description":"An item representing part of the context for the response to be\ngenerated by the model. Can contain text, images, and audio inputs,\nas well as previous assistant responses and tool call outputs.\n","$ref":"#/components/schemas/Item"},{"$ref":"#/components/schemas/ItemReferenceParam"}],"discriminator":{"propertyName":"type"}},"InputMessage":{"type":"object","title":"Input message","description":"A message input to the model with a role indicating instruction following\nhierarchy. Instructions given with the `developer` or `system` role take\nprecedence over instructions given with the `user` role.\n","properties":{"type":{"type":"string","description":"The type of the message input. Always set to `message`.\n","enum":["message"],"x-stainless-const":true},"role":{"type":"string","description":"The role of the message input. One of `user`, `system`, or `developer`.\n","enum":["user","system","developer"]},"status":{"type":"string","description":"The status of item. One of `in_progress`, `completed`, or\n`incomplete`. Populated when items are returned via API.\n","enum":["in_progress","completed","incomplete"]},"content":{"$ref":"#/components/schemas/InputMessageContentList"}},"required":["role","content"]},"InputMessageContentList":{"type":"array","title":"Input item content list","description":"A list of one or many input items to the model, containing different content \ntypes.\n","items":{"$ref":"#/components/schemas/InputContent"}},"InputMessageResource":{"allOf":[{"$ref":"#/components/schemas/InputMessage"},{"type":"object","properties":{"id":{"type":"string","description":"The unique ID of the message input.\n"}},"required":["id","type"]}]},"InputParam":{"description":"Text, image, or file inputs to the model, used to generate a response.\n\nLearn more:\n- [Text inputs and outputs](/docs/guides/text)\n- [Image inputs](/docs/guides/images)\n- [File inputs](/docs/guides/pdf-files)\n- [Conversation state](/docs/guides/conversation-state)\n- [Function calling](/docs/guides/function-calling)\n","oneOf":[{"type":"string","title":"Text input","description":"A text input to the model, equivalent to a text input with the\n`user` role.\n"},{"type":"array","title":"Input item list","description":"A list of one or many input items to the model, containing\ndifferent content types.\n","items":{"$ref":"#/components/schemas/InputItem"}}]},"Invite":{"type":"object","description":"Represents an individual `invite` to the organization.","properties":{"object":{"type":"string","enum":["organization.invite"],"description":"The object type, which is always `organization.invite`","x-stainless-const":true},"id":{"type":"string","description":"The identifier, which can be referenced in API endpoints"},"email":{"type":"string","description":"The email address of the individual to whom the invite was sent"},"role":{"type":"string","enum":["owner","reader"],"description":"`owner` or `reader`"},"status":{"type":"string","enum":["accepted","expired","pending"],"description":"`accepted`,`expired`, or `pending`"},"invited_at":{"type":"integer","description":"The Unix timestamp (in seconds) of when the invite was sent."},"expires_at":{"type":"integer","description":"The Unix timestamp (in seconds) of when the invite expires."},"accepted_at":{"type":"integer","description":"The Unix timestamp (in seconds) of when the invite was accepted."},"projects":{"type":"array","description":"The projects that were granted membership upon acceptance of the invite.","items":{"type":"object","properties":{"id":{"type":"string","description":"Project's public ID"},"role":{"type":"string","enum":["member","owner"],"description":"Project membership role"}}}}},"required":["object","id","email","role","status","invited_at","expires_at"],"x-oaiMeta":{"name":"The invite object","example":"{\n \"object\": \"organization.invite\",\n \"id\": \"invite-abc\",\n \"email\": \"user@example.com\",\n \"role\": \"owner\",\n \"status\": \"accepted\",\n \"invited_at\": 1711471533,\n \"expires_at\": 1711471533,\n \"accepted_at\": 1711471533,\n \"projects\": [\n {\n \"id\": \"project-xyz\",\n \"role\": \"member\"\n }\n ]\n}\n"}},"InviteDeleteResponse":{"type":"object","properties":{"object":{"type":"string","enum":["organization.invite.deleted"],"description":"The object type, which is always `organization.invite.deleted`","x-stainless-const":true},"id":{"type":"string"},"deleted":{"type":"boolean"}},"required":["object","id","deleted"]},"InviteListResponse":{"type":"object","properties":{"object":{"type":"string","enum":["list"],"description":"The object type, which is always `list`","x-stainless-const":true},"data":{"type":"array","items":{"$ref":"#/components/schemas/Invite"}},"first_id":{"type":"string","description":"The first `invite_id` in the retrieved `list`"},"last_id":{"type":"string","description":"The last `invite_id` in the retrieved `list`"},"has_more":{"type":"boolean","description":"The `has_more` property is used for pagination to indicate there are additional results."}},"required":["object","data"]},"InviteProjectGroupBody":{"type":"object","description":"Request payload for granting a group access to a project.","properties":{"group_id":{"type":"string","description":"Identifier of the group to add to the project."},"role":{"type":"string","description":"Identifier of the project role to grant to the group."}},"required":["group_id","role"],"x-oaiMeta":{"example":"{\n \"group_id\": \"group_01J1F8ABCDXYZ\",\n \"role\": \"role_01J1F8PROJ\"\n}\n"}},"InviteRequest":{"type":"object","properties":{"email":{"type":"string","description":"Send an email to this address"},"role":{"type":"string","enum":["reader","owner"],"description":"`owner` or `reader`"},"projects":{"type":"array","description":"An array of projects to which membership is granted at the same time the org invite is accepted. If omitted, the user will be invited to the default project for compatibility with legacy behavior.","items":{"type":"object","properties":{"id":{"type":"string","description":"Project's public ID"},"role":{"type":"string","enum":["member","owner"],"description":"Project membership role"}},"required":["id","role"]}}},"required":["email","role"]},"Item":{"type":"object","description":"Content item used to generate a response.\n","oneOf":[{"$ref":"#/components/schemas/InputMessage"},{"$ref":"#/components/schemas/OutputMessage"},{"$ref":"#/components/schemas/FileSearchToolCall"},{"$ref":"#/components/schemas/ComputerToolCall"},{"$ref":"#/components/schemas/ComputerCallOutputItemParam"},{"$ref":"#/components/schemas/WebSearchToolCall"},{"$ref":"#/components/schemas/FunctionToolCall"},{"$ref":"#/components/schemas/FunctionCallOutputItemParam"},{"$ref":"#/components/schemas/ToolSearchCallItemParam"},{"$ref":"#/components/schemas/ToolSearchOutputItemParam"},{"$ref":"#/components/schemas/ReasoningItem"},{"$ref":"#/components/schemas/CompactionSummaryItemParam"},{"$ref":"#/components/schemas/ImageGenToolCall"},{"$ref":"#/components/schemas/CodeInterpreterToolCall"},{"$ref":"#/components/schemas/LocalShellToolCall"},{"$ref":"#/components/schemas/LocalShellToolCallOutput"},{"$ref":"#/components/schemas/FunctionShellCallItemParam"},{"$ref":"#/components/schemas/FunctionShellCallOutputItemParam"},{"$ref":"#/components/schemas/ApplyPatchToolCallItemParam"},{"$ref":"#/components/schemas/ApplyPatchToolCallOutputItemParam"},{"$ref":"#/components/schemas/MCPListTools"},{"$ref":"#/components/schemas/MCPApprovalRequest"},{"$ref":"#/components/schemas/MCPApprovalResponse"},{"$ref":"#/components/schemas/MCPToolCall"},{"$ref":"#/components/schemas/CustomToolCallOutput"},{"$ref":"#/components/schemas/CustomToolCall"}],"discriminator":{"propertyName":"type"}},"ItemResource":{"description":"Content item used to generate a response.\n","oneOf":[{"$ref":"#/components/schemas/InputMessageResource"},{"$ref":"#/components/schemas/OutputMessage"},{"$ref":"#/components/schemas/FileSearchToolCall"},{"$ref":"#/components/schemas/ComputerToolCall"},{"$ref":"#/components/schemas/ComputerToolCallOutputResource"},{"$ref":"#/components/schemas/WebSearchToolCall"},{"$ref":"#/components/schemas/FunctionToolCallResource"},{"$ref":"#/components/schemas/FunctionToolCallOutputResource"},{"$ref":"#/components/schemas/ToolSearchCall"},{"$ref":"#/components/schemas/ToolSearchOutput"},{"$ref":"#/components/schemas/ReasoningItem"},{"$ref":"#/components/schemas/CompactionBody"},{"$ref":"#/components/schemas/ImageGenToolCall"},{"$ref":"#/components/schemas/CodeInterpreterToolCall"},{"$ref":"#/components/schemas/LocalShellToolCall"},{"$ref":"#/components/schemas/LocalShellToolCallOutput"},{"$ref":"#/components/schemas/FunctionShellCall"},{"$ref":"#/components/schemas/FunctionShellCallOutput"},{"$ref":"#/components/schemas/ApplyPatchToolCall"},{"$ref":"#/components/schemas/ApplyPatchToolCallOutput"},{"$ref":"#/components/schemas/MCPListTools"},{"$ref":"#/components/schemas/MCPApprovalRequest"},{"$ref":"#/components/schemas/MCPApprovalResponseResource"},{"$ref":"#/components/schemas/MCPToolCall"},{"$ref":"#/components/schemas/CustomToolCallResource"},{"$ref":"#/components/schemas/CustomToolCallOutputResource"}],"discriminator":{"propertyName":"type"}},"ListAssistantsResponse":{"type":"object","properties":{"object":{"type":"string","example":"list"},"data":{"type":"array","items":{"$ref":"#/components/schemas/AssistantObject"}},"first_id":{"type":"string","example":"asst_abc123"},"last_id":{"type":"string","example":"asst_abc456"},"has_more":{"type":"boolean","example":false}},"required":["object","data","first_id","last_id","has_more"],"x-oaiMeta":{"name":"List assistants response object","group":"chat","example":"{\n \"object\": \"list\",\n \"data\": [\n {\n \"id\": \"asst_abc123\",\n \"object\": \"assistant\",\n \"created_at\": 1698982736,\n \"name\": \"Coding Tutor\",\n \"description\": null,\n \"model\": \"gpt-4o\",\n \"instructions\": \"You are a helpful assistant designed to make me better at coding!\",\n \"tools\": [],\n \"tool_resources\": {},\n \"metadata\": {},\n \"top_p\": 1.0,\n \"temperature\": 1.0,\n \"response_format\": \"auto\"\n },\n {\n \"id\": \"asst_abc456\",\n \"object\": \"assistant\",\n \"created_at\": 1698982718,\n \"name\": \"My Assistant\",\n \"description\": null,\n \"model\": \"gpt-4o\",\n \"instructions\": \"You are a helpful assistant designed to make me better at coding!\",\n \"tools\": [],\n \"tool_resources\": {},\n \"metadata\": {},\n \"top_p\": 1.0,\n \"temperature\": 1.0,\n \"response_format\": \"auto\"\n },\n {\n \"id\": \"asst_abc789\",\n \"object\": \"assistant\",\n \"created_at\": 1698982643,\n \"name\": null,\n \"description\": null,\n \"model\": \"gpt-4o\",\n \"instructions\": null,\n \"tools\": [],\n \"tool_resources\": {},\n \"metadata\": {},\n \"top_p\": 1.0,\n \"temperature\": 1.0,\n \"response_format\": \"auto\"\n }\n ],\n \"first_id\": \"asst_abc123\",\n \"last_id\": \"asst_abc789\",\n \"has_more\": false\n}\n"}},"ListAuditLogsResponse":{"type":"object","properties":{"object":{"type":"string","enum":["list"],"x-stainless-const":true},"data":{"type":"array","items":{"$ref":"#/components/schemas/AuditLog"}},"first_id":{"type":"string","example":"audit_log-defb456h8dks"},"last_id":{"type":"string","example":"audit_log-hnbkd8s93s"},"has_more":{"type":"boolean"}},"required":["object","data","first_id","last_id","has_more"]},"ListBatchesResponse":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Batch"}},"first_id":{"type":"string","example":"batch_abc123"},"last_id":{"type":"string","example":"batch_abc456"},"has_more":{"type":"boolean"},"object":{"type":"string","enum":["list"],"x-stainless-const":true}},"required":["object","data","has_more"]},"ListCertificatesResponse":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Certificate"}},"first_id":{"type":"string","example":"cert_abc"},"last_id":{"type":"string","example":"cert_abc"},"has_more":{"type":"boolean"},"object":{"type":"string","enum":["list"],"x-stainless-const":true}},"required":["object","data","has_more"]},"ListFilesResponse":{"type":"object","properties":{"object":{"type":"string","example":"list"},"data":{"type":"array","items":{"$ref":"#/components/schemas/OpenAIFile"}},"first_id":{"type":"string","example":"file-abc123"},"last_id":{"type":"string","example":"file-abc456"},"has_more":{"type":"boolean","example":false}},"required":["object","data","first_id","last_id","has_more"]},"ListFineTuningCheckpointPermissionResponse":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/FineTuningCheckpointPermission"}},"object":{"type":"string","enum":["list"],"x-stainless-const":true},"first_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"last_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"has_more":{"type":"boolean"}},"required":["object","data","has_more"]},"ListFineTuningJobCheckpointsResponse":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/FineTuningJobCheckpoint"}},"object":{"type":"string","enum":["list"],"x-stainless-const":true},"first_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"last_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"has_more":{"type":"boolean"}},"required":["object","data","has_more"]},"ListFineTuningJobEventsResponse":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/FineTuningJobEvent"}},"object":{"type":"string","enum":["list"],"x-stainless-const":true},"has_more":{"type":"boolean"}},"required":["object","data","has_more"]},"ListMessagesResponse":{"properties":{"object":{"type":"string","example":"list"},"data":{"type":"array","items":{"$ref":"#/components/schemas/MessageObject"}},"first_id":{"type":"string","example":"msg_abc123"},"last_id":{"type":"string","example":"msg_abc123"},"has_more":{"type":"boolean","example":false}},"required":["object","data","first_id","last_id","has_more"]},"ListModelsResponse":{"type":"object","properties":{"object":{"type":"string","enum":["list"],"x-stainless-const":true},"data":{"type":"array","items":{"$ref":"#/components/schemas/Model"}}},"required":["object","data"]},"ListPaginatedFineTuningJobsResponse":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/FineTuningJob"}},"has_more":{"type":"boolean"},"object":{"type":"string","enum":["list"],"x-stainless-const":true}},"required":["object","data","has_more"]},"ListRunStepsResponse":{"properties":{"object":{"type":"string","example":"list"},"data":{"type":"array","items":{"$ref":"#/components/schemas/RunStepObject"}},"first_id":{"type":"string","example":"step_abc123"},"last_id":{"type":"string","example":"step_abc456"},"has_more":{"type":"boolean","example":false}},"required":["object","data","first_id","last_id","has_more"]},"ListRunsResponse":{"type":"object","properties":{"object":{"type":"string","example":"list"},"data":{"type":"array","items":{"$ref":"#/components/schemas/RunObject"}},"first_id":{"type":"string","example":"run_abc123"},"last_id":{"type":"string","example":"run_abc456"},"has_more":{"type":"boolean","example":false}},"required":["object","data","first_id","last_id","has_more"]},"ListVectorStoreFilesResponse":{"properties":{"object":{"type":"string","example":"list"},"data":{"type":"array","items":{"$ref":"#/components/schemas/VectorStoreFileObject"}},"first_id":{"type":"string","example":"file-abc123"},"last_id":{"type":"string","example":"file-abc456"},"has_more":{"type":"boolean","example":false}},"required":["object","data","first_id","last_id","has_more"]},"ListVectorStoresResponse":{"properties":{"object":{"type":"string","example":"list"},"data":{"type":"array","items":{"$ref":"#/components/schemas/VectorStoreObject"}},"first_id":{"type":"string","example":"vs_abc123"},"last_id":{"type":"string","example":"vs_abc456"},"has_more":{"type":"boolean","example":false}},"required":["object","data","first_id","last_id","has_more"]},"LocalShellToolCall":{"type":"object","title":"Local shell call","description":"A tool call to run a command on the local shell.\n","properties":{"type":{"type":"string","enum":["local_shell_call"],"description":"The type of the local shell call. Always `local_shell_call`.\n","x-stainless-const":true},"id":{"type":"string","description":"The unique ID of the local shell call.\n"},"call_id":{"type":"string","description":"The unique ID of the local shell tool call generated by the model.\n"},"action":{"$ref":"#/components/schemas/LocalShellExecAction"},"status":{"type":"string","enum":["in_progress","completed","incomplete"],"description":"The status of the local shell call.\n"}},"required":["type","id","call_id","action","status"]},"LocalShellToolCallOutput":{"type":"object","title":"Local shell call output","description":"The output of a local shell tool call.\n","properties":{"type":{"type":"string","enum":["local_shell_call_output"],"description":"The type of the local shell tool call output. Always `local_shell_call_output`.\n","x-stainless-const":true},"id":{"type":"string","description":"The unique ID of the local shell tool call generated by the model.\n"},"output":{"type":"string","description":"A JSON string of the output of the local shell tool call.\n"},"status":{"anyOf":[{"type":"string","enum":["in_progress","completed","incomplete"],"description":"The status of the item. One of `in_progress`, `completed`, or `incomplete`.\n"},{"type":"null"}]}},"required":["id","type","call_id","output"]},"LogProbProperties":{"type":"object","description":"A log probability object.\n","properties":{"token":{"type":"string","description":"The token that was used to generate the log probability.\n"},"logprob":{"type":"number","description":"The log probability of the token.\n"},"bytes":{"type":"array","items":{"type":"integer"},"description":"The bytes that were used to generate the log probability.\n"}},"required":["token","logprob","bytes"]},"MCPApprovalRequest":{"type":"object","title":"MCP approval request","description":"A request for human approval of a tool invocation.\n","properties":{"type":{"type":"string","enum":["mcp_approval_request"],"description":"The type of the item. Always `mcp_approval_request`.\n","x-stainless-const":true},"id":{"type":"string","description":"The unique ID of the approval request.\n"},"server_label":{"type":"string","description":"The label of the MCP server making the request.\n"},"name":{"type":"string","description":"The name of the tool to run.\n"},"arguments":{"type":"string","description":"A JSON string of arguments for the tool.\n"}},"required":["type","id","server_label","name","arguments"]},"MCPApprovalResponse":{"type":"object","title":"MCP approval response","description":"A response to an MCP approval request.\n","properties":{"type":{"type":"string","enum":["mcp_approval_response"],"description":"The type of the item. Always `mcp_approval_response`.\n","x-stainless-const":true},"id":{"anyOf":[{"type":"string","description":"The unique ID of the approval response\n"},{"type":"null"}]},"approval_request_id":{"type":"string","description":"The ID of the approval request being answered.\n"},"approve":{"type":"boolean","description":"Whether the request was approved.\n"},"reason":{"anyOf":[{"type":"string","description":"Optional reason for the decision.\n"},{"type":"null"}]}},"required":["type","request_id","approve","approval_request_id"]},"MCPApprovalResponseResource":{"type":"object","title":"MCP approval response","description":"A response to an MCP approval request.\n","properties":{"type":{"type":"string","enum":["mcp_approval_response"],"description":"The type of the item. Always `mcp_approval_response`.\n","x-stainless-const":true},"id":{"type":"string","description":"The unique ID of the approval response\n"},"approval_request_id":{"type":"string","description":"The ID of the approval request being answered.\n"},"approve":{"type":"boolean","description":"Whether the request was approved.\n"},"reason":{"anyOf":[{"type":"string","description":"Optional reason for the decision.\n"},{"type":"null"}]}},"required":["type","id","request_id","approve","approval_request_id"]},"MCPListTools":{"type":"object","title":"MCP list tools","description":"A list of tools available on an MCP server.\n","properties":{"type":{"type":"string","enum":["mcp_list_tools"],"description":"The type of the item. Always `mcp_list_tools`.\n","x-stainless-const":true},"id":{"type":"string","description":"The unique ID of the list.\n"},"server_label":{"type":"string","description":"The label of the MCP server.\n"},"tools":{"type":"array","items":{"$ref":"#/components/schemas/MCPListToolsTool"},"description":"The tools available on the server.\n"},"error":{"anyOf":[{"type":"string","description":"Error message if the server could not list tools.\n"},{"type":"null"}]}},"required":["type","id","server_label","tools"]},"MCPListToolsTool":{"type":"object","title":"MCP list tools tool","description":"A tool available on an MCP server.\n","properties":{"name":{"type":"string","description":"The name of the tool.\n"},"description":{"anyOf":[{"type":"string","description":"The description of the tool.\n"},{"type":"null"}]},"input_schema":{"type":"object","description":"The JSON schema describing the tool's input.\n"},"annotations":{"anyOf":[{"type":"object","description":"Additional annotations about the tool.\n"},{"type":"null"}]}},"required":["name","input_schema"]},"MCPTool":{"type":"object","title":"MCP tool","description":"Give the model access to additional tools via remote Model Context Protocol\n(MCP) servers. [Learn more about MCP](/docs/guides/tools-remote-mcp).\n","properties":{"type":{"type":"string","enum":["mcp"],"description":"The type of the MCP tool. Always `mcp`.","x-stainless-const":true},"server_label":{"type":"string","description":"A label for this MCP server, used to identify it in tool calls.\n"},"server_url":{"type":"string","description":"The URL for the MCP server. One of `server_url` or `connector_id` must be\nprovided.\n"},"connector_id":{"type":"string","enum":["connector_dropbox","connector_gmail","connector_googlecalendar","connector_googledrive","connector_microsoftteams","connector_outlookcalendar","connector_outlookemail","connector_sharepoint"],"description":"Identifier for service connectors, like those available in ChatGPT. One of\n`server_url` or `connector_id` must be provided. Learn more about service\nconnectors [here](/docs/guides/tools-remote-mcp#connectors).\n\nCurrently supported `connector_id` values are:\n\n- Dropbox: `connector_dropbox`\n- Gmail: `connector_gmail`\n- Google Calendar: `connector_googlecalendar`\n- Google Drive: `connector_googledrive`\n- Microsoft Teams: `connector_microsoftteams`\n- Outlook Calendar: `connector_outlookcalendar`\n- Outlook Email: `connector_outlookemail`\n- SharePoint: `connector_sharepoint`\n"},"authorization":{"type":"string","description":"An OAuth access token that can be used with a remote MCP server, either\nwith a custom MCP server URL or a service connector. Your application\nmust handle the OAuth authorization flow and provide the token here.\n"},"server_description":{"type":"string","description":"Optional description of the MCP server, used to provide more context.\n"},"headers":{"anyOf":[{"type":"object","additionalProperties":{"type":"string"},"description":"Optional HTTP headers to send to the MCP server. Use for authentication\nor other purposes.\n"},{"type":"null"}]},"allowed_tools":{"anyOf":[{"description":"List of allowed tool names or a filter object.\n","oneOf":[{"type":"array","title":"MCP allowed tools","description":"A string array of allowed tool names","items":{"type":"string"}},{"$ref":"#/components/schemas/MCPToolFilter"}]},{"type":"null"}]},"require_approval":{"anyOf":[{"description":"Specify which of the MCP server's tools require approval.","oneOf":[{"type":"object","title":"MCP tool approval filter","description":"Specify which of the MCP server's tools require approval. Can be\n`always`, `never`, or a filter object associated with tools\nthat require approval.\n","properties":{"always":{"$ref":"#/components/schemas/MCPToolFilter"},"never":{"$ref":"#/components/schemas/MCPToolFilter"}},"additionalProperties":false},{"type":"string","title":"MCP tool approval setting","description":"Specify a single approval policy for all tools. One of `always` or\n`never`. When set to `always`, all tools will require approval. When\nset to `never`, all tools will not require approval.\n","enum":["always","never"]}],"default":"always"},{"type":"null"}]},"defer_loading":{"type":"boolean","description":"Whether this MCP tool is deferred and discovered via tool search.\n"}},"required":["type","server_label"]},"MCPToolCall":{"type":"object","title":"MCP tool call","description":"An invocation of a tool on an MCP server.\n","properties":{"type":{"type":"string","enum":["mcp_call"],"description":"The type of the item. Always `mcp_call`.\n","x-stainless-const":true},"id":{"type":"string","description":"The unique ID of the tool call.\n"},"server_label":{"type":"string","description":"The label of the MCP server running the tool.\n"},"name":{"type":"string","description":"The name of the tool that was run.\n"},"arguments":{"type":"string","description":"A JSON string of the arguments passed to the tool.\n"},"output":{"anyOf":[{"type":"string","description":"The output from the tool call.\n"},{"type":"null"}]},"error":{"anyOf":[{"type":"string","description":"The error from the tool call, if any.\n"},{"type":"null"}]},"status":{"$ref":"#/components/schemas/MCPToolCallStatus","description":"The status of the tool call. One of `in_progress`, `completed`, `incomplete`, `calling`, or `failed`.\n"},"approval_request_id":{"anyOf":[{"type":"string","description":"Unique identifier for the MCP tool call approval request.\nInclude this value in a subsequent `mcp_approval_response` input to approve or reject the corresponding tool call.\n"},{"type":"null"}]}},"required":["type","id","server_label","name","arguments"]},"MCPToolFilter":{"type":"object","title":"MCP tool filter","description":"A filter object to specify which tools are allowed.\n","properties":{"tool_names":{"type":"array","title":"MCP allowed tools","items":{"type":"string"},"description":"List of allowed tool names."},"read_only":{"type":"boolean","description":"Indicates whether or not a tool modifies data or is read-only. If an\nMCP server is [annotated with `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),\nit will match this filter.\n"}},"required":[],"additionalProperties":false},"MessageContentImageFileObject":{"title":"Image file","type":"object","description":"References an image [File](/docs/api-reference/files) in the content of a message.","properties":{"type":{"description":"Always `image_file`.","type":"string","enum":["image_file"],"x-stainless-const":true},"image_file":{"type":"object","properties":{"file_id":{"description":"The [File](/docs/api-reference/files) ID of the image in the message content. Set `purpose=\"vision\"` when uploading the File if you need to later display the file content.","type":"string"},"detail":{"type":"string","description":"Specifies the detail level of the image if specified by the user. `low` uses fewer tokens, you can opt in to high resolution using `high`.","enum":["auto","low","high"],"default":"auto"}},"required":["file_id"]}},"required":["type","image_file"]},"MessageContentImageUrlObject":{"title":"Image URL","type":"object","description":"References an image URL in the content of a message.","properties":{"type":{"type":"string","enum":["image_url"],"description":"The type of the content part.","x-stainless-const":true},"image_url":{"type":"object","properties":{"url":{"type":"string","description":"The external URL of the image, must be a supported image types: jpeg, jpg, png, gif, webp.","format":"uri"},"detail":{"type":"string","description":"Specifies the detail level of the image. `low` uses fewer tokens, you can opt in to high resolution using `high`. Default value is `auto`","enum":["auto","low","high"],"default":"auto"}},"required":["url"]}},"required":["type","image_url"]},"MessageContentRefusalObject":{"title":"Refusal","type":"object","description":"The refusal content generated by the assistant.","properties":{"type":{"description":"Always `refusal`.","type":"string","enum":["refusal"],"x-stainless-const":true},"refusal":{"type":"string"}},"required":["type","refusal"]},"MessageContentTextAnnotationsFileCitationObject":{"title":"File citation","type":"object","description":"A citation within the message that points to a specific quote from a specific File associated with the assistant or the message. Generated when the assistant uses the \"file_search\" tool to search files.","properties":{"type":{"description":"Always `file_citation`.","type":"string","enum":["file_citation"],"x-stainless-const":true},"text":{"description":"The text in the message content that needs to be replaced.","type":"string"},"file_citation":{"type":"object","properties":{"file_id":{"description":"The ID of the specific File the citation is from.","type":"string"}},"required":["file_id"]},"start_index":{"type":"integer","minimum":0},"end_index":{"type":"integer","minimum":0}},"required":["type","text","file_citation","start_index","end_index"]},"MessageContentTextAnnotationsFilePathObject":{"title":"File path","type":"object","description":"A URL for the file that's generated when the assistant used the `code_interpreter` tool to generate a file.","properties":{"type":{"description":"Always `file_path`.","type":"string","enum":["file_path"],"x-stainless-const":true},"text":{"description":"The text in the message content that needs to be replaced.","type":"string"},"file_path":{"type":"object","properties":{"file_id":{"description":"The ID of the file that was generated.","type":"string"}},"required":["file_id"]},"start_index":{"type":"integer","minimum":0},"end_index":{"type":"integer","minimum":0}},"required":["type","text","file_path","start_index","end_index"]},"MessageContentTextObject":{"title":"Text","type":"object","description":"The text content that is part of a message.","properties":{"type":{"description":"Always `text`.","type":"string","enum":["text"],"x-stainless-const":true},"text":{"type":"object","properties":{"value":{"description":"The data that makes up the text.","type":"string"},"annotations":{"type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/MessageContentTextAnnotationsFileCitationObject"},{"$ref":"#/components/schemas/MessageContentTextAnnotationsFilePathObject"}]}}},"required":["value","annotations"]}},"required":["type","text"]},"MessageDeltaContentImageFileObject":{"title":"Image file","type":"object","description":"References an image [File](/docs/api-reference/files) in the content of a message.","properties":{"index":{"type":"integer","description":"The index of the content part in the message."},"type":{"description":"Always `image_file`.","type":"string","enum":["image_file"],"x-stainless-const":true},"image_file":{"type":"object","properties":{"file_id":{"description":"The [File](/docs/api-reference/files) ID of the image in the message content. Set `purpose=\"vision\"` when uploading the File if you need to later display the file content.","type":"string"},"detail":{"type":"string","description":"Specifies the detail level of the image if specified by the user. `low` uses fewer tokens, you can opt in to high resolution using `high`.","enum":["auto","low","high"],"default":"auto"}}}},"required":["index","type"]},"MessageDeltaContentImageUrlObject":{"title":"Image URL","type":"object","description":"References an image URL in the content of a message.","properties":{"index":{"type":"integer","description":"The index of the content part in the message."},"type":{"description":"Always `image_url`.","type":"string","enum":["image_url"],"x-stainless-const":true},"image_url":{"type":"object","properties":{"url":{"description":"The URL of the image, must be a supported image types: jpeg, jpg, png, gif, webp.","type":"string"},"detail":{"type":"string","description":"Specifies the detail level of the image. `low` uses fewer tokens, you can opt in to high resolution using `high`.","enum":["auto","low","high"],"default":"auto"}}}},"required":["index","type"]},"MessageDeltaContentRefusalObject":{"title":"Refusal","type":"object","description":"The refusal content that is part of a message.","properties":{"index":{"type":"integer","description":"The index of the refusal part in the message."},"type":{"description":"Always `refusal`.","type":"string","enum":["refusal"],"x-stainless-const":true},"refusal":{"type":"string"}},"required":["index","type"]},"MessageDeltaContentTextAnnotationsFileCitationObject":{"title":"File citation","type":"object","description":"A citation within the message that points to a specific quote from a specific File associated with the assistant or the message. Generated when the assistant uses the \"file_search\" tool to search files.","properties":{"index":{"type":"integer","description":"The index of the annotation in the text content part."},"type":{"description":"Always `file_citation`.","type":"string","enum":["file_citation"],"x-stainless-const":true},"text":{"description":"The text in the message content that needs to be replaced.","type":"string"},"file_citation":{"type":"object","properties":{"file_id":{"description":"The ID of the specific File the citation is from.","type":"string"},"quote":{"description":"The specific quote in the file.","type":"string"}}},"start_index":{"type":"integer","minimum":0},"end_index":{"type":"integer","minimum":0}},"required":["index","type"]},"MessageDeltaContentTextAnnotationsFilePathObject":{"title":"File path","type":"object","description":"A URL for the file that's generated when the assistant used the `code_interpreter` tool to generate a file.","properties":{"index":{"type":"integer","description":"The index of the annotation in the text content part."},"type":{"description":"Always `file_path`.","type":"string","enum":["file_path"],"x-stainless-const":true},"text":{"description":"The text in the message content that needs to be replaced.","type":"string"},"file_path":{"type":"object","properties":{"file_id":{"description":"The ID of the file that was generated.","type":"string"}}},"start_index":{"type":"integer","minimum":0},"end_index":{"type":"integer","minimum":0}},"required":["index","type"]},"MessageDeltaContentTextObject":{"title":"Text","type":"object","description":"The text content that is part of a message.","properties":{"index":{"type":"integer","description":"The index of the content part in the message."},"type":{"description":"Always `text`.","type":"string","enum":["text"],"x-stainless-const":true},"text":{"type":"object","properties":{"value":{"description":"The data that makes up the text.","type":"string"},"annotations":{"type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/MessageDeltaContentTextAnnotationsFileCitationObject"},{"$ref":"#/components/schemas/MessageDeltaContentTextAnnotationsFilePathObject"}]}}}}},"required":["index","type"]},"MessageDeltaObject":{"type":"object","title":"Message delta object","description":"Represents a message delta i.e. any changed fields on a message during streaming.\n","properties":{"id":{"description":"The identifier of the message, which can be referenced in API endpoints.","type":"string"},"object":{"description":"The object type, which is always `thread.message.delta`.","type":"string","enum":["thread.message.delta"],"x-stainless-const":true},"delta":{"description":"The delta containing the fields that have changed on the Message.","type":"object","properties":{"role":{"description":"The entity that produced the message. One of `user` or `assistant`.","type":"string","enum":["user","assistant"]},"content":{"description":"The content of the message in array of text and/or images.","type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/MessageDeltaContentImageFileObject"},{"$ref":"#/components/schemas/MessageDeltaContentTextObject"},{"$ref":"#/components/schemas/MessageDeltaContentRefusalObject"},{"$ref":"#/components/schemas/MessageDeltaContentImageUrlObject"}]}}}}},"required":["id","object","delta"],"x-oaiMeta":{"name":"The message delta object","beta":true,"example":"{\n \"id\": \"msg_123\",\n \"object\": \"thread.message.delta\",\n \"delta\": {\n \"content\": [\n {\n \"index\": 0,\n \"type\": \"text\",\n \"text\": { \"value\": \"Hello\", \"annotations\": [] }\n }\n ]\n }\n}\n"}},"MessageObject":{"type":"object","title":"The message object","description":"Represents a message within a [thread](/docs/api-reference/threads).","properties":{"id":{"description":"The identifier, which can be referenced in API endpoints.","type":"string"},"object":{"description":"The object type, which is always `thread.message`.","type":"string","enum":["thread.message"],"x-stainless-const":true},"created_at":{"description":"The Unix timestamp (in seconds) for when the message was created.","type":"integer"},"thread_id":{"description":"The [thread](/docs/api-reference/threads) ID that this message belongs to.","type":"string"},"status":{"description":"The status of the message, which can be either `in_progress`, `incomplete`, or `completed`.","type":"string","enum":["in_progress","incomplete","completed"]},"incomplete_details":{"anyOf":[{"description":"On an incomplete message, details about why the message is incomplete.","type":"object","properties":{"reason":{"type":"string","description":"The reason the message is incomplete.","enum":["content_filter","max_tokens","run_cancelled","run_expired","run_failed"]}},"required":["reason"]},{"type":"null"}]},"completed_at":{"anyOf":[{"description":"The Unix timestamp (in seconds) for when the message was completed.","type":"integer"},{"type":"null"}]},"incomplete_at":{"anyOf":[{"description":"The Unix timestamp (in seconds) for when the message was marked as incomplete.","type":"integer"},{"type":"null"}]},"role":{"description":"The entity that produced the message. One of `user` or `assistant`.","type":"string","enum":["user","assistant"]},"content":{"description":"The content of the message in array of text and/or images.","type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/MessageContentImageFileObject"},{"$ref":"#/components/schemas/MessageContentImageUrlObject"},{"$ref":"#/components/schemas/MessageContentTextObject"},{"$ref":"#/components/schemas/MessageContentRefusalObject"}]}},"assistant_id":{"anyOf":[{"description":"If applicable, the ID of the [assistant](/docs/api-reference/assistants) that authored this message.","type":"string"},{"type":"null"}]},"run_id":{"anyOf":[{"description":"The ID of the [run](/docs/api-reference/runs) associated with the creation of this message. Value is `null` when messages are created manually using the create message or create thread endpoints.","type":"string"},{"type":"null"}]},"attachments":{"anyOf":[{"type":"array","items":{"type":"object","properties":{"file_id":{"type":"string","description":"The ID of the file to attach to the message."},"tools":{"description":"The tools to add this file to.","type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/AssistantToolsCode"},{"$ref":"#/components/schemas/AssistantToolsFileSearchTypeOnly"}]}}}},"description":"A list of files attached to the message, and the tools they were added to."},{"type":"null"}]},"metadata":{"$ref":"#/components/schemas/Metadata"}},"required":["id","object","created_at","thread_id","status","incomplete_details","completed_at","incomplete_at","role","content","assistant_id","run_id","attachments","metadata"],"x-oaiMeta":{"name":"The message object","beta":true,"example":"{\n \"id\": \"msg_abc123\",\n \"object\": \"thread.message\",\n \"created_at\": 1698983503,\n \"thread_id\": \"thread_abc123\",\n \"role\": \"assistant\",\n \"content\": [\n {\n \"type\": \"text\",\n \"text\": {\n \"value\": \"Hi! How can I help you today?\",\n \"annotations\": []\n }\n }\n ],\n \"assistant_id\": \"asst_abc123\",\n \"run_id\": \"run_abc123\",\n \"attachments\": [],\n \"metadata\": {}\n}\n"}},"MessagePhase":{"type":"string","description":"Labels an `assistant` message as intermediate commentary (`commentary`) or the final answer (`final_answer`).\nFor models like `gpt-5.3-codex` and beyond, when sending follow-up requests, preserve and resend\nphase on all assistant messages — dropping it can degrade performance. Not used for user messages.\n","enum":["commentary","final_answer"]},"MessageRequestContentTextObject":{"title":"Text","type":"object","description":"The text content that is part of a message.","properties":{"type":{"description":"Always `text`.","type":"string","enum":["text"],"x-stainless-const":true},"text":{"type":"string","description":"Text content to be sent to the model"}},"required":["type","text"]},"MessageStreamEvent":{"oneOf":[{"type":"object","properties":{"event":{"type":"string","enum":["thread.message.created"],"x-stainless-const":true},"data":{"$ref":"#/components/schemas/MessageObject"}},"required":["event","data"],"description":"Occurs when a [message](/docs/api-reference/messages/object) is created.","x-oaiMeta":{"dataDescription":"`data` is a [message](/docs/api-reference/messages/object)"}},{"type":"object","properties":{"event":{"type":"string","enum":["thread.message.in_progress"],"x-stainless-const":true},"data":{"$ref":"#/components/schemas/MessageObject"}},"required":["event","data"],"description":"Occurs when a [message](/docs/api-reference/messages/object) moves to an `in_progress` state.","x-oaiMeta":{"dataDescription":"`data` is a [message](/docs/api-reference/messages/object)"}},{"type":"object","properties":{"event":{"type":"string","enum":["thread.message.delta"],"x-stainless-const":true},"data":{"$ref":"#/components/schemas/MessageDeltaObject"}},"required":["event","data"],"description":"Occurs when parts of a [Message](/docs/api-reference/messages/object) are being streamed.","x-oaiMeta":{"dataDescription":"`data` is a [message delta](/docs/api-reference/assistants-streaming/message-delta-object)"}},{"type":"object","properties":{"event":{"type":"string","enum":["thread.message.completed"],"x-stainless-const":true},"data":{"$ref":"#/components/schemas/MessageObject"}},"required":["event","data"],"description":"Occurs when a [message](/docs/api-reference/messages/object) is completed.","x-oaiMeta":{"dataDescription":"`data` is a [message](/docs/api-reference/messages/object)"}},{"type":"object","properties":{"event":{"type":"string","enum":["thread.message.incomplete"],"x-stainless-const":true},"data":{"$ref":"#/components/schemas/MessageObject"}},"required":["event","data"],"description":"Occurs when a [message](/docs/api-reference/messages/object) ends before it is completed.","x-oaiMeta":{"dataDescription":"`data` is a [message](/docs/api-reference/messages/object)"}}]},"Metadata":{"anyOf":[{"type":"object","description":"Set of 16 key-value pairs that can be attached to an object. This can be\nuseful for storing additional information about the object in a structured\nformat, and querying for objects via API or the dashboard.\n\nKeys are strings with a maximum length of 64 characters. Values are strings\nwith a maximum length of 512 characters.\n","additionalProperties":{"type":"string"},"x-oaiTypeLabel":"map"},{"type":"null"}]},"Model":{"title":"Model","description":"Describes an OpenAI model offering that can be used with the API.","properties":{"id":{"type":"string","description":"The model identifier, which can be referenced in the API endpoints."},"created":{"type":"integer","description":"The Unix timestamp (in seconds) when the model was created."},"object":{"type":"string","description":"The object type, which is always \"model\".","enum":["model"],"x-stainless-const":true},"owned_by":{"type":"string","description":"The organization that owns the model."}},"required":["id","object","created","owned_by"],"x-oaiMeta":{"name":"The model object","example":"{\n \"id\": \"VAR_chat_model_id\",\n \"object\": \"model\",\n \"created\": 1686935002,\n \"owned_by\": \"openai\"\n}\n"}},"ModelIds":{"anyOf":[{"$ref":"#/components/schemas/ModelIdsShared"},{"$ref":"#/components/schemas/ModelIdsResponses"}]},"ModelIdsCompaction":{"anyOf":[{"$ref":"#/components/schemas/ModelIdsResponses"},{"type":"string"},{"type":"null"}],"description":"Model ID used to generate the response, like `gpt-5` or `o3`. OpenAI offers a wide range of models with different capabilities, performance characteristics, and price points. Refer to the [model guide](/docs/models) to browse and compare available models."},"ModelIdsResponses":{"example":"gpt-5.1","anyOf":[{"$ref":"#/components/schemas/ModelIdsShared"},{"type":"string","title":"ResponsesOnlyModel","enum":["o1-pro","o1-pro-2025-03-19","o3-pro","o3-pro-2025-06-10","o3-deep-research","o3-deep-research-2025-06-26","o4-mini-deep-research","o4-mini-deep-research-2025-06-26","computer-use-preview","computer-use-preview-2025-03-11","gpt-5-codex","gpt-5-pro","gpt-5-pro-2025-10-06","gpt-5.1-codex-max"]}]},"ModelIdsShared":{"example":"gpt-5.4","anyOf":[{"type":"string"},{"type":"string","enum":["gpt-5.4","gpt-5.4-mini","gpt-5.4-nano","gpt-5.4-mini-2026-03-17","gpt-5.4-nano-2026-03-17","gpt-5.3-chat-latest","gpt-5.2","gpt-5.2-2025-12-11","gpt-5.2-chat-latest","gpt-5.2-pro","gpt-5.2-pro-2025-12-11","gpt-5.1","gpt-5.1-2025-11-13","gpt-5.1-codex","gpt-5.1-mini","gpt-5.1-chat-latest","gpt-5","gpt-5-mini","gpt-5-nano","gpt-5-2025-08-07","gpt-5-mini-2025-08-07","gpt-5-nano-2025-08-07","gpt-5-chat-latest","gpt-4.1","gpt-4.1-mini","gpt-4.1-nano","gpt-4.1-2025-04-14","gpt-4.1-mini-2025-04-14","gpt-4.1-nano-2025-04-14","o4-mini","o4-mini-2025-04-16","o3","o3-2025-04-16","o3-mini","o3-mini-2025-01-31","o1","o1-2024-12-17","o1-preview","o1-preview-2024-09-12","o1-mini","o1-mini-2024-09-12","gpt-4o","gpt-4o-2024-11-20","gpt-4o-2024-08-06","gpt-4o-2024-05-13","gpt-4o-audio-preview","gpt-4o-audio-preview-2024-10-01","gpt-4o-audio-preview-2024-12-17","gpt-4o-audio-preview-2025-06-03","gpt-4o-mini-audio-preview","gpt-4o-mini-audio-preview-2024-12-17","gpt-4o-search-preview","gpt-4o-mini-search-preview","gpt-4o-search-preview-2025-03-11","gpt-4o-mini-search-preview-2025-03-11","chatgpt-4o-latest","codex-mini-latest","gpt-4o-mini","gpt-4o-mini-2024-07-18","gpt-4-turbo","gpt-4-turbo-2024-04-09","gpt-4-0125-preview","gpt-4-turbo-preview","gpt-4-1106-preview","gpt-4-vision-preview","gpt-4","gpt-4-0314","gpt-4-0613","gpt-4-32k","gpt-4-32k-0314","gpt-4-32k-0613","gpt-3.5-turbo","gpt-3.5-turbo-16k","gpt-3.5-turbo-0301","gpt-3.5-turbo-0613","gpt-3.5-turbo-1106","gpt-3.5-turbo-0125","gpt-3.5-turbo-16k-0613"]}]},"ModelResponseProperties":{"type":"object","properties":{"metadata":{"$ref":"#/components/schemas/Metadata"},"top_logprobs":{"anyOf":[{"description":"An integer between 0 and 20 specifying the number of most likely tokens to\nreturn at each token position, each with an associated log probability.\n","type":"integer","minimum":0,"maximum":20},{"type":"null"}]},"temperature":{"anyOf":[{"type":"number","minimum":0,"maximum":2,"default":1,"example":1,"description":"What sampling temperature to use, between 0 and 2. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic.\nWe generally recommend altering this or `top_p` but not both.\n"},{"type":"null"}]},"top_p":{"anyOf":[{"type":"number","minimum":0,"maximum":1,"default":1,"example":1,"description":"An alternative to sampling with temperature, called nucleus sampling,\nwhere the model considers the results of the tokens with top_p probability\nmass. So 0.1 means only the tokens comprising the top 10% probability mass\nare considered.\n\nWe generally recommend altering this or `temperature` but not both.\n"},{"type":"null"}]},"user":{"type":"string","example":"user-1234","deprecated":true,"description":"This field is being replaced by `safety_identifier` and `prompt_cache_key`. Use `prompt_cache_key` instead to maintain caching optimizations.\nA stable identifier for your end-users.\nUsed to boost cache hit rates by better bucketing similar requests and to help OpenAI detect and prevent abuse. [Learn more](/docs/guides/safety-best-practices#safety-identifiers).\n"},"safety_identifier":{"type":"string","maxLength":64,"example":"safety-identifier-1234","description":"A stable identifier used to help detect users of your application that may be violating OpenAI's usage policies.\nThe IDs should be a string that uniquely identifies each user, with a maximum length of 64 characters. We recommend hashing their username or email address, in order to avoid sending us any identifying information. [Learn more](/docs/guides/safety-best-practices#safety-identifiers).\n"},"prompt_cache_key":{"type":"string","example":"prompt-cache-key-1234","description":"Used by OpenAI to cache responses for similar requests to optimize your cache hit rates. Replaces the `user` field. [Learn more](/docs/guides/prompt-caching).\n"},"service_tier":{"$ref":"#/components/schemas/ServiceTier"},"prompt_cache_retention":{"anyOf":[{"type":"string","enum":["in_memory","24h"],"description":"The retention policy for the prompt cache. Set to `24h` to enable extended prompt caching, which keeps cached prefixes active for longer, up to a maximum of 24 hours. [Learn more](/docs/guides/prompt-caching#prompt-cache-retention).\n"},{"type":"null"}]}}},"ModifyAssistantRequest":{"type":"object","additionalProperties":false,"properties":{"model":{"description":"ID of the model to use. You can use the [List models](/docs/api-reference/models/list) API to see all of your available models, or see our [Model overview](/docs/models) for descriptions of them.\n","anyOf":[{"type":"string"},{"$ref":"#/components/schemas/AssistantSupportedModels"}]},"reasoning_effort":{"$ref":"#/components/schemas/ReasoningEffort"},"name":{"anyOf":[{"description":"The name of the assistant. The maximum length is 256 characters.\n","type":"string","maxLength":256},{"type":"null"}]},"description":{"anyOf":[{"description":"The description of the assistant. The maximum length is 512 characters.\n","type":"string","maxLength":512},{"type":"null"}]},"instructions":{"anyOf":[{"description":"The system instructions that the assistant uses. The maximum length is 256,000 characters.\n","type":"string","maxLength":256000},{"type":"null"}]},"tools":{"description":"A list of tool enabled on the assistant. There can be a maximum of 128 tools per assistant. Tools can be of types `code_interpreter`, `file_search`, or `function`.\n","default":[],"type":"array","maxItems":128,"items":{"oneOf":[{"$ref":"#/components/schemas/AssistantToolsCode"},{"$ref":"#/components/schemas/AssistantToolsFileSearch"},{"$ref":"#/components/schemas/AssistantToolsFunction"}]}},"tool_resources":{"anyOf":[{"type":"object","description":"A set of resources that are used by the assistant's tools. The resources are specific to the type of tool. For example, the `code_interpreter` tool requires a list of file IDs, while the `file_search` tool requires a list of vector store IDs.\n","properties":{"code_interpreter":{"type":"object","properties":{"file_ids":{"type":"array","description":"Overrides the list of [file](/docs/api-reference/files) IDs made available to the `code_interpreter` tool. There can be a maximum of 20 files associated with the tool.\n","default":[],"maxItems":20,"items":{"type":"string"}}}},"file_search":{"type":"object","properties":{"vector_store_ids":{"type":"array","description":"Overrides the [vector store](/docs/api-reference/vector-stores/object) attached to this assistant. There can be a maximum of 1 vector store attached to the assistant.\n","maxItems":1,"items":{"type":"string"}}}}}},{"type":"null"}]},"metadata":{"$ref":"#/components/schemas/Metadata"},"temperature":{"anyOf":[{"description":"What sampling temperature to use, between 0 and 2. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic.\n","type":"number","minimum":0,"maximum":2,"default":1,"example":1},{"type":"null"}]},"top_p":{"anyOf":[{"type":"number","minimum":0,"maximum":1,"default":1,"example":1,"description":"An alternative to sampling with temperature, called nucleus sampling, where the model considers the results of the tokens with top_p probability mass. So 0.1 means only the tokens comprising the top 10% probability mass are considered.\n\nWe generally recommend altering this or temperature but not both.\n"},{"type":"null"}]},"response_format":{"anyOf":[{"$ref":"#/components/schemas/AssistantsApiResponseFormatOption"},{"type":"null"}]}}},"ModifyCertificateRequest":{"type":"object","properties":{"name":{"type":"string","description":"The updated name for the certificate"}},"required":["name"]},"ModifyMessageRequest":{"type":"object","additionalProperties":false,"properties":{"metadata":{"$ref":"#/components/schemas/Metadata"}}},"ModifyRunRequest":{"type":"object","additionalProperties":false,"properties":{"metadata":{"$ref":"#/components/schemas/Metadata"}}},"ModifyThreadRequest":{"type":"object","additionalProperties":false,"properties":{"tool_resources":{"anyOf":[{"type":"object","description":"A set of resources that are made available to the assistant's tools in this thread. The resources are specific to the type of tool. For example, the `code_interpreter` tool requires a list of file IDs, while the `file_search` tool requires a list of vector store IDs.\n","properties":{"code_interpreter":{"type":"object","properties":{"file_ids":{"type":"array","description":"A list of [file](/docs/api-reference/files) IDs made available to the `code_interpreter` tool. There can be a maximum of 20 files associated with the tool.\n","default":[],"maxItems":20,"items":{"type":"string"}}}},"file_search":{"type":"object","properties":{"vector_store_ids":{"type":"array","description":"The [vector store](/docs/api-reference/vector-stores/object) attached to this thread. There can be a maximum of 1 vector store attached to the thread.\n","maxItems":1,"items":{"type":"string"}}}}}},{"type":"null"}]},"metadata":{"$ref":"#/components/schemas/Metadata"}}},"NoiseReductionType":{"type":"string","enum":["near_field","far_field"],"description":"Type of noise reduction. `near_field` is for close-talking microphones such as headphones, `far_field` is for far-field microphones such as laptop or conference room microphones.\n"},"OpenAIFile":{"title":"OpenAIFile","description":"The `File` object represents a document that has been uploaded to OpenAI.","properties":{"id":{"type":"string","description":"The file identifier, which can be referenced in the API endpoints."},"bytes":{"type":"integer","description":"The size of the file, in bytes."},"created_at":{"type":"integer","description":"The Unix timestamp (in seconds) for when the file was created."},"expires_at":{"type":"integer","description":"The Unix timestamp (in seconds) for when the file will expire."},"filename":{"type":"string","description":"The name of the file."},"object":{"type":"string","description":"The object type, which is always `file`.","enum":["file"],"x-stainless-const":true},"purpose":{"type":"string","description":"The intended purpose of the file. Supported values are `assistants`, `assistants_output`, `batch`, `batch_output`, `fine-tune`, `fine-tune-results`, `vision`, and `user_data`.","enum":["assistants","assistants_output","batch","batch_output","fine-tune","fine-tune-results","vision","user_data"]},"status":{"type":"string","deprecated":true,"description":"Deprecated. The current status of the file, which can be either `uploaded`, `processed`, or `error`.","enum":["uploaded","processed","error"]},"status_details":{"type":"string","deprecated":true,"description":"Deprecated. For details on why a fine-tuning training file failed validation, see the `error` field on `fine_tuning.job`."}},"required":["id","object","bytes","created_at","filename","purpose","status"],"x-oaiMeta":{"name":"The file object","example":"{\n \"id\": \"file-abc123\",\n \"object\": \"file\",\n \"bytes\": 120000,\n \"created_at\": 1677610602,\n \"expires_at\": 1680202602,\n \"filename\": \"salesOverview.pdf\",\n \"purpose\": \"assistants\",\n}\n"}},"OtherChunkingStrategyResponseParam":{"type":"object","title":"Other Chunking Strategy","description":"This is returned when the chunking strategy is unknown. Typically, this is because the file was indexed before the `chunking_strategy` concept was introduced in the API.","additionalProperties":false,"properties":{"type":{"type":"string","description":"Always `other`.","enum":["other"],"x-stainless-const":true}},"required":["type"]},"OutputAudio":{"type":"object","title":"Output audio","description":"An audio output from the model.\n","properties":{"type":{"type":"string","description":"The type of the output audio. Always `output_audio`.\n","enum":["output_audio"],"x-stainless-const":true},"data":{"type":"string","description":"Base64-encoded audio data from the model.\n"},"transcript":{"type":"string","description":"The transcript of the audio data from the model.\n"}},"required":["type","data","transcript"]},"OutputContent":{"oneOf":[{"$ref":"#/components/schemas/OutputTextContent"},{"$ref":"#/components/schemas/RefusalContent"},{"$ref":"#/components/schemas/ReasoningTextContent"}],"discriminator":{"propertyName":"type"}},"OutputItem":{"oneOf":[{"$ref":"#/components/schemas/OutputMessage"},{"$ref":"#/components/schemas/FileSearchToolCall"},{"$ref":"#/components/schemas/FunctionToolCall"},{"$ref":"#/components/schemas/FunctionToolCallOutputResource"},{"$ref":"#/components/schemas/WebSearchToolCall"},{"$ref":"#/components/schemas/ComputerToolCall"},{"$ref":"#/components/schemas/ComputerToolCallOutputResource"},{"$ref":"#/components/schemas/ReasoningItem"},{"$ref":"#/components/schemas/ToolSearchCall"},{"$ref":"#/components/schemas/ToolSearchOutput"},{"$ref":"#/components/schemas/CompactionBody"},{"$ref":"#/components/schemas/ImageGenToolCall"},{"$ref":"#/components/schemas/CodeInterpreterToolCall"},{"$ref":"#/components/schemas/LocalShellToolCall"},{"$ref":"#/components/schemas/LocalShellToolCallOutput"},{"$ref":"#/components/schemas/FunctionShellCall"},{"$ref":"#/components/schemas/FunctionShellCallOutput"},{"$ref":"#/components/schemas/ApplyPatchToolCall"},{"$ref":"#/components/schemas/ApplyPatchToolCallOutput"},{"$ref":"#/components/schemas/MCPToolCall"},{"$ref":"#/components/schemas/MCPListTools"},{"$ref":"#/components/schemas/MCPApprovalRequest"},{"$ref":"#/components/schemas/MCPApprovalResponseResource"},{"$ref":"#/components/schemas/CustomToolCall"},{"$ref":"#/components/schemas/CustomToolCallOutputResource"}],"discriminator":{"propertyName":"type"}},"OutputMessage":{"type":"object","title":"Output message","description":"An output message from the model.\n","properties":{"id":{"type":"string","description":"The unique ID of the output message.\n"},"type":{"type":"string","description":"The type of the output message. Always `message`.\n","enum":["message"],"x-stainless-const":true},"role":{"type":"string","description":"The role of the output message. Always `assistant`.\n","enum":["assistant"],"x-stainless-const":true},"content":{"type":"array","description":"The content of the output message.\n","items":{"$ref":"#/components/schemas/OutputMessageContent"}},"phase":{"anyOf":[{"$ref":"#/components/schemas/MessagePhase"},{"type":"null"}]},"status":{"type":"string","description":"The status of the message input. One of `in_progress`, `completed`, or\n`incomplete`. Populated when input items are returned via API.\n","enum":["in_progress","completed","incomplete"]}},"required":["id","type","role","content","status"]},"OutputMessageContent":{"oneOf":[{"$ref":"#/components/schemas/OutputTextContent"},{"$ref":"#/components/schemas/RefusalContent"}],"discriminator":{"propertyName":"type"}},"ParallelToolCalls":{"description":"Whether to enable [parallel function calling](/docs/guides/function-calling#configuring-parallel-function-calling) during tool use.","type":"boolean","default":true},"PartialImages":{"anyOf":[{"type":"integer","maximum":3,"minimum":0,"default":0,"example":1,"description":"The number of partial images to generate. This parameter is used for\nstreaming responses that return partial images. Value must be between 0 and 3.\nWhen set to 0, the response will be a single image sent in one streaming event.\n\nNote that the final image may be sent before the full number of partial images\nare generated if the full image is generated more quickly.\n"},{"type":"null"}]},"PredictionContent":{"type":"object","title":"Static Content","description":"Static predicted output content, such as the content of a text file that is\nbeing regenerated.\n","required":["type","content"],"properties":{"type":{"type":"string","enum":["content"],"description":"The type of the predicted content you want to provide. This type is\ncurrently always `content`.\n","x-stainless-const":true},"content":{"description":"The content that should be matched when generating a model response.\nIf generated tokens would match this content, the entire model response\ncan be returned much more quickly.\n","oneOf":[{"type":"string","title":"Text content","description":"The content used for a Predicted Output. This is often the\ntext of a file you are regenerating with minor changes.\n"},{"type":"array","description":"An array of content parts with a defined type. Supported options differ based on the [model](/docs/models) being used to generate the response. Can contain text inputs.","title":"Array of content parts","items":{"$ref":"#/components/schemas/ChatCompletionRequestMessageContentPartText"},"minItems":1}]}}},"Project":{"type":"object","description":"Represents an individual project.","properties":{"id":{"type":"string","description":"The identifier, which can be referenced in API endpoints"},"object":{"type":"string","enum":["organization.project"],"description":"The object type, which is always `organization.project`","x-stainless-const":true},"name":{"type":"string","description":"The name of the project. This appears in reporting."},"created_at":{"type":"integer","description":"The Unix timestamp (in seconds) of when the project was created."},"archived_at":{"anyOf":[{"type":"integer","description":"The Unix timestamp (in seconds) of when the project was archived or `null`."},{"type":"null"}]},"status":{"type":"string","enum":["active","archived"],"description":"`active` or `archived`"}},"required":["id","object","name","created_at","status"],"x-oaiMeta":{"name":"The project object","example":"{\n \"id\": \"proj_abc\",\n \"object\": \"organization.project\",\n \"name\": \"Project example\",\n \"created_at\": 1711471533,\n \"archived_at\": null,\n \"status\": \"active\"\n}\n"}},"ProjectApiKey":{"type":"object","description":"Represents an individual API key in a project.","properties":{"object":{"type":"string","enum":["organization.project.api_key"],"description":"The object type, which is always `organization.project.api_key`","x-stainless-const":true},"redacted_value":{"type":"string","description":"The redacted value of the API key"},"name":{"type":"string","description":"The name of the API key"},"created_at":{"type":"integer","description":"The Unix timestamp (in seconds) of when the API key was created"},"last_used_at":{"type":"integer","description":"The Unix timestamp (in seconds) of when the API key was last used."},"id":{"type":"string","description":"The identifier, which can be referenced in API endpoints"},"owner":{"type":"object","properties":{"type":{"type":"string","enum":["user","service_account"],"description":"`user` or `service_account`"},"user":{"$ref":"#/components/schemas/ProjectUser"},"service_account":{"$ref":"#/components/schemas/ProjectServiceAccount"}}}},"required":["object","redacted_value","name","created_at","last_used_at","id","owner"],"x-oaiMeta":{"name":"The project API key object","example":"{\n \"object\": \"organization.project.api_key\",\n \"redacted_value\": \"sk-abc...def\",\n \"name\": \"My API Key\",\n \"created_at\": 1711471533,\n \"last_used_at\": 1711471534,\n \"id\": \"key_abc\",\n \"owner\": {\n \"type\": \"user\",\n \"user\": {\n \"object\": \"organization.project.user\",\n \"id\": \"user_abc\",\n \"name\": \"First Last\",\n \"email\": \"user@example.com\",\n \"role\": \"owner\",\n \"created_at\": 1711471533\n }\n }\n}\n"}},"ProjectApiKeyDeleteResponse":{"type":"object","properties":{"object":{"type":"string","enum":["organization.project.api_key.deleted"],"x-stainless-const":true},"id":{"type":"string"},"deleted":{"type":"boolean"}},"required":["object","id","deleted"]},"ProjectApiKeyListResponse":{"type":"object","properties":{"object":{"type":"string","enum":["list"],"x-stainless-const":true},"data":{"type":"array","items":{"$ref":"#/components/schemas/ProjectApiKey"}},"first_id":{"type":"string"},"last_id":{"type":"string"},"has_more":{"type":"boolean"}},"required":["object","data","first_id","last_id","has_more"]},"ProjectCreateRequest":{"type":"object","properties":{"name":{"type":"string","description":"The friendly name of the project, this name appears in reports."},"geography":{"type":"string","enum":["US","EU","JP","IN","KR","CA","AU","SG"],"description":"Create the project with the specified data residency region. Your organization must have access to Data residency functionality in order to use. See [data residency controls](/docs/guides/your-data#data-residency-controls) to review the functionality and limitations of setting this field."}},"required":["name"]},"ProjectGroup":{"type":"object","description":"Details about a group's membership in a project.","properties":{"object":{"type":"string","enum":["project.group"],"description":"Always `project.group`.","x-stainless-const":true},"project_id":{"type":"string","description":"Identifier of the project."},"group_id":{"type":"string","description":"Identifier of the group that has access to the project."},"group_name":{"type":"string","description":"Display name of the group."},"created_at":{"type":"integer","format":"int64","description":"Unix timestamp (in seconds) when the group was granted project access."}},"required":["object","project_id","group_id","group_name","created_at"],"x-oaiMeta":{"name":"The project group object","example":"{\n \"object\": \"project.group\",\n \"project_id\": \"proj_abc123\",\n \"group_id\": \"group_01J1F8ABCDXYZ\",\n \"group_name\": \"Support Team\",\n \"created_at\": 1711471533\n}\n"}},"ProjectGroupDeletedResource":{"type":"object","description":"Confirmation payload returned after removing a group from a project.","properties":{"object":{"type":"string","enum":["project.group.deleted"],"description":"Always `project.group.deleted`.","x-stainless-const":true},"deleted":{"type":"boolean","description":"Whether the group membership in the project was removed."}},"required":["object","deleted"],"x-oaiMeta":{"name":"Project group deletion confirmation","example":"{\n \"object\": \"project.group.deleted\",\n \"deleted\": true\n}\n"}},"ProjectGroupListResource":{"type":"object","description":"Paginated list of groups that have access to a project.","properties":{"object":{"type":"string","enum":["list"],"description":"Always `list`.","x-stainless-const":true},"data":{"type":"array","description":"Project group memberships returned in the current page.","items":{"$ref":"#/components/schemas/ProjectGroup"}},"has_more":{"type":"boolean","description":"Whether additional project group memberships are available."},"next":{"description":"Cursor to fetch the next page of results, or `null` when there are no more results.","anyOf":[{"type":"string"},{"type":"null"}]}},"required":["object","data","has_more","next"],"x-oaiMeta":{"name":"Project group list","example":"{\n \"object\": \"list\",\n \"data\": [\n {\n \"object\": \"project.group\",\n \"project_id\": \"proj_abc123\",\n \"group_id\": \"group_01J1F8ABCDXYZ\",\n \"group_name\": \"Support Team\",\n \"created_at\": 1711471533\n }\n ],\n \"has_more\": false,\n \"next\": null\n}\n"}},"ProjectListResponse":{"type":"object","properties":{"object":{"type":"string","enum":["list"],"x-stainless-const":true},"data":{"type":"array","items":{"$ref":"#/components/schemas/Project"}},"first_id":{"type":"string"},"last_id":{"type":"string"},"has_more":{"type":"boolean"}},"required":["object","data","first_id","last_id","has_more"]},"ProjectRateLimit":{"type":"object","description":"Represents a project rate limit config.","properties":{"object":{"type":"string","enum":["project.rate_limit"],"description":"The object type, which is always `project.rate_limit`","x-stainless-const":true},"id":{"type":"string","description":"The identifier, which can be referenced in API endpoints."},"model":{"type":"string","description":"The model this rate limit applies to."},"max_requests_per_1_minute":{"type":"integer","description":"The maximum requests per minute."},"max_tokens_per_1_minute":{"type":"integer","description":"The maximum tokens per minute."},"max_images_per_1_minute":{"type":"integer","description":"The maximum images per minute. Only present for relevant models."},"max_audio_megabytes_per_1_minute":{"type":"integer","description":"The maximum audio megabytes per minute. Only present for relevant models."},"max_requests_per_1_day":{"type":"integer","description":"The maximum requests per day. Only present for relevant models."},"batch_1_day_max_input_tokens":{"type":"integer","description":"The maximum batch input tokens per day. Only present for relevant models."}},"required":["object","id","model","max_requests_per_1_minute","max_tokens_per_1_minute"],"x-oaiMeta":{"name":"The project rate limit object","example":"{\n \"object\": \"project.rate_limit\",\n \"id\": \"rl_ada\",\n \"model\": \"ada\",\n \"max_requests_per_1_minute\": 600,\n \"max_tokens_per_1_minute\": 150000,\n \"max_images_per_1_minute\": 10\n}\n"}},"ProjectRateLimitListResponse":{"type":"object","properties":{"object":{"type":"string","enum":["list"],"x-stainless-const":true},"data":{"type":"array","items":{"$ref":"#/components/schemas/ProjectRateLimit"}},"first_id":{"type":"string"},"last_id":{"type":"string"},"has_more":{"type":"boolean"}},"required":["object","data","first_id","last_id","has_more"]},"ProjectRateLimitUpdateRequest":{"type":"object","properties":{"max_requests_per_1_minute":{"type":"integer","description":"The maximum requests per minute."},"max_tokens_per_1_minute":{"type":"integer","description":"The maximum tokens per minute."},"max_images_per_1_minute":{"type":"integer","description":"The maximum images per minute. Only relevant for certain models."},"max_audio_megabytes_per_1_minute":{"type":"integer","description":"The maximum audio megabytes per minute. Only relevant for certain models."},"max_requests_per_1_day":{"type":"integer","description":"The maximum requests per day. Only relevant for certain models."},"batch_1_day_max_input_tokens":{"type":"integer","description":"The maximum batch input tokens per day. Only relevant for certain models."}}},"ProjectServiceAccount":{"type":"object","description":"Represents an individual service account in a project.","properties":{"object":{"type":"string","enum":["organization.project.service_account"],"description":"The object type, which is always `organization.project.service_account`","x-stainless-const":true},"id":{"type":"string","description":"The identifier, which can be referenced in API endpoints"},"name":{"type":"string","description":"The name of the service account"},"role":{"type":"string","enum":["owner","member"],"description":"`owner` or `member`"},"created_at":{"type":"integer","description":"The Unix timestamp (in seconds) of when the service account was created"}},"required":["object","id","name","role","created_at"],"x-oaiMeta":{"name":"The project service account object","example":"{\n \"object\": \"organization.project.service_account\",\n \"id\": \"svc_acct_abc\",\n \"name\": \"Service Account\",\n \"role\": \"owner\",\n \"created_at\": 1711471533\n}\n"}},"ProjectServiceAccountApiKey":{"type":"object","properties":{"object":{"type":"string","enum":["organization.project.service_account.api_key"],"description":"The object type, which is always `organization.project.service_account.api_key`","x-stainless-const":true},"value":{"type":"string"},"name":{"type":"string"},"created_at":{"type":"integer"},"id":{"type":"string"}},"required":["object","value","name","created_at","id"]},"ProjectServiceAccountCreateRequest":{"type":"object","properties":{"name":{"type":"string","description":"The name of the service account being created."}},"required":["name"]},"ProjectServiceAccountCreateResponse":{"type":"object","properties":{"object":{"type":"string","enum":["organization.project.service_account"],"x-stainless-const":true},"id":{"type":"string"},"name":{"type":"string"},"role":{"type":"string","enum":["member"],"description":"Service accounts can only have one role of type `member`","x-stainless-const":true},"created_at":{"type":"integer"},"api_key":{"$ref":"#/components/schemas/ProjectServiceAccountApiKey"}},"required":["object","id","name","role","created_at","api_key"]},"ProjectServiceAccountDeleteResponse":{"type":"object","properties":{"object":{"type":"string","enum":["organization.project.service_account.deleted"],"x-stainless-const":true},"id":{"type":"string"},"deleted":{"type":"boolean"}},"required":["object","id","deleted"]},"ProjectServiceAccountListResponse":{"type":"object","properties":{"object":{"type":"string","enum":["list"],"x-stainless-const":true},"data":{"type":"array","items":{"$ref":"#/components/schemas/ProjectServiceAccount"}},"first_id":{"type":"string"},"last_id":{"type":"string"},"has_more":{"type":"boolean"}},"required":["object","data","first_id","last_id","has_more"]},"ProjectUpdateRequest":{"type":"object","properties":{"name":{"type":"string","description":"The updated name of the project, this name appears in reports."}},"required":["name"]},"ProjectUser":{"type":"object","description":"Represents an individual user in a project.","properties":{"object":{"type":"string","enum":["organization.project.user"],"description":"The object type, which is always `organization.project.user`","x-stainless-const":true},"id":{"type":"string","description":"The identifier, which can be referenced in API endpoints"},"name":{"type":"string","description":"The name of the user"},"email":{"type":"string","description":"The email address of the user"},"role":{"type":"string","enum":["owner","member"],"description":"`owner` or `member`"},"added_at":{"type":"integer","description":"The Unix timestamp (in seconds) of when the project was added."}},"required":["object","id","name","email","role","added_at"],"x-oaiMeta":{"name":"The project user object","example":"{\n \"object\": \"organization.project.user\",\n \"id\": \"user_abc\",\n \"name\": \"First Last\",\n \"email\": \"user@example.com\",\n \"role\": \"owner\",\n \"added_at\": 1711471533\n}\n"}},"ProjectUserCreateRequest":{"type":"object","properties":{"user_id":{"type":"string","description":"The ID of the user."},"role":{"type":"string","enum":["owner","member"],"description":"`owner` or `member`"}},"required":["user_id","role"]},"ProjectUserDeleteResponse":{"type":"object","properties":{"object":{"type":"string","enum":["organization.project.user.deleted"],"x-stainless-const":true},"id":{"type":"string"},"deleted":{"type":"boolean"}},"required":["object","id","deleted"]},"ProjectUserListResponse":{"type":"object","properties":{"object":{"type":"string"},"data":{"type":"array","items":{"$ref":"#/components/schemas/ProjectUser"}},"first_id":{"type":"string"},"last_id":{"type":"string"},"has_more":{"type":"boolean"}},"required":["object","data","first_id","last_id","has_more"]},"ProjectUserUpdateRequest":{"type":"object","properties":{"role":{"type":"string","enum":["owner","member"],"description":"`owner` or `member`"}},"required":["role"]},"Prompt":{"anyOf":[{"type":"object","description":"Reference to a prompt template and its variables.\n[Learn more](/docs/guides/text?api-mode=responses#reusable-prompts).\n","required":["id"],"properties":{"id":{"type":"string","description":"The unique identifier of the prompt template to use."},"version":{"anyOf":[{"type":"string","description":"Optional version of the prompt template."},{"type":"null"}]},"variables":{"$ref":"#/components/schemas/ResponsePromptVariables"}}},{"type":"null"}]},"PublicAssignOrganizationGroupRoleBody":{"type":"object","description":"Request payload for assigning a role to a group or user.","properties":{"role_id":{"type":"string","description":"Identifier of the role to assign."}},"required":["role_id"],"x-oaiMeta":{"example":"{\n \"role_id\": \"role_01J1F8ROLE01\"\n}\n"}},"PublicCreateOrganizationRoleBody":{"type":"object","description":"Request payload for creating a custom role.","properties":{"role_name":{"type":"string","description":"Unique name for the role."},"permissions":{"type":"array","description":"Permissions to grant to the role.","items":{"type":"string"}},"description":{"description":"Optional description of the role.","anyOf":[{"type":"string"},{"type":"null"}]}},"required":["role_name","permissions"],"x-oaiMeta":{"example":"{\n \"role_name\": \"API Group Manager\",\n \"permissions\": [\n \"api.groups.read\",\n \"api.groups.write\"\n ],\n \"description\": \"Allows managing organization groups\"\n}\n"}},"PublicRoleListResource":{"type":"object","description":"Paginated list of roles available on an organization or project.","properties":{"object":{"type":"string","enum":["list"],"description":"Always `list`.","x-stainless-const":true},"data":{"type":"array","description":"Roles returned in the current page.","items":{"$ref":"#/components/schemas/Role"}},"has_more":{"type":"boolean","description":"Whether more roles are available when paginating."},"next":{"description":"Cursor to fetch the next page of results, or `null` when there are no additional roles.","anyOf":[{"type":"string"},{"type":"null"}]}},"required":["object","data","has_more","next"],"x-oaiMeta":{"name":"Role list","example":"{\n \"object\": \"list\",\n \"data\": [\n {\n \"object\": \"role\",\n \"id\": \"role_01J1F8ROLE01\",\n \"name\": \"API Group Manager\",\n \"description\": \"Allows managing organization groups\",\n \"permissions\": [\n \"api.groups.read\",\n \"api.groups.write\"\n ],\n \"resource_type\": \"api.organization\",\n \"predefined_role\": false\n }\n ],\n \"has_more\": false,\n \"next\": null\n}\n"}},"PublicUpdateOrganizationRoleBody":{"type":"object","description":"Request payload for updating an existing role.","properties":{"permissions":{"description":"Updated set of permissions for the role.","anyOf":[{"type":"array","items":{"type":"string"}},{"type":"null"}]},"description":{"description":"New description for the role.","anyOf":[{"type":"string"},{"type":"null"}]},"role_name":{"description":"New name for the role.","anyOf":[{"type":"string"},{"type":"null"}]}},"x-oaiMeta":{"example":"{\n \"role_name\": \"API Group Manager\",\n \"permissions\": [\n \"api.groups.read\",\n \"api.groups.write\"\n ],\n \"description\": \"Allows managing organization groups\"\n}\n"}},"RealtimeAudioFormats":{"anyOf":[{"type":"object","title":"PCM audio format","description":"The PCM audio format. Only a 24kHz sample rate is supported.","properties":{"type":{"type":"string","description":"The audio format. Always `audio/pcm`.","enum":["audio/pcm"]},"rate":{"type":"integer","description":"The sample rate of the audio. Always `24000`.","enum":[24000]}}},{"type":"object","title":"PCMU audio format","description":"The G.711 μ-law format.","properties":{"type":{"type":"string","description":"The audio format. Always `audio/pcmu`.","enum":["audio/pcmu"]}}},{"type":"object","title":"PCMA audio format","description":"The G.711 A-law format.","properties":{"type":{"type":"string","description":"The audio format. Always `audio/pcma`.","enum":["audio/pcma"]}}}]},"RealtimeBetaClientEventConversationItemCreate":{"type":"object","description":"Add a new Item to the Conversation's context, including messages, function \ncalls, and function call responses. This event can be used both to populate a \n\"history\" of the conversation and to add new items mid-stream, but has the \ncurrent limitation that it cannot populate assistant audio messages.\n\nIf successful, the server will respond with a `conversation.item.created` \nevent, otherwise an `error` event will be sent.\n","properties":{"event_id":{"type":"string","maxLength":512,"description":"Optional client-generated ID used to identify this event."},"type":{"type":"string","enum":["conversation.item.create"],"description":"The event type, must be `conversation.item.create`.","x-stainless-const":true},"previous_item_id":{"type":"string","description":"The ID of the preceding item after which the new item will be inserted. \nIf not set, the new item will be appended to the end of the conversation.\nIf set to `root`, the new item will be added to the beginning of the conversation.\nIf set to an existing ID, it allows an item to be inserted mid-conversation. If the\nID cannot be found, an error will be returned and the item will not be added.\n"},"item":{"$ref":"#/components/schemas/RealtimeConversationItem"}},"required":["type","item"],"x-oaiMeta":{"name":"conversation.item.create","group":"realtime","example":"{\n \"type\": \"conversation.item.create\",\n \"item\": {\n \"type\": \"message\",\n \"role\": \"user\",\n \"content\": [\n {\n \"type\": \"input_text\",\n \"text\": \"hi\"\n }\n ]\n },\n \"event_id\": \"b904fba0-0ec4-40af-8bbb-f908a9b26793\",\n}\n"}},"RealtimeBetaClientEventConversationItemDelete":{"type":"object","description":"Send this event when you want to remove any item from the conversation \nhistory. The server will respond with a `conversation.item.deleted` event, \nunless the item does not exist in the conversation history, in which case the \nserver will respond with an error.\n","properties":{"event_id":{"type":"string","description":"Optional client-generated ID used to identify this event."},"type":{"type":"string","enum":["conversation.item.delete"],"description":"The event type, must be `conversation.item.delete`.","x-stainless-const":true},"item_id":{"type":"string","description":"The ID of the item to delete."}},"required":["type","item_id"],"x-oaiMeta":{"name":"conversation.item.delete","group":"realtime","example":"{\n \"event_id\": \"event_901\",\n \"type\": \"conversation.item.delete\",\n \"item_id\": \"msg_003\"\n}\n"}},"RealtimeBetaClientEventConversationItemRetrieve":{"type":"object","description":"Send this event when you want to retrieve the server's representation of a specific item in the conversation history. This is useful, for example, to inspect user audio after noise cancellation and VAD.\nThe server will respond with a `conversation.item.retrieved` event, \nunless the item does not exist in the conversation history, in which case the \nserver will respond with an error.\n","properties":{"event_id":{"type":"string","description":"Optional client-generated ID used to identify this event."},"type":{"type":"string","enum":["conversation.item.retrieve"],"description":"The event type, must be `conversation.item.retrieve`.","x-stainless-const":true},"item_id":{"type":"string","description":"The ID of the item to retrieve."}},"required":["type","item_id"],"x-oaiMeta":{"name":"conversation.item.retrieve","group":"realtime","example":"{\n \"event_id\": \"event_901\",\n \"type\": \"conversation.item.retrieve\",\n \"item_id\": \"msg_003\"\n}\n"}},"RealtimeBetaClientEventConversationItemTruncate":{"type":"object","description":"Send this event to truncate a previous assistant message’s audio. The server \nwill produce audio faster than realtime, so this event is useful when the user \ninterrupts to truncate audio that has already been sent to the client but not \nyet played. This will synchronize the server's understanding of the audio with \nthe client's playback.\n\nTruncating audio will delete the server-side text transcript to ensure there \nis not text in the context that hasn't been heard by the user.\n\nIf successful, the server will respond with a `conversation.item.truncated` \nevent. \n","properties":{"event_id":{"type":"string","description":"Optional client-generated ID used to identify this event."},"type":{"type":"string","enum":["conversation.item.truncate"],"description":"The event type, must be `conversation.item.truncate`.","x-stainless-const":true},"item_id":{"type":"string","description":"The ID of the assistant message item to truncate. Only assistant message \nitems can be truncated.\n"},"content_index":{"type":"integer","description":"The index of the content part to truncate. Set this to 0."},"audio_end_ms":{"type":"integer","description":"Inclusive duration up to which audio is truncated, in milliseconds. If \nthe audio_end_ms is greater than the actual audio duration, the server \nwill respond with an error.\n"}},"required":["type","item_id","content_index","audio_end_ms"],"x-oaiMeta":{"name":"conversation.item.truncate","group":"realtime","example":"{\n \"event_id\": \"event_678\",\n \"type\": \"conversation.item.truncate\",\n \"item_id\": \"msg_002\",\n \"content_index\": 0,\n \"audio_end_ms\": 1500\n}\n"}},"RealtimeBetaClientEventInputAudioBufferAppend":{"type":"object","description":"Send this event to append audio bytes to the input audio buffer. The audio \nbuffer is temporary storage you can write to and later commit. In Server VAD \nmode, the audio buffer is used to detect speech and the server will decide \nwhen to commit. When Server VAD is disabled, you must commit the audio buffer\nmanually.\n\nThe client may choose how much audio to place in each event up to a maximum \nof 15 MiB, for example streaming smaller chunks from the client may allow the \nVAD to be more responsive. Unlike made other client events, the server will \nnot send a confirmation response to this event.\n","properties":{"event_id":{"type":"string","description":"Optional client-generated ID used to identify this event."},"type":{"type":"string","enum":["input_audio_buffer.append"],"description":"The event type, must be `input_audio_buffer.append`.","x-stainless-const":true},"audio":{"type":"string","description":"Base64-encoded audio bytes. This must be in the format specified by the \n`input_audio_format` field in the session configuration.\n"}},"required":["type","audio"],"x-oaiMeta":{"name":"input_audio_buffer.append","group":"realtime","example":"{\n \"event_id\": \"event_456\",\n \"type\": \"input_audio_buffer.append\",\n \"audio\": \"Base64EncodedAudioData\"\n}\n"}},"RealtimeBetaClientEventInputAudioBufferClear":{"type":"object","description":"Send this event to clear the audio bytes in the buffer. The server will \nrespond with an `input_audio_buffer.cleared` event.\n","properties":{"event_id":{"type":"string","description":"Optional client-generated ID used to identify this event."},"type":{"type":"string","enum":["input_audio_buffer.clear"],"description":"The event type, must be `input_audio_buffer.clear`.","x-stainless-const":true}},"required":["type"],"x-oaiMeta":{"name":"input_audio_buffer.clear","group":"realtime","example":"{\n \"event_id\": \"event_012\",\n \"type\": \"input_audio_buffer.clear\"\n}\n"}},"RealtimeBetaClientEventInputAudioBufferCommit":{"type":"object","description":"Send this event to commit the user input audio buffer, which will create a \nnew user message item in the conversation. This event will produce an error \nif the input audio buffer is empty. When in Server VAD mode, the client does \nnot need to send this event, the server will commit the audio buffer \nautomatically.\n\nCommitting the input audio buffer will trigger input audio transcription \n(if enabled in session configuration), but it will not create a response \nfrom the model. The server will respond with an `input_audio_buffer.committed` \nevent.\n","properties":{"event_id":{"type":"string","description":"Optional client-generated ID used to identify this event."},"type":{"type":"string","enum":["input_audio_buffer.commit"],"description":"The event type, must be `input_audio_buffer.commit`.","x-stainless-const":true}},"required":["type"],"x-oaiMeta":{"name":"input_audio_buffer.commit","group":"realtime","example":"{\n \"event_id\": \"event_789\",\n \"type\": \"input_audio_buffer.commit\"\n}\n"}},"RealtimeBetaClientEventOutputAudioBufferClear":{"type":"object","description":"**WebRTC/SIP Only:** Emit to cut off the current audio response. This will trigger the server to\nstop generating audio and emit a `output_audio_buffer.cleared` event. This\nevent should be preceded by a `response.cancel` client event to stop the\ngeneration of the current response.\n[Learn more](/docs/guides/realtime-conversations#client-and-server-events-for-audio-in-webrtc).\n","properties":{"event_id":{"type":"string","description":"The unique ID of the client event used for error handling."},"type":{"type":"string","enum":["output_audio_buffer.clear"],"description":"The event type, must be `output_audio_buffer.clear`.","x-stainless-const":true}},"required":["type"],"x-oaiMeta":{"name":"output_audio_buffer.clear","group":"realtime","example":"{\n \"event_id\": \"optional_client_event_id\",\n \"type\": \"output_audio_buffer.clear\"\n}\n"}},"RealtimeBetaClientEventResponseCancel":{"type":"object","description":"Send this event to cancel an in-progress response. The server will respond \nwith a `response.done` event with a status of `response.status=cancelled`. If \nthere is no response to cancel, the server will respond with an error.\n","properties":{"event_id":{"type":"string","description":"Optional client-generated ID used to identify this event."},"type":{"type":"string","enum":["response.cancel"],"description":"The event type, must be `response.cancel`.","x-stainless-const":true},"response_id":{"type":"string","description":"A specific response ID to cancel - if not provided, will cancel an \nin-progress response in the default conversation.\n"}},"required":["type"],"x-oaiMeta":{"name":"response.cancel","group":"realtime","example":"{\n \"event_id\": \"event_567\",\n \"type\": \"response.cancel\"\n}\n"}},"RealtimeBetaClientEventResponseCreate":{"type":"object","description":"This event instructs the server to create a Response, which means triggering \nmodel inference. When in Server VAD mode, the server will create Responses \nautomatically.\n\nA Response will include at least one Item, and may have two, in which case \nthe second will be a function call. These Items will be appended to the \nconversation history.\n\nThe server will respond with a `response.created` event, events for Items \nand content created, and finally a `response.done` event to indicate the \nResponse is complete.\n\nThe `response.create` event can optionally include inference configuration like \n`instructions`, and `temperature`. These fields will override the Session's \nconfiguration for this Response only.\n\nResponses can be created out-of-band of the default Conversation, meaning that they can\nhave arbitrary input, and it's possible to disable writing the output to the Conversation.\nOnly one Response can write to the default Conversation at a time, but otherwise multiple\nResponses can be created in parallel.\n\nClients can set `conversation` to `none` to create a Response that does not write to the default\nConversation. Arbitrary input can be provided with the `input` field, which is an array accepting\nraw Items and references to existing Items.\n","properties":{"event_id":{"type":"string","description":"Optional client-generated ID used to identify this event."},"type":{"type":"string","enum":["response.create"],"description":"The event type, must be `response.create`.","x-stainless-const":true},"response":{"$ref":"#/components/schemas/RealtimeBetaResponseCreateParams"}},"required":["type"],"x-oaiMeta":{"name":"response.create","group":"realtime","example":"// Trigger a response with the default Conversation and no special parameters\n{\n \"type\": \"response.create\",\n}\n\n// Trigger an out-of-band response that does not write to the default Conversation\n{\n \"type\": \"response.create\",\n \"response\": {\n \"instructions\": \"Provide a concise answer.\",\n \"tools\": [], // clear any session tools\n \"conversation\": \"none\",\n \"output_modalities\": [\"text\"],\n \"input\": [\n {\n \"type\": \"item_reference\",\n \"id\": \"item_12345\",\n },\n {\n \"type\": \"message\",\n \"role\": \"user\",\n \"content\": [\n {\n \"type\": \"input_text\",\n \"text\": \"Summarize the above message in one sentence.\"\n }\n ]\n }\n ],\n }\n}\n"}},"RealtimeBetaClientEventSessionUpdate":{"type":"object","description":"Send this event to update the session’s default configuration.\nThe client may send this event at any time to update any field,\nexcept for `voice`. However, note that once a session has been\ninitialized with a particular `model`, it can’t be changed to\nanother model using `session.update`.\n\nWhen the server receives a `session.update`, it will respond\nwith a `session.updated` event showing the full, effective configuration.\nOnly the fields that are present are updated. To clear a field like\n`instructions`, pass an empty string.\n","properties":{"event_id":{"type":"string","description":"Optional client-generated ID used to identify this event."},"type":{"type":"string","enum":["session.update"],"description":"The event type, must be `session.update`.","x-stainless-const":true},"session":{"$ref":"#/components/schemas/RealtimeSessionCreateRequest"}},"required":["type","session"],"x-oaiMeta":{"name":"session.update","group":"realtime","example":"{\n \"type\": \"session.update\",\n \"session\": {\n \"tools\": [\n {\n \"type\": \"function\",\n \"name\": \"display_color_palette\",\n \"description\": \"Call this function when a user asks for a color palette.\",\n \"parameters\": {\n \"type\": \"object\",\n \"properties\": {\n \"theme\": {\n \"type\": \"string\",\n \"description\": \"Description of the theme for the color scheme.\"\n },\n \"colors\": {\n \"type\": \"array\",\n \"description\": \"Array of five hex color codes based on the theme.\",\n \"items\": {\n \"type\": \"string\",\n \"description\": \"Hex color code\"\n }\n }\n },\n \"required\": [\n \"theme\",\n \"colors\"\n ]\n }\n }\n ],\n \"tool_choice\": \"auto\"\n }\n}\n"}},"RealtimeBetaClientEventTranscriptionSessionUpdate":{"type":"object","description":"Send this event to update a transcription session.\n","properties":{"event_id":{"type":"string","description":"Optional client-generated ID used to identify this event."},"type":{"type":"string","enum":["transcription_session.update"],"description":"The event type, must be `transcription_session.update`.","x-stainless-const":true},"session":{"$ref":"#/components/schemas/RealtimeTranscriptionSessionCreateRequest"}},"required":["type","session"],"x-oaiMeta":{"name":"transcription_session.update","group":"realtime","example":"{\n \"type\": \"transcription_session.update\",\n \"session\": {\n \"input_audio_format\": \"pcm16\",\n \"input_audio_transcription\": {\n \"model\": \"gpt-4o-transcribe\",\n \"prompt\": \"\",\n \"language\": \"\"\n },\n \"turn_detection\": {\n \"type\": \"server_vad\",\n \"threshold\": 0.5,\n \"prefix_padding_ms\": 300,\n \"silence_duration_ms\": 500,\n \"create_response\": true,\n },\n \"input_audio_noise_reduction\": {\n \"type\": \"near_field\"\n },\n \"include\": [\n \"item.input_audio_transcription.logprobs\",\n ]\n }\n}\n"}},"RealtimeBetaResponse":{"type":"object","description":"The response resource.","properties":{"id":{"type":"string","description":"The unique ID of the response."},"object":{"type":"string","enum":["realtime.response"],"description":"The object type, must be `realtime.response`.","x-stainless-const":true},"status":{"type":"string","enum":["completed","cancelled","failed","incomplete","in_progress"],"description":"The final status of the response (`completed`, `cancelled`, `failed`, or \n`incomplete`, `in_progress`).\n"},"status_details":{"type":"object","description":"Additional details about the status.","properties":{"type":{"type":"string","enum":["completed","cancelled","failed","incomplete"],"description":"The type of error that caused the response to fail, corresponding \nwith the `status` field (`completed`, `cancelled`, `incomplete`, \n`failed`).\n"},"reason":{"type":"string","enum":["turn_detected","client_cancelled","max_output_tokens","content_filter"],"description":"The reason the Response did not complete. For a `cancelled` Response, \none of `turn_detected` (the server VAD detected a new start of speech) \nor `client_cancelled` (the client sent a cancel event). For an \n`incomplete` Response, one of `max_output_tokens` or `content_filter` \n(the server-side safety filter activated and cut off the response).\n"},"error":{"type":"object","description":"A description of the error that caused the response to fail, \npopulated when the `status` is `failed`.\n","properties":{"type":{"type":"string","description":"The type of error."},"code":{"type":"string","description":"Error code, if any."}}}}},"output":{"type":"array","description":"The list of output items generated by the response.","items":{"$ref":"#/components/schemas/RealtimeConversationItem"}},"metadata":{"$ref":"#/components/schemas/Metadata"},"usage":{"type":"object","description":"Usage statistics for the Response, this will correspond to billing. A \nRealtime API session will maintain a conversation context and append new \nItems to the Conversation, thus output from previous turns (text and \naudio tokens) will become the input for later turns.\n","properties":{"total_tokens":{"type":"integer","description":"The total number of tokens in the Response including input and output \ntext and audio tokens.\n"},"input_tokens":{"type":"integer","description":"The number of input tokens used in the Response, including text and \naudio tokens.\n"},"output_tokens":{"type":"integer","description":"The number of output tokens sent in the Response, including text and \naudio tokens.\n"},"input_token_details":{"type":"object","description":"Details about the input tokens used in the Response.","properties":{"cached_tokens":{"type":"integer","description":"The number of cached tokens used as input for the Response."},"text_tokens":{"type":"integer","description":"The number of text tokens used as input for the Response."},"image_tokens":{"type":"integer","description":"The number of image tokens used as input for the Response."},"audio_tokens":{"type":"integer","description":"The number of audio tokens used as input for the Response."},"cached_tokens_details":{"type":"object","description":"Details about the cached tokens used as input for the Response.","properties":{"text_tokens":{"type":"integer","description":"The number of cached text tokens used as input for the Response."},"image_tokens":{"type":"integer","description":"The number of cached image tokens used as input for the Response."},"audio_tokens":{"type":"integer","description":"The number of cached audio tokens used as input for the Response."}}}}},"output_token_details":{"type":"object","description":"Details about the output tokens used in the Response.","properties":{"text_tokens":{"type":"integer","description":"The number of text tokens used in the Response."},"audio_tokens":{"type":"integer","description":"The number of audio tokens used in the Response."}}}}},"conversation_id":{"description":"Which conversation the response is added to, determined by the `conversation`\nfield in the `response.create` event. If `auto`, the response will be added to\nthe default conversation and the value of `conversation_id` will be an id like\n`conv_1234`. If `none`, the response will not be added to any conversation and\nthe value of `conversation_id` will be `null`. If responses are being triggered\nby server VAD, the response will be added to the default conversation, thus\nthe `conversation_id` will be an id like `conv_1234`.\n","type":"string"},"voice":{"$ref":"#/components/schemas/VoiceIdsShared","description":"The voice the model used to respond.\nCurrent voice options are `alloy`, `ash`, `ballad`, `coral`, `echo`, `sage`,\n`shimmer`, and `verse`.\n"},"modalities":{"type":"array","description":"The set of modalities the model used to respond. If there are multiple modalities,\nthe model will pick one, for example if `modalities` is `[\"text\", \"audio\"]`, the model\ncould be responding in either text or audio.\n","items":{"type":"string","enum":["text","audio"]}},"output_audio_format":{"type":"string","enum":["pcm16","g711_ulaw","g711_alaw"],"description":"The format of output audio. Options are `pcm16`, `g711_ulaw`, or `g711_alaw`.\n"},"temperature":{"type":"number","description":"Sampling temperature for the model, limited to [0.6, 1.2]. Defaults to 0.8.\n"},"max_output_tokens":{"oneOf":[{"type":"integer"},{"type":"string","enum":["inf"],"x-stainless-const":true}],"description":"Maximum number of output tokens for a single assistant response,\ninclusive of tool calls, that was used in this response.\n"}}},"RealtimeBetaResponseCreateParams":{"type":"object","description":"Create a new Realtime response with these parameters","properties":{"modalities":{"type":"array","description":"The set of modalities the model can respond with. To disable audio,\nset this to [\"text\"].\n","items":{"type":"string","enum":["text","audio"]}},"instructions":{"type":"string","description":"The default system instructions (i.e. system message) prepended to model \ncalls. This field allows the client to guide the model on desired \nresponses. The model can be instructed on response content and format, \n(e.g. \"be extremely succinct\", \"act friendly\", \"here are examples of good \nresponses\") and on audio behavior (e.g. \"talk quickly\", \"inject emotion \ninto your voice\", \"laugh frequently\"). The instructions are not guaranteed \nto be followed by the model, but they provide guidance to the model on the \ndesired behavior.\n\nNote that the server sets default instructions which will be used if this \nfield is not set and are visible in the `session.created` event at the \nstart of the session.\n"},"voice":{"$ref":"#/components/schemas/VoiceIdsOrCustomVoice","description":"The voice the model uses to respond. Supported built-in voices are\n`alloy`, `ash`, `ballad`, `coral`, `echo`, `sage`, `shimmer`, `verse`,\n`marin`, and `cedar`. You may also provide a custom voice object with an\n`id`, for example `{ \"id\": \"voice_1234\" }`. Voice cannot be changed during\nthe session once the model has responded with audio at least once.\n"},"output_audio_format":{"type":"string","enum":["pcm16","g711_ulaw","g711_alaw"],"description":"The format of output audio. Options are `pcm16`, `g711_ulaw`, or `g711_alaw`.\n"},"tools":{"type":"array","description":"Tools (functions) available to the model.","items":{"type":"object","properties":{"type":{"type":"string","enum":["function"],"description":"The type of the tool, i.e. `function`.","x-stainless-const":true},"name":{"type":"string","description":"The name of the function."},"description":{"type":"string","description":"The description of the function, including guidance on when and how \nto call it, and guidance about what to tell the user when calling \n(if anything).\n"},"parameters":{"type":"object","description":"Parameters of the function in JSON Schema."}}}},"tool_choice":{"description":"How the model chooses tools. Provide one of the string modes or force a specific\nfunction/MCP tool.\n","oneOf":[{"$ref":"#/components/schemas/ToolChoiceOptions"},{"$ref":"#/components/schemas/ToolChoiceFunction"},{"$ref":"#/components/schemas/ToolChoiceMCP"}],"default":"auto"},"temperature":{"type":"number","description":"Sampling temperature for the model, limited to [0.6, 1.2]. Defaults to 0.8.\n"},"max_output_tokens":{"oneOf":[{"type":"integer"},{"type":"string","enum":["inf"],"x-stainless-const":true}],"description":"Maximum number of output tokens for a single assistant response,\ninclusive of tool calls. Provide an integer between 1 and 4096 to\nlimit output tokens, or `inf` for the maximum available tokens for a\ngiven model. Defaults to `inf`.\n"},"conversation":{"description":"Controls which conversation the response is added to. Currently supports\n`auto` and `none`, with `auto` as the default value. The `auto` value\nmeans that the contents of the response will be added to the default\nconversation. Set this to `none` to create an out-of-band response which \nwill not add items to default conversation.\n","oneOf":[{"type":"string"},{"type":"string","default":"auto","enum":["auto","none"]}]},"metadata":{"$ref":"#/components/schemas/Metadata"},"prompt":{"$ref":"#/components/schemas/Prompt"},"input":{"type":"array","description":"Input items to include in the prompt for the model. Using this field\ncreates a new context for this Response instead of using the default\nconversation. An empty array `[]` will clear the context for this Response.\nNote that this can include references to items from the default conversation.\n","items":{"$ref":"#/components/schemas/RealtimeConversationItem"}}}},"RealtimeBetaServerEventConversationItemCreated":{"type":"object","description":"Returned when a conversation item is created. There are several scenarios that produce this event:\n - The server is generating a Response, which if successful will produce\n either one or two Items, which will be of type `message`\n (role `assistant`) or type `function_call`.\n - The input audio buffer has been committed, either by the client or the\n server (in `server_vad` mode). The server will take the content of the\n input audio buffer and add it to a new user message Item.\n - The client has sent a `conversation.item.create` event to add a new Item\n to the Conversation.\n","properties":{"event_id":{"type":"string","description":"The unique ID of the server event."},"type":{"type":"string","enum":["conversation.item.created"],"description":"The event type, must be `conversation.item.created`.","x-stainless-const":true},"previous_item_id":{"anyOf":[{"type":"string","description":"The ID of the preceding item in the Conversation context, allows the\nclient to understand the order of the conversation. Can be `null` if the\nitem has no predecessor.\n"},{"type":"null"}]},"item":{"$ref":"#/components/schemas/RealtimeConversationItem"}},"required":["event_id","type","item"],"x-oaiMeta":{"name":"conversation.item.created","group":"realtime","example":"{\n \"event_id\": \"event_1920\",\n \"type\": \"conversation.item.created\",\n \"previous_item_id\": \"msg_002\",\n \"item\": {\n \"id\": \"msg_003\",\n \"object\": \"realtime.item\",\n \"type\": \"message\",\n \"status\": \"completed\",\n \"role\": \"user\",\n \"content\": []\n }\n}\n"}},"RealtimeBetaServerEventConversationItemDeleted":{"type":"object","description":"Returned when an item in the conversation is deleted by the client with a \n`conversation.item.delete` event. This event is used to synchronize the \nserver's understanding of the conversation history with the client's view.\n","properties":{"event_id":{"type":"string","description":"The unique ID of the server event."},"type":{"type":"string","enum":["conversation.item.deleted"],"description":"The event type, must be `conversation.item.deleted`.","x-stainless-const":true},"item_id":{"type":"string","description":"The ID of the item that was deleted."}},"required":["event_id","type","item_id"],"x-oaiMeta":{"name":"conversation.item.deleted","group":"realtime","example":"{\n \"event_id\": \"event_2728\",\n \"type\": \"conversation.item.deleted\",\n \"item_id\": \"msg_005\"\n}\n"}},"RealtimeBetaServerEventConversationItemInputAudioTranscriptionCompleted":{"type":"object","description":"This event is the output of audio transcription for user audio written to the\nuser audio buffer. Transcription begins when the input audio buffer is\ncommitted by the client or server (in `server_vad` mode). Transcription runs\nasynchronously with Response creation, so this event may come before or after\nthe Response events.\n\nRealtime API models accept audio natively, and thus input transcription is a\nseparate process run on a separate ASR (Automatic Speech Recognition) model.\nThe transcript may diverge somewhat from the model's interpretation, and\nshould be treated as a rough guide.\n","properties":{"event_id":{"type":"string","description":"The unique ID of the server event."},"type":{"type":"string","enum":["conversation.item.input_audio_transcription.completed"],"description":"The event type, must be\n`conversation.item.input_audio_transcription.completed`.\n","x-stainless-const":true},"item_id":{"type":"string","description":"The ID of the user message item containing the audio."},"content_index":{"type":"integer","description":"The index of the content part containing the audio."},"transcript":{"type":"string","description":"The transcribed text."},"logprobs":{"anyOf":[{"type":"array","description":"The log probabilities of the transcription.","items":{"$ref":"#/components/schemas/LogProbProperties"}},{"type":"null"}]},"usage":{"type":"object","description":"Usage statistics for the transcription.","oneOf":[{"$ref":"#/components/schemas/TranscriptTextUsageTokens","title":"Token Usage"},{"$ref":"#/components/schemas/TranscriptTextUsageDuration","title":"Duration Usage"}]}},"required":["event_id","type","item_id","content_index","transcript","usage"],"x-oaiMeta":{"name":"conversation.item.input_audio_transcription.completed","group":"realtime","example":"{\n \"event_id\": \"event_2122\",\n \"type\": \"conversation.item.input_audio_transcription.completed\",\n \"item_id\": \"msg_003\",\n \"content_index\": 0,\n \"transcript\": \"Hello, how are you?\",\n \"usage\": {\n \"type\": \"tokens\",\n \"total_tokens\": 48,\n \"input_tokens\": 38,\n \"input_token_details\": {\n \"text_tokens\": 10,\n \"audio_tokens\": 28,\n },\n \"output_tokens\": 10,\n }\n}\n"}},"RealtimeBetaServerEventConversationItemInputAudioTranscriptionDelta":{"type":"object","description":"Returned when the text value of an input audio transcription content part is updated.\n","properties":{"event_id":{"type":"string","description":"The unique ID of the server event."},"type":{"type":"string","enum":["conversation.item.input_audio_transcription.delta"],"description":"The event type, must be `conversation.item.input_audio_transcription.delta`.","x-stainless-const":true},"item_id":{"type":"string","description":"The ID of the item."},"content_index":{"type":"integer","description":"The index of the content part in the item's content array."},"delta":{"type":"string","description":"The text delta."},"logprobs":{"anyOf":[{"type":"array","description":"The log probabilities of the transcription.","items":{"$ref":"#/components/schemas/LogProbProperties"}},{"type":"null"}]}},"required":["event_id","type","item_id"],"x-oaiMeta":{"name":"conversation.item.input_audio_transcription.delta","group":"realtime","example":"{\n \"type\": \"conversation.item.input_audio_transcription.delta\",\n \"event_id\": \"event_001\",\n \"item_id\": \"item_001\",\n \"content_index\": 0,\n \"delta\": \"Hello\"\n}\n"}},"RealtimeBetaServerEventConversationItemInputAudioTranscriptionFailed":{"type":"object","description":"Returned when input audio transcription is configured, and a transcription \nrequest for a user message failed. These events are separate from other \n`error` events so that the client can identify the related Item.\n","properties":{"event_id":{"type":"string","description":"The unique ID of the server event."},"type":{"type":"string","enum":["conversation.item.input_audio_transcription.failed"],"description":"The event type, must be\n`conversation.item.input_audio_transcription.failed`.\n","x-stainless-const":true},"item_id":{"type":"string","description":"The ID of the user message item."},"content_index":{"type":"integer","description":"The index of the content part containing the audio."},"error":{"type":"object","description":"Details of the transcription error.","properties":{"type":{"type":"string","description":"The type of error."},"code":{"type":"string","description":"Error code, if any."},"message":{"type":"string","description":"A human-readable error message."},"param":{"type":"string","description":"Parameter related to the error, if any."}}}},"required":["event_id","type","item_id","content_index","error"],"x-oaiMeta":{"name":"conversation.item.input_audio_transcription.failed","group":"realtime","example":"{\n \"event_id\": \"event_2324\",\n \"type\": \"conversation.item.input_audio_transcription.failed\",\n \"item_id\": \"msg_003\",\n \"content_index\": 0,\n \"error\": {\n \"type\": \"transcription_error\",\n \"code\": \"audio_unintelligible\",\n \"message\": \"The audio could not be transcribed.\",\n \"param\": null\n }\n}\n"}},"RealtimeBetaServerEventConversationItemInputAudioTranscriptionSegment":{"type":"object","description":"Returned when an input audio transcription segment is identified for an item.","properties":{"event_id":{"type":"string","description":"The unique ID of the server event."},"type":{"type":"string","enum":["conversation.item.input_audio_transcription.segment"],"description":"The event type, must be `conversation.item.input_audio_transcription.segment`.","x-stainless-const":true},"item_id":{"type":"string","description":"The ID of the item containing the input audio content."},"content_index":{"type":"integer","description":"The index of the input audio content part within the item."},"text":{"type":"string","description":"The text for this segment."},"id":{"type":"string","description":"The segment identifier."},"speaker":{"type":"string","description":"The detected speaker label for this segment."},"start":{"type":"number","format":"float","description":"Start time of the segment in seconds."},"end":{"type":"number","format":"float","description":"End time of the segment in seconds."}},"required":["event_id","type","item_id","content_index","text","id","speaker","start","end"],"x-oaiMeta":{"name":"conversation.item.input_audio_transcription.segment","group":"realtime","example":"{\n \"event_id\": \"event_6501\",\n \"type\": \"conversation.item.input_audio_transcription.segment\",\n \"item_id\": \"msg_011\",\n \"content_index\": 0,\n \"text\": \"hello\",\n \"id\": \"seg_0001\",\n \"speaker\": \"spk_1\",\n \"start\": 0.0,\n \"end\": 0.4\n}\n"}},"RealtimeBetaServerEventConversationItemRetrieved":{"type":"object","description":"Returned when a conversation item is retrieved with `conversation.item.retrieve`.\n","properties":{"event_id":{"type":"string","description":"The unique ID of the server event."},"type":{"type":"string","enum":["conversation.item.retrieved"],"description":"The event type, must be `conversation.item.retrieved`.","x-stainless-const":true},"item":{"$ref":"#/components/schemas/RealtimeConversationItem"}},"required":["event_id","type","item"],"x-oaiMeta":{"name":"conversation.item.retrieved","group":"realtime","example":"{\n \"event_id\": \"event_1920\",\n \"type\": \"conversation.item.created\",\n \"previous_item_id\": \"msg_002\",\n \"item\": {\n \"id\": \"msg_003\",\n \"object\": \"realtime.item\",\n \"type\": \"message\",\n \"status\": \"completed\",\n \"role\": \"user\",\n \"content\": [\n {\n \"type\": \"input_audio\",\n \"transcript\": \"hello how are you\",\n \"audio\": \"base64encodedaudio==\"\n }\n ]\n }\n}\n"}},"RealtimeBetaServerEventConversationItemTruncated":{"type":"object","description":"Returned when an earlier assistant audio message item is truncated by the \nclient with a `conversation.item.truncate` event. This event is used to \nsynchronize the server's understanding of the audio with the client's playback.\n\nThis action will truncate the audio and remove the server-side text transcript \nto ensure there is no text in the context that hasn't been heard by the user.\n","properties":{"event_id":{"type":"string","description":"The unique ID of the server event."},"type":{"type":"string","enum":["conversation.item.truncated"],"description":"The event type, must be `conversation.item.truncated`.","x-stainless-const":true},"item_id":{"type":"string","description":"The ID of the assistant message item that was truncated."},"content_index":{"type":"integer","description":"The index of the content part that was truncated."},"audio_end_ms":{"type":"integer","description":"The duration up to which the audio was truncated, in milliseconds.\n"}},"required":["event_id","type","item_id","content_index","audio_end_ms"],"x-oaiMeta":{"name":"conversation.item.truncated","group":"realtime","example":"{\n \"event_id\": \"event_2526\",\n \"type\": \"conversation.item.truncated\",\n \"item_id\": \"msg_004\",\n \"content_index\": 0,\n \"audio_end_ms\": 1500\n}\n"}},"RealtimeBetaServerEventError":{"type":"object","description":"Returned when an error occurs, which could be a client problem or a server\nproblem. Most errors are recoverable and the session will stay open, we\nrecommend to implementors to monitor and log error messages by default.\n","properties":{"event_id":{"type":"string","description":"The unique ID of the server event."},"type":{"type":"string","enum":["error"],"description":"The event type, must be `error`.","x-stainless-const":true},"error":{"type":"object","description":"Details of the error.","required":["type","message"],"properties":{"type":{"type":"string","description":"The type of error (e.g., \"invalid_request_error\", \"server_error\").\n"},"code":{"anyOf":[{"type":"string","description":"Error code, if any."},{"type":"null"}]},"message":{"type":"string","description":"A human-readable error message."},"param":{"anyOf":[{"type":"string","description":"Parameter related to the error, if any."},{"type":"null"}]},"event_id":{"anyOf":[{"type":"string","description":"The event_id of the client event that caused the error, if applicable.\n"},{"type":"null"}]}}}},"required":["event_id","type","error"],"x-oaiMeta":{"name":"error","group":"realtime","example":"{\n \"event_id\": \"event_890\",\n \"type\": \"error\",\n \"error\": {\n \"type\": \"invalid_request_error\",\n \"code\": \"invalid_event\",\n \"message\": \"The 'type' field is missing.\",\n \"param\": null,\n \"event_id\": \"event_567\"\n }\n}\n"}},"RealtimeBetaServerEventInputAudioBufferCleared":{"type":"object","description":"Returned when the input audio buffer is cleared by the client with a \n`input_audio_buffer.clear` event.\n","properties":{"event_id":{"type":"string","description":"The unique ID of the server event."},"type":{"type":"string","enum":["input_audio_buffer.cleared"],"description":"The event type, must be `input_audio_buffer.cleared`.","x-stainless-const":true}},"required":["event_id","type"],"x-oaiMeta":{"name":"input_audio_buffer.cleared","group":"realtime","example":"{\n \"event_id\": \"event_1314\",\n \"type\": \"input_audio_buffer.cleared\"\n}\n"}},"RealtimeBetaServerEventInputAudioBufferCommitted":{"type":"object","description":"Returned when an input audio buffer is committed, either by the client or\nautomatically in server VAD mode. The `item_id` property is the ID of the user\nmessage item that will be created, thus a `conversation.item.created` event\nwill also be sent to the client.\n","properties":{"event_id":{"type":"string","description":"The unique ID of the server event."},"type":{"type":"string","enum":["input_audio_buffer.committed"],"description":"The event type, must be `input_audio_buffer.committed`.","x-stainless-const":true},"previous_item_id":{"anyOf":[{"type":"string","description":"The ID of the preceding item after which the new item will be inserted.\nCan be `null` if the item has no predecessor.\n"},{"type":"null"}]},"item_id":{"type":"string","description":"The ID of the user message item that will be created."}},"required":["event_id","type","item_id"],"x-oaiMeta":{"name":"input_audio_buffer.committed","group":"realtime","example":"{\n \"event_id\": \"event_1121\",\n \"type\": \"input_audio_buffer.committed\",\n \"previous_item_id\": \"msg_001\",\n \"item_id\": \"msg_002\"\n}\n"}},"RealtimeBetaServerEventInputAudioBufferSpeechStarted":{"type":"object","description":"Sent by the server when in `server_vad` mode to indicate that speech has been \ndetected in the audio buffer. This can happen any time audio is added to the \nbuffer (unless speech is already detected). The client may want to use this \nevent to interrupt audio playback or provide visual feedback to the user. \n\nThe client should expect to receive a `input_audio_buffer.speech_stopped` event \nwhen speech stops. The `item_id` property is the ID of the user message item \nthat will be created when speech stops and will also be included in the \n`input_audio_buffer.speech_stopped` event (unless the client manually commits \nthe audio buffer during VAD activation).\n","properties":{"event_id":{"type":"string","description":"The unique ID of the server event."},"type":{"type":"string","enum":["input_audio_buffer.speech_started"],"description":"The event type, must be `input_audio_buffer.speech_started`.","x-stainless-const":true},"audio_start_ms":{"type":"integer","description":"Milliseconds from the start of all audio written to the buffer during the \nsession when speech was first detected. This will correspond to the \nbeginning of audio sent to the model, and thus includes the \n`prefix_padding_ms` configured in the Session.\n"},"item_id":{"type":"string","description":"The ID of the user message item that will be created when speech stops.\n"}},"required":["event_id","type","audio_start_ms","item_id"],"x-oaiMeta":{"name":"input_audio_buffer.speech_started","group":"realtime","example":"{\n \"event_id\": \"event_1516\",\n \"type\": \"input_audio_buffer.speech_started\",\n \"audio_start_ms\": 1000,\n \"item_id\": \"msg_003\"\n}\n"}},"RealtimeBetaServerEventInputAudioBufferSpeechStopped":{"type":"object","description":"Returned in `server_vad` mode when the server detects the end of speech in \nthe audio buffer. The server will also send an `conversation.item.created` \nevent with the user message item that is created from the audio buffer.\n","properties":{"event_id":{"type":"string","description":"The unique ID of the server event."},"type":{"type":"string","enum":["input_audio_buffer.speech_stopped"],"description":"The event type, must be `input_audio_buffer.speech_stopped`.","x-stainless-const":true},"audio_end_ms":{"type":"integer","description":"Milliseconds since the session started when speech stopped. This will \ncorrespond to the end of audio sent to the model, and thus includes the \n`min_silence_duration_ms` configured in the Session.\n"},"item_id":{"type":"string","description":"The ID of the user message item that will be created."}},"required":["event_id","type","audio_end_ms","item_id"],"x-oaiMeta":{"name":"input_audio_buffer.speech_stopped","group":"realtime","example":"{\n \"event_id\": \"event_1718\",\n \"type\": \"input_audio_buffer.speech_stopped\",\n \"audio_end_ms\": 2000,\n \"item_id\": \"msg_003\"\n}\n"}},"RealtimeBetaServerEventMCPListToolsCompleted":{"type":"object","description":"Returned when listing MCP tools has completed for an item.","properties":{"event_id":{"type":"string","description":"The unique ID of the server event."},"type":{"type":"string","enum":["mcp_list_tools.completed"],"description":"The event type, must be `mcp_list_tools.completed`.","x-stainless-const":true},"item_id":{"type":"string","description":"The ID of the MCP list tools item."}},"required":["event_id","type","item_id"],"x-oaiMeta":{"name":"mcp_list_tools.completed","group":"realtime","example":"{\n \"event_id\": \"event_6102\",\n \"type\": \"mcp_list_tools.completed\",\n \"item_id\": \"mcp_list_tools_001\"\n}\n"}},"RealtimeBetaServerEventMCPListToolsFailed":{"type":"object","description":"Returned when listing MCP tools has failed for an item.","properties":{"event_id":{"type":"string","description":"The unique ID of the server event."},"type":{"type":"string","enum":["mcp_list_tools.failed"],"description":"The event type, must be `mcp_list_tools.failed`.","x-stainless-const":true},"item_id":{"type":"string","description":"The ID of the MCP list tools item."}},"required":["event_id","type","item_id"],"x-oaiMeta":{"name":"mcp_list_tools.failed","group":"realtime","example":"{\n \"event_id\": \"event_6103\",\n \"type\": \"mcp_list_tools.failed\",\n \"item_id\": \"mcp_list_tools_001\"\n}\n"}},"RealtimeBetaServerEventMCPListToolsInProgress":{"type":"object","description":"Returned when listing MCP tools is in progress for an item.","properties":{"event_id":{"type":"string","description":"The unique ID of the server event."},"type":{"type":"string","enum":["mcp_list_tools.in_progress"],"description":"The event type, must be `mcp_list_tools.in_progress`.","x-stainless-const":true},"item_id":{"type":"string","description":"The ID of the MCP list tools item."}},"required":["event_id","type","item_id"],"x-oaiMeta":{"name":"mcp_list_tools.in_progress","group":"realtime","example":"{\n \"event_id\": \"event_6101\",\n \"type\": \"mcp_list_tools.in_progress\",\n \"item_id\": \"mcp_list_tools_001\"\n}\n"}},"RealtimeBetaServerEventRateLimitsUpdated":{"type":"object","description":"Emitted at the beginning of a Response to indicate the updated rate limits. \nWhen a Response is created some tokens will be \"reserved\" for the output \ntokens, the rate limits shown here reflect that reservation, which is then \nadjusted accordingly once the Response is completed.\n","properties":{"event_id":{"type":"string","description":"The unique ID of the server event."},"type":{"type":"string","enum":["rate_limits.updated"],"description":"The event type, must be `rate_limits.updated`.","x-stainless-const":true},"rate_limits":{"type":"array","description":"List of rate limit information.","items":{"type":"object","properties":{"name":{"type":"string","enum":["requests","tokens"],"description":"The name of the rate limit (`requests`, `tokens`).\n"},"limit":{"type":"integer","description":"The maximum allowed value for the rate limit."},"remaining":{"type":"integer","description":"The remaining value before the limit is reached."},"reset_seconds":{"type":"number","description":"Seconds until the rate limit resets."}}}}},"required":["event_id","type","rate_limits"],"x-oaiMeta":{"name":"rate_limits.updated","group":"realtime","example":"{\n \"event_id\": \"event_5758\",\n \"type\": \"rate_limits.updated\",\n \"rate_limits\": [\n {\n \"name\": \"requests\",\n \"limit\": 1000,\n \"remaining\": 999,\n \"reset_seconds\": 60\n },\n {\n \"name\": \"tokens\",\n \"limit\": 50000,\n \"remaining\": 49950,\n \"reset_seconds\": 60\n }\n ]\n}\n"}},"RealtimeBetaServerEventResponseAudioDelta":{"type":"object","description":"Returned when the model-generated audio is updated.","properties":{"event_id":{"type":"string","description":"The unique ID of the server event."},"type":{"type":"string","enum":["response.output_audio.delta"],"description":"The event type, must be `response.output_audio.delta`.","x-stainless-const":true},"response_id":{"type":"string","description":"The ID of the response."},"item_id":{"type":"string","description":"The ID of the item."},"output_index":{"type":"integer","description":"The index of the output item in the response."},"content_index":{"type":"integer","description":"The index of the content part in the item's content array."},"delta":{"type":"string","description":"Base64-encoded audio data delta."}},"required":["event_id","type","response_id","item_id","output_index","content_index","delta"],"x-oaiMeta":{"name":"response.output_audio.delta","group":"realtime","example":"{\n \"event_id\": \"event_4950\",\n \"type\": \"response.output_audio.delta\",\n \"response_id\": \"resp_001\",\n \"item_id\": \"msg_008\",\n \"output_index\": 0,\n \"content_index\": 0,\n \"delta\": \"Base64EncodedAudioDelta\"\n}\n"}},"RealtimeBetaServerEventResponseAudioDone":{"type":"object","description":"Returned when the model-generated audio is done. Also emitted when a Response\nis interrupted, incomplete, or cancelled.\n","properties":{"event_id":{"type":"string","description":"The unique ID of the server event."},"type":{"type":"string","enum":["response.output_audio.done"],"description":"The event type, must be `response.output_audio.done`.","x-stainless-const":true},"response_id":{"type":"string","description":"The ID of the response."},"item_id":{"type":"string","description":"The ID of the item."},"output_index":{"type":"integer","description":"The index of the output item in the response."},"content_index":{"type":"integer","description":"The index of the content part in the item's content array."}},"required":["event_id","type","response_id","item_id","output_index","content_index"],"x-oaiMeta":{"name":"response.output_audio.done","group":"realtime","example":"{\n \"event_id\": \"event_5152\",\n \"type\": \"response.output_audio.done\",\n \"response_id\": \"resp_001\",\n \"item_id\": \"msg_008\",\n \"output_index\": 0,\n \"content_index\": 0\n}\n"}},"RealtimeBetaServerEventResponseAudioTranscriptDelta":{"type":"object","description":"Returned when the model-generated transcription of audio output is updated.\n","properties":{"event_id":{"type":"string","description":"The unique ID of the server event."},"type":{"type":"string","enum":["response.output_audio_transcript.delta"],"description":"The event type, must be `response.output_audio_transcript.delta`.","x-stainless-const":true},"response_id":{"type":"string","description":"The ID of the response."},"item_id":{"type":"string","description":"The ID of the item."},"output_index":{"type":"integer","description":"The index of the output item in the response."},"content_index":{"type":"integer","description":"The index of the content part in the item's content array."},"delta":{"type":"string","description":"The transcript delta."}},"required":["event_id","type","response_id","item_id","output_index","content_index","delta"],"x-oaiMeta":{"name":"response.output_audio_transcript.delta","group":"realtime","example":"{\n \"event_id\": \"event_4546\",\n \"type\": \"response.output_audio_transcript.delta\",\n \"response_id\": \"resp_001\",\n \"item_id\": \"msg_008\",\n \"output_index\": 0,\n \"content_index\": 0,\n \"delta\": \"Hello, how can I a\"\n}\n"}},"RealtimeBetaServerEventResponseAudioTranscriptDone":{"type":"object","description":"Returned when the model-generated transcription of audio output is done\nstreaming. Also emitted when a Response is interrupted, incomplete, or\ncancelled.\n","properties":{"event_id":{"type":"string","description":"The unique ID of the server event."},"type":{"type":"string","enum":["response.output_audio_transcript.done"],"description":"The event type, must be `response.output_audio_transcript.done`.","x-stainless-const":true},"response_id":{"type":"string","description":"The ID of the response."},"item_id":{"type":"string","description":"The ID of the item."},"output_index":{"type":"integer","description":"The index of the output item in the response."},"content_index":{"type":"integer","description":"The index of the content part in the item's content array."},"transcript":{"type":"string","description":"The final transcript of the audio."}},"required":["event_id","type","response_id","item_id","output_index","content_index","transcript"],"x-oaiMeta":{"name":"response.output_audio_transcript.done","group":"realtime","example":"{\n \"event_id\": \"event_4748\",\n \"type\": \"response.output_audio_transcript.done\",\n \"response_id\": \"resp_001\",\n \"item_id\": \"msg_008\",\n \"output_index\": 0,\n \"content_index\": 0,\n \"transcript\": \"Hello, how can I assist you today?\"\n}\n"}},"RealtimeBetaServerEventResponseContentPartAdded":{"type":"object","description":"Returned when a new content part is added to an assistant message item during\nresponse generation.\n","properties":{"event_id":{"type":"string","description":"The unique ID of the server event."},"type":{"type":"string","enum":["response.content_part.added"],"description":"The event type, must be `response.content_part.added`.","x-stainless-const":true},"response_id":{"type":"string","description":"The ID of the response."},"item_id":{"type":"string","description":"The ID of the item to which the content part was added."},"output_index":{"type":"integer","description":"The index of the output item in the response."},"content_index":{"type":"integer","description":"The index of the content part in the item's content array."},"part":{"type":"object","description":"The content part that was added.","properties":{"type":{"type":"string","enum":["audio","text"],"description":"The content type (\"text\", \"audio\")."},"text":{"type":"string","description":"The text content (if type is \"text\")."},"audio":{"type":"string","description":"Base64-encoded audio data (if type is \"audio\")."},"transcript":{"type":"string","description":"The transcript of the audio (if type is \"audio\")."}}}},"required":["event_id","type","response_id","item_id","output_index","content_index","part"],"x-oaiMeta":{"name":"response.content_part.added","group":"realtime","example":"{\n \"event_id\": \"event_3738\",\n \"type\": \"response.content_part.added\",\n \"response_id\": \"resp_001\",\n \"item_id\": \"msg_007\",\n \"output_index\": 0,\n \"content_index\": 0,\n \"part\": {\n \"type\": \"text\",\n \"text\": \"\"\n }\n}\n"}},"RealtimeBetaServerEventResponseContentPartDone":{"type":"object","description":"Returned when a content part is done streaming in an assistant message item.\nAlso emitted when a Response is interrupted, incomplete, or cancelled.\n","properties":{"event_id":{"type":"string","description":"The unique ID of the server event."},"type":{"type":"string","enum":["response.content_part.done"],"description":"The event type, must be `response.content_part.done`.","x-stainless-const":true},"response_id":{"type":"string","description":"The ID of the response."},"item_id":{"type":"string","description":"The ID of the item."},"output_index":{"type":"integer","description":"The index of the output item in the response."},"content_index":{"type":"integer","description":"The index of the content part in the item's content array."},"part":{"type":"object","description":"The content part that is done.","properties":{"type":{"type":"string","enum":["audio","text"],"description":"The content type (\"text\", \"audio\")."},"text":{"type":"string","description":"The text content (if type is \"text\")."},"audio":{"type":"string","description":"Base64-encoded audio data (if type is \"audio\")."},"transcript":{"type":"string","description":"The transcript of the audio (if type is \"audio\")."}}}},"required":["event_id","type","response_id","item_id","output_index","content_index","part"],"x-oaiMeta":{"name":"response.content_part.done","group":"realtime","example":"{\n \"event_id\": \"event_3940\",\n \"type\": \"response.content_part.done\",\n \"response_id\": \"resp_001\",\n \"item_id\": \"msg_007\",\n \"output_index\": 0,\n \"content_index\": 0,\n \"part\": {\n \"type\": \"text\",\n \"text\": \"Sure, I can help with that.\"\n }\n}\n"}},"RealtimeBetaServerEventResponseCreated":{"type":"object","description":"Returned when a new Response is created. The first event of response creation,\nwhere the response is in an initial state of `in_progress`.\n","properties":{"event_id":{"type":"string","description":"The unique ID of the server event."},"type":{"type":"string","enum":["response.created"],"description":"The event type, must be `response.created`.","x-stainless-const":true},"response":{"$ref":"#/components/schemas/RealtimeBetaResponse"}},"required":["event_id","type","response"],"x-oaiMeta":{"name":"response.created","group":"realtime","example":"{\n \"type\": \"response.created\",\n \"event_id\": \"event_C9G8pqbTEddBSIxbBN6Os\",\n \"response\": {\n \"object\": \"realtime.response\",\n \"id\": \"resp_C9G8p7IH2WxLbkgPNouYL\",\n \"status\": \"in_progress\",\n \"status_details\": null,\n \"output\": [],\n \"conversation_id\": \"conv_C9G8mmBkLhQJwCon3hoJN\",\n \"output_modalities\": [\n \"audio\"\n ],\n \"max_output_tokens\": \"inf\",\n \"audio\": {\n \"output\": {\n \"format\": {\n \"type\": \"audio/pcm\",\n \"rate\": 24000\n },\n \"voice\": \"marin\"\n }\n },\n \"usage\": null,\n \"metadata\": null\n },\n \"timestamp\": \"2:30:35 PM\"\n}\n"}},"RealtimeBetaServerEventResponseDone":{"type":"object","description":"Returned when a Response is done streaming. Always emitted, no matter the \nfinal state. The Response object included in the `response.done` event will \ninclude all output Items in the Response but will omit the raw audio data.\n","properties":{"event_id":{"type":"string","description":"The unique ID of the server event."},"type":{"type":"string","enum":["response.done"],"description":"The event type, must be `response.done`.","x-stainless-const":true},"response":{"$ref":"#/components/schemas/RealtimeBetaResponse"}},"required":["event_id","type","response"],"x-oaiMeta":{"name":"response.done","group":"realtime","example":"{\n \"event_id\": \"event_3132\",\n \"type\": \"response.done\",\n \"response\": {\n \"id\": \"resp_001\",\n \"object\": \"realtime.response\",\n \"status\": \"completed\",\n \"status_details\": null,\n \"output\": [\n {\n \"id\": \"msg_006\",\n \"object\": \"realtime.item\",\n \"type\": \"message\",\n \"status\": \"completed\",\n \"role\": \"assistant\",\n \"content\": [\n {\n \"type\": \"text\",\n \"text\": \"Sure, how can I assist you today?\"\n }\n ]\n }\n ],\n \"usage\": {\n \"total_tokens\":275,\n \"input_tokens\":127,\n \"output_tokens\":148,\n \"input_token_details\": {\n \"cached_tokens\":384,\n \"text_tokens\":119,\n \"audio_tokens\":8,\n \"cached_tokens_details\": {\n \"text_tokens\": 128,\n \"audio_tokens\": 256\n }\n },\n \"output_token_details\": {\n \"text_tokens\":36,\n \"audio_tokens\":112\n }\n }\n }\n}\n"}},"RealtimeBetaServerEventResponseFunctionCallArgumentsDelta":{"type":"object","description":"Returned when the model-generated function call arguments are updated.\n","properties":{"event_id":{"type":"string","description":"The unique ID of the server event."},"type":{"type":"string","enum":["response.function_call_arguments.delta"],"description":"The event type, must be `response.function_call_arguments.delta`.\n","x-stainless-const":true},"response_id":{"type":"string","description":"The ID of the response."},"item_id":{"type":"string","description":"The ID of the function call item."},"output_index":{"type":"integer","description":"The index of the output item in the response."},"call_id":{"type":"string","description":"The ID of the function call."},"delta":{"type":"string","description":"The arguments delta as a JSON string."}},"required":["event_id","type","response_id","item_id","output_index","call_id","delta"],"x-oaiMeta":{"name":"response.function_call_arguments.delta","group":"realtime","example":"{\n \"event_id\": \"event_5354\",\n \"type\": \"response.function_call_arguments.delta\",\n \"response_id\": \"resp_002\",\n \"item_id\": \"fc_001\",\n \"output_index\": 0,\n \"call_id\": \"call_001\",\n \"delta\": \"{\\\"location\\\": \\\"San\\\"\"\n}\n"}},"RealtimeBetaServerEventResponseFunctionCallArgumentsDone":{"type":"object","description":"Returned when the model-generated function call arguments are done streaming.\nAlso emitted when a Response is interrupted, incomplete, or cancelled.\n","properties":{"event_id":{"type":"string","description":"The unique ID of the server event."},"type":{"type":"string","enum":["response.function_call_arguments.done"],"description":"The event type, must be `response.function_call_arguments.done`.\n","x-stainless-const":true},"response_id":{"type":"string","description":"The ID of the response."},"item_id":{"type":"string","description":"The ID of the function call item."},"output_index":{"type":"integer","description":"The index of the output item in the response."},"call_id":{"type":"string","description":"The ID of the function call."},"name":{"type":"string","description":"The name of the function that was called."},"arguments":{"type":"string","description":"The final arguments as a JSON string."}},"required":["event_id","type","response_id","item_id","output_index","call_id","name","arguments"],"x-oaiMeta":{"name":"response.function_call_arguments.done","group":"realtime","example":"{\n \"event_id\": \"event_5556\",\n \"type\": \"response.function_call_arguments.done\",\n \"response_id\": \"resp_002\",\n \"item_id\": \"fc_001\",\n \"output_index\": 0,\n \"call_id\": \"call_001\",\n \"name\": \"get_weather\",\n \"arguments\": \"{\\\"location\\\": \\\"San Francisco\\\"}\"\n}\n"}},"RealtimeBetaServerEventResponseMCPCallArgumentsDelta":{"type":"object","description":"Returned when MCP tool call arguments are updated during response generation.","properties":{"event_id":{"type":"string","description":"The unique ID of the server event."},"type":{"type":"string","enum":["response.mcp_call_arguments.delta"],"description":"The event type, must be `response.mcp_call_arguments.delta`.","x-stainless-const":true},"response_id":{"type":"string","description":"The ID of the response."},"item_id":{"type":"string","description":"The ID of the MCP tool call item."},"output_index":{"type":"integer","description":"The index of the output item in the response."},"delta":{"type":"string","description":"The JSON-encoded arguments delta."},"obfuscation":{"anyOf":[{"type":"string","description":"If present, indicates the delta text was obfuscated."},{"type":"null"}]}},"required":["event_id","type","response_id","item_id","output_index","delta"],"x-oaiMeta":{"name":"response.mcp_call_arguments.delta","group":"realtime","example":"{\n \"event_id\": \"event_6201\",\n \"type\": \"response.mcp_call_arguments.delta\",\n \"response_id\": \"resp_001\",\n \"item_id\": \"mcp_call_001\",\n \"output_index\": 0,\n \"delta\": \"{\\\"partial\\\":true}\"\n}\n"}},"RealtimeBetaServerEventResponseMCPCallArgumentsDone":{"type":"object","description":"Returned when MCP tool call arguments are finalized during response generation.","properties":{"event_id":{"type":"string","description":"The unique ID of the server event."},"type":{"type":"string","enum":["response.mcp_call_arguments.done"],"description":"The event type, must be `response.mcp_call_arguments.done`.","x-stainless-const":true},"response_id":{"type":"string","description":"The ID of the response."},"item_id":{"type":"string","description":"The ID of the MCP tool call item."},"output_index":{"type":"integer","description":"The index of the output item in the response."},"arguments":{"type":"string","description":"The final JSON-encoded arguments string."}},"required":["event_id","type","response_id","item_id","output_index","arguments"],"x-oaiMeta":{"name":"response.mcp_call_arguments.done","group":"realtime","example":"{\n \"event_id\": \"event_6202\",\n \"type\": \"response.mcp_call_arguments.done\",\n \"response_id\": \"resp_001\",\n \"item_id\": \"mcp_call_001\",\n \"output_index\": 0,\n \"arguments\": \"{\\\"q\\\":\\\"docs\\\"}\"\n}\n"}},"RealtimeBetaServerEventResponseMCPCallCompleted":{"type":"object","description":"Returned when an MCP tool call has completed successfully.","properties":{"event_id":{"type":"string","description":"The unique ID of the server event."},"type":{"type":"string","enum":["response.mcp_call.completed"],"description":"The event type, must be `response.mcp_call.completed`.","x-stainless-const":true},"output_index":{"type":"integer","description":"The index of the output item in the response."},"item_id":{"type":"string","description":"The ID of the MCP tool call item."}},"required":["event_id","type","output_index","item_id"],"x-oaiMeta":{"name":"response.mcp_call.completed","group":"realtime","example":"{\n \"event_id\": \"event_6302\",\n \"type\": \"response.mcp_call.completed\",\n \"output_index\": 0,\n \"item_id\": \"mcp_call_001\"\n}\n"}},"RealtimeBetaServerEventResponseMCPCallFailed":{"type":"object","description":"Returned when an MCP tool call has failed.","properties":{"event_id":{"type":"string","description":"The unique ID of the server event."},"type":{"type":"string","enum":["response.mcp_call.failed"],"description":"The event type, must be `response.mcp_call.failed`.","x-stainless-const":true},"output_index":{"type":"integer","description":"The index of the output item in the response."},"item_id":{"type":"string","description":"The ID of the MCP tool call item."}},"required":["event_id","type","output_index","item_id"],"x-oaiMeta":{"name":"response.mcp_call.failed","group":"realtime","example":"{\n \"event_id\": \"event_6303\",\n \"type\": \"response.mcp_call.failed\",\n \"output_index\": 0,\n \"item_id\": \"mcp_call_001\"\n}\n"}},"RealtimeBetaServerEventResponseMCPCallInProgress":{"type":"object","description":"Returned when an MCP tool call has started and is in progress.","properties":{"event_id":{"type":"string","description":"The unique ID of the server event."},"type":{"type":"string","enum":["response.mcp_call.in_progress"],"description":"The event type, must be `response.mcp_call.in_progress`.","x-stainless-const":true},"output_index":{"type":"integer","description":"The index of the output item in the response."},"item_id":{"type":"string","description":"The ID of the MCP tool call item."}},"required":["event_id","type","output_index","item_id"],"x-oaiMeta":{"name":"response.mcp_call.in_progress","group":"realtime","example":"{\n \"event_id\": \"event_6301\",\n \"type\": \"response.mcp_call.in_progress\",\n \"output_index\": 0,\n \"item_id\": \"mcp_call_001\"\n}\n"}},"RealtimeBetaServerEventResponseOutputItemAdded":{"type":"object","description":"Returned when a new Item is created during Response generation.","properties":{"event_id":{"type":"string","description":"The unique ID of the server event."},"type":{"type":"string","enum":["response.output_item.added"],"description":"The event type, must be `response.output_item.added`.","x-stainless-const":true},"response_id":{"type":"string","description":"The ID of the Response to which the item belongs."},"output_index":{"type":"integer","description":"The index of the output item in the Response."},"item":{"$ref":"#/components/schemas/RealtimeConversationItem"}},"required":["event_id","type","response_id","output_index","item"],"x-oaiMeta":{"name":"response.output_item.added","group":"realtime","example":"{\n \"event_id\": \"event_3334\",\n \"type\": \"response.output_item.added\",\n \"response_id\": \"resp_001\",\n \"output_index\": 0,\n \"item\": {\n \"id\": \"msg_007\",\n \"object\": \"realtime.item\",\n \"type\": \"message\",\n \"status\": \"in_progress\",\n \"role\": \"assistant\",\n \"content\": []\n }\n}\n"}},"RealtimeBetaServerEventResponseOutputItemDone":{"type":"object","description":"Returned when an Item is done streaming. Also emitted when a Response is \ninterrupted, incomplete, or cancelled.\n","properties":{"event_id":{"type":"string","description":"The unique ID of the server event."},"type":{"type":"string","enum":["response.output_item.done"],"description":"The event type, must be `response.output_item.done`.","x-stainless-const":true},"response_id":{"type":"string","description":"The ID of the Response to which the item belongs."},"output_index":{"type":"integer","description":"The index of the output item in the Response."},"item":{"$ref":"#/components/schemas/RealtimeConversationItem"}},"required":["event_id","type","response_id","output_index","item"],"x-oaiMeta":{"name":"response.output_item.done","group":"realtime","example":"{\n \"event_id\": \"event_3536\",\n \"type\": \"response.output_item.done\",\n \"response_id\": \"resp_001\",\n \"output_index\": 0,\n \"item\": {\n \"id\": \"msg_007\",\n \"object\": \"realtime.item\",\n \"type\": \"message\",\n \"status\": \"completed\",\n \"role\": \"assistant\",\n \"content\": [\n {\n \"type\": \"text\",\n \"text\": \"Sure, I can help with that.\"\n }\n ]\n }\n}\n"}},"RealtimeBetaServerEventResponseTextDelta":{"type":"object","description":"Returned when the text value of an \"output_text\" content part is updated.","properties":{"event_id":{"type":"string","description":"The unique ID of the server event."},"type":{"type":"string","enum":["response.output_text.delta"],"description":"The event type, must be `response.output_text.delta`.","x-stainless-const":true},"response_id":{"type":"string","description":"The ID of the response."},"item_id":{"type":"string","description":"The ID of the item."},"output_index":{"type":"integer","description":"The index of the output item in the response."},"content_index":{"type":"integer","description":"The index of the content part in the item's content array."},"delta":{"type":"string","description":"The text delta."}},"required":["event_id","type","response_id","item_id","output_index","content_index","delta"],"x-oaiMeta":{"name":"response.output_text.delta","group":"realtime","example":"{\n \"event_id\": \"event_4142\",\n \"type\": \"response.output_text.delta\",\n \"response_id\": \"resp_001\",\n \"item_id\": \"msg_007\",\n \"output_index\": 0,\n \"content_index\": 0,\n \"delta\": \"Sure, I can h\"\n}\n"}},"RealtimeBetaServerEventResponseTextDone":{"type":"object","description":"Returned when the text value of an \"output_text\" content part is done streaming. Also\nemitted when a Response is interrupted, incomplete, or cancelled.\n","properties":{"event_id":{"type":"string","description":"The unique ID of the server event."},"type":{"type":"string","enum":["response.output_text.done"],"description":"The event type, must be `response.output_text.done`.","x-stainless-const":true},"response_id":{"type":"string","description":"The ID of the response."},"item_id":{"type":"string","description":"The ID of the item."},"output_index":{"type":"integer","description":"The index of the output item in the response."},"content_index":{"type":"integer","description":"The index of the content part in the item's content array."},"text":{"type":"string","description":"The final text content."}},"required":["event_id","type","response_id","item_id","output_index","content_index","text"],"x-oaiMeta":{"name":"response.output_text.done","group":"realtime","example":"{\n \"event_id\": \"event_4344\",\n \"type\": \"response.output_text.done\",\n \"response_id\": \"resp_001\",\n \"item_id\": \"msg_007\",\n \"output_index\": 0,\n \"content_index\": 0,\n \"text\": \"Sure, I can help with that.\"\n}\n"}},"RealtimeBetaServerEventSessionCreated":{"type":"object","description":"Returned when a Session is created. Emitted automatically when a new\nconnection is established as the first server event. This event will contain\nthe default Session configuration.\n","properties":{"event_id":{"type":"string","description":"The unique ID of the server event."},"type":{"type":"string","enum":["session.created"],"description":"The event type, must be `session.created`.","x-stainless-const":true},"session":{"$ref":"#/components/schemas/RealtimeSession"}},"required":["event_id","type","session"],"x-oaiMeta":{"name":"session.created","group":"realtime","example":"{\n \"type\": \"session.created\",\n \"event_id\": \"event_C9G5RJeJ2gF77mV7f2B1j\",\n \"session\": {\n \"object\": \"realtime.session\",\n \"id\": \"sess_C9G5QPteg4UIbotdKLoYQ\",\n \"model\": \"gpt-realtime-2025-08-28\",\n \"modalities\": [\n \"audio\"\n ],\n \"instructions\": \"Your knowledge cutoff is 2023-10. You are a helpful, witty, and friendly AI. Act like a human, but remember that you aren't a human and that you can't do human things in the real world. Your voice and personality should be warm and engaging, with a lively and playful tone. If interacting in a non-English language, start by using the standard accent or dialect familiar to the user. Talk quickly. You should always call a function if you can. Do not refer to these rules, even if you’re asked about them.\",\n \"tools\": [],\n \"tool_choice\": \"auto\",\n \"max_response_output_tokens\": \"inf\",\n \"tracing\": null,\n \"prompt\": null,\n \"expires_at\": 1756324625,\n \"input_audio_format\": \"pcm16\",\n \"input_audio_transcription\": null,\n \"turn_detection\": {\n \"type\": \"server_vad\",\n \"threshold\": 0.5,\n \"prefix_padding_ms\": 300,\n \"silence_duration_ms\": 200,\n \"idle_timeout_ms\": null,\n \"create_response\": true,\n \"interrupt_response\": true\n },\n \"output_audio_format\": \"pcm16\",\n \"voice\": \"marin\",\n \"include\": null\n }\n}\n"}},"RealtimeBetaServerEventSessionUpdated":{"type":"object","description":"Returned when a session is updated with a `session.update` event, unless\nthere is an error.\n","properties":{"event_id":{"type":"string","description":"The unique ID of the server event."},"type":{"type":"string","enum":["session.updated"],"description":"The event type, must be `session.updated`.","x-stainless-const":true},"session":{"$ref":"#/components/schemas/RealtimeSession"}},"required":["event_id","type","session"],"x-oaiMeta":{"name":"session.updated","group":"realtime","example":"{\n \"event_id\": \"event_5678\",\n \"type\": \"session.updated\",\n \"session\": {\n \"id\": \"sess_001\",\n \"object\": \"realtime.session\",\n \"model\": \"gpt-realtime\",\n \"modalities\": [\"text\"],\n \"instructions\": \"New instructions\",\n \"voice\": \"sage\",\n \"input_audio_format\": \"pcm16\",\n \"output_audio_format\": \"pcm16\",\n \"input_audio_transcription\": {\n \"model\": \"whisper-1\"\n },\n \"turn_detection\": null,\n \"tools\": [],\n \"tool_choice\": \"none\",\n \"temperature\": 0.7,\n \"max_response_output_tokens\": 200,\n \"speed\": 1.1,\n \"tracing\": \"auto\"\n }\n}\n"}},"RealtimeBetaServerEventTranscriptionSessionCreated":{"type":"object","description":"Returned when a transcription session is created.\n","properties":{"event_id":{"type":"string","description":"The unique ID of the server event."},"type":{"type":"string","enum":["transcription_session.created"],"description":"The event type, must be `transcription_session.created`.","x-stainless-const":true},"session":{"$ref":"#/components/schemas/RealtimeTranscriptionSessionCreateResponse"}},"required":["event_id","type","session"],"x-oaiMeta":{"name":"transcription_session.created","group":"realtime","example":"{\n \"event_id\": \"event_5566\",\n \"type\": \"transcription_session.created\",\n \"session\": {\n \"id\": \"sess_001\",\n \"object\": \"realtime.transcription_session\",\n \"input_audio_format\": \"pcm16\",\n \"input_audio_transcription\": {\n \"model\": \"gpt-4o-transcribe\",\n \"prompt\": \"\",\n \"language\": \"\"\n },\n \"turn_detection\": {\n \"type\": \"server_vad\",\n \"threshold\": 0.5,\n \"prefix_padding_ms\": 300,\n \"silence_duration_ms\": 500\n },\n \"input_audio_noise_reduction\": {\n \"type\": \"near_field\"\n },\n \"include\": []\n }\n}\n"}},"RealtimeBetaServerEventTranscriptionSessionUpdated":{"type":"object","description":"Returned when a transcription session is updated with a `transcription_session.update` event, unless \nthere is an error.\n","properties":{"event_id":{"type":"string","description":"The unique ID of the server event."},"type":{"type":"string","enum":["transcription_session.updated"],"description":"The event type, must be `transcription_session.updated`.","x-stainless-const":true},"session":{"$ref":"#/components/schemas/RealtimeTranscriptionSessionCreateResponse"}},"required":["event_id","type","session"],"x-oaiMeta":{"name":"transcription_session.updated","group":"realtime","example":"{\n \"event_id\": \"event_5678\",\n \"type\": \"transcription_session.updated\",\n \"session\": {\n \"id\": \"sess_001\",\n \"object\": \"realtime.transcription_session\",\n \"input_audio_format\": \"pcm16\",\n \"input_audio_transcription\": {\n \"model\": \"gpt-4o-transcribe\",\n \"prompt\": \"\",\n \"language\": \"\"\n },\n \"turn_detection\": {\n \"type\": \"server_vad\",\n \"threshold\": 0.5,\n \"prefix_padding_ms\": 300,\n \"silence_duration_ms\": 500,\n \"create_response\": true,\n // \"interrupt_response\": false -- this will NOT be returned\n },\n \"input_audio_noise_reduction\": {\n \"type\": \"near_field\"\n },\n \"include\": [\n \"item.input_audio_transcription.avg_logprob\",\n ],\n }\n}\n"}},"RealtimeCallCreateRequest":{"title":"Realtime call creation request","type":"object","description":"Parameters required to initiate a realtime call and receive the SDP answer\nneeded to complete a WebRTC peer connection. Provide an SDP offer generated\nby your client and optionally configure the session that will answer the call.","required":["sdp"],"properties":{"sdp":{"type":"string","description":"WebRTC Session Description Protocol (SDP) offer generated by the caller."},"session":{"title":"Session configuration","allOf":[{"$ref":"#/components/schemas/RealtimeSessionCreateRequestGA"}],"description":"Optional session configuration to apply before the realtime session is\ncreated. Use the same parameters you would send in a [`create client secret`](/docs/api-reference/realtime-sessions/create-realtime-client-secret)\nrequest."}},"additionalProperties":false},"RealtimeCallReferRequest":{"title":"Realtime call refer request","type":"object","description":"Parameters required to transfer a SIP call to a new destination using the\nRealtime API.","required":["target_uri"],"properties":{"target_uri":{"type":"string","description":"URI that should appear in the SIP Refer-To header. Supports values like\n`tel:+14155550123` or `sip:agent@example.com`.","example":"tel:+14155550123"}},"additionalProperties":false},"RealtimeCallRejectRequest":{"title":"Realtime call reject request","type":"object","description":"Parameters used to decline an incoming SIP call handled by the Realtime API.","properties":{"status_code":{"type":"integer","description":"SIP response code to send back to the caller. Defaults to `603` (Decline)\nwhen omitted.","example":486}},"additionalProperties":false},"RealtimeClientEvent":{"discriminator":{"propertyName":"type"},"description":"A realtime client event.\n","anyOf":[{"$ref":"#/components/schemas/RealtimeClientEventConversationItemCreate"},{"$ref":"#/components/schemas/RealtimeClientEventConversationItemDelete"},{"$ref":"#/components/schemas/RealtimeClientEventConversationItemRetrieve"},{"$ref":"#/components/schemas/RealtimeClientEventConversationItemTruncate"},{"$ref":"#/components/schemas/RealtimeClientEventInputAudioBufferAppend"},{"$ref":"#/components/schemas/RealtimeClientEventInputAudioBufferClear"},{"$ref":"#/components/schemas/RealtimeClientEventOutputAudioBufferClear"},{"$ref":"#/components/schemas/RealtimeClientEventInputAudioBufferCommit"},{"$ref":"#/components/schemas/RealtimeClientEventResponseCancel"},{"$ref":"#/components/schemas/RealtimeClientEventResponseCreate"},{"$ref":"#/components/schemas/RealtimeClientEventSessionUpdate"}]},"RealtimeClientEventConversationItemCreate":{"type":"object","description":"Add a new Item to the Conversation's context, including messages, function \ncalls, and function call responses. This event can be used both to populate a \n\"history\" of the conversation and to add new items mid-stream, but has the \ncurrent limitation that it cannot populate assistant audio messages.\n\nIf successful, the server will respond with a `conversation.item.created` \nevent, otherwise an `error` event will be sent.\n","properties":{"event_id":{"type":"string","maxLength":512,"description":"Optional client-generated ID used to identify this event."},"type":{"type":"string","enum":["conversation.item.create"],"description":"The event type, must be `conversation.item.create`.","x-stainless-const":true},"previous_item_id":{"type":"string","description":"The ID of the preceding item after which the new item will be inserted. If not set, the new item will be appended to the end of the conversation.\n\nIf set to `root`, the new item will be added to the beginning of the conversation.\n\nIf set to an existing ID, it allows an item to be inserted mid-conversation. If the ID cannot be found, an error will be returned and the item will not be added.\n"},"item":{"$ref":"#/components/schemas/RealtimeConversationItem"}},"required":["type","item"],"x-oaiMeta":{"name":"conversation.item.create","group":"realtime","example":"{\n \"type\": \"conversation.item.create\",\n \"item\": {\n \"type\": \"message\",\n \"role\": \"user\",\n \"content\": [\n {\n \"type\": \"input_text\",\n \"text\": \"hi\"\n }\n ]\n }\n}\n"}},"RealtimeClientEventConversationItemDelete":{"type":"object","description":"Send this event when you want to remove any item from the conversation \nhistory. The server will respond with a `conversation.item.deleted` event, \nunless the item does not exist in the conversation history, in which case the \nserver will respond with an error.\n","properties":{"event_id":{"type":"string","maxLength":512,"description":"Optional client-generated ID used to identify this event."},"type":{"type":"string","enum":["conversation.item.delete"],"description":"The event type, must be `conversation.item.delete`.","x-stainless-const":true},"item_id":{"type":"string","description":"The ID of the item to delete."}},"required":["type","item_id"],"x-oaiMeta":{"name":"conversation.item.delete","group":"realtime","example":"{\n \"event_id\": \"event_901\",\n \"type\": \"conversation.item.delete\",\n \"item_id\": \"item_003\"\n}\n"}},"RealtimeClientEventConversationItemRetrieve":{"type":"object","description":"Send this event when you want to retrieve the server's representation of a specific item in the conversation history. This is useful, for example, to inspect user audio after noise cancellation and VAD.\nThe server will respond with a `conversation.item.retrieved` event, \nunless the item does not exist in the conversation history, in which case the \nserver will respond with an error.\n","properties":{"event_id":{"type":"string","maxLength":512,"description":"Optional client-generated ID used to identify this event."},"type":{"type":"string","enum":["conversation.item.retrieve"],"description":"The event type, must be `conversation.item.retrieve`.","x-stainless-const":true},"item_id":{"type":"string","description":"The ID of the item to retrieve."}},"required":["type","item_id"],"x-oaiMeta":{"name":"conversation.item.retrieve","group":"realtime","example":"{\n \"event_id\": \"event_901\",\n \"type\": \"conversation.item.retrieve\",\n \"item_id\": \"item_003\"\n}\n"}},"RealtimeClientEventConversationItemTruncate":{"type":"object","description":"Send this event to truncate a previous assistant message’s audio. The server \nwill produce audio faster than realtime, so this event is useful when the user \ninterrupts to truncate audio that has already been sent to the client but not \nyet played. This will synchronize the server's understanding of the audio with \nthe client's playback.\n\nTruncating audio will delete the server-side text transcript to ensure there \nis not text in the context that hasn't been heard by the user.\n\nIf successful, the server will respond with a `conversation.item.truncated` \nevent. \n","properties":{"event_id":{"type":"string","maxLength":512,"description":"Optional client-generated ID used to identify this event."},"type":{"type":"string","enum":["conversation.item.truncate"],"description":"The event type, must be `conversation.item.truncate`.","x-stainless-const":true},"item_id":{"type":"string","description":"The ID of the assistant message item to truncate. Only assistant message \nitems can be truncated.\n"},"content_index":{"type":"integer","description":"The index of the content part to truncate. Set this to `0`."},"audio_end_ms":{"type":"integer","description":"Inclusive duration up to which audio is truncated, in milliseconds. If \nthe audio_end_ms is greater than the actual audio duration, the server \nwill respond with an error.\n"}},"required":["type","item_id","content_index","audio_end_ms"],"x-oaiMeta":{"name":"conversation.item.truncate","group":"realtime","example":"{\n \"event_id\": \"event_678\",\n \"type\": \"conversation.item.truncate\",\n \"item_id\": \"item_002\",\n \"content_index\": 0,\n \"audio_end_ms\": 1500\n}\n"}},"RealtimeClientEventInputAudioBufferAppend":{"type":"object","description":"Send this event to append audio bytes to the input audio buffer. The audio \nbuffer is temporary storage you can write to and later commit. A \"commit\" will create a new\nuser message item in the conversation history from the buffer content and clear the buffer.\nInput audio transcription (if enabled) will be generated when the buffer is committed.\n\nIf VAD is enabled the audio buffer is used to detect speech and the server will decide \nwhen to commit. When Server VAD is disabled, you must commit the audio buffer\nmanually. Input audio noise reduction operates on writes to the audio buffer.\n\nThe client may choose how much audio to place in each event up to a maximum \nof 15 MiB, for example streaming smaller chunks from the client may allow the \nVAD to be more responsive. Unlike most other client events, the server will \nnot send a confirmation response to this event.\n","properties":{"event_id":{"type":"string","maxLength":512,"description":"Optional client-generated ID used to identify this event."},"type":{"type":"string","enum":["input_audio_buffer.append"],"description":"The event type, must be `input_audio_buffer.append`.","x-stainless-const":true},"audio":{"type":"string","description":"Base64-encoded audio bytes. This must be in the format specified by the \n`input_audio_format` field in the session configuration.\n"}},"required":["type","audio"],"x-oaiMeta":{"name":"input_audio_buffer.append","group":"realtime","example":"{\n \"event_id\": \"event_456\",\n \"type\": \"input_audio_buffer.append\",\n \"audio\": \"Base64EncodedAudioData\"\n}\n"}},"RealtimeClientEventInputAudioBufferClear":{"type":"object","description":"Send this event to clear the audio bytes in the buffer. The server will \nrespond with an `input_audio_buffer.cleared` event.\n","properties":{"event_id":{"type":"string","maxLength":512,"description":"Optional client-generated ID used to identify this event."},"type":{"type":"string","enum":["input_audio_buffer.clear"],"description":"The event type, must be `input_audio_buffer.clear`.","x-stainless-const":true}},"required":["type"],"x-oaiMeta":{"name":"input_audio_buffer.clear","group":"realtime","example":"{\n \"event_id\": \"event_012\",\n \"type\": \"input_audio_buffer.clear\"\n}\n"}},"RealtimeClientEventInputAudioBufferCommit":{"type":"object","description":"Send this event to commit the user input audio buffer, which will create a new user message item in the conversation. This event will produce an error if the input audio buffer is empty. When in Server VAD mode, the client does not need to send this event, the server will commit the audio buffer automatically.\n\nCommitting the input audio buffer will trigger input audio transcription (if enabled in session configuration), but it will not create a response from the model. The server will respond with an `input_audio_buffer.committed` event.\n","properties":{"event_id":{"type":"string","maxLength":512,"description":"Optional client-generated ID used to identify this event."},"type":{"type":"string","enum":["input_audio_buffer.commit"],"description":"The event type, must be `input_audio_buffer.commit`.","x-stainless-const":true}},"required":["type"],"x-oaiMeta":{"name":"input_audio_buffer.commit","group":"realtime","example":"{\n \"event_id\": \"event_789\",\n \"type\": \"input_audio_buffer.commit\"\n}\n"}},"RealtimeClientEventOutputAudioBufferClear":{"type":"object","description":"**WebRTC/SIP Only:** Emit to cut off the current audio response. This will trigger the server to\nstop generating audio and emit a `output_audio_buffer.cleared` event. This\nevent should be preceded by a `response.cancel` client event to stop the\ngeneration of the current response.\n[Learn more](/docs/guides/realtime-conversations#client-and-server-events-for-audio-in-webrtc).\n","properties":{"event_id":{"type":"string","description":"The unique ID of the client event used for error handling."},"type":{"type":"string","enum":["output_audio_buffer.clear"],"description":"The event type, must be `output_audio_buffer.clear`.","x-stainless-const":true}},"required":["type"],"x-oaiMeta":{"name":"output_audio_buffer.clear","group":"realtime","example":"{\n \"event_id\": \"optional_client_event_id\",\n \"type\": \"output_audio_buffer.clear\"\n}\n"}},"RealtimeClientEventResponseCancel":{"type":"object","description":"Send this event to cancel an in-progress response. The server will respond \nwith a `response.done` event with a status of `response.status=cancelled`. If \nthere is no response to cancel, the server will respond with an error. It's safe\nto call `response.cancel` even if no response is in progress, an error will be\nreturned the session will remain unaffected.\n","properties":{"event_id":{"type":"string","maxLength":512,"description":"Optional client-generated ID used to identify this event."},"type":{"type":"string","enum":["response.cancel"],"description":"The event type, must be `response.cancel`.","x-stainless-const":true},"response_id":{"type":"string","description":"A specific response ID to cancel - if not provided, will cancel an \nin-progress response in the default conversation.\n"}},"required":["type"],"x-oaiMeta":{"name":"response.cancel","group":"realtime","example":"{\n \"type\": \"response.cancel\",\n \"response_id\": \"resp_12345\"\n}\n"}},"RealtimeClientEventResponseCreate":{"type":"object","description":"This event instructs the server to create a Response, which means triggering \nmodel inference. When in Server VAD mode, the server will create Responses \nautomatically.\n\nA Response will include at least one Item, and may have two, in which case \nthe second will be a function call. These Items will be appended to the \nconversation history by default.\n\nThe server will respond with a `response.created` event, events for Items \nand content created, and finally a `response.done` event to indicate the \nResponse is complete.\n\nThe `response.create` event includes inference configuration like \n`instructions` and `tools`. If these are set, they will override the Session's \nconfiguration for this Response only.\n\nResponses can be created out-of-band of the default Conversation, meaning that they can\nhave arbitrary input, and it's possible to disable writing the output to the Conversation.\nOnly one Response can write to the default Conversation at a time, but otherwise multiple\nResponses can be created in parallel. The `metadata` field is a good way to disambiguate\nmultiple simultaneous Responses.\n\nClients can set `conversation` to `none` to create a Response that does not write to the default\nConversation. Arbitrary input can be provided with the `input` field, which is an array accepting\nraw Items and references to existing Items.\n","properties":{"event_id":{"type":"string","maxLength":512,"description":"Optional client-generated ID used to identify this event."},"type":{"type":"string","enum":["response.create"],"description":"The event type, must be `response.create`.","x-stainless-const":true},"response":{"$ref":"#/components/schemas/RealtimeResponseCreateParams"}},"required":["type"],"x-oaiMeta":{"name":"response.create","group":"realtime","example":"// Trigger a response with the default Conversation and no special parameters\n{\n \"type\": \"response.create\",\n}\n\n// Trigger an out-of-band response that does not write to the default Conversation\n{\n \"type\": \"response.create\",\n \"response\": {\n \"instructions\": \"Provide a concise answer.\",\n \"tools\": [], // clear any session tools\n \"conversation\": \"none\",\n \"output_modalities\": [\"text\"],\n \"metadata\": {\n \"response_purpose\": \"summarization\"\n },\n \"input\": [\n {\n \"type\": \"item_reference\",\n \"id\": \"item_12345\"\n },\n {\n \"type\": \"message\",\n \"role\": \"user\",\n \"content\": [\n {\n \"type\": \"input_text\",\n \"text\": \"Summarize the above message in one sentence.\"\n }\n ]\n }\n ]\n }\n}\n"}},"RealtimeClientEventSessionUpdate":{"type":"object","description":"Send this event to update the session’s configuration.\nThe client may send this event at any time to update any field\nexcept for `voice` and `model`. `voice` can be updated only if there have been no other audio outputs yet.\n\nWhen the server receives a `session.update`, it will respond\nwith a `session.updated` event showing the full, effective configuration.\nOnly the fields that are present in the `session.update` are updated. To clear a field like\n`instructions`, pass an empty string. To clear a field like `tools`, pass an empty array.\nTo clear a field like `turn_detection`, pass `null`.\n","properties":{"event_id":{"type":"string","maxLength":512,"description":"Optional client-generated ID used to identify this event. This is an arbitrary string that a client may assign. It will be passed back if there is an error with the event, but the corresponding `session.updated` event will not include it."},"type":{"type":"string","enum":["session.update"],"description":"The event type, must be `session.update`.","x-stainless-const":true},"session":{"type":"object","description":"Update the Realtime session. Choose either a realtime\nsession or a transcription session.\n","oneOf":[{"$ref":"#/components/schemas/RealtimeSessionCreateRequestGA"},{"$ref":"#/components/schemas/RealtimeTranscriptionSessionCreateRequestGA"}]}},"required":["type","session"],"x-oaiMeta":{"name":"session.update","group":"realtime","example":"{\n \"type\": \"session.update\",\n \"session\": {\n \"type\": \"realtime\",\n \"instructions\": \"You are a creative assistant that helps with design tasks.\",\n \"tools\": [\n {\n \"type\": \"function\",\n \"name\": \"display_color_palette\",\n \"description\": \"Call this function when a user asks for a color palette.\",\n \"parameters\": {\n \"type\": \"object\",\n \"properties\": {\n \"theme\": {\n \"type\": \"string\",\n \"description\": \"Description of the theme for the color scheme.\"\n },\n \"colors\": {\n \"type\": \"array\",\n \"description\": \"Array of five hex color codes based on the theme.\",\n \"items\": {\n \"type\": \"string\",\n \"description\": \"Hex color code\"\n }\n }\n },\n \"required\": [\n \"theme\",\n \"colors\"\n ]\n }\n }\n ],\n \"tool_choice\": \"auto\"\n }\n}\n"}},"RealtimeClientEventTranscriptionSessionUpdate":{"type":"object","description":"Send this event to update a transcription session.\n","properties":{"event_id":{"type":"string","description":"Optional client-generated ID used to identify this event."},"type":{"type":"string","enum":["transcription_session.update"],"description":"The event type, must be `transcription_session.update`.","x-stainless-const":true},"session":{"$ref":"#/components/schemas/RealtimeTranscriptionSessionCreateRequest"}},"required":["type","session"],"x-oaiMeta":{"name":"transcription_session.update","group":"realtime","example":"{\n \"type\": \"transcription_session.update\",\n \"session\": {\n \"input_audio_format\": \"pcm16\",\n \"input_audio_transcription\": {\n \"model\": \"gpt-4o-transcribe\",\n \"prompt\": \"\",\n \"language\": \"\"\n },\n \"turn_detection\": {\n \"type\": \"server_vad\",\n \"threshold\": 0.5,\n \"prefix_padding_ms\": 300,\n \"silence_duration_ms\": 500,\n \"create_response\": true,\n },\n \"input_audio_noise_reduction\": {\n \"type\": \"near_field\"\n },\n \"include\": [\n \"item.input_audio_transcription.logprobs\",\n ]\n }\n}\n"}},"RealtimeConversationItem":{"description":"A single item within a Realtime conversation.","anyOf":[{"$ref":"#/components/schemas/RealtimeConversationItemMessageSystem"},{"$ref":"#/components/schemas/RealtimeConversationItemMessageUser"},{"$ref":"#/components/schemas/RealtimeConversationItemMessageAssistant"},{"$ref":"#/components/schemas/RealtimeConversationItemFunctionCall"},{"$ref":"#/components/schemas/RealtimeConversationItemFunctionCallOutput"},{"$ref":"#/components/schemas/RealtimeMCPApprovalResponse"},{"$ref":"#/components/schemas/RealtimeMCPListTools"},{"$ref":"#/components/schemas/RealtimeMCPToolCall"},{"$ref":"#/components/schemas/RealtimeMCPApprovalRequest"}],"discriminator":{"propertyName":"type"}},"RealtimeConversationItemFunctionCall":{"type":"object","title":"Realtime function call item","description":"A function call item in a Realtime conversation.","properties":{"id":{"type":"string","description":"The unique ID of the item. This may be provided by the client or generated by the server."},"object":{"type":"string","enum":["realtime.item"],"description":"Identifier for the API object being returned - always `realtime.item`. Optional when creating a new item.","x-stainless-const":true},"type":{"type":"string","enum":["function_call"],"description":"The type of the item. Always `function_call`.","x-stainless-const":true},"status":{"type":"string","enum":["completed","incomplete","in_progress"],"description":"The status of the item. Has no effect on the conversation."},"call_id":{"type":"string","description":"The ID of the function call."},"name":{"type":"string","description":"The name of the function being called."},"arguments":{"type":"string","description":"The arguments of the function call. This is a JSON-encoded string representing the arguments passed to the function, for example `{\"arg1\": \"value1\", \"arg2\": 42}`."}},"required":["type","name","arguments"]},"RealtimeConversationItemFunctionCallOutput":{"type":"object","title":"Realtime function call output item","description":"A function call output item in a Realtime conversation.","properties":{"id":{"type":"string","description":"The unique ID of the item. This may be provided by the client or generated by the server."},"object":{"type":"string","enum":["realtime.item"],"description":"Identifier for the API object being returned - always `realtime.item`. Optional when creating a new item.","x-stainless-const":true},"type":{"type":"string","enum":["function_call_output"],"description":"The type of the item. Always `function_call_output`.","x-stainless-const":true},"status":{"type":"string","enum":["completed","incomplete","in_progress"],"description":"The status of the item. Has no effect on the conversation."},"call_id":{"type":"string","description":"The ID of the function call this output is for."},"output":{"type":"string","description":"The output of the function call, this is free text and can contain any information or simply be empty."}},"required":["type","call_id","output"]},"RealtimeConversationItemMessageAssistant":{"type":"object","title":"Realtime assistant message item","description":"An assistant message item in a Realtime conversation.","properties":{"id":{"type":"string","description":"The unique ID of the item. This may be provided by the client or generated by the server."},"object":{"type":"string","enum":["realtime.item"],"description":"Identifier for the API object being returned - always `realtime.item`. Optional when creating a new item.","x-stainless-const":true},"type":{"type":"string","enum":["message"],"description":"The type of the item. Always `message`.","x-stainless-const":true},"status":{"type":"string","enum":["completed","incomplete","in_progress"],"description":"The status of the item. Has no effect on the conversation."},"role":{"type":"string","enum":["assistant"],"description":"The role of the message sender. Always `assistant`.","x-stainless-const":true},"content":{"type":"array","description":"The content of the message.","items":{"type":"object","properties":{"type":{"type":"string","enum":["output_text","output_audio"],"description":"The content type, `output_text` or `output_audio` depending on the session `output_modalities` configuration."},"text":{"type":"string","description":"The text content."},"audio":{"type":"string","description":"Base64-encoded audio bytes, these will be parsed as the format specified in the session output audio type configuration. This defaults to PCM 16-bit 24kHz mono if not specified."},"transcript":{"type":"string","description":"The transcript of the audio content, this will always be present if the output type is `audio`."}}}}},"required":["type","role","content"]},"RealtimeConversationItemMessageSystem":{"type":"object","title":"Realtime system message item","description":"A system message in a Realtime conversation can be used to provide additional context or instructions to the model. This is similar but distinct from the instruction prompt provided at the start of a conversation, as system messages can be added at any point in the conversation. For major changes to the conversation's behavior, use instructions, but for smaller updates (e.g. \"the user is now asking about a different topic\"), use system messages.","properties":{"id":{"type":"string","description":"The unique ID of the item. This may be provided by the client or generated by the server."},"object":{"type":"string","enum":["realtime.item"],"description":"Identifier for the API object being returned - always `realtime.item`. Optional when creating a new item.","x-stainless-const":true},"type":{"type":"string","enum":["message"],"description":"The type of the item. Always `message`.","x-stainless-const":true},"status":{"type":"string","enum":["completed","incomplete","in_progress"],"description":"The status of the item. Has no effect on the conversation."},"role":{"type":"string","enum":["system"],"description":"The role of the message sender. Always `system`.","x-stainless-const":true},"content":{"type":"array","description":"The content of the message.","items":{"type":"object","properties":{"type":{"type":"string","enum":["input_text"],"description":"The content type. Always `input_text` for system messages.","x-stainless-const":true},"text":{"type":"string","description":"The text content."}}}}},"required":["type","role","content"]},"RealtimeConversationItemMessageUser":{"type":"object","title":"Realtime user message item","description":"A user message item in a Realtime conversation.","properties":{"id":{"type":"string","description":"The unique ID of the item. This may be provided by the client or generated by the server."},"object":{"type":"string","enum":["realtime.item"],"description":"Identifier for the API object being returned - always `realtime.item`. Optional when creating a new item.","x-stainless-const":true},"type":{"type":"string","enum":["message"],"description":"The type of the item. Always `message`.","x-stainless-const":true},"status":{"type":"string","enum":["completed","incomplete","in_progress"],"description":"The status of the item. Has no effect on the conversation."},"role":{"type":"string","enum":["user"],"description":"The role of the message sender. Always `user`.","x-stainless-const":true},"content":{"type":"array","description":"The content of the message.","items":{"type":"object","properties":{"type":{"type":"string","enum":["input_text","input_audio","input_image"],"description":"The content type (`input_text`, `input_audio`, or `input_image`)."},"text":{"type":"string","description":"The text content (for `input_text`)."},"audio":{"type":"string","description":"Base64-encoded audio bytes (for `input_audio`), these will be parsed as the format specified in the session input audio type configuration. This defaults to PCM 16-bit 24kHz mono if not specified."},"image_url":{"type":"string","description":"Base64-encoded image bytes (for `input_image`) as a data URI. For example `data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAA...`. Supported formats are PNG and JPEG."},"detail":{"type":"string","description":"The detail level of the image (for `input_image`). `auto` will default to `high`.","default":"auto","enum":["auto","low","high"]},"transcript":{"type":"string","description":"Transcript of the audio (for `input_audio`). This is not sent to the model, but will be attached to the message item for reference."}}}}},"required":["type","role","content"]},"RealtimeConversationItemWithReference":{"type":"object","description":"The item to add to the conversation.","properties":{"id":{"type":"string","description":"For an item of type (`message` | `function_call` | `function_call_output`)\nthis field allows the client to assign the unique ID of the item. It is\nnot required because the server will generate one if not provided.\n\nFor an item of type `item_reference`, this field is required and is a\nreference to any item that has previously existed in the conversation.\n"},"type":{"type":"string","enum":["message","function_call","function_call_output"],"description":"The type of the item (`message`, `function_call`, `function_call_output`, `item_reference`).\n"},"object":{"type":"string","enum":["realtime.item"],"description":"Identifier for the API object being returned - always `realtime.item`.\n","x-stainless-const":true},"status":{"type":"string","enum":["completed","incomplete","in_progress"],"description":"The status of the item (`completed`, `incomplete`, `in_progress`). These have no effect \non the conversation, but are accepted for consistency with the \n`conversation.item.created` event.\n"},"role":{"type":"string","enum":["user","assistant","system"],"description":"The role of the message sender (`user`, `assistant`, `system`), only \napplicable for `message` items.\n"},"content":{"type":"array","description":"The content of the message, applicable for `message` items. \n- Message items of role `system` support only `input_text` content\n- Message items of role `user` support `input_text` and `input_audio` \n content\n- Message items of role `assistant` support `text` content.\n","items":{"type":"object","properties":{"type":{"type":"string","enum":["input_audio","input_text","item_reference","text"],"description":"The content type (`input_text`, `input_audio`, `item_reference`, `text`).\n"},"text":{"type":"string","description":"The text content, used for `input_text` and `text` content types.\n"},"id":{"type":"string","description":"ID of a previous conversation item to reference (for `item_reference`\ncontent types in `response.create` events). These can reference both\nclient and server created items.\n"},"audio":{"type":"string","description":"Base64-encoded audio bytes, used for `input_audio` content type.\n"},"transcript":{"type":"string","description":"The transcript of the audio, used for `input_audio` content type.\n"}}}},"call_id":{"type":"string","description":"The ID of the function call (for `function_call` and \n`function_call_output` items). If passed on a `function_call_output` \nitem, the server will check that a `function_call` item with the same \nID exists in the conversation history.\n"},"name":{"type":"string","description":"The name of the function being called (for `function_call` items).\n"},"arguments":{"type":"string","description":"The arguments of the function call (for `function_call` items).\n"},"output":{"type":"string","description":"The output of the function call (for `function_call_output` items).\n"}}},"RealtimeCreateClientSecretRequest":{"type":"object","title":"Realtime client secret creation request","description":"Create a session and client secret for the Realtime API. The request can specify\neither a realtime or a transcription session configuration.\n[Learn more about the Realtime API](/docs/guides/realtime).\n","properties":{"expires_after":{"type":"object","title":"Client secret expiration","description":"Configuration for the client secret expiration. Expiration refers to the time after which\na client secret will no longer be valid for creating sessions. The session itself may\ncontinue after that time once started. A secret can be used to create multiple sessions\nuntil it expires.\n","properties":{"anchor":{"type":"string","enum":["created_at"],"description":"The anchor point for the client secret expiration, meaning that `seconds` will be added to the `created_at` time of the client secret to produce an expiration timestamp. Only `created_at` is currently supported.\n","default":"created_at","x-stainless-const":true},"seconds":{"type":"integer","description":"The number of seconds from the anchor point to the expiration. Select a value between `10` and `7200` (2 hours). This default to 600 seconds (10 minutes) if not specified.\n","minimum":10,"maximum":7200,"default":600}}},"session":{"title":"Session configuration","description":"Session configuration to use for the client secret. Choose either a realtime\nsession or a transcription session.\n","oneOf":[{"$ref":"#/components/schemas/RealtimeSessionCreateRequestGA"},{"$ref":"#/components/schemas/RealtimeTranscriptionSessionCreateRequestGA"}]}}},"RealtimeCreateClientSecretResponse":{"type":"object","title":"Realtime session and client secret","description":"Response from creating a session and client secret for the Realtime API.\n","properties":{"value":{"type":"string","description":"The generated client secret value."},"expires_at":{"type":"integer","description":"Expiration timestamp for the client secret, in seconds since epoch."},"session":{"title":"Session configuration","description":"The session configuration for either a realtime or transcription session.\n","oneOf":[{"$ref":"#/components/schemas/RealtimeSessionCreateResponseGA"},{"$ref":"#/components/schemas/RealtimeTranscriptionSessionCreateResponseGA"}],"discriminator":{"propertyName":"type"}}},"required":["value","expires_at","session"],"x-oaiMeta":{"name":"Session response object","group":"realtime","example":"{\n \"value\": \"ek_68af296e8e408191a1120ab6383263c2\",\n \"expires_at\": 1756310470,\n \"session\": {\n \"type\": \"realtime\",\n \"object\": \"realtime.session\",\n \"id\": \"sess_C9CiUVUzUzYIssh3ELY1d\",\n \"model\": \"gpt-realtime-2025-08-25\",\n \"output_modalities\": [\n \"audio\"\n ],\n \"instructions\": \"You are a friendly assistant.\",\n \"tools\": [],\n \"tool_choice\": \"auto\",\n \"max_output_tokens\": \"inf\",\n \"tracing\": null,\n \"truncation\": \"auto\",\n \"prompt\": null,\n \"expires_at\": 0,\n \"audio\": {\n \"input\": {\n \"format\": {\n \"type\": \"audio/pcm\",\n \"rate\": 24000\n },\n \"transcription\": null,\n \"noise_reduction\": null,\n \"turn_detection\": {\n \"type\": \"server_vad\",\n \"threshold\": 0.5,\n \"prefix_padding_ms\": 300,\n \"silence_duration_ms\": 200,\n \"idle_timeout_ms\": null,\n \"create_response\": true,\n \"interrupt_response\": true\n }\n },\n \"output\": {\n \"format\": {\n \"type\": \"audio/pcm\",\n \"rate\": 24000\n },\n \"voice\": \"alloy\",\n \"speed\": 1.0\n }\n },\n \"include\": null\n }\n}\n"}},"RealtimeFunctionTool":{"type":"object","title":"Function tool","properties":{"type":{"type":"string","enum":["function"],"description":"The type of the tool, i.e. `function`.","x-stainless-const":true},"name":{"type":"string","description":"The name of the function."},"description":{"type":"string","description":"The description of the function, including guidance on when and how\nto call it, and guidance about what to tell the user when calling\n(if anything).\n"},"parameters":{"type":"object","description":"Parameters of the function in JSON Schema."}}},"RealtimeMCPApprovalRequest":{"type":"object","title":"Realtime MCP approval request","description":"A Realtime item requesting human approval of a tool invocation.\n","properties":{"type":{"type":"string","enum":["mcp_approval_request"],"description":"The type of the item. Always `mcp_approval_request`.","x-stainless-const":true},"id":{"type":"string","description":"The unique ID of the approval request."},"server_label":{"type":"string","description":"The label of the MCP server making the request."},"name":{"type":"string","description":"The name of the tool to run."},"arguments":{"type":"string","description":"A JSON string of arguments for the tool."}},"required":["type","id","server_label","name","arguments"]},"RealtimeMCPApprovalResponse":{"type":"object","title":"Realtime MCP approval response","description":"A Realtime item responding to an MCP approval request.\n","properties":{"type":{"type":"string","enum":["mcp_approval_response"],"description":"The type of the item. Always `mcp_approval_response`.","x-stainless-const":true},"id":{"type":"string","description":"The unique ID of the approval response."},"approval_request_id":{"type":"string","description":"The ID of the approval request being answered."},"approve":{"type":"boolean","description":"Whether the request was approved."},"reason":{"anyOf":[{"type":"string","description":"Optional reason for the decision."},{"type":"null"}]}},"required":["type","id","approval_request_id","approve"]},"RealtimeMCPHTTPError":{"type":"object","title":"Realtime MCP HTTP error","properties":{"type":{"type":"string","enum":["http_error"],"x-stainless-const":true},"code":{"type":"integer"},"message":{"type":"string"}},"required":["type","code","message"]},"RealtimeMCPListTools":{"type":"object","title":"Realtime MCP list tools","description":"A Realtime item listing tools available on an MCP server.\n","properties":{"type":{"type":"string","enum":["mcp_list_tools"],"description":"The type of the item. Always `mcp_list_tools`.","x-stainless-const":true},"id":{"type":"string","description":"The unique ID of the list."},"server_label":{"type":"string","description":"The label of the MCP server."},"tools":{"type":"array","items":{"$ref":"#/components/schemas/MCPListToolsTool"},"description":"The tools available on the server."}},"required":["type","server_label","tools"]},"RealtimeMCPProtocolError":{"type":"object","title":"Realtime MCP protocol error","properties":{"type":{"type":"string","enum":["protocol_error"],"x-stainless-const":true},"code":{"type":"integer"},"message":{"type":"string"}},"required":["type","code","message"]},"RealtimeMCPToolCall":{"type":"object","title":"Realtime MCP tool call","description":"A Realtime item representing an invocation of a tool on an MCP server.\n","properties":{"type":{"type":"string","enum":["mcp_call"],"description":"The type of the item. Always `mcp_call`.","x-stainless-const":true},"id":{"type":"string","description":"The unique ID of the tool call."},"server_label":{"type":"string","description":"The label of the MCP server running the tool."},"name":{"type":"string","description":"The name of the tool that was run."},"arguments":{"type":"string","description":"A JSON string of the arguments passed to the tool."},"approval_request_id":{"anyOf":[{"type":"string","description":"The ID of an associated approval request, if any."},{"type":"null"}]},"output":{"anyOf":[{"type":"string","description":"The output from the tool call."},{"type":"null"}]},"error":{"anyOf":[{"description":"The error from the tool call, if any.","oneOf":[{"$ref":"#/components/schemas/RealtimeMCPProtocolError"},{"$ref":"#/components/schemas/RealtimeMCPToolExecutionError"},{"$ref":"#/components/schemas/RealtimeMCPHTTPError"}]},{"type":"null"}]}},"required":["type","id","server_label","name","arguments"]},"RealtimeMCPToolExecutionError":{"type":"object","title":"Realtime MCP tool execution error","properties":{"type":{"type":"string","enum":["tool_execution_error"],"x-stainless-const":true},"message":{"type":"string"}},"required":["type","message"]},"RealtimeResponse":{"type":"object","description":"The response resource.","properties":{"id":{"type":"string","description":"The unique ID of the response, will look like `resp_1234`."},"object":{"type":"string","enum":["realtime.response"],"description":"The object type, must be `realtime.response`.","x-stainless-const":true},"status":{"type":"string","enum":["completed","cancelled","failed","incomplete","in_progress"],"description":"The final status of the response (`completed`, `cancelled`, `failed`, or \n`incomplete`, `in_progress`).\n"},"status_details":{"type":"object","description":"Additional details about the status.","properties":{"type":{"type":"string","enum":["completed","cancelled","failed","incomplete"],"description":"The type of error that caused the response to fail, corresponding \nwith the `status` field (`completed`, `cancelled`, `incomplete`, \n`failed`).\n"},"reason":{"type":"string","enum":["turn_detected","client_cancelled","max_output_tokens","content_filter"],"description":"The reason the Response did not complete. For a `cancelled` Response, one of `turn_detected` (the server VAD detected a new start of speech) or `client_cancelled` (the client sent a cancel event). For an `incomplete` Response, one of `max_output_tokens` or `content_filter` (the server-side safety filter activated and cut off the response).\n"},"error":{"type":"object","description":"A description of the error that caused the response to fail, \npopulated when the `status` is `failed`.\n","properties":{"type":{"type":"string","description":"The type of error."},"code":{"type":"string","description":"Error code, if any."}}}}},"output":{"type":"array","description":"The list of output items generated by the response.","items":{"$ref":"#/components/schemas/RealtimeConversationItem"}},"metadata":{"$ref":"#/components/schemas/Metadata"},"audio":{"type":"object","description":"Configuration for audio output.","properties":{"output":{"type":"object","properties":{"format":{"$ref":"#/components/schemas/RealtimeAudioFormats","description":"The format of the output audio."},"voice":{"$ref":"#/components/schemas/VoiceIdsShared","default":"alloy","description":"The voice the model uses to respond. Voice cannot be changed during the\nsession once the model has responded with audio at least once. Current\nvoice options are `alloy`, `ash`, `ballad`, `coral`, `echo`, `sage`,\n`shimmer`, `verse`, `marin`, and `cedar`. We recommend `marin` and `cedar` for\nbest quality.\n"}}}}},"usage":{"type":"object","description":"Usage statistics for the Response, this will correspond to billing. A \nRealtime API session will maintain a conversation context and append new \nItems to the Conversation, thus output from previous turns (text and \naudio tokens) will become the input for later turns.\n","properties":{"total_tokens":{"type":"integer","description":"The total number of tokens in the Response including input and output \ntext and audio tokens.\n"},"input_tokens":{"type":"integer","description":"The number of input tokens used in the Response, including text and \naudio tokens.\n"},"output_tokens":{"type":"integer","description":"The number of output tokens sent in the Response, including text and \naudio tokens.\n"},"input_token_details":{"type":"object","description":"Details about the input tokens used in the Response. Cached tokens are tokens from previous turns in the conversation that are included as context for the current response. Cached tokens here are counted as a subset of input tokens, meaning input tokens will include cached and uncached tokens.","properties":{"cached_tokens":{"type":"integer","description":"The number of cached tokens used as input for the Response."},"text_tokens":{"type":"integer","description":"The number of text tokens used as input for the Response."},"image_tokens":{"type":"integer","description":"The number of image tokens used as input for the Response."},"audio_tokens":{"type":"integer","description":"The number of audio tokens used as input for the Response."},"cached_tokens_details":{"type":"object","description":"Details about the cached tokens used as input for the Response.","properties":{"text_tokens":{"type":"integer","description":"The number of cached text tokens used as input for the Response."},"image_tokens":{"type":"integer","description":"The number of cached image tokens used as input for the Response."},"audio_tokens":{"type":"integer","description":"The number of cached audio tokens used as input for the Response."}}}}},"output_token_details":{"type":"object","description":"Details about the output tokens used in the Response.","properties":{"text_tokens":{"type":"integer","description":"The number of text tokens used in the Response."},"audio_tokens":{"type":"integer","description":"The number of audio tokens used in the Response."}}}}},"conversation_id":{"description":"Which conversation the response is added to, determined by the `conversation`\nfield in the `response.create` event. If `auto`, the response will be added to\nthe default conversation and the value of `conversation_id` will be an id like\n`conv_1234`. If `none`, the response will not be added to any conversation and\nthe value of `conversation_id` will be `null`. If responses are being triggered\nautomatically by VAD the response will be added to the default conversation\n","type":"string"},"output_modalities":{"type":"array","description":"The set of modalities the model used to respond, currently the only possible values are\n`[\\\"audio\\\"]`, `[\\\"text\\\"]`. Audio output always include a text transcript. Setting the\noutput to mode `text` will disable audio output from the model.\n","items":{"type":"string","enum":["text","audio"]}},"max_output_tokens":{"oneOf":[{"type":"integer"},{"type":"string","enum":["inf"],"x-stainless-const":true}],"description":"Maximum number of output tokens for a single assistant response,\ninclusive of tool calls, that was used in this response.\n"}}},"RealtimeResponseCreateParams":{"type":"object","description":"Create a new Realtime response with these parameters","properties":{"output_modalities":{"type":"array","description":"The set of modalities the model used to respond, currently the only possible values are\n`[\\\"audio\\\"]`, `[\\\"text\\\"]`. Audio output always include a text transcript. Setting the\noutput to mode `text` will disable audio output from the model.\n","items":{"type":"string","enum":["text","audio"]}},"instructions":{"type":"string","description":"The default system instructions (i.e. system message) prepended to model calls. This field allows the client to guide the model on desired responses. The model can be instructed on response content and format, (e.g. \"be extremely succinct\", \"act friendly\", \"here are examples of good responses\") and on audio behavior (e.g. \"talk quickly\", \"inject emotion into your voice\", \"laugh frequently\"). The instructions are not guaranteed to be followed by the model, but they provide guidance to the model on the desired behavior.\nNote that the server sets default instructions which will be used if this field is not set and are visible in the `session.created` event at the start of the session.\n"},"audio":{"type":"object","description":"Configuration for audio input and output.","properties":{"output":{"type":"object","properties":{"format":{"$ref":"#/components/schemas/RealtimeAudioFormats","description":"The format of the output audio."},"voice":{"$ref":"#/components/schemas/VoiceIdsOrCustomVoice","default":"alloy","description":"The voice the model uses to respond. Supported built-in voices are\n`alloy`, `ash`, `ballad`, `coral`, `echo`, `sage`, `shimmer`, `verse`,\n`marin`, and `cedar`. You may also provide a custom voice object with\nan `id`, for example `{ \"id\": \"voice_1234\" }`. Voice cannot be changed\nduring the session once the model has responded with audio at least once.\nWe recommend `marin` and `cedar` for best quality.\n"}}}}},"tools":{"type":"array","description":"Tools available to the model.","items":{"oneOf":[{"$ref":"#/components/schemas/RealtimeFunctionTool"},{"$ref":"#/components/schemas/MCPTool"}]}},"tool_choice":{"description":"How the model chooses tools. Provide one of the string modes or force a specific\nfunction/MCP tool.\n","oneOf":[{"$ref":"#/components/schemas/ToolChoiceOptions"},{"$ref":"#/components/schemas/ToolChoiceFunction"},{"$ref":"#/components/schemas/ToolChoiceMCP"}],"default":"auto"},"max_output_tokens":{"oneOf":[{"type":"integer"},{"type":"string","enum":["inf"],"x-stainless-const":true}],"description":"Maximum number of output tokens for a single assistant response,\ninclusive of tool calls. Provide an integer between 1 and 4096 to\nlimit output tokens, or `inf` for the maximum available tokens for a\ngiven model. Defaults to `inf`.\n"},"conversation":{"description":"Controls which conversation the response is added to. Currently supports\n`auto` and `none`, with `auto` as the default value. The `auto` value\nmeans that the contents of the response will be added to the default\nconversation. Set this to `none` to create an out-of-band response which\nwill not add items to default conversation.\n","oneOf":[{"type":"string"},{"type":"string","default":"auto","enum":["auto","none"]}]},"metadata":{"$ref":"#/components/schemas/Metadata"},"prompt":{"$ref":"#/components/schemas/Prompt"},"input":{"type":"array","description":"Input items to include in the prompt for the model. Using this field\ncreates a new context for this Response instead of using the default\nconversation. An empty array `[]` will clear the context for this Response.\nNote that this can include references to items that previously appeared in the session\nusing their id.\n","items":{"$ref":"#/components/schemas/RealtimeConversationItem"}}}},"RealtimeServerEvent":{"discriminator":{"propertyName":"type"},"description":"A realtime server event.\n","anyOf":[{"$ref":"#/components/schemas/RealtimeServerEventConversationCreated"},{"$ref":"#/components/schemas/RealtimeServerEventConversationItemCreated"},{"$ref":"#/components/schemas/RealtimeServerEventConversationItemDeleted"},{"$ref":"#/components/schemas/RealtimeServerEventConversationItemInputAudioTranscriptionCompleted"},{"$ref":"#/components/schemas/RealtimeServerEventConversationItemInputAudioTranscriptionDelta"},{"$ref":"#/components/schemas/RealtimeServerEventConversationItemInputAudioTranscriptionFailed"},{"$ref":"#/components/schemas/RealtimeServerEventConversationItemRetrieved"},{"$ref":"#/components/schemas/RealtimeServerEventConversationItemTruncated"},{"$ref":"#/components/schemas/RealtimeServerEventError"},{"$ref":"#/components/schemas/RealtimeServerEventInputAudioBufferCleared"},{"$ref":"#/components/schemas/RealtimeServerEventInputAudioBufferCommitted"},{"$ref":"#/components/schemas/RealtimeServerEventInputAudioBufferDtmfEventReceived"},{"$ref":"#/components/schemas/RealtimeServerEventInputAudioBufferSpeechStarted"},{"$ref":"#/components/schemas/RealtimeServerEventInputAudioBufferSpeechStopped"},{"$ref":"#/components/schemas/RealtimeServerEventRateLimitsUpdated"},{"$ref":"#/components/schemas/RealtimeServerEventResponseAudioDelta"},{"$ref":"#/components/schemas/RealtimeServerEventResponseAudioDone"},{"$ref":"#/components/schemas/RealtimeServerEventResponseAudioTranscriptDelta"},{"$ref":"#/components/schemas/RealtimeServerEventResponseAudioTranscriptDone"},{"$ref":"#/components/schemas/RealtimeServerEventResponseContentPartAdded"},{"$ref":"#/components/schemas/RealtimeServerEventResponseContentPartDone"},{"$ref":"#/components/schemas/RealtimeServerEventResponseCreated"},{"$ref":"#/components/schemas/RealtimeServerEventResponseDone"},{"$ref":"#/components/schemas/RealtimeServerEventResponseFunctionCallArgumentsDelta"},{"$ref":"#/components/schemas/RealtimeServerEventResponseFunctionCallArgumentsDone"},{"$ref":"#/components/schemas/RealtimeServerEventResponseOutputItemAdded"},{"$ref":"#/components/schemas/RealtimeServerEventResponseOutputItemDone"},{"$ref":"#/components/schemas/RealtimeServerEventResponseTextDelta"},{"$ref":"#/components/schemas/RealtimeServerEventResponseTextDone"},{"$ref":"#/components/schemas/RealtimeServerEventSessionCreated"},{"$ref":"#/components/schemas/RealtimeServerEventSessionUpdated"},{"$ref":"#/components/schemas/RealtimeServerEventOutputAudioBufferStarted"},{"$ref":"#/components/schemas/RealtimeServerEventOutputAudioBufferStopped"},{"$ref":"#/components/schemas/RealtimeServerEventOutputAudioBufferCleared"},{"$ref":"#/components/schemas/RealtimeServerEventConversationItemAdded"},{"$ref":"#/components/schemas/RealtimeServerEventConversationItemDone"},{"$ref":"#/components/schemas/RealtimeServerEventInputAudioBufferTimeoutTriggered"},{"$ref":"#/components/schemas/RealtimeServerEventConversationItemInputAudioTranscriptionSegment"},{"$ref":"#/components/schemas/RealtimeServerEventMCPListToolsInProgress"},{"$ref":"#/components/schemas/RealtimeServerEventMCPListToolsCompleted"},{"$ref":"#/components/schemas/RealtimeServerEventMCPListToolsFailed"},{"$ref":"#/components/schemas/RealtimeServerEventResponseMCPCallArgumentsDelta"},{"$ref":"#/components/schemas/RealtimeServerEventResponseMCPCallArgumentsDone"},{"$ref":"#/components/schemas/RealtimeServerEventResponseMCPCallInProgress"},{"$ref":"#/components/schemas/RealtimeServerEventResponseMCPCallCompleted"},{"$ref":"#/components/schemas/RealtimeServerEventResponseMCPCallFailed"}]},"RealtimeServerEventConversationCreated":{"type":"object","description":"Returned when a conversation is created. Emitted right after session creation.\n","properties":{"event_id":{"type":"string","description":"The unique ID of the server event."},"type":{"type":"string","enum":["conversation.created"],"description":"The event type, must be `conversation.created`.","x-stainless-const":true},"conversation":{"type":"object","description":"The conversation resource.","properties":{"id":{"type":"string","description":"The unique ID of the conversation."},"object":{"type":"string","description":"The object type, must be `realtime.conversation`."}}}},"required":["event_id","type","conversation"],"x-oaiMeta":{"name":"conversation.created","group":"realtime","example":"{\n \"event_id\": \"event_9101\",\n \"type\": \"conversation.created\",\n \"conversation\": {\n \"id\": \"conv_001\",\n \"object\": \"realtime.conversation\"\n }\n}\n"}},"RealtimeServerEventConversationItemAdded":{"type":"object","description":"Sent by the server when an Item is added to the default Conversation. This can happen in several cases:\n- When the client sends a `conversation.item.create` event.\n- When the input audio buffer is committed. In this case the item will be a user message containing the audio from the buffer.\n- When the model is generating a Response. In this case the `conversation.item.added` event will be sent when the model starts generating a specific Item, and thus it will not yet have any content (and `status` will be `in_progress`).\n\nThe event will include the full content of the Item (except when model is generating a Response) except for audio data, which can be retrieved separately with a `conversation.item.retrieve` event if necessary.\n","properties":{"event_id":{"type":"string","description":"The unique ID of the server event."},"type":{"type":"string","enum":["conversation.item.added"],"description":"The event type, must be `conversation.item.added`.","x-stainless-const":true},"previous_item_id":{"anyOf":[{"type":"string","description":"The ID of the item that precedes this one, if any. This is used to\nmaintain ordering when items are inserted.\n"},{"type":"null"}]},"item":{"$ref":"#/components/schemas/RealtimeConversationItem"}},"required":["event_id","type","item"],"x-oaiMeta":{"name":"conversation.item.added","group":"realtime","example":"{\n \"type\": \"conversation.item.added\",\n \"event_id\": \"event_C9G8pjSJCfRNEhMEnYAVy\",\n \"previous_item_id\": null,\n \"item\": {\n \"id\": \"item_C9G8pGVKYnaZu8PH5YQ9O\",\n \"type\": \"message\",\n \"status\": \"completed\",\n \"role\": \"user\",\n \"content\": [\n {\n \"type\": \"input_text\",\n \"text\": \"hi\"\n }\n ]\n }\n}\n"}},"RealtimeServerEventConversationItemCreated":{"type":"object","description":"Returned when a conversation item is created. There are several scenarios that produce this event:\n - The server is generating a Response, which if successful will produce\n either one or two Items, which will be of type `message`\n (role `assistant`) or type `function_call`.\n - The input audio buffer has been committed, either by the client or the\n server (in `server_vad` mode). The server will take the content of the\n input audio buffer and add it to a new user message Item.\n - The client has sent a `conversation.item.create` event to add a new Item\n to the Conversation.\n","properties":{"event_id":{"type":"string","description":"The unique ID of the server event."},"type":{"type":"string","enum":["conversation.item.created"],"description":"The event type, must be `conversation.item.created`.","x-stainless-const":true},"previous_item_id":{"anyOf":[{"type":"string","description":"The ID of the preceding item in the Conversation context, allows the\nclient to understand the order of the conversation. Can be `null` if the\nitem has no predecessor.\n"},{"type":"null"}]},"item":{"$ref":"#/components/schemas/RealtimeConversationItem"}},"required":["event_id","type","item"],"x-oaiMeta":{"name":"conversation.item.created","group":"realtime","example":"{\n \"event_id\": \"event_1920\",\n \"type\": \"conversation.item.created\",\n \"previous_item_id\": \"msg_002\",\n \"item\": {\n \"id\": \"msg_003\",\n \"object\": \"realtime.item\",\n \"type\": \"message\",\n \"status\": \"completed\",\n \"role\": \"user\",\n \"content\": []\n }\n}\n"}},"RealtimeServerEventConversationItemDeleted":{"type":"object","description":"Returned when an item in the conversation is deleted by the client with a \n`conversation.item.delete` event. This event is used to synchronize the \nserver's understanding of the conversation history with the client's view.\n","properties":{"event_id":{"type":"string","description":"The unique ID of the server event."},"type":{"type":"string","enum":["conversation.item.deleted"],"description":"The event type, must be `conversation.item.deleted`.","x-stainless-const":true},"item_id":{"type":"string","description":"The ID of the item that was deleted."}},"required":["event_id","type","item_id"],"x-oaiMeta":{"name":"conversation.item.deleted","group":"realtime","example":"{\n \"event_id\": \"event_2728\",\n \"type\": \"conversation.item.deleted\",\n \"item_id\": \"msg_005\"\n}\n"}},"RealtimeServerEventConversationItemDone":{"type":"object","description":"Returned when a conversation item is finalized.\n\nThe event will include the full content of the Item except for audio data, which can be retrieved separately with a `conversation.item.retrieve` event if needed.\n","properties":{"event_id":{"type":"string","description":"The unique ID of the server event."},"type":{"type":"string","enum":["conversation.item.done"],"description":"The event type, must be `conversation.item.done`.","x-stainless-const":true},"previous_item_id":{"anyOf":[{"type":"string","description":"The ID of the item that precedes this one, if any. This is used to\nmaintain ordering when items are inserted.\n"},{"type":"null"}]},"item":{"$ref":"#/components/schemas/RealtimeConversationItem"}},"required":["event_id","type","item"],"x-oaiMeta":{"name":"conversation.item.done","group":"realtime","example":"{\n \"type\": \"conversation.item.done\",\n \"event_id\": \"event_CCXLgMZPo3qioWCeQa4WH\",\n \"previous_item_id\": \"item_CCXLecNJVIVR2HUy3ABLj\",\n \"item\": {\n \"id\": \"item_CCXLfxmM5sXVJVz4mCa2S\",\n \"type\": \"message\",\n \"status\": \"completed\",\n \"role\": \"assistant\",\n \"content\": [\n {\n \"type\": \"output_audio\",\n \"transcript\": \"Oh, I can hear you loud and clear! Sounds like we're connected just fine. What can I help you with today?\"\n }\n ]\n }\n}\n"}},"RealtimeServerEventConversationItemInputAudioTranscriptionCompleted":{"type":"object","description":"This event is the output of audio transcription for user audio written to the\nuser audio buffer. Transcription begins when the input audio buffer is\ncommitted by the client or server (when VAD is enabled). Transcription runs\nasynchronously with Response creation, so this event may come before or after\nthe Response events.\n\nRealtime API models accept audio natively, and thus input transcription is a\nseparate process run on a separate ASR (Automatic Speech Recognition) model.\nThe transcript may diverge somewhat from the model's interpretation, and\nshould be treated as a rough guide.\n","properties":{"event_id":{"type":"string","description":"The unique ID of the server event."},"type":{"type":"string","enum":["conversation.item.input_audio_transcription.completed"],"description":"The event type, must be\n`conversation.item.input_audio_transcription.completed`.\n","x-stainless-const":true},"item_id":{"type":"string","description":"The ID of the item containing the audio that is being transcribed."},"content_index":{"type":"integer","description":"The index of the content part containing the audio."},"transcript":{"type":"string","description":"The transcribed text."},"logprobs":{"anyOf":[{"type":"array","description":"The log probabilities of the transcription.","items":{"$ref":"#/components/schemas/LogProbProperties"}},{"type":"null"}]},"usage":{"type":"object","description":"Usage statistics for the transcription, this is billed according to the ASR model's pricing rather than the realtime model's pricing.","oneOf":[{"$ref":"#/components/schemas/TranscriptTextUsageTokens","title":"Token Usage"},{"$ref":"#/components/schemas/TranscriptTextUsageDuration","title":"Duration Usage"}]}},"required":["event_id","type","item_id","content_index","transcript","usage"],"x-oaiMeta":{"name":"conversation.item.input_audio_transcription.completed","group":"realtime","example":"{\n \"type\": \"conversation.item.input_audio_transcription.completed\",\n \"event_id\": \"event_CCXGRvtUVrax5SJAnNOWZ\",\n \"item_id\": \"item_CCXGQ4e1ht4cOraEYcuR2\",\n \"content_index\": 0,\n \"transcript\": \"Hey, can you hear me?\",\n \"usage\": {\n \"type\": \"tokens\",\n \"total_tokens\": 22,\n \"input_tokens\": 13,\n \"input_token_details\": {\n \"text_tokens\": 0,\n \"audio_tokens\": 13\n },\n \"output_tokens\": 9\n }\n}\n"}},"RealtimeServerEventConversationItemInputAudioTranscriptionDelta":{"type":"object","description":"Returned when the text value of an input audio transcription content part is updated with incremental transcription results.\n","properties":{"event_id":{"type":"string","description":"The unique ID of the server event."},"type":{"type":"string","enum":["conversation.item.input_audio_transcription.delta"],"description":"The event type, must be `conversation.item.input_audio_transcription.delta`.","x-stainless-const":true},"item_id":{"type":"string","description":"The ID of the item containing the audio that is being transcribed."},"content_index":{"type":"integer","description":"The index of the content part in the item's content array."},"delta":{"type":"string","description":"The text delta."},"logprobs":{"anyOf":[{"type":"array","description":"The log probabilities of the transcription. These can be enabled by configurating the session with `\"include\": [\"item.input_audio_transcription.logprobs\"]`. Each entry in the array corresponds a log probability of which token would be selected for this chunk of transcription. This can help to identify if it was possible there were multiple valid options for a given chunk of transcription.","items":{"$ref":"#/components/schemas/LogProbProperties"}},{"type":"null"}]}},"required":["event_id","type","item_id"],"x-oaiMeta":{"name":"conversation.item.input_audio_transcription.delta","group":"realtime","example":"{\n \"type\": \"conversation.item.input_audio_transcription.delta\",\n \"event_id\": \"event_CCXGRxsAimPAs8kS2Wc7Z\",\n \"item_id\": \"item_CCXGQ4e1ht4cOraEYcuR2\",\n \"content_index\": 0,\n \"delta\": \"Hey\",\n \"obfuscation\": \"aLxx0jTEciOGe\"\n}\n"}},"RealtimeServerEventConversationItemInputAudioTranscriptionFailed":{"type":"object","description":"Returned when input audio transcription is configured, and a transcription \nrequest for a user message failed. These events are separate from other \n`error` events so that the client can identify the related Item.\n","properties":{"event_id":{"type":"string","description":"The unique ID of the server event."},"type":{"type":"string","enum":["conversation.item.input_audio_transcription.failed"],"description":"The event type, must be\n`conversation.item.input_audio_transcription.failed`.\n","x-stainless-const":true},"item_id":{"type":"string","description":"The ID of the user message item."},"content_index":{"type":"integer","description":"The index of the content part containing the audio."},"error":{"type":"object","description":"Details of the transcription error.","properties":{"type":{"type":"string","description":"The type of error."},"code":{"type":"string","description":"Error code, if any."},"message":{"type":"string","description":"A human-readable error message."},"param":{"type":"string","description":"Parameter related to the error, if any."}}}},"required":["event_id","type","item_id","content_index","error"],"x-oaiMeta":{"name":"conversation.item.input_audio_transcription.failed","group":"realtime","example":"{\n \"event_id\": \"event_2324\",\n \"type\": \"conversation.item.input_audio_transcription.failed\",\n \"item_id\": \"msg_003\",\n \"content_index\": 0,\n \"error\": {\n \"type\": \"transcription_error\",\n \"code\": \"audio_unintelligible\",\n \"message\": \"The audio could not be transcribed.\",\n \"param\": null\n }\n}\n"}},"RealtimeServerEventConversationItemInputAudioTranscriptionSegment":{"type":"object","description":"Returned when an input audio transcription segment is identified for an item.","properties":{"event_id":{"type":"string","description":"The unique ID of the server event."},"type":{"type":"string","enum":["conversation.item.input_audio_transcription.segment"],"description":"The event type, must be `conversation.item.input_audio_transcription.segment`.","x-stainless-const":true},"item_id":{"type":"string","description":"The ID of the item containing the input audio content."},"content_index":{"type":"integer","description":"The index of the input audio content part within the item."},"text":{"type":"string","description":"The text for this segment."},"id":{"type":"string","description":"The segment identifier."},"speaker":{"type":"string","description":"The detected speaker label for this segment."},"start":{"type":"number","format":"float","description":"Start time of the segment in seconds."},"end":{"type":"number","format":"float","description":"End time of the segment in seconds."}},"required":["event_id","type","item_id","content_index","text","id","speaker","start","end"],"x-oaiMeta":{"name":"conversation.item.input_audio_transcription.segment","group":"realtime","example":"{\n \"event_id\": \"event_6501\",\n \"type\": \"conversation.item.input_audio_transcription.segment\",\n \"item_id\": \"msg_011\",\n \"content_index\": 0,\n \"text\": \"hello\",\n \"id\": \"seg_0001\",\n \"speaker\": \"spk_1\",\n \"start\": 0.0,\n \"end\": 0.4\n}\n"}},"RealtimeServerEventConversationItemRetrieved":{"type":"object","description":"Returned when a conversation item is retrieved with `conversation.item.retrieve`. This is provided as a way to fetch the server's representation of an item, for example to get access to the post-processed audio data after noise cancellation and VAD. It includes the full content of the Item, including audio data.\n","properties":{"event_id":{"type":"string","description":"The unique ID of the server event."},"type":{"type":"string","enum":["conversation.item.retrieved"],"description":"The event type, must be `conversation.item.retrieved`.","x-stainless-const":true},"item":{"$ref":"#/components/schemas/RealtimeConversationItem"}},"required":["event_id","type","item"],"x-oaiMeta":{"name":"conversation.item.retrieved","group":"realtime","example":"{\n \"type\": \"conversation.item.retrieved\",\n \"event_id\": \"event_CCXGSizgEppa2d4XbKA7K\",\n \"item\": {\n \"id\": \"item_CCXGRxbY0n6WE4EszhF5w\",\n \"object\": \"realtime.item\",\n \"type\": \"message\",\n \"status\": \"completed\",\n \"role\": \"assistant\",\n \"content\": [\n {\n \"type\": \"audio\",\n \"transcript\": \"Yes, I can hear you loud and clear. How can I help you today?\",\n \"audio\": \"8//2//v/9//q/+//+P/s...\",\n \"format\": \"pcm16\"\n }\n ]\n }\n}\n"}},"RealtimeServerEventConversationItemTruncated":{"type":"object","description":"Returned when an earlier assistant audio message item is truncated by the \nclient with a `conversation.item.truncate` event. This event is used to \nsynchronize the server's understanding of the audio with the client's playback.\n\nThis action will truncate the audio and remove the server-side text transcript \nto ensure there is no text in the context that hasn't been heard by the user.\n","properties":{"event_id":{"type":"string","description":"The unique ID of the server event."},"type":{"type":"string","enum":["conversation.item.truncated"],"description":"The event type, must be `conversation.item.truncated`.","x-stainless-const":true},"item_id":{"type":"string","description":"The ID of the assistant message item that was truncated."},"content_index":{"type":"integer","description":"The index of the content part that was truncated."},"audio_end_ms":{"type":"integer","description":"The duration up to which the audio was truncated, in milliseconds.\n"}},"required":["event_id","type","item_id","content_index","audio_end_ms"],"x-oaiMeta":{"name":"conversation.item.truncated","group":"realtime","example":"{\n \"event_id\": \"event_2526\",\n \"type\": \"conversation.item.truncated\",\n \"item_id\": \"msg_004\",\n \"content_index\": 0,\n \"audio_end_ms\": 1500\n}\n"}},"RealtimeServerEventError":{"type":"object","description":"Returned when an error occurs, which could be a client problem or a server\nproblem. Most errors are recoverable and the session will stay open, we\nrecommend to implementors to monitor and log error messages by default.\n","properties":{"event_id":{"type":"string","description":"The unique ID of the server event."},"type":{"type":"string","enum":["error"],"description":"The event type, must be `error`.","x-stainless-const":true},"error":{"type":"object","description":"Details of the error.","required":["type","message"],"properties":{"type":{"type":"string","description":"The type of error (e.g., \"invalid_request_error\", \"server_error\").\n"},"code":{"anyOf":[{"type":"string","description":"Error code, if any."},{"type":"null"}]},"message":{"type":"string","description":"A human-readable error message."},"param":{"anyOf":[{"type":"string","description":"Parameter related to the error, if any."},{"type":"null"}]},"event_id":{"anyOf":[{"type":"string","description":"The event_id of the client event that caused the error, if applicable.\n"},{"type":"null"}]}}}},"required":["event_id","type","error"],"x-oaiMeta":{"name":"error","group":"realtime","example":"{\n \"event_id\": \"event_890\",\n \"type\": \"error\",\n \"error\": {\n \"type\": \"invalid_request_error\",\n \"code\": \"invalid_event\",\n \"message\": \"The 'type' field is missing.\",\n \"param\": null,\n \"event_id\": \"event_567\"\n }\n}\n"}},"RealtimeServerEventInputAudioBufferCleared":{"type":"object","description":"Returned when the input audio buffer is cleared by the client with a \n`input_audio_buffer.clear` event.\n","properties":{"event_id":{"type":"string","description":"The unique ID of the server event."},"type":{"type":"string","enum":["input_audio_buffer.cleared"],"description":"The event type, must be `input_audio_buffer.cleared`.","x-stainless-const":true}},"required":["event_id","type"],"x-oaiMeta":{"name":"input_audio_buffer.cleared","group":"realtime","example":"{\n \"event_id\": \"event_1314\",\n \"type\": \"input_audio_buffer.cleared\"\n}\n"}},"RealtimeServerEventInputAudioBufferCommitted":{"type":"object","description":"Returned when an input audio buffer is committed, either by the client or\nautomatically in server VAD mode. The `item_id` property is the ID of the user\nmessage item that will be created, thus a `conversation.item.created` event\nwill also be sent to the client.\n","properties":{"event_id":{"type":"string","description":"The unique ID of the server event."},"type":{"type":"string","enum":["input_audio_buffer.committed"],"description":"The event type, must be `input_audio_buffer.committed`.","x-stainless-const":true},"previous_item_id":{"anyOf":[{"type":"string","description":"The ID of the preceding item after which the new item will be inserted.\nCan be `null` if the item has no predecessor.\n"},{"type":"null"}]},"item_id":{"type":"string","description":"The ID of the user message item that will be created."}},"required":["event_id","type","item_id"],"x-oaiMeta":{"name":"input_audio_buffer.committed","group":"realtime","example":"{\n \"event_id\": \"event_1121\",\n \"type\": \"input_audio_buffer.committed\",\n \"previous_item_id\": \"msg_001\",\n \"item_id\": \"msg_002\"\n}\n"}},"RealtimeServerEventInputAudioBufferDtmfEventReceived":{"type":"object","description":"**SIP Only:** Returned when an DTMF event is received. A DTMF event is a message that\nrepresents a telephone keypad press (0–9, *, #, A–D). The `event` property\nis the keypad that the user press. The `received_at` is the UTC Unix Timestamp\nthat the server received the event.\n","properties":{"type":{"type":"string","enum":["input_audio_buffer.dtmf_event_received"],"description":"The event type, must be `input_audio_buffer.dtmf_event_received`.","x-stainless-const":true},"event":{"type":"string","description":"The telephone keypad that was pressed by the user."},"received_at":{"type":"integer","description":"UTC Unix Timestamp when DTMF Event was received by server.\n"}},"required":["type","event","received_at"],"x-oaiMeta":{"name":"input_audio_buffer.dtmf_event_received","group":"realtime","example":"{\n \"type\":\" input_audio_buffer.dtmf_event_received\",\n \"event\": \"9\",\n \"received_at\": 1763605109,\n}\n"}},"RealtimeServerEventInputAudioBufferSpeechStarted":{"type":"object","description":"Sent by the server when in `server_vad` mode to indicate that speech has been \ndetected in the audio buffer. This can happen any time audio is added to the \nbuffer (unless speech is already detected). The client may want to use this \nevent to interrupt audio playback or provide visual feedback to the user. \n\nThe client should expect to receive a `input_audio_buffer.speech_stopped` event \nwhen speech stops. The `item_id` property is the ID of the user message item \nthat will be created when speech stops and will also be included in the \n`input_audio_buffer.speech_stopped` event (unless the client manually commits \nthe audio buffer during VAD activation).\n","properties":{"event_id":{"type":"string","description":"The unique ID of the server event."},"type":{"type":"string","enum":["input_audio_buffer.speech_started"],"description":"The event type, must be `input_audio_buffer.speech_started`.","x-stainless-const":true},"audio_start_ms":{"type":"integer","description":"Milliseconds from the start of all audio written to the buffer during the \nsession when speech was first detected. This will correspond to the \nbeginning of audio sent to the model, and thus includes the \n`prefix_padding_ms` configured in the Session.\n"},"item_id":{"type":"string","description":"The ID of the user message item that will be created when speech stops.\n"}},"required":["event_id","type","audio_start_ms","item_id"],"x-oaiMeta":{"name":"input_audio_buffer.speech_started","group":"realtime","example":"{\n \"event_id\": \"event_1516\",\n \"type\": \"input_audio_buffer.speech_started\",\n \"audio_start_ms\": 1000,\n \"item_id\": \"msg_003\"\n}\n"}},"RealtimeServerEventInputAudioBufferSpeechStopped":{"type":"object","description":"Returned in `server_vad` mode when the server detects the end of speech in \nthe audio buffer. The server will also send an `conversation.item.created` \nevent with the user message item that is created from the audio buffer.\n","properties":{"event_id":{"type":"string","description":"The unique ID of the server event."},"type":{"type":"string","enum":["input_audio_buffer.speech_stopped"],"description":"The event type, must be `input_audio_buffer.speech_stopped`.","x-stainless-const":true},"audio_end_ms":{"type":"integer","description":"Milliseconds since the session started when speech stopped. This will \ncorrespond to the end of audio sent to the model, and thus includes the \n`min_silence_duration_ms` configured in the Session.\n"},"item_id":{"type":"string","description":"The ID of the user message item that will be created."}},"required":["event_id","type","audio_end_ms","item_id"],"x-oaiMeta":{"name":"input_audio_buffer.speech_stopped","group":"realtime","example":"{\n \"event_id\": \"event_1718\",\n \"type\": \"input_audio_buffer.speech_stopped\",\n \"audio_end_ms\": 2000,\n \"item_id\": \"msg_003\"\n}\n"}},"RealtimeServerEventInputAudioBufferTimeoutTriggered":{"type":"object","description":"Returned when the Server VAD timeout is triggered for the input audio buffer. This is configured\nwith `idle_timeout_ms` in the `turn_detection` settings of the session, and it indicates that\nthere hasn't been any speech detected for the configured duration.\n\nThe `audio_start_ms` and `audio_end_ms` fields indicate the segment of audio after the last\nmodel response up to the triggering time, as an offset from the beginning of audio written\nto the input audio buffer. This means it demarcates the segment of audio that was silent and\nthe difference between the start and end values will roughly match the configured timeout.\n\nThe empty audio will be committed to the conversation as an `input_audio` item (there will be a\n`input_audio_buffer.committed` event) and a model response will be generated. There may be speech\nthat didn't trigger VAD but is still detected by the model, so the model may respond with\nsomething relevant to the conversation or a prompt to continue speaking.\n","properties":{"event_id":{"type":"string","description":"The unique ID of the server event."},"type":{"type":"string","enum":["input_audio_buffer.timeout_triggered"],"description":"The event type, must be `input_audio_buffer.timeout_triggered`.","x-stainless-const":true},"audio_start_ms":{"type":"integer","description":"Millisecond offset of audio written to the input audio buffer that was after the playback time of the last model response."},"audio_end_ms":{"type":"integer","description":"Millisecond offset of audio written to the input audio buffer at the time the timeout was triggered."},"item_id":{"type":"string","description":"The ID of the item associated with this segment."}},"required":["event_id","type","audio_start_ms","audio_end_ms","item_id"],"x-oaiMeta":{"name":"input_audio_buffer.timeout_triggered","group":"realtime","example":"{\n \"type\":\"input_audio_buffer.timeout_triggered\",\n \"event_id\":\"event_CEKKrf1KTGvemCPyiJTJ2\",\n \"audio_start_ms\":13216,\n \"audio_end_ms\":19232,\n \"item_id\":\"item_CEKKrWH0GiwN0ET97NUZc\"\n}\n"}},"RealtimeServerEventMCPListToolsCompleted":{"type":"object","description":"Returned when listing MCP tools has completed for an item.","properties":{"event_id":{"type":"string","description":"The unique ID of the server event."},"type":{"type":"string","enum":["mcp_list_tools.completed"],"description":"The event type, must be `mcp_list_tools.completed`.","x-stainless-const":true},"item_id":{"type":"string","description":"The ID of the MCP list tools item."}},"required":["event_id","type","item_id"],"x-oaiMeta":{"name":"mcp_list_tools.completed","group":"realtime","example":"{\n \"event_id\": \"event_6102\",\n \"type\": \"mcp_list_tools.completed\",\n \"item_id\": \"mcp_list_tools_001\"\n}\n"}},"RealtimeServerEventMCPListToolsFailed":{"type":"object","description":"Returned when listing MCP tools has failed for an item.","properties":{"event_id":{"type":"string","description":"The unique ID of the server event."},"type":{"type":"string","enum":["mcp_list_tools.failed"],"description":"The event type, must be `mcp_list_tools.failed`.","x-stainless-const":true},"item_id":{"type":"string","description":"The ID of the MCP list tools item."}},"required":["event_id","type","item_id"],"x-oaiMeta":{"name":"mcp_list_tools.failed","group":"realtime","example":"{\n \"event_id\": \"event_6103\",\n \"type\": \"mcp_list_tools.failed\",\n \"item_id\": \"mcp_list_tools_001\"\n}\n"}},"RealtimeServerEventMCPListToolsInProgress":{"type":"object","description":"Returned when listing MCP tools is in progress for an item.","properties":{"event_id":{"type":"string","description":"The unique ID of the server event."},"type":{"type":"string","enum":["mcp_list_tools.in_progress"],"description":"The event type, must be `mcp_list_tools.in_progress`.","x-stainless-const":true},"item_id":{"type":"string","description":"The ID of the MCP list tools item."}},"required":["event_id","type","item_id"],"x-oaiMeta":{"name":"mcp_list_tools.in_progress","group":"realtime","example":"{\n \"event_id\": \"event_6101\",\n \"type\": \"mcp_list_tools.in_progress\",\n \"item_id\": \"mcp_list_tools_001\"\n}\n"}},"RealtimeServerEventOutputAudioBufferCleared":{"type":"object","description":"**WebRTC/SIP Only:** Emitted when the output audio buffer is cleared. This happens either in VAD\nmode when the user has interrupted (`input_audio_buffer.speech_started`),\nor when the client has emitted the `output_audio_buffer.clear` event to manually\ncut off the current audio response.\n[Learn more](/docs/guides/realtime-conversations#client-and-server-events-for-audio-in-webrtc).\n","properties":{"event_id":{"type":"string","description":"The unique ID of the server event."},"type":{"type":"string","enum":["output_audio_buffer.cleared"],"description":"The event type, must be `output_audio_buffer.cleared`.","x-stainless-const":true},"response_id":{"type":"string","description":"The unique ID of the response that produced the audio."}},"required":["event_id","type","response_id"],"x-oaiMeta":{"name":"output_audio_buffer.cleared","group":"realtime","example":"{\n \"event_id\": \"event_abc123\",\n \"type\": \"output_audio_buffer.cleared\",\n \"response_id\": \"resp_abc123\"\n}\n"}},"RealtimeServerEventOutputAudioBufferStarted":{"type":"object","description":"**WebRTC/SIP Only:** Emitted when the server begins streaming audio to the client. This event is\nemitted after an audio content part has been added (`response.content_part.added`)\nto the response.\n[Learn more](/docs/guides/realtime-conversations#client-and-server-events-for-audio-in-webrtc).\n","properties":{"event_id":{"type":"string","description":"The unique ID of the server event."},"type":{"type":"string","enum":["output_audio_buffer.started"],"description":"The event type, must be `output_audio_buffer.started`.","x-stainless-const":true},"response_id":{"type":"string","description":"The unique ID of the response that produced the audio."}},"required":["event_id","type","response_id"],"x-oaiMeta":{"name":"output_audio_buffer.started","group":"realtime","example":"{\n \"event_id\": \"event_abc123\",\n \"type\": \"output_audio_buffer.started\",\n \"response_id\": \"resp_abc123\"\n}\n"}},"RealtimeServerEventOutputAudioBufferStopped":{"type":"object","description":"**WebRTC/SIP Only:** Emitted when the output audio buffer has been completely drained on the server,\nand no more audio is forthcoming. This event is emitted after the full response\ndata has been sent to the client (`response.done`).\n[Learn more](/docs/guides/realtime-conversations#client-and-server-events-for-audio-in-webrtc).\n","properties":{"event_id":{"type":"string","description":"The unique ID of the server event."},"type":{"type":"string","enum":["output_audio_buffer.stopped"],"description":"The event type, must be `output_audio_buffer.stopped`.","x-stainless-const":true},"response_id":{"type":"string","description":"The unique ID of the response that produced the audio."}},"required":["event_id","type","response_id"],"x-oaiMeta":{"name":"output_audio_buffer.stopped","group":"realtime","example":"{\n \"event_id\": \"event_abc123\",\n \"type\": \"output_audio_buffer.stopped\",\n \"response_id\": \"resp_abc123\"\n}\n"}},"RealtimeServerEventRateLimitsUpdated":{"type":"object","description":"Emitted at the beginning of a Response to indicate the updated rate limits. \nWhen a Response is created some tokens will be \"reserved\" for the output \ntokens, the rate limits shown here reflect that reservation, which is then \nadjusted accordingly once the Response is completed.\n","properties":{"event_id":{"type":"string","description":"The unique ID of the server event."},"type":{"type":"string","enum":["rate_limits.updated"],"description":"The event type, must be `rate_limits.updated`.","x-stainless-const":true},"rate_limits":{"type":"array","description":"List of rate limit information.","items":{"type":"object","properties":{"name":{"type":"string","enum":["requests","tokens"],"description":"The name of the rate limit (`requests`, `tokens`).\n"},"limit":{"type":"integer","description":"The maximum allowed value for the rate limit."},"remaining":{"type":"integer","description":"The remaining value before the limit is reached."},"reset_seconds":{"type":"number","description":"Seconds until the rate limit resets."}}}}},"required":["event_id","type","rate_limits"],"x-oaiMeta":{"name":"rate_limits.updated","group":"realtime","example":"{\n \"event_id\": \"event_5758\",\n \"type\": \"rate_limits.updated\",\n \"rate_limits\": [\n {\n \"name\": \"requests\",\n \"limit\": 1000,\n \"remaining\": 999,\n \"reset_seconds\": 60\n },\n {\n \"name\": \"tokens\",\n \"limit\": 50000,\n \"remaining\": 49950,\n \"reset_seconds\": 60\n }\n ]\n}\n"}},"RealtimeServerEventResponseAudioDelta":{"type":"object","description":"Returned when the model-generated audio is updated.","properties":{"event_id":{"type":"string","description":"The unique ID of the server event."},"type":{"type":"string","enum":["response.output_audio.delta"],"description":"The event type, must be `response.output_audio.delta`.","x-stainless-const":true},"response_id":{"type":"string","description":"The ID of the response."},"item_id":{"type":"string","description":"The ID of the item."},"output_index":{"type":"integer","description":"The index of the output item in the response."},"content_index":{"type":"integer","description":"The index of the content part in the item's content array."},"delta":{"type":"string","description":"Base64-encoded audio data delta."}},"required":["event_id","type","response_id","item_id","output_index","content_index","delta"],"x-oaiMeta":{"name":"response.output_audio.delta","group":"realtime","example":"{\n \"event_id\": \"event_4950\",\n \"type\": \"response.output_audio.delta\",\n \"response_id\": \"resp_001\",\n \"item_id\": \"msg_008\",\n \"output_index\": 0,\n \"content_index\": 0,\n \"delta\": \"Base64EncodedAudioDelta\"\n}\n"}},"RealtimeServerEventResponseAudioDone":{"type":"object","description":"Returned when the model-generated audio is done. Also emitted when a Response\nis interrupted, incomplete, or cancelled.\n","properties":{"event_id":{"type":"string","description":"The unique ID of the server event."},"type":{"type":"string","enum":["response.output_audio.done"],"description":"The event type, must be `response.output_audio.done`.","x-stainless-const":true},"response_id":{"type":"string","description":"The ID of the response."},"item_id":{"type":"string","description":"The ID of the item."},"output_index":{"type":"integer","description":"The index of the output item in the response."},"content_index":{"type":"integer","description":"The index of the content part in the item's content array."}},"required":["event_id","type","response_id","item_id","output_index","content_index"],"x-oaiMeta":{"name":"response.output_audio.done","group":"realtime","example":"{\n \"event_id\": \"event_5152\",\n \"type\": \"response.output_audio.done\",\n \"response_id\": \"resp_001\",\n \"item_id\": \"msg_008\",\n \"output_index\": 0,\n \"content_index\": 0\n}\n"}},"RealtimeServerEventResponseAudioTranscriptDelta":{"type":"object","description":"Returned when the model-generated transcription of audio output is updated.\n","properties":{"event_id":{"type":"string","description":"The unique ID of the server event."},"type":{"type":"string","enum":["response.output_audio_transcript.delta"],"description":"The event type, must be `response.output_audio_transcript.delta`.","x-stainless-const":true},"response_id":{"type":"string","description":"The ID of the response."},"item_id":{"type":"string","description":"The ID of the item."},"output_index":{"type":"integer","description":"The index of the output item in the response."},"content_index":{"type":"integer","description":"The index of the content part in the item's content array."},"delta":{"type":"string","description":"The transcript delta."}},"required":["event_id","type","response_id","item_id","output_index","content_index","delta"],"x-oaiMeta":{"name":"response.output_audio_transcript.delta","group":"realtime","example":"{\n \"event_id\": \"event_4546\",\n \"type\": \"response.output_audio_transcript.delta\",\n \"response_id\": \"resp_001\",\n \"item_id\": \"msg_008\",\n \"output_index\": 0,\n \"content_index\": 0,\n \"delta\": \"Hello, how can I a\"\n}\n"}},"RealtimeServerEventResponseAudioTranscriptDone":{"type":"object","description":"Returned when the model-generated transcription of audio output is done\nstreaming. Also emitted when a Response is interrupted, incomplete, or\ncancelled.\n","properties":{"event_id":{"type":"string","description":"The unique ID of the server event."},"type":{"type":"string","enum":["response.output_audio_transcript.done"],"description":"The event type, must be `response.output_audio_transcript.done`.","x-stainless-const":true},"response_id":{"type":"string","description":"The ID of the response."},"item_id":{"type":"string","description":"The ID of the item."},"output_index":{"type":"integer","description":"The index of the output item in the response."},"content_index":{"type":"integer","description":"The index of the content part in the item's content array."},"transcript":{"type":"string","description":"The final transcript of the audio."}},"required":["event_id","type","response_id","item_id","output_index","content_index","transcript"],"x-oaiMeta":{"name":"response.output_audio_transcript.done","group":"realtime","example":"{\n \"event_id\": \"event_4748\",\n \"type\": \"response.output_audio_transcript.done\",\n \"response_id\": \"resp_001\",\n \"item_id\": \"msg_008\",\n \"output_index\": 0,\n \"content_index\": 0,\n \"transcript\": \"Hello, how can I assist you today?\"\n}\n"}},"RealtimeServerEventResponseContentPartAdded":{"type":"object","description":"Returned when a new content part is added to an assistant message item during\nresponse generation.\n","properties":{"event_id":{"type":"string","description":"The unique ID of the server event."},"type":{"type":"string","enum":["response.content_part.added"],"description":"The event type, must be `response.content_part.added`.","x-stainless-const":true},"response_id":{"type":"string","description":"The ID of the response."},"item_id":{"type":"string","description":"The ID of the item to which the content part was added."},"output_index":{"type":"integer","description":"The index of the output item in the response."},"content_index":{"type":"integer","description":"The index of the content part in the item's content array."},"part":{"type":"object","description":"The content part that was added.","properties":{"type":{"type":"string","enum":["audio","text"],"description":"The content type (\"text\", \"audio\")."},"text":{"type":"string","description":"The text content (if type is \"text\")."},"audio":{"type":"string","description":"Base64-encoded audio data (if type is \"audio\")."},"transcript":{"type":"string","description":"The transcript of the audio (if type is \"audio\")."}}}},"required":["event_id","type","response_id","item_id","output_index","content_index","part"],"x-oaiMeta":{"name":"response.content_part.added","group":"realtime","example":"{\n \"event_id\": \"event_3738\",\n \"type\": \"response.content_part.added\",\n \"response_id\": \"resp_001\",\n \"item_id\": \"msg_007\",\n \"output_index\": 0,\n \"content_index\": 0,\n \"part\": {\n \"type\": \"text\",\n \"text\": \"\"\n }\n}\n"}},"RealtimeServerEventResponseContentPartDone":{"type":"object","description":"Returned when a content part is done streaming in an assistant message item.\nAlso emitted when a Response is interrupted, incomplete, or cancelled.\n","properties":{"event_id":{"type":"string","description":"The unique ID of the server event."},"type":{"type":"string","enum":["response.content_part.done"],"description":"The event type, must be `response.content_part.done`.","x-stainless-const":true},"response_id":{"type":"string","description":"The ID of the response."},"item_id":{"type":"string","description":"The ID of the item."},"output_index":{"type":"integer","description":"The index of the output item in the response."},"content_index":{"type":"integer","description":"The index of the content part in the item's content array."},"part":{"type":"object","description":"The content part that is done.","properties":{"type":{"type":"string","enum":["audio","text"],"description":"The content type (\"text\", \"audio\")."},"text":{"type":"string","description":"The text content (if type is \"text\")."},"audio":{"type":"string","description":"Base64-encoded audio data (if type is \"audio\")."},"transcript":{"type":"string","description":"The transcript of the audio (if type is \"audio\")."}}}},"required":["event_id","type","response_id","item_id","output_index","content_index","part"],"x-oaiMeta":{"name":"response.content_part.done","group":"realtime","example":"{\n \"event_id\": \"event_3940\",\n \"type\": \"response.content_part.done\",\n \"response_id\": \"resp_001\",\n \"item_id\": \"msg_007\",\n \"output_index\": 0,\n \"content_index\": 0,\n \"part\": {\n \"type\": \"text\",\n \"text\": \"Sure, I can help with that.\"\n }\n}\n"}},"RealtimeServerEventResponseCreated":{"type":"object","description":"Returned when a new Response is created. The first event of response creation,\nwhere the response is in an initial state of `in_progress`.\n","properties":{"event_id":{"type":"string","description":"The unique ID of the server event."},"type":{"type":"string","enum":["response.created"],"description":"The event type, must be `response.created`.","x-stainless-const":true},"response":{"$ref":"#/components/schemas/RealtimeResponse"}},"required":["event_id","type","response"],"x-oaiMeta":{"name":"response.created","group":"realtime","example":"{\n \"type\": \"response.created\",\n \"event_id\": \"event_C9G8pqbTEddBSIxbBN6Os\",\n \"response\": {\n \"object\": \"realtime.response\",\n \"id\": \"resp_C9G8p7IH2WxLbkgPNouYL\",\n \"status\": \"in_progress\",\n \"status_details\": null,\n \"output\": [],\n \"conversation_id\": \"conv_C9G8mmBkLhQJwCon3hoJN\",\n \"output_modalities\": [\n \"audio\"\n ],\n \"max_output_tokens\": \"inf\",\n \"audio\": {\n \"output\": {\n \"format\": {\n \"type\": \"audio/pcm\",\n \"rate\": 24000\n },\n \"voice\": \"marin\"\n }\n },\n \"usage\": null,\n \"metadata\": null\n },\n}\n"}},"RealtimeServerEventResponseDone":{"type":"object","description":"Returned when a Response is done streaming. Always emitted, no matter the \nfinal state. The Response object included in the `response.done` event will \ninclude all output Items in the Response but will omit the raw audio data.\n\nClients should check the `status` field of the Response to determine if it was successful\n(`completed`) or if there was another outcome: `cancelled`, `failed`, or `incomplete`.\n\nA response will contain all output items that were generated during the response, excluding\nany audio content.\n","properties":{"event_id":{"type":"string","description":"The unique ID of the server event."},"type":{"type":"string","enum":["response.done"],"description":"The event type, must be `response.done`.","x-stainless-const":true},"response":{"$ref":"#/components/schemas/RealtimeResponse"}},"required":["event_id","type","response"],"x-oaiMeta":{"name":"response.done","group":"realtime","example":"{\n \"type\": \"response.done\",\n \"event_id\": \"event_CCXHxcMy86rrKhBLDdqCh\",\n \"response\": {\n \"object\": \"realtime.response\",\n \"id\": \"resp_CCXHw0UJld10EzIUXQCNh\",\n \"status\": \"completed\",\n \"status_details\": null,\n \"output\": [\n {\n \"id\": \"item_CCXHwGjjDUfOXbiySlK7i\",\n \"type\": \"message\",\n \"status\": \"completed\",\n \"role\": \"assistant\",\n \"content\": [\n {\n \"type\": \"output_audio\",\n \"transcript\": \"Loud and clear! I can hear you perfectly. How can I help you today?\"\n }\n ]\n }\n ],\n \"conversation_id\": \"conv_CCXHsurMKcaVxIZvaCI5m\",\n \"output_modalities\": [\n \"audio\"\n ],\n \"max_output_tokens\": \"inf\",\n \"audio\": {\n \"output\": {\n \"format\": {\n \"type\": \"audio/pcm\",\n \"rate\": 24000\n },\n \"voice\": \"alloy\"\n }\n },\n \"usage\": {\n \"total_tokens\": 253,\n \"input_tokens\": 132,\n \"output_tokens\": 121,\n \"input_token_details\": {\n \"text_tokens\": 119,\n \"audio_tokens\": 13,\n \"image_tokens\": 0,\n \"cached_tokens\": 64,\n \"cached_tokens_details\": {\n \"text_tokens\": 64,\n \"audio_tokens\": 0,\n \"image_tokens\": 0\n }\n },\n \"output_token_details\": {\n \"text_tokens\": 30,\n \"audio_tokens\": 91\n }\n },\n \"metadata\": null\n }\n}\n"}},"RealtimeServerEventResponseFunctionCallArgumentsDelta":{"type":"object","description":"Returned when the model-generated function call arguments are updated.\n","properties":{"event_id":{"type":"string","description":"The unique ID of the server event."},"type":{"type":"string","enum":["response.function_call_arguments.delta"],"description":"The event type, must be `response.function_call_arguments.delta`.\n","x-stainless-const":true},"response_id":{"type":"string","description":"The ID of the response."},"item_id":{"type":"string","description":"The ID of the function call item."},"output_index":{"type":"integer","description":"The index of the output item in the response."},"call_id":{"type":"string","description":"The ID of the function call."},"delta":{"type":"string","description":"The arguments delta as a JSON string."}},"required":["event_id","type","response_id","item_id","output_index","call_id","delta"],"x-oaiMeta":{"name":"response.function_call_arguments.delta","group":"realtime","example":"{\n \"event_id\": \"event_5354\",\n \"type\": \"response.function_call_arguments.delta\",\n \"response_id\": \"resp_002\",\n \"item_id\": \"fc_001\",\n \"output_index\": 0,\n \"call_id\": \"call_001\",\n \"delta\": \"{\\\"location\\\": \\\"San\\\"\"\n}\n"}},"RealtimeServerEventResponseFunctionCallArgumentsDone":{"type":"object","description":"Returned when the model-generated function call arguments are done streaming.\nAlso emitted when a Response is interrupted, incomplete, or cancelled.\n","properties":{"event_id":{"type":"string","description":"The unique ID of the server event."},"type":{"type":"string","enum":["response.function_call_arguments.done"],"description":"The event type, must be `response.function_call_arguments.done`.\n","x-stainless-const":true},"response_id":{"type":"string","description":"The ID of the response."},"item_id":{"type":"string","description":"The ID of the function call item."},"output_index":{"type":"integer","description":"The index of the output item in the response."},"call_id":{"type":"string","description":"The ID of the function call."},"name":{"type":"string","description":"The name of the function that was called."},"arguments":{"type":"string","description":"The final arguments as a JSON string."}},"required":["event_id","type","response_id","item_id","output_index","call_id","name","arguments"],"x-oaiMeta":{"name":"response.function_call_arguments.done","group":"realtime","example":"{\n \"event_id\": \"event_5556\",\n \"type\": \"response.function_call_arguments.done\",\n \"response_id\": \"resp_002\",\n \"item_id\": \"fc_001\",\n \"output_index\": 0,\n \"call_id\": \"call_001\",\n \"name\": \"get_weather\",\n \"arguments\": \"{\\\"location\\\": \\\"San Francisco\\\"}\"\n}\n"}},"RealtimeServerEventResponseMCPCallArgumentsDelta":{"type":"object","description":"Returned when MCP tool call arguments are updated during response generation.","properties":{"event_id":{"type":"string","description":"The unique ID of the server event."},"type":{"type":"string","enum":["response.mcp_call_arguments.delta"],"description":"The event type, must be `response.mcp_call_arguments.delta`.","x-stainless-const":true},"response_id":{"type":"string","description":"The ID of the response."},"item_id":{"type":"string","description":"The ID of the MCP tool call item."},"output_index":{"type":"integer","description":"The index of the output item in the response."},"delta":{"type":"string","description":"The JSON-encoded arguments delta."},"obfuscation":{"anyOf":[{"type":"string","description":"If present, indicates the delta text was obfuscated."},{"type":"null"}]}},"required":["event_id","type","response_id","item_id","output_index","delta"],"x-oaiMeta":{"name":"response.mcp_call_arguments.delta","group":"realtime","example":"{\n \"event_id\": \"event_6201\",\n \"type\": \"response.mcp_call_arguments.delta\",\n \"response_id\": \"resp_001\",\n \"item_id\": \"mcp_call_001\",\n \"output_index\": 0,\n \"delta\": \"{\\\"partial\\\":true}\"\n}\n"}},"RealtimeServerEventResponseMCPCallArgumentsDone":{"type":"object","description":"Returned when MCP tool call arguments are finalized during response generation.","properties":{"event_id":{"type":"string","description":"The unique ID of the server event."},"type":{"type":"string","enum":["response.mcp_call_arguments.done"],"description":"The event type, must be `response.mcp_call_arguments.done`.","x-stainless-const":true},"response_id":{"type":"string","description":"The ID of the response."},"item_id":{"type":"string","description":"The ID of the MCP tool call item."},"output_index":{"type":"integer","description":"The index of the output item in the response."},"arguments":{"type":"string","description":"The final JSON-encoded arguments string."}},"required":["event_id","type","response_id","item_id","output_index","arguments"],"x-oaiMeta":{"name":"response.mcp_call_arguments.done","group":"realtime","example":"{\n \"event_id\": \"event_6202\",\n \"type\": \"response.mcp_call_arguments.done\",\n \"response_id\": \"resp_001\",\n \"item_id\": \"mcp_call_001\",\n \"output_index\": 0,\n \"arguments\": \"{\\\"q\\\":\\\"docs\\\"}\"\n}\n"}},"RealtimeServerEventResponseMCPCallCompleted":{"type":"object","description":"Returned when an MCP tool call has completed successfully.","properties":{"event_id":{"type":"string","description":"The unique ID of the server event."},"type":{"type":"string","enum":["response.mcp_call.completed"],"description":"The event type, must be `response.mcp_call.completed`.","x-stainless-const":true},"output_index":{"type":"integer","description":"The index of the output item in the response."},"item_id":{"type":"string","description":"The ID of the MCP tool call item."}},"required":["event_id","type","output_index","item_id"],"x-oaiMeta":{"name":"response.mcp_call.completed","group":"realtime","example":"{\n \"event_id\": \"event_6302\",\n \"type\": \"response.mcp_call.completed\",\n \"output_index\": 0,\n \"item_id\": \"mcp_call_001\"\n}\n"}},"RealtimeServerEventResponseMCPCallFailed":{"type":"object","description":"Returned when an MCP tool call has failed.","properties":{"event_id":{"type":"string","description":"The unique ID of the server event."},"type":{"type":"string","enum":["response.mcp_call.failed"],"description":"The event type, must be `response.mcp_call.failed`.","x-stainless-const":true},"output_index":{"type":"integer","description":"The index of the output item in the response."},"item_id":{"type":"string","description":"The ID of the MCP tool call item."}},"required":["event_id","type","output_index","item_id"],"x-oaiMeta":{"name":"response.mcp_call.failed","group":"realtime","example":"{\n \"event_id\": \"event_6303\",\n \"type\": \"response.mcp_call.failed\",\n \"output_index\": 0,\n \"item_id\": \"mcp_call_001\"\n}\n"}},"RealtimeServerEventResponseMCPCallInProgress":{"type":"object","description":"Returned when an MCP tool call has started and is in progress.","properties":{"event_id":{"type":"string","description":"The unique ID of the server event."},"type":{"type":"string","enum":["response.mcp_call.in_progress"],"description":"The event type, must be `response.mcp_call.in_progress`.","x-stainless-const":true},"output_index":{"type":"integer","description":"The index of the output item in the response."},"item_id":{"type":"string","description":"The ID of the MCP tool call item."}},"required":["event_id","type","output_index","item_id"],"x-oaiMeta":{"name":"response.mcp_call.in_progress","group":"realtime","example":"{\n \"event_id\": \"event_6301\",\n \"type\": \"response.mcp_call.in_progress\",\n \"output_index\": 0,\n \"item_id\": \"mcp_call_001\"\n}\n"}},"RealtimeServerEventResponseOutputItemAdded":{"type":"object","description":"Returned when a new Item is created during Response generation.","properties":{"event_id":{"type":"string","description":"The unique ID of the server event."},"type":{"type":"string","enum":["response.output_item.added"],"description":"The event type, must be `response.output_item.added`.","x-stainless-const":true},"response_id":{"type":"string","description":"The ID of the Response to which the item belongs."},"output_index":{"type":"integer","description":"The index of the output item in the Response."},"item":{"$ref":"#/components/schemas/RealtimeConversationItem"}},"required":["event_id","type","response_id","output_index","item"],"x-oaiMeta":{"name":"response.output_item.added","group":"realtime","example":"{\n \"event_id\": \"event_3334\",\n \"type\": \"response.output_item.added\",\n \"response_id\": \"resp_001\",\n \"output_index\": 0,\n \"item\": {\n \"id\": \"msg_007\",\n \"object\": \"realtime.item\",\n \"type\": \"message\",\n \"status\": \"in_progress\",\n \"role\": \"assistant\",\n \"content\": []\n }\n}\n"}},"RealtimeServerEventResponseOutputItemDone":{"type":"object","description":"Returned when an Item is done streaming. Also emitted when a Response is \ninterrupted, incomplete, or cancelled.\n","properties":{"event_id":{"type":"string","description":"The unique ID of the server event."},"type":{"type":"string","enum":["response.output_item.done"],"description":"The event type, must be `response.output_item.done`.","x-stainless-const":true},"response_id":{"type":"string","description":"The ID of the Response to which the item belongs."},"output_index":{"type":"integer","description":"The index of the output item in the Response."},"item":{"$ref":"#/components/schemas/RealtimeConversationItem"}},"required":["event_id","type","response_id","output_index","item"],"x-oaiMeta":{"name":"response.output_item.done","group":"realtime","example":"{\n \"event_id\": \"event_3536\",\n \"type\": \"response.output_item.done\",\n \"response_id\": \"resp_001\",\n \"output_index\": 0,\n \"item\": {\n \"id\": \"msg_007\",\n \"object\": \"realtime.item\",\n \"type\": \"message\",\n \"status\": \"completed\",\n \"role\": \"assistant\",\n \"content\": [\n {\n \"type\": \"text\",\n \"text\": \"Sure, I can help with that.\"\n }\n ]\n }\n}\n"}},"RealtimeServerEventResponseTextDelta":{"type":"object","description":"Returned when the text value of an \"output_text\" content part is updated.","properties":{"event_id":{"type":"string","description":"The unique ID of the server event."},"type":{"type":"string","enum":["response.output_text.delta"],"description":"The event type, must be `response.output_text.delta`.","x-stainless-const":true},"response_id":{"type":"string","description":"The ID of the response."},"item_id":{"type":"string","description":"The ID of the item."},"output_index":{"type":"integer","description":"The index of the output item in the response."},"content_index":{"type":"integer","description":"The index of the content part in the item's content array."},"delta":{"type":"string","description":"The text delta."}},"required":["event_id","type","response_id","item_id","output_index","content_index","delta"],"x-oaiMeta":{"name":"response.output_text.delta","group":"realtime","example":"{\n \"event_id\": \"event_4142\",\n \"type\": \"response.output_text.delta\",\n \"response_id\": \"resp_001\",\n \"item_id\": \"msg_007\",\n \"output_index\": 0,\n \"content_index\": 0,\n \"delta\": \"Sure, I can h\"\n}\n"}},"RealtimeServerEventResponseTextDone":{"type":"object","description":"Returned when the text value of an \"output_text\" content part is done streaming. Also\nemitted when a Response is interrupted, incomplete, or cancelled.\n","properties":{"event_id":{"type":"string","description":"The unique ID of the server event."},"type":{"type":"string","enum":["response.output_text.done"],"description":"The event type, must be `response.output_text.done`.","x-stainless-const":true},"response_id":{"type":"string","description":"The ID of the response."},"item_id":{"type":"string","description":"The ID of the item."},"output_index":{"type":"integer","description":"The index of the output item in the response."},"content_index":{"type":"integer","description":"The index of the content part in the item's content array."},"text":{"type":"string","description":"The final text content."}},"required":["event_id","type","response_id","item_id","output_index","content_index","text"],"x-oaiMeta":{"name":"response.output_text.done","group":"realtime","example":"{\n \"event_id\": \"event_4344\",\n \"type\": \"response.output_text.done\",\n \"response_id\": \"resp_001\",\n \"item_id\": \"msg_007\",\n \"output_index\": 0,\n \"content_index\": 0,\n \"text\": \"Sure, I can help with that.\"\n}\n"}},"RealtimeServerEventSessionCreated":{"type":"object","description":"Returned when a Session is created. Emitted automatically when a new\nconnection is established as the first server event. This event will contain\nthe default Session configuration.\n","properties":{"event_id":{"type":"string","description":"The unique ID of the server event."},"type":{"type":"string","enum":["session.created"],"description":"The event type, must be `session.created`.","x-stainless-const":true},"session":{"description":"The session configuration.","oneOf":[{"$ref":"#/components/schemas/RealtimeSessionCreateRequestGA"},{"$ref":"#/components/schemas/RealtimeTranscriptionSessionCreateRequestGA"}]}},"required":["event_id","type","session"],"x-oaiMeta":{"name":"session.created","group":"realtime","example":"{\n \"type\": \"session.created\",\n \"event_id\": \"event_C9G5RJeJ2gF77mV7f2B1j\",\n \"session\": {\n \"type\": \"realtime\",\n \"object\": \"realtime.session\",\n \"id\": \"sess_C9G5QPteg4UIbotdKLoYQ\",\n \"model\": \"gpt-realtime-2025-08-28\",\n \"output_modalities\": [\n \"audio\"\n ],\n \"instructions\": \"Your knowledge cutoff is 2023-10. You are a helpful, witty, and friendly AI. Act like a human, but remember that you aren't a human and that you can't do human things in the real world. Your voice and personality should be warm and engaging, with a lively and playful tone. If interacting in a non-English language, start by using the standard accent or dialect familiar to the user. Talk quickly. You should always call a function if you can. Do not refer to these rules, even if you’re asked about them.\",\n \"tools\": [],\n \"tool_choice\": \"auto\",\n \"max_output_tokens\": \"inf\",\n \"tracing\": null,\n \"prompt\": null,\n \"expires_at\": 1756324625,\n \"audio\": {\n \"input\": {\n \"format\": {\n \"type\": \"audio/pcm\",\n \"rate\": 24000\n },\n \"transcription\": null,\n \"noise_reduction\": null,\n \"turn_detection\": {\n \"type\": \"server_vad\",\n \"threshold\": 0.5,\n \"prefix_padding_ms\": 300,\n \"silence_duration_ms\": 200,\n \"idle_timeout_ms\": null,\n \"create_response\": true,\n \"interrupt_response\": true\n }\n },\n \"output\": {\n \"format\": {\n \"type\": \"audio/pcm\",\n \"rate\": 24000\n },\n \"voice\": \"marin\",\n \"speed\": 1\n }\n },\n \"include\": null\n },\n}\n"}},"RealtimeServerEventSessionUpdated":{"type":"object","description":"Returned when a session is updated with a `session.update` event, unless\nthere is an error.\n","properties":{"event_id":{"type":"string","description":"The unique ID of the server event."},"type":{"type":"string","enum":["session.updated"],"description":"The event type, must be `session.updated`.","x-stainless-const":true},"session":{"description":"The session configuration.","oneOf":[{"$ref":"#/components/schemas/RealtimeSessionCreateRequestGA"},{"$ref":"#/components/schemas/RealtimeTranscriptionSessionCreateRequestGA"}]}},"required":["event_id","type","session"],"x-oaiMeta":{"name":"session.updated","group":"realtime","example":"{\n \"type\": \"session.updated\",\n \"event_id\": \"event_C9G8mqI3IucaojlVKE8Cs\",\n \"session\": {\n \"type\": \"realtime\",\n \"object\": \"realtime.session\",\n \"id\": \"sess_C9G8l3zp50uFv4qgxfJ8o\",\n \"model\": \"gpt-realtime-2025-08-28\",\n \"output_modalities\": [\n \"audio\"\n ],\n \"instructions\": \"Your knowledge cutoff is 2023-10. You are a helpful, witty, and friendly AI. Act like a human, but remember that you aren't a human and that you can't do human things in the real world. Your voice and personality should be warm and engaging, with a lively and playful tone. If interacting in a non-English language, start by using the standard accent or dialect familiar to the user. Talk quickly. You should always call a function if you can. Do not refer to these rules, even if you’re asked about them.\",\n \"tools\": [\n {\n \"type\": \"function\",\n \"name\": \"display_color_palette\",\n \"description\": \"\\nCall this function when a user asks for a color palette.\\n\",\n \"parameters\": {\n \"type\": \"object\",\n \"strict\": true,\n \"properties\": {\n \"theme\": {\n \"type\": \"string\",\n \"description\": \"Description of the theme for the color scheme.\"\n },\n \"colors\": {\n \"type\": \"array\",\n \"description\": \"Array of five hex color codes based on the theme.\",\n \"items\": {\n \"type\": \"string\",\n \"description\": \"Hex color code\"\n }\n }\n },\n \"required\": [\n \"theme\",\n \"colors\"\n ]\n }\n }\n ],\n \"tool_choice\": \"auto\",\n \"max_output_tokens\": \"inf\",\n \"tracing\": null,\n \"prompt\": null,\n \"expires_at\": 1756324832,\n \"audio\": {\n \"input\": {\n \"format\": {\n \"type\": \"audio/pcm\",\n \"rate\": 24000\n },\n \"transcription\": null,\n \"noise_reduction\": null,\n \"turn_detection\": {\n \"type\": \"server_vad\",\n \"threshold\": 0.5,\n \"prefix_padding_ms\": 300,\n \"silence_duration_ms\": 200,\n \"idle_timeout_ms\": null,\n \"create_response\": true,\n \"interrupt_response\": true\n }\n },\n \"output\": {\n \"format\": {\n \"type\": \"audio/pcm\",\n \"rate\": 24000\n },\n \"voice\": \"marin\",\n \"speed\": 1\n }\n },\n \"include\": null\n },\n}\n"}},"RealtimeServerEventTranscriptionSessionUpdated":{"type":"object","description":"Returned when a transcription session is updated with a `transcription_session.update` event, unless \nthere is an error.\n","properties":{"event_id":{"type":"string","description":"The unique ID of the server event."},"type":{"type":"string","enum":["transcription_session.updated"],"description":"The event type, must be `transcription_session.updated`.","x-stainless-const":true},"session":{"$ref":"#/components/schemas/RealtimeTranscriptionSessionCreateResponse"}},"required":["event_id","type","session"],"x-oaiMeta":{"name":"transcription_session.updated","group":"realtime","example":"{\n \"event_id\": \"event_5678\",\n \"type\": \"transcription_session.updated\",\n \"session\": {\n \"id\": \"sess_001\",\n \"object\": \"realtime.transcription_session\",\n \"input_audio_format\": \"pcm16\",\n \"input_audio_transcription\": {\n \"model\": \"gpt-4o-transcribe\",\n \"prompt\": \"\",\n \"language\": \"\"\n },\n \"turn_detection\": {\n \"type\": \"server_vad\",\n \"threshold\": 0.5,\n \"prefix_padding_ms\": 300,\n \"silence_duration_ms\": 500,\n \"create_response\": true,\n // \"interrupt_response\": false -- this will NOT be returned\n },\n \"input_audio_noise_reduction\": {\n \"type\": \"near_field\"\n },\n \"include\": [\n \"item.input_audio_transcription.avg_logprob\",\n ],\n }\n}\n"}},"RealtimeSession":{"type":"object","description":"Realtime session object for the beta interface.","properties":{"id":{"type":"string","description":"Unique identifier for the session that looks like `sess_1234567890abcdef`.\n"},"object":{"type":"string","enum":["realtime.session"],"description":"The object type. Always `realtime.session`."},"modalities":{"description":"The set of modalities the model can respond with. To disable audio,\nset this to [\"text\"].\n","items":{"type":"string","default":["text","audio"],"enum":["text","audio"]}},"model":{"description":"The Realtime model used for this session.\n","anyOf":[{"type":"string"},{"type":"string","enum":["gpt-realtime","gpt-realtime-1.5","gpt-realtime-2025-08-28","gpt-4o-realtime-preview","gpt-4o-realtime-preview-2024-10-01","gpt-4o-realtime-preview-2024-12-17","gpt-4o-realtime-preview-2025-06-03","gpt-4o-mini-realtime-preview","gpt-4o-mini-realtime-preview-2024-12-17","gpt-realtime-mini","gpt-realtime-mini-2025-10-06","gpt-realtime-mini-2025-12-15","gpt-audio-1.5","gpt-audio-mini","gpt-audio-mini-2025-10-06","gpt-audio-mini-2025-12-15"]}]},"instructions":{"type":"string","description":"The default system instructions (i.e. system message) prepended to model\ncalls. This field allows the client to guide the model on desired\nresponses. The model can be instructed on response content and format,\n(e.g. \"be extremely succinct\", \"act friendly\", \"here are examples of good\nresponses\") and on audio behavior (e.g. \"talk quickly\", \"inject emotion\ninto your voice\", \"laugh frequently\"). The instructions are not\nguaranteed to be followed by the model, but they provide guidance to the\nmodel on the desired behavior.\n\n\nNote that the server sets default instructions which will be used if this\nfield is not set and are visible in the `session.created` event at the\nstart of the session.\n"},"voice":{"$ref":"#/components/schemas/VoiceIdsShared","description":"The voice the model uses to respond. Voice cannot be changed during the\nsession once the model has responded with audio at least once. Current\nvoice options are `alloy`, `ash`, `ballad`, `coral`, `echo`, `sage`,\n`shimmer`, and `verse`.\n"},"input_audio_format":{"type":"string","default":"pcm16","enum":["pcm16","g711_ulaw","g711_alaw"],"description":"The format of input audio. Options are `pcm16`, `g711_ulaw`, or `g711_alaw`.\nFor `pcm16`, input audio must be 16-bit PCM at a 24kHz sample rate,\nsingle channel (mono), and little-endian byte order.\n"},"output_audio_format":{"type":"string","default":"pcm16","enum":["pcm16","g711_ulaw","g711_alaw"],"description":"The format of output audio. Options are `pcm16`, `g711_ulaw`, or `g711_alaw`.\nFor `pcm16`, output audio is sampled at a rate of 24kHz.\n"},"input_audio_transcription":{"anyOf":[{"allOf":[{"$ref":"#/components/schemas/AudioTranscription"}],"description":"Configuration for input audio transcription, defaults to off and can be set to `null` to turn off once on. Input audio transcription is not native to the model, since the model consumes audio directly. Transcription runs asynchronously through [the /audio/transcriptions endpoint](https://platform.openai.com/docs/api-reference/audio/createTranscription) and should be treated as guidance of input audio content rather than precisely what the model heard. The client can optionally set the language and prompt for transcription, these offer additional guidance to the transcription service.\n"},{"type":"null"}]},"turn_detection":{"$ref":"#/components/schemas/RealtimeTurnDetection"},"input_audio_noise_reduction":{"type":"object","default":null,"description":"Configuration for input audio noise reduction. This can be set to `null` to turn off.\nNoise reduction filters audio added to the input audio buffer before it is sent to VAD and the model.\nFiltering the audio can improve VAD and turn detection accuracy (reducing false positives) and model performance by improving perception of the input audio.\n","properties":{"type":{"$ref":"#/components/schemas/NoiseReductionType"}}},"speed":{"type":"number","default":1,"maximum":1.5,"minimum":0.25,"description":"The speed of the model's spoken response. 1.0 is the default speed. 0.25 is\nthe minimum speed. 1.5 is the maximum speed. This value can only be changed\nin between model turns, not while a response is in progress.\n"},"tracing":{"anyOf":[{"title":"Tracing Configuration","description":"Configuration options for tracing. Set to null to disable tracing. Once\ntracing is enabled for a session, the configuration cannot be modified.\n\n`auto` will create a trace for the session with default values for the\nworkflow name, group id, and metadata.\n","oneOf":[{"type":"string","default":"auto","description":"Default tracing mode for the session.\n","enum":["auto"],"x-stainless-const":true},{"type":"object","title":"Tracing Configuration","description":"Granular configuration for tracing.\n","properties":{"workflow_name":{"type":"string","description":"The name of the workflow to attach to this trace. This is used to\nname the trace in the traces dashboard.\n"},"group_id":{"type":"string","description":"The group id to attach to this trace to enable filtering and\ngrouping in the traces dashboard.\n"},"metadata":{"type":"object","description":"The arbitrary metadata to attach to this trace to enable\nfiltering in the traces dashboard.\n"}}}]},{"type":"null"}]},"tools":{"type":"array","description":"Tools (functions) available to the model.","items":{"$ref":"#/components/schemas/RealtimeFunctionTool"}},"tool_choice":{"type":"string","default":"auto","description":"How the model chooses tools. Options are `auto`, `none`, `required`, or\nspecify a function.\n"},"temperature":{"type":"number","default":0.8,"description":"Sampling temperature for the model, limited to [0.6, 1.2]. For audio models a temperature of 0.8 is highly recommended for best performance.\n"},"max_response_output_tokens":{"oneOf":[{"type":"integer"},{"type":"string","enum":["inf"],"x-stainless-const":true}],"description":"Maximum number of output tokens for a single assistant response,\ninclusive of tool calls. Provide an integer between 1 and 4096 to\nlimit output tokens, or `inf` for the maximum available tokens for a\ngiven model. Defaults to `inf`.\n"},"expires_at":{"type":"integer","description":"Expiration timestamp for the session, in seconds since epoch."},"prompt":{"anyOf":[{"$ref":"#/components/schemas/Prompt"},{"type":"null"}]},"include":{"anyOf":[{"type":"array","items":{"type":"string","enum":["item.input_audio_transcription.logprobs"]},"description":"Additional fields to include in server outputs.\n- `item.input_audio_transcription.logprobs`: Include logprobs for input audio transcription.\n"},{"type":"null"}]}}},"RealtimeSessionCreateRequest":{"type":"object","description":"A new Realtime session configuration, with an ephemeral key. Default TTL\nfor keys is one minute.\n","properties":{"client_secret":{"type":"object","description":"Ephemeral key returned by the API.","properties":{"value":{"type":"string","description":"Ephemeral key usable in client environments to authenticate connections\nto the Realtime API. Use this in client-side environments rather than\na standard API token, which should only be used server-side.\n"},"expires_at":{"type":"integer","description":"Timestamp for when the token expires. Currently, all tokens expire\nafter one minute.\n"}},"required":["value","expires_at"]},"modalities":{"description":"The set of modalities the model can respond with. To disable audio,\nset this to [\"text\"].\n","items":{"type":"string","enum":["text","audio"]}},"instructions":{"type":"string","description":"The default system instructions (i.e. system message) prepended to model calls. This field allows the client to guide the model on desired responses. The model can be instructed on response content and format, (e.g. \"be extremely succinct\", \"act friendly\", \"here are examples of good responses\") and on audio behavior (e.g. \"talk quickly\", \"inject emotion into your voice\", \"laugh frequently\"). The instructions are not guaranteed to be followed by the model, but they provide guidance to the model on the desired behavior.\nNote that the server sets default instructions which will be used if this field is not set and are visible in the `session.created` event at the start of the session.\n"},"voice":{"$ref":"#/components/schemas/VoiceIdsOrCustomVoice","description":"The voice the model uses to respond. Supported built-in voices are\n`alloy`, `ash`, `ballad`, `coral`, `echo`, `sage`, `shimmer`, `verse`,\n`marin`, and `cedar`. You may also provide a custom voice object with an\n`id`, for example `{ \"id\": \"voice_1234\" }`. Voice cannot be changed during\nthe session once the model has responded with audio at least once.\n"},"input_audio_format":{"type":"string","description":"The format of input audio. Options are `pcm16`, `g711_ulaw`, or `g711_alaw`.\n"},"output_audio_format":{"type":"string","description":"The format of output audio. Options are `pcm16`, `g711_ulaw`, or `g711_alaw`.\n"},"input_audio_transcription":{"type":"object","description":"Configuration for input audio transcription, defaults to off and can be\nset to `null` to turn off once on. Input audio transcription is not native\nto the model, since the model consumes audio directly. Transcription runs\nasynchronously and should be treated as rough guidance\nrather than the representation understood by the model.\n","properties":{"model":{"type":"string","description":"The model to use for transcription.\n"}}},"speed":{"type":"number","default":1,"maximum":1.5,"minimum":0.25,"description":"The speed of the model's spoken response. 1.0 is the default speed. 0.25 is\nthe minimum speed. 1.5 is the maximum speed. This value can only be changed\nin between model turns, not while a response is in progress.\n"},"tracing":{"title":"Tracing Configuration","description":"Configuration options for tracing. Set to null to disable tracing. Once\ntracing is enabled for a session, the configuration cannot be modified.\n\n`auto` will create a trace for the session with default values for the\nworkflow name, group id, and metadata.\n","oneOf":[{"type":"string","default":"auto","description":"Default tracing mode for the session.\n","enum":["auto"],"x-stainless-const":true},{"type":"object","title":"Tracing Configuration","description":"Granular configuration for tracing.\n","properties":{"workflow_name":{"type":"string","description":"The name of the workflow to attach to this trace. This is used to\nname the trace in the traces dashboard.\n"},"group_id":{"type":"string","description":"The group id to attach to this trace to enable filtering and\ngrouping in the traces dashboard.\n"},"metadata":{"type":"object","description":"The arbitrary metadata to attach to this trace to enable\nfiltering in the traces dashboard.\n"}}}]},"turn_detection":{"type":"object","description":"Configuration for turn detection. Can be set to `null` to turn off. Server\nVAD means that the model will detect the start and end of speech based on\naudio volume and respond at the end of user speech.\n","properties":{"type":{"type":"string","description":"Type of turn detection, only `server_vad` is currently supported.\n"},"threshold":{"type":"number","description":"Activation threshold for VAD (0.0 to 1.0), this defaults to 0.5. A\nhigher threshold will require louder audio to activate the model, and\nthus might perform better in noisy environments.\n"},"prefix_padding_ms":{"type":"integer","description":"Amount of audio to include before the VAD detected speech (in\nmilliseconds). Defaults to 300ms.\n"},"silence_duration_ms":{"type":"integer","description":"Duration of silence to detect speech stop (in milliseconds). Defaults\nto 500ms. With shorter values the model will respond more quickly,\nbut may jump in on short pauses from the user.\n"}}},"tools":{"type":"array","description":"Tools (functions) available to the model.","items":{"type":"object","properties":{"type":{"type":"string","enum":["function"],"description":"The type of the tool, i.e. `function`.","x-stainless-const":true},"name":{"type":"string","description":"The name of the function."},"description":{"type":"string","description":"The description of the function, including guidance on when and how\nto call it, and guidance about what to tell the user when calling\n(if anything).\n"},"parameters":{"type":"object","description":"Parameters of the function in JSON Schema."}}}},"tool_choice":{"type":"string","description":"How the model chooses tools. Options are `auto`, `none`, `required`, or\nspecify a function.\n"},"temperature":{"type":"number","description":"Sampling temperature for the model, limited to [0.6, 1.2]. Defaults to 0.8.\n"},"max_response_output_tokens":{"oneOf":[{"type":"integer"},{"type":"string","enum":["inf"],"x-stainless-const":true}],"description":"Maximum number of output tokens for a single assistant response,\ninclusive of tool calls. Provide an integer between 1 and 4096 to\nlimit output tokens, or `inf` for the maximum available tokens for a\ngiven model. Defaults to `inf`.\n"},"truncation":{"$ref":"#/components/schemas/RealtimeTruncation"},"prompt":{"$ref":"#/components/schemas/Prompt"}},"required":["client_secret"],"x-oaiMeta":{"name":"The session object","group":"realtime","example":"{\n \"id\": \"sess_001\",\n \"object\": \"realtime.session\",\n \"model\": \"gpt-realtime-2025-08-25\",\n \"modalities\": [\"audio\", \"text\"],\n \"instructions\": \"You are a friendly assistant.\",\n \"voice\": \"alloy\",\n \"input_audio_format\": \"pcm16\",\n \"output_audio_format\": \"pcm16\",\n \"input_audio_transcription\": {\n \"model\": \"whisper-1\"\n },\n \"turn_detection\": null,\n \"tools\": [],\n \"tool_choice\": \"none\",\n \"temperature\": 0.7,\n \"speed\": 1.1,\n \"tracing\": \"auto\",\n \"max_response_output_tokens\": 200,\n \"truncation\": \"auto\",\n \"prompt\": null,\n \"client_secret\": {\n \"value\": \"ek_abc123\",\n \"expires_at\": 1234567890\n }\n}\n"}},"RealtimeSessionCreateRequestGA":{"type":"object","title":"Realtime session configuration","description":"Realtime session object configuration.","properties":{"type":{"type":"string","description":"The type of session to create. Always `realtime` for the Realtime API.\n","enum":["realtime"],"x-stainless-const":true},"output_modalities":{"type":"array","description":"The set of modalities the model can respond with. It defaults to `[\"audio\"]`, indicating\nthat the model will respond with audio plus a transcript. `[\"text\"]` can be used to make\nthe model respond with text only. It is not possible to request both `text` and `audio` at the same time.\n","default":["audio"],"items":{"type":"string","enum":["text","audio"]}},"model":{"anyOf":[{"type":"string"},{"type":"string","enum":["gpt-realtime","gpt-realtime-1.5","gpt-realtime-2025-08-28","gpt-4o-realtime-preview","gpt-4o-realtime-preview-2024-10-01","gpt-4o-realtime-preview-2024-12-17","gpt-4o-realtime-preview-2025-06-03","gpt-4o-mini-realtime-preview","gpt-4o-mini-realtime-preview-2024-12-17","gpt-realtime-mini","gpt-realtime-mini-2025-10-06","gpt-realtime-mini-2025-12-15","gpt-audio-1.5","gpt-audio-mini","gpt-audio-mini-2025-10-06","gpt-audio-mini-2025-12-15"]}],"description":"The Realtime model used for this session.\n"},"instructions":{"type":"string","description":"The default system instructions (i.e. system message) prepended to model calls. This field allows the client to guide the model on desired responses. The model can be instructed on response content and format, (e.g. \"be extremely succinct\", \"act friendly\", \"here are examples of good responses\") and on audio behavior (e.g. \"talk quickly\", \"inject emotion into your voice\", \"laugh frequently\"). The instructions are not guaranteed to be followed by the model, but they provide guidance to the model on the desired behavior.\n\nNote that the server sets default instructions which will be used if this field is not set and are visible in the `session.created` event at the start of the session.\n"},"audio":{"type":"object","description":"Configuration for input and output audio.\n","properties":{"input":{"type":"object","properties":{"format":{"$ref":"#/components/schemas/RealtimeAudioFormats","description":"The format of the input audio."},"transcription":{"description":"Configuration for input audio transcription, defaults to off and can be set to `null` to turn off once on. Input audio transcription is not native to the model, since the model consumes audio directly. Transcription runs asynchronously through [the /audio/transcriptions endpoint](/docs/api-reference/audio/createTranscription) and should be treated as guidance of input audio content rather than precisely what the model heard. The client can optionally set the language and prompt for transcription, these offer additional guidance to the transcription service.\n","$ref":"#/components/schemas/AudioTranscription"},"noise_reduction":{"type":"object","default":null,"description":"Configuration for input audio noise reduction. This can be set to `null` to turn off.\nNoise reduction filters audio added to the input audio buffer before it is sent to VAD and the model.\nFiltering the audio can improve VAD and turn detection accuracy (reducing false positives) and model performance by improving perception of the input audio.\n","properties":{"type":{"$ref":"#/components/schemas/NoiseReductionType"}}},"turn_detection":{"$ref":"#/components/schemas/RealtimeTurnDetection"}}},"output":{"type":"object","properties":{"format":{"$ref":"#/components/schemas/RealtimeAudioFormats","description":"The format of the output audio."},"voice":{"$ref":"#/components/schemas/VoiceIdsOrCustomVoice","default":"alloy","description":"The voice the model uses to respond. Supported built-in voices are\n`alloy`, `ash`, `ballad`, `coral`, `echo`, `sage`, `shimmer`, `verse`,\n`marin`, and `cedar`. You may also provide a custom voice object with\nan `id`, for example `{ \"id\": \"voice_1234\" }`. Voice cannot be changed\nduring the session once the model has responded with audio at least once.\nWe recommend `marin` and `cedar` for best quality.\n"},"speed":{"type":"number","default":1,"maximum":1.5,"minimum":0.25,"description":"The speed of the model's spoken response as a multiple of the original speed.\n1.0 is the default speed. 0.25 is the minimum speed. 1.5 is the maximum speed. This value can only be changed in between model turns, not while a response is in progress.\n\nThis parameter is a post-processing adjustment to the audio after it is generated, it's\nalso possible to prompt the model to speak faster or slower.\n"}}}}},"include":{"type":"array","items":{"type":"string","enum":["item.input_audio_transcription.logprobs"]},"description":"Additional fields to include in server outputs.\n\n`item.input_audio_transcription.logprobs`: Include logprobs for input audio transcription.\n"},"tracing":{"title":"Tracing Configuration","default":null,"description":"Realtime API can write session traces to the [Traces Dashboard](https://platform.openai.com/logs?api=traces). Set to null to disable tracing. Once\ntracing is enabled for a session, the configuration cannot be modified.\n\n`auto` will create a trace for the session with default values for the\nworkflow name, group id, and metadata.\n","nullable":true,"oneOf":[{"type":"string","title":"auto","default":"auto","description":"Enables tracing and sets default values for tracing configuration options. Always `auto`.\n","enum":["auto"],"x-stainless-const":true},{"type":"object","title":"Tracing Configuration","description":"Granular configuration for tracing.\n","properties":{"workflow_name":{"type":"string","description":"The name of the workflow to attach to this trace. This is used to\nname the trace in the Traces Dashboard.\n"},"group_id":{"type":"string","description":"The group id to attach to this trace to enable filtering and\ngrouping in the Traces Dashboard.\n"},"metadata":{"type":"object","description":"The arbitrary metadata to attach to this trace to enable\nfiltering in the Traces Dashboard.\n"}}}]},"tools":{"type":"array","description":"Tools available to the model.","items":{"oneOf":[{"$ref":"#/components/schemas/RealtimeFunctionTool"},{"$ref":"#/components/schemas/MCPTool"}]}},"tool_choice":{"description":"How the model chooses tools. Provide one of the string modes or force a specific\nfunction/MCP tool.\n","oneOf":[{"$ref":"#/components/schemas/ToolChoiceOptions"},{"$ref":"#/components/schemas/ToolChoiceFunction"},{"$ref":"#/components/schemas/ToolChoiceMCP"}],"default":"auto"},"max_output_tokens":{"oneOf":[{"type":"integer"},{"type":"string","enum":["inf"],"x-stainless-const":true}],"description":"Maximum number of output tokens for a single assistant response,\ninclusive of tool calls. Provide an integer between 1 and 4096 to\nlimit output tokens, or `inf` for the maximum available tokens for a\ngiven model. Defaults to `inf`.\n"},"truncation":{"$ref":"#/components/schemas/RealtimeTruncation"},"prompt":{"$ref":"#/components/schemas/Prompt"}},"required":["type"]},"RealtimeSessionCreateResponse":{"type":"object","title":"Realtime session configuration object","description":"A Realtime session configuration object.\n","properties":{"id":{"type":"string","description":"Unique identifier for the session that looks like `sess_1234567890abcdef`.\n"},"object":{"type":"string","description":"The object type. Always `realtime.session`."},"expires_at":{"type":"integer","description":"Expiration timestamp for the session, in seconds since epoch."},"include":{"type":"array","items":{"type":"string","enum":["item.input_audio_transcription.logprobs"]},"description":"Additional fields to include in server outputs.\n- `item.input_audio_transcription.logprobs`: Include logprobs for input audio transcription.\n"},"model":{"type":"string","description":"The Realtime model used for this session."},"output_modalities":{"description":"The set of modalities the model can respond with. To disable audio,\nset this to [\"text\"].\n","items":{"type":"string","enum":["text","audio"]}},"instructions":{"type":"string","description":"The default system instructions (i.e. system message) prepended to model\ncalls. This field allows the client to guide the model on desired\nresponses. The model can be instructed on response content and format,\n(e.g. \"be extremely succinct\", \"act friendly\", \"here are examples of good\nresponses\") and on audio behavior (e.g. \"talk quickly\", \"inject emotion\ninto your voice\", \"laugh frequently\"). The instructions are not guaranteed\nto be followed by the model, but they provide guidance to the model on the\ndesired behavior.\n\nNote that the server sets default instructions which will be used if this\nfield is not set and are visible in the `session.created` event at the\nstart of the session.\n"},"audio":{"type":"object","description":"Configuration for input and output audio for the session.\n","properties":{"input":{"type":"object","properties":{"format":{"$ref":"#/components/schemas/RealtimeAudioFormats"},"transcription":{"description":"Configuration for input audio transcription.\n","$ref":"#/components/schemas/AudioTranscription"},"noise_reduction":{"type":"object","description":"Configuration for input audio noise reduction.\n","properties":{"type":{"$ref":"#/components/schemas/NoiseReductionType"}}},"turn_detection":{"type":"object","description":"Configuration for turn detection.\n","properties":{"type":{"type":"string","description":"Type of turn detection, only `server_vad` is currently supported.\n"},"threshold":{"type":"number"},"prefix_padding_ms":{"type":"integer"},"silence_duration_ms":{"type":"integer"}}}}},"output":{"type":"object","properties":{"format":{"$ref":"#/components/schemas/RealtimeAudioFormats"},"voice":{"$ref":"#/components/schemas/VoiceIdsShared"},"speed":{"type":"number"}}}}},"tracing":{"title":"Tracing Configuration","description":"Configuration options for tracing. Set to null to disable tracing. Once\ntracing is enabled for a session, the configuration cannot be modified.\n\n`auto` will create a trace for the session with default values for the\nworkflow name, group id, and metadata.\n","oneOf":[{"type":"string","default":"auto","description":"Default tracing mode for the session.\n","enum":["auto"],"x-stainless-const":true},{"type":"object","title":"Tracing Configuration","description":"Granular configuration for tracing.\n","properties":{"workflow_name":{"type":"string","description":"The name of the workflow to attach to this trace. This is used to\nname the trace in the traces dashboard.\n"},"group_id":{"type":"string","description":"The group id to attach to this trace to enable filtering and\ngrouping in the traces dashboard.\n"},"metadata":{"type":"object","description":"The arbitrary metadata to attach to this trace to enable\nfiltering in the traces dashboard.\n"}}}]},"turn_detection":{"type":"object","description":"Configuration for turn detection. Can be set to `null` to turn off. Server\nVAD means that the model will detect the start and end of speech based on\naudio volume and respond at the end of user speech.\n","properties":{"type":{"type":"string","description":"Type of turn detection, only `server_vad` is currently supported.\n"},"threshold":{"type":"number","description":"Activation threshold for VAD (0.0 to 1.0), this defaults to 0.5. A\nhigher threshold will require louder audio to activate the model, and\nthus might perform better in noisy environments.\n"},"prefix_padding_ms":{"type":"integer","description":"Amount of audio to include before the VAD detected speech (in\nmilliseconds). Defaults to 300ms.\n"},"silence_duration_ms":{"type":"integer","description":"Duration of silence to detect speech stop (in milliseconds). Defaults\nto 500ms. With shorter values the model will respond more quickly,\nbut may jump in on short pauses from the user.\n"}}},"tools":{"type":"array","description":"Tools (functions) available to the model.","items":{"$ref":"#/components/schemas/RealtimeFunctionTool"}},"tool_choice":{"type":"string","description":"How the model chooses tools. Options are `auto`, `none`, `required`, or\nspecify a function.\n"},"max_output_tokens":{"oneOf":[{"type":"integer"},{"type":"string","enum":["inf"],"x-stainless-const":true}],"description":"Maximum number of output tokens for a single assistant response,\ninclusive of tool calls. Provide an integer between 1 and 4096 to\nlimit output tokens, or `inf` for the maximum available tokens for a\ngiven model. Defaults to `inf`.\n"}},"x-oaiMeta":{"name":"The session object","group":"realtime","example":"{\n \"id\": \"sess_001\",\n \"object\": \"realtime.session\",\n \"expires_at\": 1742188264,\n \"model\": \"gpt-realtime\",\n \"output_modalities\": [\"audio\"],\n \"instructions\": \"You are a friendly assistant.\",\n \"tools\": [],\n \"tool_choice\": \"none\",\n \"max_output_tokens\": \"inf\",\n \"tracing\": \"auto\",\n \"truncation\": \"auto\",\n \"prompt\": null,\n \"audio\": {\n \"input\": {\n \"format\": {\n \"type\": \"audio/pcm\",\n \"rate\": 24000\n },\n \"transcription\": { \"model\": \"whisper-1\" },\n \"noise_reduction\": null,\n \"turn_detection\": null\n },\n \"output\": {\n \"format\": {\n \"type\": \"audio/pcm\",\n \"rate\": 24000\n },\n \"voice\": \"alloy\",\n \"speed\": 1.0\n }\n }\n}\n"}},"RealtimeSessionCreateResponseGA":{"type":"object","description":"A new Realtime session configuration, with an ephemeral key. Default TTL\nfor keys is one minute.\n","properties":{"client_secret":{"type":"object","description":"Ephemeral key returned by the API.","properties":{"value":{"type":"string","description":"Ephemeral key usable in client environments to authenticate connections to the Realtime API. Use this in client-side environments rather than a standard API token, which should only be used server-side.\n"},"expires_at":{"type":"integer","description":"Timestamp for when the token expires. Currently, all tokens expire\nafter one minute.\n"}},"required":["value","expires_at"]},"type":{"type":"string","description":"The type of session to create. Always `realtime` for the Realtime API.\n","enum":["realtime"],"x-stainless-const":true},"output_modalities":{"type":"array","description":"The set of modalities the model can respond with. It defaults to `[\"audio\"]`, indicating\nthat the model will respond with audio plus a transcript. `[\"text\"]` can be used to make\nthe model respond with text only. It is not possible to request both `text` and `audio` at the same time.\n","default":["audio"],"items":{"type":"string","enum":["text","audio"]}},"model":{"anyOf":[{"type":"string"},{"type":"string","enum":["gpt-realtime","gpt-realtime-1.5","gpt-realtime-2025-08-28","gpt-4o-realtime-preview","gpt-4o-realtime-preview-2024-10-01","gpt-4o-realtime-preview-2024-12-17","gpt-4o-realtime-preview-2025-06-03","gpt-4o-mini-realtime-preview","gpt-4o-mini-realtime-preview-2024-12-17","gpt-realtime-mini","gpt-realtime-mini-2025-10-06","gpt-realtime-mini-2025-12-15","gpt-audio-1.5","gpt-audio-mini","gpt-audio-mini-2025-10-06","gpt-audio-mini-2025-12-15"]}],"description":"The Realtime model used for this session.\n"},"instructions":{"type":"string","description":"The default system instructions (i.e. system message) prepended to model calls. This field allows the client to guide the model on desired responses. The model can be instructed on response content and format, (e.g. \"be extremely succinct\", \"act friendly\", \"here are examples of good responses\") and on audio behavior (e.g. \"talk quickly\", \"inject emotion into your voice\", \"laugh frequently\"). The instructions are not guaranteed to be followed by the model, but they provide guidance to the model on the desired behavior.\n\nNote that the server sets default instructions which will be used if this field is not set and are visible in the `session.created` event at the start of the session.\n"},"audio":{"type":"object","description":"Configuration for input and output audio.\n","properties":{"input":{"type":"object","properties":{"format":{"$ref":"#/components/schemas/RealtimeAudioFormats","description":"The format of the input audio."},"transcription":{"description":"Configuration for input audio transcription, defaults to off and can be set to `null` to turn off once on. Input audio transcription is not native to the model, since the model consumes audio directly. Transcription runs asynchronously through [the /audio/transcriptions endpoint](/docs/api-reference/audio/createTranscription) and should be treated as guidance of input audio content rather than precisely what the model heard. The client can optionally set the language and prompt for transcription, these offer additional guidance to the transcription service.\n","$ref":"#/components/schemas/AudioTranscription"},"noise_reduction":{"type":"object","default":null,"description":"Configuration for input audio noise reduction. This can be set to `null` to turn off.\nNoise reduction filters audio added to the input audio buffer before it is sent to VAD and the model.\nFiltering the audio can improve VAD and turn detection accuracy (reducing false positives) and model performance by improving perception of the input audio.\n","properties":{"type":{"$ref":"#/components/schemas/NoiseReductionType"}}},"turn_detection":{"$ref":"#/components/schemas/RealtimeTurnDetection"}}},"output":{"type":"object","properties":{"format":{"$ref":"#/components/schemas/RealtimeAudioFormats","description":"The format of the output audio."},"voice":{"$ref":"#/components/schemas/VoiceIdsShared","default":"alloy","description":"The voice the model uses to respond. Voice cannot be changed during the\nsession once the model has responded with audio at least once. Current\nvoice options are `alloy`, `ash`, `ballad`, `coral`, `echo`, `sage`,\n`shimmer`, `verse`, `marin`, and `cedar`. We recommend `marin` and `cedar` for\nbest quality.\n"},"speed":{"type":"number","default":1,"maximum":1.5,"minimum":0.25,"description":"The speed of the model's spoken response as a multiple of the original speed.\n1.0 is the default speed. 0.25 is the minimum speed. 1.5 is the maximum speed. This value can only be changed in between model turns, not while a response is in progress.\n\nThis parameter is a post-processing adjustment to the audio after it is generated, it's\nalso possible to prompt the model to speak faster or slower.\n"}}}}},"include":{"type":"array","items":{"type":"string","enum":["item.input_audio_transcription.logprobs"]},"description":"Additional fields to include in server outputs.\n\n`item.input_audio_transcription.logprobs`: Include logprobs for input audio transcription.\n"},"tracing":{"anyOf":[{"title":"Tracing Configuration","default":null,"description":"Realtime API can write session traces to the [Traces Dashboard](https://platform.openai.com/logs?api=traces). Set to null to disable tracing. Once\ntracing is enabled for a session, the configuration cannot be modified.\n\n`auto` will create a trace for the session with default values for the\nworkflow name, group id, and metadata.\n","oneOf":[{"type":"string","title":"auto","default":"auto","description":"Enables tracing and sets default values for tracing configuration options. Always `auto`.\n","enum":["auto"],"x-stainless-const":true},{"type":"object","title":"Tracing Configuration","description":"Granular configuration for tracing.\n","properties":{"workflow_name":{"type":"string","description":"The name of the workflow to attach to this trace. This is used to\nname the trace in the Traces Dashboard.\n"},"group_id":{"type":"string","description":"The group id to attach to this trace to enable filtering and\ngrouping in the Traces Dashboard.\n"},"metadata":{"type":"object","description":"The arbitrary metadata to attach to this trace to enable\nfiltering in the Traces Dashboard.\n"}}}]},{"type":"null"}]},"tools":{"type":"array","description":"Tools available to the model.","items":{"oneOf":[{"$ref":"#/components/schemas/RealtimeFunctionTool"},{"$ref":"#/components/schemas/MCPTool"}]}},"tool_choice":{"description":"How the model chooses tools. Provide one of the string modes or force a specific\nfunction/MCP tool.\n","oneOf":[{"$ref":"#/components/schemas/ToolChoiceOptions"},{"$ref":"#/components/schemas/ToolChoiceFunction"},{"$ref":"#/components/schemas/ToolChoiceMCP"}],"default":"auto"},"max_output_tokens":{"oneOf":[{"type":"integer"},{"type":"string","enum":["inf"],"x-stainless-const":true}],"description":"Maximum number of output tokens for a single assistant response,\ninclusive of tool calls. Provide an integer between 1 and 4096 to\nlimit output tokens, or `inf` for the maximum available tokens for a\ngiven model. Defaults to `inf`.\n"},"truncation":{"$ref":"#/components/schemas/RealtimeTruncation"},"prompt":{"$ref":"#/components/schemas/Prompt"}},"required":["client_secret","type"],"x-oaiMeta":{"name":"The session object","group":"realtime"}},"RealtimeTranscriptionSessionCreateRequest":{"type":"object","title":"Realtime transcription session configuration","description":"Realtime transcription session object configuration.","properties":{"turn_detection":{"type":"object","description":"Configuration for turn detection. Can be set to `null` to turn off. Server VAD means that the model will detect the start and end of speech based on audio volume and respond at the end of user speech.\n","properties":{"type":{"type":"string","description":"Type of turn detection. Only `server_vad` is currently supported for transcription sessions.\n","enum":["server_vad"]},"threshold":{"type":"number","description":"Activation threshold for VAD (0.0 to 1.0), this defaults to 0.5. A\nhigher threshold will require louder audio to activate the model, and\nthus might perform better in noisy environments.\n"},"prefix_padding_ms":{"type":"integer","description":"Amount of audio to include before the VAD detected speech (in\nmilliseconds). Defaults to 300ms.\n"},"silence_duration_ms":{"type":"integer","description":"Duration of silence to detect speech stop (in milliseconds). Defaults\nto 500ms. With shorter values the model will respond more quickly,\nbut may jump in on short pauses from the user.\n"}}},"input_audio_noise_reduction":{"type":"object","default":null,"description":"Configuration for input audio noise reduction. This can be set to `null` to turn off.\nNoise reduction filters audio added to the input audio buffer before it is sent to VAD and the model.\nFiltering the audio can improve VAD and turn detection accuracy (reducing false positives) and model performance by improving perception of the input audio.\n","properties":{"type":{"$ref":"#/components/schemas/NoiseReductionType"}}},"input_audio_format":{"type":"string","default":"pcm16","enum":["pcm16","g711_ulaw","g711_alaw"],"description":"The format of input audio. Options are `pcm16`, `g711_ulaw`, or `g711_alaw`.\nFor `pcm16`, input audio must be 16-bit PCM at a 24kHz sample rate,\nsingle channel (mono), and little-endian byte order.\n"},"input_audio_transcription":{"description":"Configuration for input audio transcription. The client can optionally set the language and prompt for transcription, these offer additional guidance to the transcription service.\n","$ref":"#/components/schemas/AudioTranscription"},"include":{"type":"array","items":{"type":"string","enum":["item.input_audio_transcription.logprobs"]},"description":"The set of items to include in the transcription. Current available items are:\n`item.input_audio_transcription.logprobs`\n"}}},"RealtimeTranscriptionSessionCreateRequestGA":{"type":"object","title":"Realtime transcription session configuration","description":"Realtime transcription session object configuration.","properties":{"type":{"type":"string","description":"The type of session to create. Always `transcription` for transcription sessions.\n","enum":["transcription"],"x-stainless-const":true},"audio":{"type":"object","description":"Configuration for input and output audio.\n","properties":{"input":{"type":"object","properties":{"format":{"$ref":"#/components/schemas/RealtimeAudioFormats"},"transcription":{"description":"Configuration for input audio transcription, defaults to off and can be set to `null` to turn off once on. Input audio transcription is not native to the model, since the model consumes audio directly. Transcription runs asynchronously through [the /audio/transcriptions endpoint](/docs/api-reference/audio/createTranscription) and should be treated as guidance of input audio content rather than precisely what the model heard. The client can optionally set the language and prompt for transcription, these offer additional guidance to the transcription service.\n","$ref":"#/components/schemas/AudioTranscription"},"noise_reduction":{"type":"object","default":null,"description":"Configuration for input audio noise reduction. This can be set to `null` to turn off.\nNoise reduction filters audio added to the input audio buffer before it is sent to VAD and the model.\nFiltering the audio can improve VAD and turn detection accuracy (reducing false positives) and model performance by improving perception of the input audio.\n","properties":{"type":{"$ref":"#/components/schemas/NoiseReductionType"}}},"turn_detection":{"$ref":"#/components/schemas/RealtimeTurnDetection"}}}}},"include":{"type":"array","items":{"type":"string","enum":["item.input_audio_transcription.logprobs"]},"description":"Additional fields to include in server outputs.\n\n`item.input_audio_transcription.logprobs`: Include logprobs for input audio transcription.\n"}},"required":["type"]},"RealtimeTranscriptionSessionCreateResponse":{"type":"object","description":"A new Realtime transcription session configuration.\n\nWhen a session is created on the server via REST API, the session object\nalso contains an ephemeral key. Default TTL for keys is 10 minutes. This\nproperty is not present when a session is updated via the WebSocket API.\n","properties":{"client_secret":{"type":"object","description":"Ephemeral key returned by the API. Only present when the session is\ncreated on the server via REST API.\n","properties":{"value":{"type":"string","description":"Ephemeral key usable in client environments to authenticate connections\nto the Realtime API. Use this in client-side environments rather than\na standard API token, which should only be used server-side.\n"},"expires_at":{"type":"integer","description":"Timestamp for when the token expires. Currently, all tokens expire\nafter one minute.\n"}},"required":["value","expires_at"]},"modalities":{"description":"The set of modalities the model can respond with. To disable audio,\nset this to [\"text\"].\n","items":{"type":"string","enum":["text","audio"]}},"input_audio_format":{"type":"string","description":"The format of input audio. Options are `pcm16`, `g711_ulaw`, or `g711_alaw`.\n"},"input_audio_transcription":{"description":"Configuration of the transcription model.\n","$ref":"#/components/schemas/AudioTranscription"},"turn_detection":{"type":"object","description":"Configuration for turn detection. Can be set to `null` to turn off. Server\nVAD means that the model will detect the start and end of speech based on\naudio volume and respond at the end of user speech.\n","properties":{"type":{"type":"string","description":"Type of turn detection, only `server_vad` is currently supported.\n"},"threshold":{"type":"number","description":"Activation threshold for VAD (0.0 to 1.0), this defaults to 0.5. A\nhigher threshold will require louder audio to activate the model, and\nthus might perform better in noisy environments.\n"},"prefix_padding_ms":{"type":"integer","description":"Amount of audio to include before the VAD detected speech (in\nmilliseconds). Defaults to 300ms.\n"},"silence_duration_ms":{"type":"integer","description":"Duration of silence to detect speech stop (in milliseconds). Defaults\nto 500ms. With shorter values the model will respond more quickly,\nbut may jump in on short pauses from the user.\n"}}}},"required":["client_secret"],"x-oaiMeta":{"name":"The transcription session object","group":"realtime","example":"{\n \"id\": \"sess_BBwZc7cFV3XizEyKGDCGL\",\n \"object\": \"realtime.transcription_session\",\n \"expires_at\": 1742188264,\n \"modalities\": [\"audio\", \"text\"],\n \"turn_detection\": {\n \"type\": \"server_vad\",\n \"threshold\": 0.5,\n \"prefix_padding_ms\": 300,\n \"silence_duration_ms\": 200\n },\n \"input_audio_format\": \"pcm16\",\n \"input_audio_transcription\": {\n \"model\": \"gpt-4o-transcribe\",\n \"language\": null,\n \"prompt\": \"\"\n },\n \"client_secret\": null\n}\n"}},"RealtimeTranscriptionSessionCreateResponseGA":{"type":"object","title":"Realtime transcription session configuration object","description":"A Realtime transcription session configuration object.\n","properties":{"type":{"type":"string","description":"The type of session. Always `transcription` for transcription sessions.\n","enum":["transcription"],"x-stainless-const":true},"id":{"type":"string","description":"Unique identifier for the session that looks like `sess_1234567890abcdef`.\n"},"object":{"type":"string","description":"The object type. Always `realtime.transcription_session`."},"expires_at":{"type":"integer","description":"Expiration timestamp for the session, in seconds since epoch."},"include":{"type":"array","items":{"type":"string","enum":["item.input_audio_transcription.logprobs"]},"description":"Additional fields to include in server outputs.\n- `item.input_audio_transcription.logprobs`: Include logprobs for input audio transcription.\n"},"audio":{"type":"object","description":"Configuration for input audio for the session.\n","properties":{"input":{"type":"object","properties":{"format":{"$ref":"#/components/schemas/RealtimeAudioFormats"},"transcription":{"description":"Configuration of the transcription model.\n","$ref":"#/components/schemas/AudioTranscription"},"noise_reduction":{"type":"object","description":"Configuration for input audio noise reduction.\n","properties":{"type":{"$ref":"#/components/schemas/NoiseReductionType"}}},"turn_detection":{"type":"object","description":"Configuration for turn detection. Can be set to `null` to turn off. Server\nVAD means that the model will detect the start and end of speech based on\naudio volume and respond at the end of user speech.\n","properties":{"type":{"type":"string","description":"Type of turn detection, only `server_vad` is currently supported.\n"},"threshold":{"type":"number","description":"Activation threshold for VAD (0.0 to 1.0), this defaults to 0.5. A\nhigher threshold will require louder audio to activate the model, and\nthus might perform better in noisy environments.\n"},"prefix_padding_ms":{"type":"integer","description":"Amount of audio to include before the VAD detected speech (in\nmilliseconds). Defaults to 300ms.\n"},"silence_duration_ms":{"type":"integer","description":"Duration of silence to detect speech stop (in milliseconds). Defaults\nto 500ms. With shorter values the model will respond more quickly,\nbut may jump in on short pauses from the user.\n"}}}}}}}},"required":["type","id","object"],"x-oaiMeta":{"name":"The transcription session object","group":"realtime","example":"{\n \"id\": \"sess_BBwZc7cFV3XizEyKGDCGL\",\n \"type\": \"transcription\",\n \"object\": \"realtime.transcription_session\",\n \"expires_at\": 1742188264,\n \"include\": [\"item.input_audio_transcription.logprobs\"],\n \"audio\": {\n \"input\": {\n \"format\": \"pcm16\",\n \"transcription\": {\n \"model\": \"gpt-4o-transcribe\",\n \"language\": null,\n \"prompt\": \"\"\n },\n \"noise_reduction\": null,\n \"turn_detection\": {\n \"type\": \"server_vad\",\n \"threshold\": 0.5,\n \"prefix_padding_ms\": 300,\n \"silence_duration_ms\": 200\n }\n }\n }\n}\n"}},"RealtimeTruncation":{"title":"Realtime Truncation Controls","description":"When the number of tokens in a conversation exceeds the model's input token limit, the conversation be truncated, meaning messages (starting from the oldest) will not be included in the model's context. A 32k context model with 4,096 max output tokens can only include 28,224 tokens in the context before truncation occurs.\n\nClients can configure truncation behavior to truncate with a lower max token limit, which is an effective way to control token usage and cost.\n\nTruncation will reduce the number of cached tokens on the next turn (busting the cache), since messages are dropped from the beginning of the context. However, clients can also configure truncation to retain messages up to a fraction of the maximum context size, which will reduce the need for future truncations and thus improve the cache rate.\n\nTruncation can be disabled entirely, which means the server will never truncate but would instead return an error if the conversation exceeds the model's input token limit.\n","oneOf":[{"type":"string","description":"The truncation strategy to use for the session. `auto` is the default truncation strategy. `disabled` will disable truncation and emit errors when the conversation exceeds the input token limit.","enum":["auto","disabled"]},{"type":"object","title":"Retention ratio truncation","description":"Retain a fraction of the conversation tokens when the conversation exceeds the input token limit. This allows you to amortize truncations across multiple turns, which can help improve cached token usage.","properties":{"type":{"type":"string","enum":["retention_ratio"],"description":"Use retention ratio truncation.","x-stainless-const":true},"retention_ratio":{"type":"number","description":"Fraction of post-instruction conversation tokens to retain (`0.0` - `1.0`) when the conversation exceeds the input token limit. Setting this to `0.8` means that messages will be dropped until 80% of the maximum allowed tokens are used. This helps reduce the frequency of truncations and improve cache rates.\n","minimum":0,"maximum":1},"token_limits":{"type":"object","description":"Optional custom token limits for this truncation strategy. If not provided, the model's default token limits will be used.","properties":{"post_instructions":{"type":"integer","description":"Maximum tokens allowed in the conversation after instructions (which including tool definitions). For example, setting this to 5,000 would mean that truncation would occur when the conversation exceeds 5,000 tokens after instructions. This cannot be higher than the model's context window size minus the maximum output tokens.","minimum":0}}}},"required":["type","retention_ratio"]}]},"RealtimeTurnDetection":{"anyOf":[{"title":"Realtime Turn Detection","description":"Configuration for turn detection, ether Server VAD or Semantic VAD. This can be set to `null` to turn off, in which case the client must manually trigger model response.\n\nServer VAD means that the model will detect the start and end of speech based on audio volume and respond at the end of user speech.\n\nSemantic VAD is more advanced and uses a turn detection model (in conjunction with VAD) to semantically estimate whether the user has finished speaking, then dynamically sets a timeout based on this probability. For example, if user audio trails off with \"uhhm\", the model will score a low probability of turn end and wait longer for the user to continue speaking. This can be useful for more natural conversations, but may have a higher latency.\n","oneOf":[{"type":"object","title":"Server VAD","description":"Server-side voice activity detection (VAD) which flips on when user speech is detected and off after a period of silence.","required":["type"],"properties":{"type":{"type":"string","default":"server_vad","const":"server_vad","description":"Type of turn detection, `server_vad` to turn on simple Server VAD.\n"},"threshold":{"type":"number","description":"Used only for `server_vad` mode. Activation threshold for VAD (0.0 to 1.0), this defaults to 0.5. A\nhigher threshold will require louder audio to activate the model, and\nthus might perform better in noisy environments.\n"},"prefix_padding_ms":{"type":"integer","description":"Used only for `server_vad` mode. Amount of audio to include before the VAD detected speech (in\nmilliseconds). Defaults to 300ms.\n"},"silence_duration_ms":{"type":"integer","description":"Used only for `server_vad` mode. Duration of silence to detect speech stop (in milliseconds). Defaults\nto 500ms. With shorter values the model will respond more quickly,\nbut may jump in on short pauses from the user.\n"},"create_response":{"type":"boolean","default":true,"description":"Whether or not to automatically generate a response when a VAD stop event occurs. If `interrupt_response` is set to `false` this may fail to create a response if the model is already responding.\n\nIf both `create_response` and `interrupt_response` are set to `false`, the model will never respond automatically but VAD events will still be emitted.\n"},"interrupt_response":{"type":"boolean","default":true,"description":"Whether or not to automatically interrupt (cancel) any ongoing response with output to the default\nconversation (i.e. `conversation` of `auto`) when a VAD start event occurs. If `true` then the response will be cancelled, otherwise it will continue until complete.\n\nIf both `create_response` and `interrupt_response` are set to `false`, the model will never respond automatically but VAD events will still be emitted.\n"},"idle_timeout_ms":{"anyOf":[{"type":"integer","minimum":5000,"maximum":30000,"description":"Optional timeout after which a model response will be triggered automatically. This is\nuseful for situations in which a long pause from the user is unexpected, such as a phone\ncall. The model will effectively prompt the user to continue the conversation based\non the current context.\n\nThe timeout value will be applied after the last model response's audio has finished playing,\ni.e. it's set to the `response.done` time plus audio playback duration.\n\nAn `input_audio_buffer.timeout_triggered` event (plus events\nassociated with the Response) will be emitted when the timeout is reached.\nIdle timeout is currently only supported for `server_vad` mode.\n"},{"type":"null"}]}}},{"type":"object","title":"Semantic VAD","description":"Server-side semantic turn detection which uses a model to determine when the user has finished speaking.","required":["type"],"properties":{"type":{"type":"string","const":"semantic_vad","description":"Type of turn detection, `semantic_vad` to turn on Semantic VAD.\n"},"eagerness":{"type":"string","default":"auto","enum":["low","medium","high","auto"],"description":"Used only for `semantic_vad` mode. The eagerness of the model to respond. `low` will wait longer for the user to continue speaking, `high` will respond more quickly. `auto` is the default and is equivalent to `medium`. `low`, `medium`, and `high` have max timeouts of 8s, 4s, and 2s respectively.\n"},"create_response":{"type":"boolean","default":true,"description":"Whether or not to automatically generate a response when a VAD stop event occurs.\n"},"interrupt_response":{"type":"boolean","default":true,"description":"Whether or not to automatically interrupt any ongoing response with output to the default\nconversation (i.e. `conversation` of `auto`) when a VAD start event occurs.\n"}}}],"discriminator":{"propertyName":"type"}},{"type":"null"}]},"Reasoning":{"type":"object","description":"**gpt-5 and o-series models only**\n\nConfiguration options for\n[reasoning models](https://platform.openai.com/docs/guides/reasoning).\n","title":"Reasoning","properties":{"effort":{"$ref":"#/components/schemas/ReasoningEffort"},"summary":{"anyOf":[{"type":"string","description":"A summary of the reasoning performed by the model. This can be\nuseful for debugging and understanding the model's reasoning process.\nOne of `auto`, `concise`, or `detailed`.\n\n`concise` is supported for `computer-use-preview` models and all reasoning models after `gpt-5`.\n","enum":["auto","concise","detailed"]},{"type":"null"}]},"generate_summary":{"anyOf":[{"type":"string","deprecated":true,"description":"**Deprecated:** use `summary` instead.\n\nA summary of the reasoning performed by the model. This can be\nuseful for debugging and understanding the model's reasoning process.\nOne of `auto`, `concise`, or `detailed`.\n","enum":["auto","concise","detailed"]},{"type":"null"}]}}},"ReasoningEffort":{"anyOf":[{"type":"string","enum":["none","minimal","low","medium","high","xhigh"],"default":"medium","description":"Constrains effort on reasoning for\n[reasoning models](https://platform.openai.com/docs/guides/reasoning).\nCurrently supported values are `none`, `minimal`, `low`, `medium`, `high`, and `xhigh`. Reducing\nreasoning effort can result in faster responses and fewer tokens used\non reasoning in a response.\n\n- `gpt-5.1` defaults to `none`, which does not perform reasoning. The supported reasoning values for `gpt-5.1` are `none`, `low`, `medium`, and `high`. Tool calls are supported for all reasoning values in gpt-5.1.\n- All models before `gpt-5.1` default to `medium` reasoning effort, and do not support `none`.\n- The `gpt-5-pro` model defaults to (and only supports) `high` reasoning effort.\n- `xhigh` is supported for all models after `gpt-5.1-codex-max`.\n"},{"type":"null"}]},"ReasoningItem":{"type":"object","description":"A description of the chain of thought used by a reasoning model while generating\na response. Be sure to include these items in your `input` to the Responses API\nfor subsequent turns of a conversation if you are manually\n[managing context](/docs/guides/conversation-state).\n","title":"Reasoning","properties":{"type":{"type":"string","description":"The type of the object. Always `reasoning`.\n","enum":["reasoning"],"x-stainless-const":true},"id":{"type":"string","description":"The unique identifier of the reasoning content.\n"},"encrypted_content":{"anyOf":[{"type":"string","description":"The encrypted content of the reasoning item - populated when a response is\ngenerated with `reasoning.encrypted_content` in the `include` parameter.\n"},{"type":"null"}]},"summary":{"type":"array","description":"Reasoning summary content.\n","items":{"$ref":"#/components/schemas/SummaryTextContent"}},"content":{"type":"array","description":"Reasoning text content.\n","items":{"$ref":"#/components/schemas/ReasoningTextContent"}},"status":{"type":"string","description":"The status of the item. One of `in_progress`, `completed`, or\n`incomplete`. Populated when items are returned via API.\n","enum":["in_progress","completed","incomplete"]}},"required":["id","summary","type"]},"Response":{"title":"The response object","allOf":[{"$ref":"#/components/schemas/ModelResponseProperties"},{"$ref":"#/components/schemas/ResponseProperties"},{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier for this Response.\n"},"object":{"type":"string","description":"The object type of this resource - always set to `response`.\n","enum":["response"],"x-stainless-const":true},"status":{"type":"string","description":"The status of the response generation. One of `completed`, `failed`,\n`in_progress`, `cancelled`, `queued`, or `incomplete`.\n","enum":["completed","failed","in_progress","cancelled","queued","incomplete"]},"created_at":{"type":"number","description":"Unix timestamp (in seconds) of when this Response was created.\n"},"completed_at":{"anyOf":[{"type":"number","description":"Unix timestamp (in seconds) of when this Response was completed.\nOnly present when the status is `completed`.\n"},{"type":"null"}]},"error":{"$ref":"#/components/schemas/ResponseError"},"incomplete_details":{"anyOf":[{"type":"object","description":"Details about why the response is incomplete.\n","properties":{"reason":{"type":"string","description":"The reason why the response is incomplete.","enum":["max_output_tokens","content_filter"]}}},{"type":"null"}]},"output":{"type":"array","description":"An array of content items generated by the model.\n\n- The length and order of items in the `output` array is dependent\n on the model's response.\n- Rather than accessing the first item in the `output` array and\n assuming it's an `assistant` message with the content generated by\n the model, you might consider using the `output_text` property where\n supported in SDKs.\n","items":{"$ref":"#/components/schemas/OutputItem"}},"instructions":{"anyOf":[{"description":"A system (or developer) message inserted into the model's context.\n\nWhen using along with `previous_response_id`, the instructions from a previous\nresponse will not be carried over to the next response. This makes it simple\nto swap out system (or developer) messages in new responses.\n","oneOf":[{"type":"string","description":"A text input to the model, equivalent to a text input with the\n`developer` role.\n"},{"type":"array","title":"Input item list","description":"A list of one or many input items to the model, containing\ndifferent content types.\n","items":{"$ref":"#/components/schemas/InputItem"}}]},{"type":"null"}]},"output_text":{"anyOf":[{"type":"string","description":"SDK-only convenience property that contains the aggregated text output\nfrom all `output_text` items in the `output` array, if any are present.\nSupported in the Python and JavaScript SDKs.\n","x-oaiSupportedSDKs":["python","javascript"]},{"type":"null"}]},"usage":{"$ref":"#/components/schemas/ResponseUsage"},"parallel_tool_calls":{"type":"boolean","description":"Whether to allow the model to run tool calls in parallel.\n","default":true},"conversation":{"anyOf":[{"default":null,"$ref":"#/components/schemas/Conversation-2"},{"type":"null"}]},"max_output_tokens":{"anyOf":[{"description":"An upper bound for the number of tokens that can be generated for a response, including visible output tokens and [reasoning tokens](/docs/guides/reasoning).\n","type":"integer"},{"type":"null"}]}},"required":["id","object","created_at","error","incomplete_details","instructions","model","tools","output","parallel_tool_calls","metadata","tool_choice","temperature","top_p"]}],"example":{"id":"resp_67ccd3a9da748190baa7f1570fe91ac604becb25c45c1d41","object":"response","created_at":1741476777,"status":"completed","completed_at":1741476778,"error":null,"incomplete_details":null,"instructions":null,"max_output_tokens":null,"model":"gpt-4o-2024-08-06","output":[{"type":"message","id":"msg_67ccd3acc8d48190a77525dc6de64b4104becb25c45c1d41","status":"completed","role":"assistant","content":[{"type":"output_text","text":"The image depicts a scenic landscape with a wooden boardwalk or pathway leading through lush, green grass under a blue sky with some clouds. The setting suggests a peaceful natural area, possibly a park or nature reserve. There are trees and shrubs in the background.","annotations":[]}]}],"parallel_tool_calls":true,"previous_response_id":null,"reasoning":{"effort":null,"summary":null},"store":true,"temperature":1,"text":{"format":{"type":"text"}},"tool_choice":"auto","tools":[],"top_p":1,"truncation":"disabled","usage":{"input_tokens":328,"input_tokens_details":{"cached_tokens":0},"output_tokens":52,"output_tokens_details":{"reasoning_tokens":0},"total_tokens":380},"user":null,"metadata":{}}},"ResponseAudioDeltaEvent":{"type":"object","description":"Emitted when there is a partial audio response.","properties":{"type":{"type":"string","description":"The type of the event. Always `response.audio.delta`.\n","enum":["response.audio.delta"],"x-stainless-const":true},"sequence_number":{"type":"integer","description":"A sequence number for this chunk of the stream response.\n"},"delta":{"type":"string","description":"A chunk of Base64 encoded response audio bytes.\n"}},"required":["type","delta","sequence_number"],"x-oaiMeta":{"name":"response.audio.delta","group":"responses","example":"{\n \"type\": \"response.audio.delta\",\n \"response_id\": \"resp_123\",\n \"delta\": \"base64encoded...\",\n \"sequence_number\": 1\n}\n"}},"ResponseAudioDoneEvent":{"type":"object","description":"Emitted when the audio response is complete.","properties":{"type":{"type":"string","description":"The type of the event. Always `response.audio.done`.\n","enum":["response.audio.done"],"x-stainless-const":true},"sequence_number":{"type":"integer","description":"The sequence number of the delta.\n"}},"required":["type","sequence_number","response_id"],"x-oaiMeta":{"name":"response.audio.done","group":"responses","example":"{\n \"type\": \"response.audio.done\",\n \"response_id\": \"resp-123\",\n \"sequence_number\": 1\n}\n"}},"ResponseAudioTranscriptDeltaEvent":{"type":"object","description":"Emitted when there is a partial transcript of audio.","properties":{"type":{"type":"string","description":"The type of the event. Always `response.audio.transcript.delta`.\n","enum":["response.audio.transcript.delta"],"x-stainless-const":true},"delta":{"type":"string","description":"The partial transcript of the audio response.\n"},"sequence_number":{"type":"integer","description":"The sequence number of this event."}},"required":["type","response_id","delta","sequence_number"],"x-oaiMeta":{"name":"response.audio.transcript.delta","group":"responses","example":"{\n \"type\": \"response.audio.transcript.delta\",\n \"response_id\": \"resp_123\",\n \"delta\": \" ... partial transcript ... \",\n \"sequence_number\": 1\n}\n"}},"ResponseAudioTranscriptDoneEvent":{"type":"object","description":"Emitted when the full audio transcript is completed.","properties":{"type":{"type":"string","description":"The type of the event. Always `response.audio.transcript.done`.\n","enum":["response.audio.transcript.done"],"x-stainless-const":true},"sequence_number":{"type":"integer","description":"The sequence number of this event."}},"required":["type","response_id","sequence_number"],"x-oaiMeta":{"name":"response.audio.transcript.done","group":"responses","example":"{\n \"type\": \"response.audio.transcript.done\",\n \"response_id\": \"resp_123\",\n \"sequence_number\": 1\n}\n"}},"ResponseCodeInterpreterCallCodeDeltaEvent":{"type":"object","description":"Emitted when a partial code snippet is streamed by the code interpreter.","properties":{"type":{"type":"string","description":"The type of the event. Always `response.code_interpreter_call_code.delta`.","enum":["response.code_interpreter_call_code.delta"],"x-stainless-const":true},"output_index":{"type":"integer","description":"The index of the output item in the response for which the code is being streamed."},"item_id":{"type":"string","description":"The unique identifier of the code interpreter tool call item."},"delta":{"type":"string","description":"The partial code snippet being streamed by the code interpreter."},"sequence_number":{"type":"integer","description":"The sequence number of this event, used to order streaming events."}},"required":["type","output_index","item_id","delta","sequence_number"],"x-oaiMeta":{"name":"response.code_interpreter_call_code.delta","group":"responses","example":"{\n \"type\": \"response.code_interpreter_call_code.delta\",\n \"output_index\": 0,\n \"item_id\": \"ci_12345\",\n \"delta\": \"print('Hello, world')\",\n \"sequence_number\": 1\n}\n"}},"ResponseCodeInterpreterCallCodeDoneEvent":{"type":"object","description":"Emitted when the code snippet is finalized by the code interpreter.","properties":{"type":{"type":"string","description":"The type of the event. Always `response.code_interpreter_call_code.done`.","enum":["response.code_interpreter_call_code.done"],"x-stainless-const":true},"output_index":{"type":"integer","description":"The index of the output item in the response for which the code is finalized."},"item_id":{"type":"string","description":"The unique identifier of the code interpreter tool call item."},"code":{"type":"string","description":"The final code snippet output by the code interpreter."},"sequence_number":{"type":"integer","description":"The sequence number of this event, used to order streaming events."}},"required":["type","output_index","item_id","code","sequence_number"],"x-oaiMeta":{"name":"response.code_interpreter_call_code.done","group":"responses","example":"{\n \"type\": \"response.code_interpreter_call_code.done\",\n \"output_index\": 3,\n \"item_id\": \"ci_12345\",\n \"code\": \"print('done')\",\n \"sequence_number\": 1\n}\n"}},"ResponseCodeInterpreterCallCompletedEvent":{"type":"object","description":"Emitted when the code interpreter call is completed.","properties":{"type":{"type":"string","description":"The type of the event. Always `response.code_interpreter_call.completed`.","enum":["response.code_interpreter_call.completed"],"x-stainless-const":true},"output_index":{"type":"integer","description":"The index of the output item in the response for which the code interpreter call is completed."},"item_id":{"type":"string","description":"The unique identifier of the code interpreter tool call item."},"sequence_number":{"type":"integer","description":"The sequence number of this event, used to order streaming events."}},"required":["type","output_index","item_id","sequence_number"],"x-oaiMeta":{"name":"response.code_interpreter_call.completed","group":"responses","example":"{\n \"type\": \"response.code_interpreter_call.completed\",\n \"output_index\": 5,\n \"item_id\": \"ci_12345\",\n \"sequence_number\": 1\n}\n"}},"ResponseCodeInterpreterCallInProgressEvent":{"type":"object","description":"Emitted when a code interpreter call is in progress.","properties":{"type":{"type":"string","description":"The type of the event. Always `response.code_interpreter_call.in_progress`.","enum":["response.code_interpreter_call.in_progress"],"x-stainless-const":true},"output_index":{"type":"integer","description":"The index of the output item in the response for which the code interpreter call is in progress."},"item_id":{"type":"string","description":"The unique identifier of the code interpreter tool call item."},"sequence_number":{"type":"integer","description":"The sequence number of this event, used to order streaming events."}},"required":["type","output_index","item_id","sequence_number"],"x-oaiMeta":{"name":"response.code_interpreter_call.in_progress","group":"responses","example":"{\n \"type\": \"response.code_interpreter_call.in_progress\",\n \"output_index\": 0,\n \"item_id\": \"ci_12345\",\n \"sequence_number\": 1\n}\n"}},"ResponseCodeInterpreterCallInterpretingEvent":{"type":"object","description":"Emitted when the code interpreter is actively interpreting the code snippet.","properties":{"type":{"type":"string","description":"The type of the event. Always `response.code_interpreter_call.interpreting`.","enum":["response.code_interpreter_call.interpreting"],"x-stainless-const":true},"output_index":{"type":"integer","description":"The index of the output item in the response for which the code interpreter is interpreting code."},"item_id":{"type":"string","description":"The unique identifier of the code interpreter tool call item."},"sequence_number":{"type":"integer","description":"The sequence number of this event, used to order streaming events."}},"required":["type","output_index","item_id","sequence_number"],"x-oaiMeta":{"name":"response.code_interpreter_call.interpreting","group":"responses","example":"{\n \"type\": \"response.code_interpreter_call.interpreting\",\n \"output_index\": 4,\n \"item_id\": \"ci_12345\",\n \"sequence_number\": 1\n}\n"}},"ResponseCompletedEvent":{"type":"object","description":"Emitted when the model response is complete.","properties":{"type":{"type":"string","description":"The type of the event. Always `response.completed`.\n","enum":["response.completed"],"x-stainless-const":true},"response":{"$ref":"#/components/schemas/Response","description":"Properties of the completed response.\n"},"sequence_number":{"type":"integer","description":"The sequence number for this event."}},"required":["type","response","sequence_number"],"x-oaiMeta":{"name":"response.completed","group":"responses","example":"{\n \"type\": \"response.completed\",\n \"response\": {\n \"id\": \"resp_123\",\n \"object\": \"response\",\n \"created_at\": 1740855869,\n \"status\": \"completed\",\n \"completed_at\": 1740855870,\n \"error\": null,\n \"incomplete_details\": null,\n \"input\": [],\n \"instructions\": null,\n \"max_output_tokens\": null,\n \"model\": \"gpt-4o-mini-2024-07-18\",\n \"output\": [\n {\n \"id\": \"msg_123\",\n \"type\": \"message\",\n \"role\": \"assistant\",\n \"content\": [\n {\n \"type\": \"output_text\",\n \"text\": \"In a shimmering forest under a sky full of stars, a lonely unicorn named Lila discovered a hidden pond that glowed with moonlight. Every night, she would leave sparkling, magical flowers by the water's edge, hoping to share her beauty with others. One enchanting evening, she woke to find a group of friendly animals gathered around, eager to be friends and share in her magic.\",\n \"annotations\": []\n }\n ]\n }\n ],\n \"previous_response_id\": null,\n \"reasoning_effort\": null,\n \"store\": false,\n \"temperature\": 1,\n \"text\": {\n \"format\": {\n \"type\": \"text\"\n }\n },\n \"tool_choice\": \"auto\",\n \"tools\": [],\n \"top_p\": 1,\n \"truncation\": \"disabled\",\n \"usage\": {\n \"input_tokens\": 0,\n \"output_tokens\": 0,\n \"output_tokens_details\": {\n \"reasoning_tokens\": 0\n },\n \"total_tokens\": 0\n },\n \"user\": null,\n \"metadata\": {}\n },\n \"sequence_number\": 1\n}\n"}},"ResponseContentPartAddedEvent":{"type":"object","description":"Emitted when a new content part is added.","properties":{"type":{"type":"string","description":"The type of the event. Always `response.content_part.added`.\n","enum":["response.content_part.added"],"x-stainless-const":true},"item_id":{"type":"string","description":"The ID of the output item that the content part was added to.\n"},"output_index":{"type":"integer","description":"The index of the output item that the content part was added to.\n"},"content_index":{"type":"integer","description":"The index of the content part that was added.\n"},"part":{"$ref":"#/components/schemas/OutputContent","description":"The content part that was added.\n"},"sequence_number":{"type":"integer","description":"The sequence number of this event."}},"required":["type","item_id","output_index","content_index","part","sequence_number"],"x-oaiMeta":{"name":"response.content_part.added","group":"responses","example":"{\n \"type\": \"response.content_part.added\",\n \"item_id\": \"msg_123\",\n \"output_index\": 0,\n \"content_index\": 0,\n \"part\": {\n \"type\": \"output_text\",\n \"text\": \"\",\n \"annotations\": []\n },\n \"sequence_number\": 1\n}\n"}},"ResponseContentPartDoneEvent":{"type":"object","description":"Emitted when a content part is done.","properties":{"type":{"type":"string","description":"The type of the event. Always `response.content_part.done`.\n","enum":["response.content_part.done"],"x-stainless-const":true},"item_id":{"type":"string","description":"The ID of the output item that the content part was added to.\n"},"output_index":{"type":"integer","description":"The index of the output item that the content part was added to.\n"},"content_index":{"type":"integer","description":"The index of the content part that is done.\n"},"sequence_number":{"type":"integer","description":"The sequence number of this event."},"part":{"$ref":"#/components/schemas/OutputContent","description":"The content part that is done.\n"}},"required":["type","item_id","output_index","content_index","part","sequence_number"],"x-oaiMeta":{"name":"response.content_part.done","group":"responses","example":"{\n \"type\": \"response.content_part.done\",\n \"item_id\": \"msg_123\",\n \"output_index\": 0,\n \"content_index\": 0,\n \"sequence_number\": 1,\n \"part\": {\n \"type\": \"output_text\",\n \"text\": \"In a shimmering forest under a sky full of stars, a lonely unicorn named Lila discovered a hidden pond that glowed with moonlight. Every night, she would leave sparkling, magical flowers by the water's edge, hoping to share her beauty with others. One enchanting evening, she woke to find a group of friendly animals gathered around, eager to be friends and share in her magic.\",\n \"annotations\": []\n }\n}\n"}},"ResponseCreatedEvent":{"type":"object","description":"An event that is emitted when a response is created.\n","properties":{"type":{"type":"string","description":"The type of the event. Always `response.created`.\n","enum":["response.created"],"x-stainless-const":true},"response":{"$ref":"#/components/schemas/Response","description":"The response that was created.\n"},"sequence_number":{"type":"integer","description":"The sequence number for this event."}},"required":["type","response","sequence_number"],"x-oaiMeta":{"name":"response.created","group":"responses","example":"{\n \"type\": \"response.created\",\n \"response\": {\n \"id\": \"resp_67ccfcdd16748190a91872c75d38539e09e4d4aac714747c\",\n \"object\": \"response\",\n \"created_at\": 1741487325,\n \"status\": \"in_progress\",\n \"completed_at\": null,\n \"error\": null,\n \"incomplete_details\": null,\n \"instructions\": null,\n \"max_output_tokens\": null,\n \"model\": \"gpt-4o-2024-08-06\",\n \"output\": [],\n \"parallel_tool_calls\": true,\n \"previous_response_id\": null,\n \"reasoning\": {\n \"effort\": null,\n \"summary\": null\n },\n \"store\": true,\n \"temperature\": 1,\n \"text\": {\n \"format\": {\n \"type\": \"text\"\n }\n },\n \"tool_choice\": \"auto\",\n \"tools\": [],\n \"top_p\": 1,\n \"truncation\": \"disabled\",\n \"usage\": null,\n \"user\": null,\n \"metadata\": {}\n },\n \"sequence_number\": 1\n}\n"}},"ResponseCustomToolCallInputDeltaEvent":{"title":"ResponseCustomToolCallInputDelta","type":"object","description":"Event representing a delta (partial update) to the input of a custom tool call.\n","properties":{"type":{"type":"string","enum":["response.custom_tool_call_input.delta"],"description":"The event type identifier.","x-stainless-const":true},"sequence_number":{"type":"integer","description":"The sequence number of this event."},"output_index":{"type":"integer","description":"The index of the output this delta applies to."},"item_id":{"type":"string","description":"Unique identifier for the API item associated with this event."},"delta":{"type":"string","description":"The incremental input data (delta) for the custom tool call."}},"required":["type","output_index","item_id","delta","sequence_number"],"x-oaiMeta":{"name":"response.custom_tool_call_input.delta","group":"responses","example":"{\n \"type\": \"response.custom_tool_call_input.delta\",\n \"output_index\": 0,\n \"item_id\": \"ctc_1234567890abcdef\",\n \"delta\": \"partial input text\"\n}\n"}},"ResponseCustomToolCallInputDoneEvent":{"title":"ResponseCustomToolCallInputDone","type":"object","description":"Event indicating that input for a custom tool call is complete.\n","properties":{"type":{"type":"string","enum":["response.custom_tool_call_input.done"],"description":"The event type identifier.","x-stainless-const":true},"sequence_number":{"type":"integer","description":"The sequence number of this event."},"output_index":{"type":"integer","description":"The index of the output this event applies to."},"item_id":{"type":"string","description":"Unique identifier for the API item associated with this event."},"input":{"type":"string","description":"The complete input data for the custom tool call."}},"required":["type","output_index","item_id","input","sequence_number"],"x-oaiMeta":{"name":"response.custom_tool_call_input.done","group":"responses","example":"{\n \"type\": \"response.custom_tool_call_input.done\",\n \"output_index\": 0,\n \"item_id\": \"ctc_1234567890abcdef\",\n \"input\": \"final complete input text\"\n}\n"}},"ResponseError":{"anyOf":[{"type":"object","description":"An error object returned when the model fails to generate a Response.\n","properties":{"code":{"$ref":"#/components/schemas/ResponseErrorCode"},"message":{"type":"string","description":"A human-readable description of the error.\n"}},"required":["code","message"]},{"type":"null"}]},"ResponseErrorCode":{"type":"string","description":"The error code for the response.\n","enum":["server_error","rate_limit_exceeded","invalid_prompt","vector_store_timeout","invalid_image","invalid_image_format","invalid_base64_image","invalid_image_url","image_too_large","image_too_small","image_parse_error","image_content_policy_violation","invalid_image_mode","image_file_too_large","unsupported_image_media_type","empty_image_file","failed_to_download_image","image_file_not_found"]},"ResponseErrorEvent":{"type":"object","description":"Emitted when an error occurs.","properties":{"type":{"type":"string","description":"The type of the event. Always `error`.\n","enum":["error"],"x-stainless-const":true},"code":{"anyOf":[{"type":"string","description":"The error code.\n"},{"type":"null"}]},"message":{"type":"string","description":"The error message.\n"},"param":{"anyOf":[{"type":"string","description":"The error parameter.\n"},{"type":"null"}]},"sequence_number":{"type":"integer","description":"The sequence number of this event."}},"required":["type","code","message","param","sequence_number"],"x-oaiMeta":{"name":"error","group":"responses","example":"{\n \"type\": \"error\",\n \"code\": \"ERR_SOMETHING\",\n \"message\": \"Something went wrong\",\n \"param\": null,\n \"sequence_number\": 1\n}\n"}},"ResponseFailedEvent":{"type":"object","description":"An event that is emitted when a response fails.\n","properties":{"type":{"type":"string","description":"The type of the event. Always `response.failed`.\n","enum":["response.failed"],"x-stainless-const":true},"sequence_number":{"type":"integer","description":"The sequence number of this event."},"response":{"$ref":"#/components/schemas/Response","description":"The response that failed.\n"}},"required":["type","response","sequence_number"],"x-oaiMeta":{"name":"response.failed","group":"responses","example":"{\n \"type\": \"response.failed\",\n \"response\": {\n \"id\": \"resp_123\",\n \"object\": \"response\",\n \"created_at\": 1740855869,\n \"status\": \"failed\",\n \"completed_at\": null,\n \"error\": {\n \"code\": \"server_error\",\n \"message\": \"The model failed to generate a response.\"\n },\n \"incomplete_details\": null,\n \"instructions\": null,\n \"max_output_tokens\": null,\n \"model\": \"gpt-4o-mini-2024-07-18\",\n \"output\": [],\n \"previous_response_id\": null,\n \"reasoning_effort\": null,\n \"store\": false,\n \"temperature\": 1,\n \"text\": {\n \"format\": {\n \"type\": \"text\"\n }\n },\n \"tool_choice\": \"auto\",\n \"tools\": [],\n \"top_p\": 1,\n \"truncation\": \"disabled\",\n \"usage\": null,\n \"user\": null,\n \"metadata\": {}\n }\n}\n"}},"ResponseFileSearchCallCompletedEvent":{"type":"object","description":"Emitted when a file search call is completed (results found).","properties":{"type":{"type":"string","description":"The type of the event. Always `response.file_search_call.completed`.\n","enum":["response.file_search_call.completed"],"x-stainless-const":true},"output_index":{"type":"integer","description":"The index of the output item that the file search call is initiated.\n"},"item_id":{"type":"string","description":"The ID of the output item that the file search call is initiated.\n"},"sequence_number":{"type":"integer","description":"The sequence number of this event."}},"required":["type","output_index","item_id","sequence_number"],"x-oaiMeta":{"name":"response.file_search_call.completed","group":"responses","example":"{\n \"type\": \"response.file_search_call.completed\",\n \"output_index\": 0,\n \"item_id\": \"fs_123\",\n \"sequence_number\": 1\n}\n"}},"ResponseFileSearchCallInProgressEvent":{"type":"object","description":"Emitted when a file search call is initiated.","properties":{"type":{"type":"string","description":"The type of the event. Always `response.file_search_call.in_progress`.\n","enum":["response.file_search_call.in_progress"],"x-stainless-const":true},"output_index":{"type":"integer","description":"The index of the output item that the file search call is initiated.\n"},"item_id":{"type":"string","description":"The ID of the output item that the file search call is initiated.\n"},"sequence_number":{"type":"integer","description":"The sequence number of this event."}},"required":["type","output_index","item_id","sequence_number"],"x-oaiMeta":{"name":"response.file_search_call.in_progress","group":"responses","example":"{\n \"type\": \"response.file_search_call.in_progress\",\n \"output_index\": 0,\n \"item_id\": \"fs_123\",\n \"sequence_number\": 1\n}\n"}},"ResponseFileSearchCallSearchingEvent":{"type":"object","description":"Emitted when a file search is currently searching.","properties":{"type":{"type":"string","description":"The type of the event. Always `response.file_search_call.searching`.\n","enum":["response.file_search_call.searching"],"x-stainless-const":true},"output_index":{"type":"integer","description":"The index of the output item that the file search call is searching.\n"},"item_id":{"type":"string","description":"The ID of the output item that the file search call is initiated.\n"},"sequence_number":{"type":"integer","description":"The sequence number of this event."}},"required":["type","output_index","item_id","sequence_number"],"x-oaiMeta":{"name":"response.file_search_call.searching","group":"responses","example":"{\n \"type\": \"response.file_search_call.searching\",\n \"output_index\": 0,\n \"item_id\": \"fs_123\",\n \"sequence_number\": 1\n}\n"}},"ResponseFormatJsonObject":{"type":"object","title":"JSON object","description":"JSON object response format. An older method of generating JSON responses.\nUsing `json_schema` is recommended for models that support it. Note that the\nmodel will not generate JSON without a system or user message instructing it\nto do so.\n","properties":{"type":{"type":"string","description":"The type of response format being defined. Always `json_object`.","enum":["json_object"],"x-stainless-const":true}},"required":["type"]},"ResponseFormatJsonSchema":{"type":"object","title":"JSON schema","description":"JSON Schema response format. Used to generate structured JSON responses.\nLearn more about [Structured Outputs](/docs/guides/structured-outputs).\n","properties":{"type":{"type":"string","description":"The type of response format being defined. Always `json_schema`.","enum":["json_schema"],"x-stainless-const":true},"json_schema":{"type":"object","title":"JSON schema","description":"Structured Outputs configuration options, including a JSON Schema.\n","properties":{"description":{"type":"string","description":"A description of what the response format is for, used by the model to\ndetermine how to respond in the format.\n"},"name":{"type":"string","description":"The name of the response format. Must be a-z, A-Z, 0-9, or contain\nunderscores and dashes, with a maximum length of 64.\n"},"schema":{"$ref":"#/components/schemas/ResponseFormatJsonSchemaSchema"},"strict":{"anyOf":[{"type":"boolean","default":false,"description":"Whether to enable strict schema adherence when generating the output.\nIf set to true, the model will always follow the exact schema defined\nin the `schema` field. Only a subset of JSON Schema is supported when\n`strict` is `true`. To learn more, read the [Structured Outputs\nguide](/docs/guides/structured-outputs).\n"},{"type":"null"}]}},"required":["name"]}},"required":["type","json_schema"]},"ResponseFormatJsonSchemaSchema":{"type":"object","title":"JSON schema","description":"The schema for the response format, described as a JSON Schema object.\nLearn how to build JSON schemas [here](https://json-schema.org/).\n","additionalProperties":true},"ResponseFormatText":{"type":"object","title":"Text","description":"Default response format. Used to generate text responses.\n","properties":{"type":{"type":"string","description":"The type of response format being defined. Always `text`.","enum":["text"],"x-stainless-const":true}},"required":["type"]},"ResponseFormatTextGrammar":{"type":"object","title":"Text grammar","description":"A custom grammar for the model to follow when generating text.\nLearn more in the [custom grammars guide](/docs/guides/custom-grammars).\n","properties":{"type":{"type":"string","description":"The type of response format being defined. Always `grammar`.","enum":["grammar"],"x-stainless-const":true},"grammar":{"type":"string","description":"The custom grammar for the model to follow."}},"required":["type","grammar"]},"ResponseFormatTextPython":{"type":"object","title":"Python grammar","description":"Configure the model to generate valid Python code. See the\n[custom grammars guide](/docs/guides/custom-grammars) for more details.\n","properties":{"type":{"type":"string","description":"The type of response format being defined. Always `python`.","enum":["python"],"x-stainless-const":true}},"required":["type"]},"ResponseFunctionCallArgumentsDeltaEvent":{"type":"object","description":"Emitted when there is a partial function-call arguments delta.","properties":{"type":{"type":"string","description":"The type of the event. Always `response.function_call_arguments.delta`.\n","enum":["response.function_call_arguments.delta"],"x-stainless-const":true},"item_id":{"type":"string","description":"The ID of the output item that the function-call arguments delta is added to.\n"},"output_index":{"type":"integer","description":"The index of the output item that the function-call arguments delta is added to.\n"},"sequence_number":{"type":"integer","description":"The sequence number of this event."},"delta":{"type":"string","description":"The function-call arguments delta that is added.\n"}},"required":["type","item_id","output_index","delta","sequence_number"],"x-oaiMeta":{"name":"response.function_call_arguments.delta","group":"responses","example":"{\n \"type\": \"response.function_call_arguments.delta\",\n \"item_id\": \"item-abc\",\n \"output_index\": 0,\n \"delta\": \"{ \\\"arg\\\":\"\n \"sequence_number\": 1\n}\n"}},"ResponseFunctionCallArgumentsDoneEvent":{"type":"object","description":"Emitted when function-call arguments are finalized.","properties":{"type":{"type":"string","enum":["response.function_call_arguments.done"],"x-stainless-const":true},"item_id":{"type":"string","description":"The ID of the item."},"name":{"type":"string","description":"The name of the function that was called."},"output_index":{"type":"integer","description":"The index of the output item."},"sequence_number":{"type":"integer","description":"The sequence number of this event."},"arguments":{"type":"string","description":"The function-call arguments."}},"required":["type","item_id","name","output_index","arguments","sequence_number"],"x-oaiMeta":{"name":"response.function_call_arguments.done","group":"responses","example":"{\n \"type\": \"response.function_call_arguments.done\",\n \"item_id\": \"item-abc\",\n \"name\": \"get_weather\",\n \"output_index\": 1,\n \"arguments\": \"{ \\\"arg\\\": 123 }\",\n \"sequence_number\": 1\n}\n"}},"ResponseImageGenCallCompletedEvent":{"type":"object","title":"ResponseImageGenCallCompletedEvent","description":"Emitted when an image generation tool call has completed and the final image is available.\n","properties":{"type":{"type":"string","enum":["response.image_generation_call.completed"],"description":"The type of the event. Always 'response.image_generation_call.completed'.","x-stainless-const":true},"output_index":{"type":"integer","description":"The index of the output item in the response's output array."},"sequence_number":{"type":"integer","description":"The sequence number of this event."},"item_id":{"type":"string","description":"The unique identifier of the image generation item being processed."}},"required":["type","output_index","item_id","sequence_number"],"x-oaiMeta":{"name":"response.image_generation_call.completed","group":"responses","example":"{\n \"type\": \"response.image_generation_call.completed\",\n \"output_index\": 0,\n \"item_id\": \"item-123\",\n \"sequence_number\": 1\n}\n"}},"ResponseImageGenCallGeneratingEvent":{"type":"object","title":"ResponseImageGenCallGeneratingEvent","description":"Emitted when an image generation tool call is actively generating an image (intermediate state).\n","properties":{"type":{"type":"string","enum":["response.image_generation_call.generating"],"description":"The type of the event. Always 'response.image_generation_call.generating'.","x-stainless-const":true},"output_index":{"type":"integer","description":"The index of the output item in the response's output array."},"item_id":{"type":"string","description":"The unique identifier of the image generation item being processed."},"sequence_number":{"type":"integer","description":"The sequence number of the image generation item being processed."}},"required":["type","output_index","item_id","sequence_number"],"x-oaiMeta":{"name":"response.image_generation_call.generating","group":"responses","example":"{\n \"type\": \"response.image_generation_call.generating\",\n \"output_index\": 0,\n \"item_id\": \"item-123\",\n \"sequence_number\": 0\n}\n"}},"ResponseImageGenCallInProgressEvent":{"type":"object","title":"ResponseImageGenCallInProgressEvent","description":"Emitted when an image generation tool call is in progress.\n","properties":{"type":{"type":"string","enum":["response.image_generation_call.in_progress"],"description":"The type of the event. Always 'response.image_generation_call.in_progress'.","x-stainless-const":true},"output_index":{"type":"integer","description":"The index of the output item in the response's output array."},"item_id":{"type":"string","description":"The unique identifier of the image generation item being processed."},"sequence_number":{"type":"integer","description":"The sequence number of the image generation item being processed."}},"required":["type","output_index","item_id","sequence_number"],"x-oaiMeta":{"name":"response.image_generation_call.in_progress","group":"responses","example":"{\n \"type\": \"response.image_generation_call.in_progress\",\n \"output_index\": 0,\n \"item_id\": \"item-123\",\n \"sequence_number\": 0\n}\n"}},"ResponseImageGenCallPartialImageEvent":{"type":"object","title":"ResponseImageGenCallPartialImageEvent","description":"Emitted when a partial image is available during image generation streaming.\n","properties":{"type":{"type":"string","enum":["response.image_generation_call.partial_image"],"description":"The type of the event. Always 'response.image_generation_call.partial_image'.","x-stainless-const":true},"output_index":{"type":"integer","description":"The index of the output item in the response's output array."},"item_id":{"type":"string","description":"The unique identifier of the image generation item being processed."},"sequence_number":{"type":"integer","description":"The sequence number of the image generation item being processed."},"partial_image_index":{"type":"integer","description":"0-based index for the partial image (backend is 1-based, but this is 0-based for the user)."},"partial_image_b64":{"type":"string","description":"Base64-encoded partial image data, suitable for rendering as an image."}},"required":["type","output_index","item_id","sequence_number","partial_image_index","partial_image_b64"],"x-oaiMeta":{"name":"response.image_generation_call.partial_image","group":"responses","example":"{\n \"type\": \"response.image_generation_call.partial_image\",\n \"output_index\": 0,\n \"item_id\": \"item-123\",\n \"sequence_number\": 0,\n \"partial_image_index\": 0,\n \"partial_image_b64\": \"...\"\n}\n"}},"ResponseInProgressEvent":{"type":"object","description":"Emitted when the response is in progress.","properties":{"type":{"type":"string","description":"The type of the event. Always `response.in_progress`.\n","enum":["response.in_progress"],"x-stainless-const":true},"response":{"$ref":"#/components/schemas/Response","description":"The response that is in progress.\n"},"sequence_number":{"type":"integer","description":"The sequence number of this event."}},"required":["type","response","sequence_number"],"x-oaiMeta":{"name":"response.in_progress","group":"responses","example":"{\n \"type\": \"response.in_progress\",\n \"response\": {\n \"id\": \"resp_67ccfcdd16748190a91872c75d38539e09e4d4aac714747c\",\n \"object\": \"response\",\n \"created_at\": 1741487325,\n \"status\": \"in_progress\",\n \"completed_at\": null,\n \"error\": null,\n \"incomplete_details\": null,\n \"instructions\": null,\n \"max_output_tokens\": null,\n \"model\": \"gpt-4o-2024-08-06\",\n \"output\": [],\n \"parallel_tool_calls\": true,\n \"previous_response_id\": null,\n \"reasoning\": {\n \"effort\": null,\n \"summary\": null\n },\n \"store\": true,\n \"temperature\": 1,\n \"text\": {\n \"format\": {\n \"type\": \"text\"\n }\n },\n \"tool_choice\": \"auto\",\n \"tools\": [],\n \"top_p\": 1,\n \"truncation\": \"disabled\",\n \"usage\": null,\n \"user\": null,\n \"metadata\": {}\n },\n \"sequence_number\": 1\n}\n"}},"ResponseIncompleteEvent":{"type":"object","description":"An event that is emitted when a response finishes as incomplete.\n","properties":{"type":{"type":"string","description":"The type of the event. Always `response.incomplete`.\n","enum":["response.incomplete"],"x-stainless-const":true},"response":{"$ref":"#/components/schemas/Response","description":"The response that was incomplete.\n"},"sequence_number":{"type":"integer","description":"The sequence number of this event."}},"required":["type","response","sequence_number"],"x-oaiMeta":{"name":"response.incomplete","group":"responses","example":"{\n \"type\": \"response.incomplete\",\n \"response\": {\n \"id\": \"resp_123\",\n \"object\": \"response\",\n \"created_at\": 1740855869,\n \"status\": \"incomplete\",\n \"completed_at\": null,\n \"error\": null,\n \"incomplete_details\": {\n \"reason\": \"max_tokens\"\n },\n \"instructions\": null,\n \"max_output_tokens\": null,\n \"model\": \"gpt-4o-mini-2024-07-18\",\n \"output\": [],\n \"previous_response_id\": null,\n \"reasoning_effort\": null,\n \"store\": false,\n \"temperature\": 1,\n \"text\": {\n \"format\": {\n \"type\": \"text\"\n }\n },\n \"tool_choice\": \"auto\",\n \"tools\": [],\n \"top_p\": 1,\n \"truncation\": \"disabled\",\n \"usage\": null,\n \"user\": null,\n \"metadata\": {}\n },\n \"sequence_number\": 1\n}\n"}},"ResponseItemList":{"type":"object","description":"A list of Response items.","properties":{"object":{"type":"string","description":"The type of object returned, must be `list`.","enum":["list"],"x-stainless-const":true},"data":{"type":"array","description":"A list of items used to generate this response.","items":{"$ref":"#/components/schemas/ItemResource"}},"has_more":{"type":"boolean","description":"Whether there are more items available."},"first_id":{"type":"string","description":"The ID of the first item in the list."},"last_id":{"type":"string","description":"The ID of the last item in the list."}},"required":["object","data","has_more","first_id","last_id"],"x-oaiMeta":{"name":"The input item list","group":"responses","example":"{\n \"object\": \"list\",\n \"data\": [\n {\n \"id\": \"msg_abc123\",\n \"type\": \"message\",\n \"role\": \"user\",\n \"content\": [\n {\n \"type\": \"input_text\",\n \"text\": \"Tell me a three sentence bedtime story about a unicorn.\"\n }\n ]\n }\n ],\n \"first_id\": \"msg_abc123\",\n \"last_id\": \"msg_abc123\",\n \"has_more\": false\n}\n"}},"ResponseLogProb":{"type":"object","description":"A logprob is the logarithmic probability that the model assigns to producing \na particular token at a given position in the sequence. Less-negative (higher) \nlogprob values indicate greater model confidence in that token choice.\n","properties":{"token":{"description":"A possible text token.","type":"string"},"logprob":{"description":"The log probability of this token.\n","type":"number"},"top_logprobs":{"description":"The log probability of the top 20 most likely tokens.\n","type":"array","items":{"type":"object","properties":{"token":{"description":"A possible text token.","type":"string"},"logprob":{"description":"The log probability of this token.","type":"number"}}}}},"required":["token","logprob"]},"ResponseMCPCallArgumentsDeltaEvent":{"type":"object","title":"ResponseMCPCallArgumentsDeltaEvent","description":"Emitted when there is a delta (partial update) to the arguments of an MCP tool call.\n","properties":{"type":{"type":"string","enum":["response.mcp_call_arguments.delta"],"description":"The type of the event. Always 'response.mcp_call_arguments.delta'.","x-stainless-const":true},"output_index":{"type":"integer","description":"The index of the output item in the response's output array."},"item_id":{"type":"string","description":"The unique identifier of the MCP tool call item being processed."},"delta":{"type":"string","description":"A JSON string containing the partial update to the arguments for the MCP tool call.\n"},"sequence_number":{"type":"integer","description":"The sequence number of this event."}},"required":["type","output_index","item_id","delta","sequence_number"],"x-oaiMeta":{"name":"response.mcp_call_arguments.delta","group":"responses","example":"{\n \"type\": \"response.mcp_call_arguments.delta\",\n \"output_index\": 0,\n \"item_id\": \"item-abc\",\n \"delta\": \"{\",\n \"sequence_number\": 1\n}\n"}},"ResponseMCPCallArgumentsDoneEvent":{"type":"object","title":"ResponseMCPCallArgumentsDoneEvent","description":"Emitted when the arguments for an MCP tool call are finalized.\n","properties":{"type":{"type":"string","enum":["response.mcp_call_arguments.done"],"description":"The type of the event. Always 'response.mcp_call_arguments.done'.","x-stainless-const":true},"output_index":{"type":"integer","description":"The index of the output item in the response's output array."},"item_id":{"type":"string","description":"The unique identifier of the MCP tool call item being processed."},"arguments":{"type":"string","description":"A JSON string containing the finalized arguments for the MCP tool call.\n"},"sequence_number":{"type":"integer","description":"The sequence number of this event."}},"required":["type","output_index","item_id","arguments","sequence_number"],"x-oaiMeta":{"name":"response.mcp_call_arguments.done","group":"responses","example":"{\n \"type\": \"response.mcp_call_arguments.done\",\n \"output_index\": 0,\n \"item_id\": \"item-abc\",\n \"arguments\": \"{\\\"arg1\\\": \\\"value1\\\", \\\"arg2\\\": \\\"value2\\\"}\",\n \"sequence_number\": 1\n}\n"}},"ResponseMCPCallCompletedEvent":{"type":"object","title":"ResponseMCPCallCompletedEvent","description":"Emitted when an MCP tool call has completed successfully.\n","properties":{"type":{"type":"string","enum":["response.mcp_call.completed"],"description":"The type of the event. Always 'response.mcp_call.completed'.","x-stainless-const":true},"item_id":{"type":"string","description":"The ID of the MCP tool call item that completed."},"output_index":{"type":"integer","description":"The index of the output item that completed."},"sequence_number":{"type":"integer","description":"The sequence number of this event."}},"required":["type","item_id","output_index","sequence_number"],"x-oaiMeta":{"name":"response.mcp_call.completed","group":"responses","example":"{\n \"type\": \"response.mcp_call.completed\",\n \"sequence_number\": 1,\n \"item_id\": \"mcp_682d437d90a88191bf88cd03aae0c3e503937d5f622d7a90\",\n \"output_index\": 0\n}\n"}},"ResponseMCPCallFailedEvent":{"type":"object","title":"ResponseMCPCallFailedEvent","description":"Emitted when an MCP tool call has failed.\n","properties":{"type":{"type":"string","enum":["response.mcp_call.failed"],"description":"The type of the event. Always 'response.mcp_call.failed'.","x-stainless-const":true},"item_id":{"type":"string","description":"The ID of the MCP tool call item that failed."},"output_index":{"type":"integer","description":"The index of the output item that failed."},"sequence_number":{"type":"integer","description":"The sequence number of this event."}},"required":["type","item_id","output_index","sequence_number"],"x-oaiMeta":{"name":"response.mcp_call.failed","group":"responses","example":"{\n \"type\": \"response.mcp_call.failed\",\n \"sequence_number\": 1,\n \"item_id\": \"mcp_682d437d90a88191bf88cd03aae0c3e503937d5f622d7a90\",\n \"output_index\": 0\n}\n"}},"ResponseMCPCallInProgressEvent":{"type":"object","title":"ResponseMCPCallInProgressEvent","description":"Emitted when an MCP tool call is in progress.\n","properties":{"type":{"type":"string","enum":["response.mcp_call.in_progress"],"description":"The type of the event. Always 'response.mcp_call.in_progress'.","x-stainless-const":true},"sequence_number":{"type":"integer","description":"The sequence number of this event."},"output_index":{"type":"integer","description":"The index of the output item in the response's output array."},"item_id":{"type":"string","description":"The unique identifier of the MCP tool call item being processed."}},"required":["type","output_index","item_id","sequence_number"],"x-oaiMeta":{"name":"response.mcp_call.in_progress","group":"responses","example":"{\n \"type\": \"response.mcp_call.in_progress\",\n \"sequence_number\": 1,\n \"output_index\": 0,\n \"item_id\": \"mcp_682d437d90a88191bf88cd03aae0c3e503937d5f622d7a90\"\n}\n"}},"ResponseMCPListToolsCompletedEvent":{"type":"object","title":"ResponseMCPListToolsCompletedEvent","description":"Emitted when the list of available MCP tools has been successfully retrieved.\n","properties":{"type":{"type":"string","enum":["response.mcp_list_tools.completed"],"description":"The type of the event. Always 'response.mcp_list_tools.completed'.","x-stainless-const":true},"item_id":{"type":"string","description":"The ID of the MCP tool call item that produced this output."},"output_index":{"type":"integer","description":"The index of the output item that was processed."},"sequence_number":{"type":"integer","description":"The sequence number of this event."}},"required":["type","item_id","output_index","sequence_number"],"x-oaiMeta":{"name":"response.mcp_list_tools.completed","group":"responses","example":"{\n \"type\": \"response.mcp_list_tools.completed\",\n \"sequence_number\": 1,\n \"output_index\": 0,\n \"item_id\": \"mcpl_682d4379df088191886b70f4ec39f90403937d5f622d7a90\"\n}\n"}},"ResponseMCPListToolsFailedEvent":{"type":"object","title":"ResponseMCPListToolsFailedEvent","description":"Emitted when the attempt to list available MCP tools has failed.\n","properties":{"type":{"type":"string","enum":["response.mcp_list_tools.failed"],"description":"The type of the event. Always 'response.mcp_list_tools.failed'.","x-stainless-const":true},"item_id":{"type":"string","description":"The ID of the MCP tool call item that failed."},"output_index":{"type":"integer","description":"The index of the output item that failed."},"sequence_number":{"type":"integer","description":"The sequence number of this event."}},"required":["type","item_id","output_index","sequence_number"],"x-oaiMeta":{"name":"response.mcp_list_tools.failed","group":"responses","example":"{\n \"type\": \"response.mcp_list_tools.failed\",\n \"sequence_number\": 1,\n \"output_index\": 0,\n \"item_id\": \"mcpl_682d4379df088191886b70f4ec39f90403937d5f622d7a90\"\n}\n"}},"ResponseMCPListToolsInProgressEvent":{"type":"object","title":"ResponseMCPListToolsInProgressEvent","description":"Emitted when the system is in the process of retrieving the list of available MCP tools.\n","properties":{"type":{"type":"string","enum":["response.mcp_list_tools.in_progress"],"description":"The type of the event. Always 'response.mcp_list_tools.in_progress'.","x-stainless-const":true},"item_id":{"type":"string","description":"The ID of the MCP tool call item that is being processed."},"output_index":{"type":"integer","description":"The index of the output item that is being processed."},"sequence_number":{"type":"integer","description":"The sequence number of this event."}},"required":["type","item_id","output_index","sequence_number"],"x-oaiMeta":{"name":"response.mcp_list_tools.in_progress","group":"responses","example":"{\n \"type\": \"response.mcp_list_tools.in_progress\",\n \"sequence_number\": 1,\n \"output_index\": 0,\n \"item_id\": \"mcpl_682d4379df088191886b70f4ec39f90403937d5f622d7a90\"\n}\n"}},"ResponseModalities":{"anyOf":[{"type":"array","description":"Output types that you would like the model to generate.\nMost models are capable of generating text, which is the default:\n\n`[\"text\"]`\n\nThe `gpt-4o-audio-preview` model can also be used to\n[generate audio](/docs/guides/audio). To request that this model generate\nboth text and audio responses, you can use:\n\n`[\"text\", \"audio\"]`\n","items":{"type":"string","enum":["text","audio"]}},{"type":"null"}]},"ResponseOutputItemAddedEvent":{"type":"object","description":"Emitted when a new output item is added.","properties":{"type":{"type":"string","description":"The type of the event. Always `response.output_item.added`.\n","enum":["response.output_item.added"],"x-stainless-const":true},"output_index":{"type":"integer","description":"The index of the output item that was added.\n"},"sequence_number":{"type":"integer","description":"The sequence number of this event.\n"},"item":{"$ref":"#/components/schemas/OutputItem","description":"The output item that was added.\n"}},"required":["type","output_index","item","sequence_number"],"x-oaiMeta":{"name":"response.output_item.added","group":"responses","example":"{\n \"type\": \"response.output_item.added\",\n \"output_index\": 0,\n \"item\": {\n \"id\": \"msg_123\",\n \"status\": \"in_progress\",\n \"type\": \"message\",\n \"role\": \"assistant\",\n \"content\": []\n },\n \"sequence_number\": 1\n}\n"}},"ResponseOutputItemDoneEvent":{"type":"object","description":"Emitted when an output item is marked done.","properties":{"type":{"type":"string","description":"The type of the event. Always `response.output_item.done`.\n","enum":["response.output_item.done"],"x-stainless-const":true},"output_index":{"type":"integer","description":"The index of the output item that was marked done.\n"},"sequence_number":{"type":"integer","description":"The sequence number of this event.\n"},"item":{"$ref":"#/components/schemas/OutputItem","description":"The output item that was marked done.\n"}},"required":["type","output_index","item","sequence_number"],"x-oaiMeta":{"name":"response.output_item.done","group":"responses","example":"{\n \"type\": \"response.output_item.done\",\n \"output_index\": 0,\n \"item\": {\n \"id\": \"msg_123\",\n \"status\": \"completed\",\n \"type\": \"message\",\n \"role\": \"assistant\",\n \"content\": [\n {\n \"type\": \"output_text\",\n \"text\": \"In a shimmering forest under a sky full of stars, a lonely unicorn named Lila discovered a hidden pond that glowed with moonlight. Every night, she would leave sparkling, magical flowers by the water's edge, hoping to share her beauty with others. One enchanting evening, she woke to find a group of friendly animals gathered around, eager to be friends and share in her magic.\",\n \"annotations\": []\n }\n ]\n },\n \"sequence_number\": 1\n}\n"}},"ResponseOutputTextAnnotationAddedEvent":{"type":"object","title":"ResponseOutputTextAnnotationAddedEvent","description":"Emitted when an annotation is added to output text content.\n","properties":{"type":{"type":"string","enum":["response.output_text.annotation.added"],"description":"The type of the event. Always 'response.output_text.annotation.added'.","x-stainless-const":true},"item_id":{"type":"string","description":"The unique identifier of the item to which the annotation is being added."},"output_index":{"type":"integer","description":"The index of the output item in the response's output array."},"content_index":{"type":"integer","description":"The index of the content part within the output item."},"annotation_index":{"type":"integer","description":"The index of the annotation within the content part."},"sequence_number":{"type":"integer","description":"The sequence number of this event."},"annotation":{"type":"object","description":"The annotation object being added. (See annotation schema for details.)"}},"required":["type","item_id","output_index","content_index","annotation_index","annotation","sequence_number"],"x-oaiMeta":{"name":"response.output_text.annotation.added","group":"responses","example":"{\n \"type\": \"response.output_text.annotation.added\",\n \"item_id\": \"item-abc\",\n \"output_index\": 0,\n \"content_index\": 0,\n \"annotation_index\": 0,\n \"annotation\": {\n \"type\": \"text_annotation\",\n \"text\": \"This is a test annotation\",\n \"start\": 0,\n \"end\": 10\n },\n \"sequence_number\": 1\n}\n"}},"ResponsePromptVariables":{"anyOf":[{"type":"object","title":"Prompt Variables","description":"Optional map of values to substitute in for variables in your\nprompt. The substitution values can either be strings, or other\nResponse input types like images or files.\n","x-oaiExpandable":true,"x-oaiTypeLabel":"map","additionalProperties":{"x-oaiExpandable":true,"x-oaiTypeLabel":"map","oneOf":[{"type":"string"},{"$ref":"#/components/schemas/InputTextContent"},{"$ref":"#/components/schemas/InputImageContent"},{"$ref":"#/components/schemas/InputFileContent"}]}},{"type":"null"}]},"ResponseProperties":{"type":"object","properties":{"previous_response_id":{"anyOf":[{"type":"string","description":"The unique ID of the previous response to the model. Use this to\ncreate multi-turn conversations. Learn more about\n[conversation state](/docs/guides/conversation-state). Cannot be used in conjunction with `conversation`.\n"},{"type":"null"}]},"model":{"description":"Model ID used to generate the response, like `gpt-4o` or `o3`. OpenAI\noffers a wide range of models with different capabilities, performance\ncharacteristics, and price points. Refer to the [model guide](/docs/models)\nto browse and compare available models.\n","$ref":"#/components/schemas/ModelIdsResponses"},"reasoning":{"anyOf":[{"$ref":"#/components/schemas/Reasoning"},{"type":"null"}]},"background":{"anyOf":[{"type":"boolean","description":"Whether to run the model response in the background.\n[Learn more](/docs/guides/background).\n","default":false},{"type":"null"}]},"max_tool_calls":{"anyOf":[{"description":"The maximum number of total calls to built-in tools that can be processed in a response. This maximum number applies across all built-in tool calls, not per individual tool. Any further attempts to call a tool by the model will be ignored.\n","type":"integer"},{"type":"null"}]},"text":{"$ref":"#/components/schemas/ResponseTextParam"},"tools":{"$ref":"#/components/schemas/ToolsArray"},"tool_choice":{"$ref":"#/components/schemas/ToolChoiceParam"},"prompt":{"$ref":"#/components/schemas/Prompt"},"truncation":{"anyOf":[{"type":"string","description":"The truncation strategy to use for the model response.\n- `auto`: If the input to this Response exceeds\n the model's context window size, the model will truncate the\n response to fit the context window by dropping items from the beginning of the conversation.\n- `disabled` (default): If the input size will exceed the context window\n size for a model, the request will fail with a 400 error.\n","enum":["auto","disabled"],"default":"disabled"},{"type":"null"}]}}},"ResponseQueuedEvent":{"type":"object","title":"ResponseQueuedEvent","description":"Emitted when a response is queued and waiting to be processed.\n","properties":{"type":{"type":"string","enum":["response.queued"],"description":"The type of the event. Always 'response.queued'.","x-stainless-const":true},"response":{"$ref":"#/components/schemas/Response","description":"The full response object that is queued."},"sequence_number":{"type":"integer","description":"The sequence number for this event."}},"required":["type","response","sequence_number"],"x-oaiMeta":{"name":"response.queued","group":"responses","example":"{\n \"type\": \"response.queued\",\n \"response\": {\n \"id\": \"res_123\",\n \"status\": \"queued\",\n \"created_at\": \"2021-01-01T00:00:00Z\",\n \"updated_at\": \"2021-01-01T00:00:00Z\"\n },\n \"sequence_number\": 1\n}\n"}},"ResponseReasoningSummaryPartAddedEvent":{"type":"object","description":"Emitted when a new reasoning summary part is added.","properties":{"type":{"type":"string","description":"The type of the event. Always `response.reasoning_summary_part.added`.\n","enum":["response.reasoning_summary_part.added"],"x-stainless-const":true},"item_id":{"type":"string","description":"The ID of the item this summary part is associated with.\n"},"output_index":{"type":"integer","description":"The index of the output item this summary part is associated with.\n"},"summary_index":{"type":"integer","description":"The index of the summary part within the reasoning summary.\n"},"sequence_number":{"type":"integer","description":"The sequence number of this event.\n"},"part":{"type":"object","description":"The summary part that was added.\n","properties":{"type":{"type":"string","description":"The type of the summary part. Always `summary_text`.","enum":["summary_text"],"x-stainless-const":true},"text":{"type":"string","description":"The text of the summary part."}},"required":["type","text"]}},"required":["type","item_id","output_index","summary_index","part","sequence_number"],"x-oaiMeta":{"name":"response.reasoning_summary_part.added","group":"responses","example":"{\n \"type\": \"response.reasoning_summary_part.added\",\n \"item_id\": \"rs_6806bfca0b2481918a5748308061a2600d3ce51bdffd5476\",\n \"output_index\": 0,\n \"summary_index\": 0,\n \"part\": {\n \"type\": \"summary_text\",\n \"text\": \"\"\n },\n \"sequence_number\": 1\n}\n"}},"ResponseReasoningSummaryPartDoneEvent":{"type":"object","description":"Emitted when a reasoning summary part is completed.","properties":{"type":{"type":"string","description":"The type of the event. Always `response.reasoning_summary_part.done`.\n","enum":["response.reasoning_summary_part.done"],"x-stainless-const":true},"item_id":{"type":"string","description":"The ID of the item this summary part is associated with.\n"},"output_index":{"type":"integer","description":"The index of the output item this summary part is associated with.\n"},"summary_index":{"type":"integer","description":"The index of the summary part within the reasoning summary.\n"},"sequence_number":{"type":"integer","description":"The sequence number of this event.\n"},"part":{"type":"object","description":"The completed summary part.\n","properties":{"type":{"type":"string","description":"The type of the summary part. Always `summary_text`.","enum":["summary_text"],"x-stainless-const":true},"text":{"type":"string","description":"The text of the summary part."}},"required":["type","text"]}},"required":["type","item_id","output_index","summary_index","part","sequence_number"],"x-oaiMeta":{"name":"response.reasoning_summary_part.done","group":"responses","example":"{\n \"type\": \"response.reasoning_summary_part.done\",\n \"item_id\": \"rs_6806bfca0b2481918a5748308061a2600d3ce51bdffd5476\",\n \"output_index\": 0,\n \"summary_index\": 0,\n \"part\": {\n \"type\": \"summary_text\",\n \"text\": \"**Responding to a greeting**\\n\\nThe user just said, \\\"Hello!\\\" So, it seems I need to engage. I'll greet them back and offer help since they're looking to chat. I could say something like, \\\"Hello! How can I assist you today?\\\" That feels friendly and open. They didn't ask a specific question, so this approach will work well for starting a conversation. Let's see where it goes from there!\"\n },\n \"sequence_number\": 1\n}\n"}},"ResponseReasoningSummaryTextDeltaEvent":{"type":"object","description":"Emitted when a delta is added to a reasoning summary text.","properties":{"type":{"type":"string","description":"The type of the event. Always `response.reasoning_summary_text.delta`.\n","enum":["response.reasoning_summary_text.delta"],"x-stainless-const":true},"item_id":{"type":"string","description":"The ID of the item this summary text delta is associated with.\n"},"output_index":{"type":"integer","description":"The index of the output item this summary text delta is associated with.\n"},"summary_index":{"type":"integer","description":"The index of the summary part within the reasoning summary.\n"},"delta":{"type":"string","description":"The text delta that was added to the summary.\n"},"sequence_number":{"type":"integer","description":"The sequence number of this event.\n"}},"required":["type","item_id","output_index","summary_index","delta","sequence_number"],"x-oaiMeta":{"name":"response.reasoning_summary_text.delta","group":"responses","example":"{\n \"type\": \"response.reasoning_summary_text.delta\",\n \"item_id\": \"rs_6806bfca0b2481918a5748308061a2600d3ce51bdffd5476\",\n \"output_index\": 0,\n \"summary_index\": 0,\n \"delta\": \"**Responding to a greeting**\\n\\nThe user just said, \\\"Hello!\\\" So, it seems I need to engage. I'll greet them back and offer help since they're looking to chat. I could say something like, \\\"Hello! How can I assist you today?\\\" That feels friendly and open. They didn't ask a specific question, so this approach will work well for starting a conversation. Let's see where it goes from there!\",\n \"sequence_number\": 1\n}\n"}},"ResponseReasoningSummaryTextDoneEvent":{"type":"object","description":"Emitted when a reasoning summary text is completed.","properties":{"type":{"type":"string","description":"The type of the event. Always `response.reasoning_summary_text.done`.\n","enum":["response.reasoning_summary_text.done"],"x-stainless-const":true},"item_id":{"type":"string","description":"The ID of the item this summary text is associated with.\n"},"output_index":{"type":"integer","description":"The index of the output item this summary text is associated with.\n"},"summary_index":{"type":"integer","description":"The index of the summary part within the reasoning summary.\n"},"text":{"type":"string","description":"The full text of the completed reasoning summary.\n"},"sequence_number":{"type":"integer","description":"The sequence number of this event.\n"}},"required":["type","item_id","output_index","summary_index","text","sequence_number"],"x-oaiMeta":{"name":"response.reasoning_summary_text.done","group":"responses","example":"{\n \"type\": \"response.reasoning_summary_text.done\",\n \"item_id\": \"rs_6806bfca0b2481918a5748308061a2600d3ce51bdffd5476\",\n \"output_index\": 0,\n \"summary_index\": 0,\n \"text\": \"**Responding to a greeting**\\n\\nThe user just said, \\\"Hello!\\\" So, it seems I need to engage. I'll greet them back and offer help since they're looking to chat. I could say something like, \\\"Hello! How can I assist you today?\\\" That feels friendly and open. They didn't ask a specific question, so this approach will work well for starting a conversation. Let's see where it goes from there!\",\n \"sequence_number\": 1\n}\n"}},"ResponseReasoningTextDeltaEvent":{"type":"object","description":"Emitted when a delta is added to a reasoning text.","properties":{"type":{"type":"string","description":"The type of the event. Always `response.reasoning_text.delta`.\n","enum":["response.reasoning_text.delta"],"x-stainless-const":true},"item_id":{"type":"string","description":"The ID of the item this reasoning text delta is associated with.\n"},"output_index":{"type":"integer","description":"The index of the output item this reasoning text delta is associated with.\n"},"content_index":{"type":"integer","description":"The index of the reasoning content part this delta is associated with.\n"},"delta":{"type":"string","description":"The text delta that was added to the reasoning content.\n"},"sequence_number":{"type":"integer","description":"The sequence number of this event.\n"}},"required":["type","item_id","output_index","content_index","delta","sequence_number"],"x-oaiMeta":{"name":"response.reasoning_text.delta","group":"responses","example":"{\n \"type\": \"response.reasoning_text.delta\",\n \"item_id\": \"rs_123\",\n \"output_index\": 0,\n \"content_index\": 0,\n \"delta\": \"The\",\n \"sequence_number\": 1\n}\n"}},"ResponseReasoningTextDoneEvent":{"type":"object","description":"Emitted when a reasoning text is completed.","properties":{"type":{"type":"string","description":"The type of the event. Always `response.reasoning_text.done`.\n","enum":["response.reasoning_text.done"],"x-stainless-const":true},"item_id":{"type":"string","description":"The ID of the item this reasoning text is associated with.\n"},"output_index":{"type":"integer","description":"The index of the output item this reasoning text is associated with.\n"},"content_index":{"type":"integer","description":"The index of the reasoning content part.\n"},"text":{"type":"string","description":"The full text of the completed reasoning content.\n"},"sequence_number":{"type":"integer","description":"The sequence number of this event.\n"}},"required":["type","item_id","output_index","content_index","text","sequence_number"],"x-oaiMeta":{"name":"response.reasoning_text.done","group":"responses","example":"{\n \"type\": \"response.reasoning_text.done\",\n \"item_id\": \"rs_123\",\n \"output_index\": 0,\n \"content_index\": 0,\n \"text\": \"The user is asking...\",\n \"sequence_number\": 4\n}\n"}},"ResponseRefusalDeltaEvent":{"type":"object","description":"Emitted when there is a partial refusal text.","properties":{"type":{"type":"string","description":"The type of the event. Always `response.refusal.delta`.\n","enum":["response.refusal.delta"],"x-stainless-const":true},"item_id":{"type":"string","description":"The ID of the output item that the refusal text is added to.\n"},"output_index":{"type":"integer","description":"The index of the output item that the refusal text is added to.\n"},"content_index":{"type":"integer","description":"The index of the content part that the refusal text is added to.\n"},"delta":{"type":"string","description":"The refusal text that is added.\n"},"sequence_number":{"type":"integer","description":"The sequence number of this event.\n"}},"required":["type","item_id","output_index","content_index","delta","sequence_number"],"x-oaiMeta":{"name":"response.refusal.delta","group":"responses","example":"{\n \"type\": \"response.refusal.delta\",\n \"item_id\": \"msg_123\",\n \"output_index\": 0,\n \"content_index\": 0,\n \"delta\": \"refusal text so far\",\n \"sequence_number\": 1\n}\n"}},"ResponseRefusalDoneEvent":{"type":"object","description":"Emitted when refusal text is finalized.","properties":{"type":{"type":"string","description":"The type of the event. Always `response.refusal.done`.\n","enum":["response.refusal.done"],"x-stainless-const":true},"item_id":{"type":"string","description":"The ID of the output item that the refusal text is finalized.\n"},"output_index":{"type":"integer","description":"The index of the output item that the refusal text is finalized.\n"},"content_index":{"type":"integer","description":"The index of the content part that the refusal text is finalized.\n"},"refusal":{"type":"string","description":"The refusal text that is finalized.\n"},"sequence_number":{"type":"integer","description":"The sequence number of this event.\n"}},"required":["type","item_id","output_index","content_index","refusal","sequence_number"],"x-oaiMeta":{"name":"response.refusal.done","group":"responses","example":"{\n \"type\": \"response.refusal.done\",\n \"item_id\": \"item-abc\",\n \"output_index\": 1,\n \"content_index\": 2,\n \"refusal\": \"final refusal text\",\n \"sequence_number\": 1\n}\n"}},"ResponseStreamEvent":{"anyOf":[{"$ref":"#/components/schemas/ResponseAudioDeltaEvent"},{"$ref":"#/components/schemas/ResponseAudioDoneEvent"},{"$ref":"#/components/schemas/ResponseAudioTranscriptDeltaEvent"},{"$ref":"#/components/schemas/ResponseAudioTranscriptDoneEvent"},{"$ref":"#/components/schemas/ResponseCodeInterpreterCallCodeDeltaEvent"},{"$ref":"#/components/schemas/ResponseCodeInterpreterCallCodeDoneEvent"},{"$ref":"#/components/schemas/ResponseCodeInterpreterCallCompletedEvent"},{"$ref":"#/components/schemas/ResponseCodeInterpreterCallInProgressEvent"},{"$ref":"#/components/schemas/ResponseCodeInterpreterCallInterpretingEvent"},{"$ref":"#/components/schemas/ResponseCompletedEvent"},{"$ref":"#/components/schemas/ResponseContentPartAddedEvent"},{"$ref":"#/components/schemas/ResponseContentPartDoneEvent"},{"$ref":"#/components/schemas/ResponseCreatedEvent"},{"$ref":"#/components/schemas/ResponseErrorEvent"},{"$ref":"#/components/schemas/ResponseFileSearchCallCompletedEvent"},{"$ref":"#/components/schemas/ResponseFileSearchCallInProgressEvent"},{"$ref":"#/components/schemas/ResponseFileSearchCallSearchingEvent"},{"$ref":"#/components/schemas/ResponseFunctionCallArgumentsDeltaEvent"},{"$ref":"#/components/schemas/ResponseFunctionCallArgumentsDoneEvent"},{"$ref":"#/components/schemas/ResponseInProgressEvent"},{"$ref":"#/components/schemas/ResponseFailedEvent"},{"$ref":"#/components/schemas/ResponseIncompleteEvent"},{"$ref":"#/components/schemas/ResponseOutputItemAddedEvent"},{"$ref":"#/components/schemas/ResponseOutputItemDoneEvent"},{"$ref":"#/components/schemas/ResponseReasoningSummaryPartAddedEvent"},{"$ref":"#/components/schemas/ResponseReasoningSummaryPartDoneEvent"},{"$ref":"#/components/schemas/ResponseReasoningSummaryTextDeltaEvent"},{"$ref":"#/components/schemas/ResponseReasoningSummaryTextDoneEvent"},{"$ref":"#/components/schemas/ResponseReasoningTextDeltaEvent"},{"$ref":"#/components/schemas/ResponseReasoningTextDoneEvent"},{"$ref":"#/components/schemas/ResponseRefusalDeltaEvent"},{"$ref":"#/components/schemas/ResponseRefusalDoneEvent"},{"$ref":"#/components/schemas/ResponseTextDeltaEvent"},{"$ref":"#/components/schemas/ResponseTextDoneEvent"},{"$ref":"#/components/schemas/ResponseWebSearchCallCompletedEvent"},{"$ref":"#/components/schemas/ResponseWebSearchCallInProgressEvent"},{"$ref":"#/components/schemas/ResponseWebSearchCallSearchingEvent"},{"$ref":"#/components/schemas/ResponseImageGenCallCompletedEvent"},{"$ref":"#/components/schemas/ResponseImageGenCallGeneratingEvent"},{"$ref":"#/components/schemas/ResponseImageGenCallInProgressEvent"},{"$ref":"#/components/schemas/ResponseImageGenCallPartialImageEvent"},{"$ref":"#/components/schemas/ResponseMCPCallArgumentsDeltaEvent"},{"$ref":"#/components/schemas/ResponseMCPCallArgumentsDoneEvent"},{"$ref":"#/components/schemas/ResponseMCPCallCompletedEvent"},{"$ref":"#/components/schemas/ResponseMCPCallFailedEvent"},{"$ref":"#/components/schemas/ResponseMCPCallInProgressEvent"},{"$ref":"#/components/schemas/ResponseMCPListToolsCompletedEvent"},{"$ref":"#/components/schemas/ResponseMCPListToolsFailedEvent"},{"$ref":"#/components/schemas/ResponseMCPListToolsInProgressEvent"},{"$ref":"#/components/schemas/ResponseOutputTextAnnotationAddedEvent"},{"$ref":"#/components/schemas/ResponseQueuedEvent"},{"$ref":"#/components/schemas/ResponseCustomToolCallInputDeltaEvent"},{"$ref":"#/components/schemas/ResponseCustomToolCallInputDoneEvent"}],"discriminator":{"propertyName":"type"}},"ResponseStreamOptions":{"anyOf":[{"description":"Options for streaming responses. Only set this when you set `stream: true`.\n","type":"object","default":null,"properties":{"include_obfuscation":{"type":"boolean","description":"When true, stream obfuscation will be enabled. Stream obfuscation adds\nrandom characters to an `obfuscation` field on streaming delta events to\nnormalize payload sizes as a mitigation to certain side-channel attacks.\nThese obfuscation fields are included by default, but add a small amount\nof overhead to the data stream. You can set `include_obfuscation` to\nfalse to optimize for bandwidth if you trust the network links between\nyour application and the OpenAI API.\n"}}},{"type":"null"}]},"ResponseTextDeltaEvent":{"type":"object","description":"Emitted when there is an additional text delta.","properties":{"type":{"type":"string","description":"The type of the event. Always `response.output_text.delta`.\n","enum":["response.output_text.delta"],"x-stainless-const":true},"item_id":{"type":"string","description":"The ID of the output item that the text delta was added to.\n"},"output_index":{"type":"integer","description":"The index of the output item that the text delta was added to.\n"},"content_index":{"type":"integer","description":"The index of the content part that the text delta was added to.\n"},"delta":{"type":"string","description":"The text delta that was added.\n"},"sequence_number":{"type":"integer","description":"The sequence number for this event."},"logprobs":{"type":"array","description":"The log probabilities of the tokens in the delta.\n","items":{"$ref":"#/components/schemas/ResponseLogProb"}}},"required":["type","item_id","output_index","content_index","delta","sequence_number","logprobs"],"x-oaiMeta":{"name":"response.output_text.delta","group":"responses","example":"{\n \"type\": \"response.output_text.delta\",\n \"item_id\": \"msg_123\",\n \"output_index\": 0,\n \"content_index\": 0,\n \"delta\": \"In\",\n \"sequence_number\": 1\n}\n"}},"ResponseTextDoneEvent":{"type":"object","description":"Emitted when text content is finalized.","properties":{"type":{"type":"string","description":"The type of the event. Always `response.output_text.done`.\n","enum":["response.output_text.done"],"x-stainless-const":true},"item_id":{"type":"string","description":"The ID of the output item that the text content is finalized.\n"},"output_index":{"type":"integer","description":"The index of the output item that the text content is finalized.\n"},"content_index":{"type":"integer","description":"The index of the content part that the text content is finalized.\n"},"text":{"type":"string","description":"The text content that is finalized.\n"},"sequence_number":{"type":"integer","description":"The sequence number for this event."},"logprobs":{"type":"array","description":"The log probabilities of the tokens in the delta.\n","items":{"$ref":"#/components/schemas/ResponseLogProb"}}},"required":["type","item_id","output_index","content_index","text","sequence_number","logprobs"],"x-oaiMeta":{"name":"response.output_text.done","group":"responses","example":"{\n \"type\": \"response.output_text.done\",\n \"item_id\": \"msg_123\",\n \"output_index\": 0,\n \"content_index\": 0,\n \"text\": \"In a shimmering forest under a sky full of stars, a lonely unicorn named Lila discovered a hidden pond that glowed with moonlight. Every night, she would leave sparkling, magical flowers by the water's edge, hoping to share her beauty with others. One enchanting evening, she woke to find a group of friendly animals gathered around, eager to be friends and share in her magic.\",\n \"sequence_number\": 1\n}\n"}},"ResponseTextParam":{"type":"object","description":"Configuration options for a text response from the model. Can be plain\ntext or structured JSON data. Learn more:\n- [Text inputs and outputs](/docs/guides/text)\n- [Structured Outputs](/docs/guides/structured-outputs)\n","properties":{"format":{"$ref":"#/components/schemas/TextResponseFormatConfiguration"},"verbosity":{"$ref":"#/components/schemas/Verbosity"}}},"ResponseUsage":{"type":"object","description":"Represents token usage details including input tokens, output tokens,\na breakdown of output tokens, and the total tokens used.\n","properties":{"input_tokens":{"type":"integer","description":"The number of input tokens."},"input_tokens_details":{"type":"object","description":"A detailed breakdown of the input tokens.","properties":{"cached_tokens":{"type":"integer","description":"The number of tokens that were retrieved from the cache. \n[More on prompt caching](/docs/guides/prompt-caching).\n"}},"required":["cached_tokens"]},"output_tokens":{"type":"integer","description":"The number of output tokens."},"output_tokens_details":{"type":"object","description":"A detailed breakdown of the output tokens.","properties":{"reasoning_tokens":{"type":"integer","description":"The number of reasoning tokens."}},"required":["reasoning_tokens"]},"total_tokens":{"type":"integer","description":"The total number of tokens used."}},"required":["input_tokens","input_tokens_details","output_tokens","output_tokens_details","total_tokens"]},"ResponseWebSearchCallCompletedEvent":{"type":"object","description":"Emitted when a web search call is completed.","properties":{"type":{"type":"string","description":"The type of the event. Always `response.web_search_call.completed`.\n","enum":["response.web_search_call.completed"],"x-stainless-const":true},"output_index":{"type":"integer","description":"The index of the output item that the web search call is associated with.\n"},"item_id":{"type":"string","description":"Unique ID for the output item associated with the web search call.\n"},"sequence_number":{"type":"integer","description":"The sequence number of the web search call being processed."}},"required":["type","output_index","item_id","sequence_number"],"x-oaiMeta":{"name":"response.web_search_call.completed","group":"responses","example":"{\n \"type\": \"response.web_search_call.completed\",\n \"output_index\": 0,\n \"item_id\": \"ws_123\",\n \"sequence_number\": 0\n}\n"}},"ResponseWebSearchCallInProgressEvent":{"type":"object","description":"Emitted when a web search call is initiated.","properties":{"type":{"type":"string","description":"The type of the event. Always `response.web_search_call.in_progress`.\n","enum":["response.web_search_call.in_progress"],"x-stainless-const":true},"output_index":{"type":"integer","description":"The index of the output item that the web search call is associated with.\n"},"item_id":{"type":"string","description":"Unique ID for the output item associated with the web search call.\n"},"sequence_number":{"type":"integer","description":"The sequence number of the web search call being processed."}},"required":["type","output_index","item_id","sequence_number"],"x-oaiMeta":{"name":"response.web_search_call.in_progress","group":"responses","example":"{\n \"type\": \"response.web_search_call.in_progress\",\n \"output_index\": 0,\n \"item_id\": \"ws_123\",\n \"sequence_number\": 0\n}\n"}},"ResponseWebSearchCallSearchingEvent":{"type":"object","description":"Emitted when a web search call is executing.","properties":{"type":{"type":"string","description":"The type of the event. Always `response.web_search_call.searching`.\n","enum":["response.web_search_call.searching"],"x-stainless-const":true},"output_index":{"type":"integer","description":"The index of the output item that the web search call is associated with.\n"},"item_id":{"type":"string","description":"Unique ID for the output item associated with the web search call.\n"},"sequence_number":{"type":"integer","description":"The sequence number of the web search call being processed."}},"required":["type","output_index","item_id","sequence_number"],"x-oaiMeta":{"name":"response.web_search_call.searching","group":"responses","example":"{\n \"type\": \"response.web_search_call.searching\",\n \"output_index\": 0,\n \"item_id\": \"ws_123\",\n \"sequence_number\": 0\n}\n"}},"ResponsesClientEvent":{"discriminator":{"propertyName":"type"},"description":"Client events accepted by the Responses WebSocket server.\n","anyOf":[{"$ref":"#/components/schemas/ResponsesClientEventResponseCreate"}]},"ResponsesClientEventResponseCreate":{"allOf":[{"type":"object","properties":{"type":{"type":"string","enum":["response.create"],"description":"The type of the client event. Always `response.create`.\n","x-stainless-const":true}},"required":["type"]},{"$ref":"#/components/schemas/CreateResponse"}],"description":"Client event for creating a response over a persistent WebSocket connection.\nThis payload uses the same top-level fields as `POST /v1/responses`.\n\nNotes:\n- `stream` is implicit over WebSocket and should not be sent.\n- `background` is not supported over WebSocket.\n"},"ResponsesServerEvent":{"discriminator":{"propertyName":"type"},"description":"Server events emitted by the Responses WebSocket server.\n","anyOf":[{"$ref":"#/components/schemas/ResponseStreamEvent"}]},"Role":{"type":"object","description":"Details about a role that can be assigned through the public Roles API.","properties":{"object":{"type":"string","enum":["role"],"description":"Always `role`.","x-stainless-const":true},"id":{"type":"string","description":"Identifier for the role."},"name":{"type":"string","description":"Unique name for the role."},"description":{"description":"Optional description of the role.","anyOf":[{"type":"string"},{"type":"null"}]},"permissions":{"type":"array","description":"Permissions granted by the role.","items":{"type":"string"}},"resource_type":{"type":"string","description":"Resource type the role is bound to (for example `api.organization` or `api.project`)."},"predefined_role":{"type":"boolean","description":"Whether the role is predefined and managed by OpenAI."}},"required":["object","id","name","description","permissions","resource_type","predefined_role"],"x-oaiMeta":{"name":"The role object","example":"{\n \"object\": \"role\",\n \"id\": \"role_01J1F8ROLE01\",\n \"name\": \"API Group Manager\",\n \"description\": \"Allows managing organization groups\",\n \"permissions\": [\n \"api.groups.read\",\n \"api.groups.write\"\n ],\n \"resource_type\": \"api.organization\",\n \"predefined_role\": false\n}\n"}},"RoleDeletedResource":{"type":"object","description":"Confirmation payload returned after deleting a role.","properties":{"object":{"type":"string","enum":["role.deleted"],"description":"Always `role.deleted`.","x-stainless-const":true},"id":{"type":"string","description":"Identifier of the deleted role."},"deleted":{"type":"boolean","description":"Whether the role was deleted."}},"required":["object","id","deleted"],"x-oaiMeta":{"name":"Role deletion confirmation","example":"{\n \"object\": \"role.deleted\",\n \"id\": \"role_01J1F8ROLE01\",\n \"deleted\": true\n}\n"}},"RoleListResource":{"type":"object","description":"Paginated list of roles assigned to a principal.","properties":{"object":{"type":"string","enum":["list"],"description":"Always `list`.","x-stainless-const":true},"data":{"type":"array","description":"Role assignments returned in the current page.","items":{"$ref":"#/components/schemas/AssignedRoleDetails"}},"has_more":{"type":"boolean","description":"Whether additional assignments are available when paginating."},"next":{"description":"Cursor to fetch the next page of results, or `null` when there are no more assignments.","anyOf":[{"type":"string"},{"type":"null"}]}},"required":["object","data","has_more","next"],"x-oaiMeta":{"name":"Assigned role list","example":"{\n \"object\": \"list\",\n \"data\": [\n {\n \"id\": \"role_01J1F8ROLE01\",\n \"name\": \"API Group Manager\",\n \"permissions\": [\n \"api.groups.read\",\n \"api.groups.write\"\n ],\n \"resource_type\": \"api.organization\",\n \"predefined_role\": false,\n \"description\": \"Allows managing organization groups\",\n \"created_at\": 1711471533,\n \"updated_at\": 1711472599,\n \"created_by\": \"user_abc123\",\n \"created_by_user_obj\": {\n \"id\": \"user_abc123\",\n \"name\": \"Ada Lovelace\",\n \"email\": \"ada@example.com\"\n },\n \"metadata\": {}\n }\n ],\n \"has_more\": false,\n \"next\": null\n}\n"}},"RunCompletionUsage":{"anyOf":[{"type":"object","description":"Usage statistics related to the run. This value will be `null` if the run is not in a terminal state (i.e. `in_progress`, `queued`, etc.).","properties":{"completion_tokens":{"type":"integer","description":"Number of completion tokens used over the course of the run."},"prompt_tokens":{"type":"integer","description":"Number of prompt tokens used over the course of the run."},"total_tokens":{"type":"integer","description":"Total number of tokens used (prompt + completion)."}},"required":["prompt_tokens","completion_tokens","total_tokens"]},{"type":"null"}]},"RunGraderRequest":{"type":"object","title":"RunGraderRequest","properties":{"grader":{"type":"object","description":"The grader used for the fine-tuning job.","oneOf":[{"$ref":"#/components/schemas/GraderStringCheck"},{"$ref":"#/components/schemas/GraderTextSimilarity"},{"$ref":"#/components/schemas/GraderPython"},{"$ref":"#/components/schemas/GraderScoreModel"},{"$ref":"#/components/schemas/GraderMulti"}]},"item":{"type":"object","description":"The dataset item provided to the grader. This will be used to populate \nthe `item` namespace. See [the guide](/docs/guides/graders) for more details. \n"},"model_sample":{"type":"string","description":"The model sample to be evaluated. This value will be used to populate \nthe `sample` namespace. See [the guide](/docs/guides/graders) for more details.\nThe `output_json` variable will be populated if the model sample is a \nvalid JSON string.\n \n"}},"required":["grader","model_sample"]},"RunGraderResponse":{"type":"object","properties":{"reward":{"type":"number"},"metadata":{"type":"object","properties":{"name":{"type":"string"},"type":{"type":"string"},"errors":{"type":"object","properties":{"formula_parse_error":{"type":"boolean"},"sample_parse_error":{"type":"boolean"},"truncated_observation_error":{"type":"boolean"},"unresponsive_reward_error":{"type":"boolean"},"invalid_variable_error":{"type":"boolean"},"other_error":{"type":"boolean"},"python_grader_server_error":{"type":"boolean"},"python_grader_server_error_type":{"anyOf":[{"type":"string"},{"type":"null"}]},"python_grader_runtime_error":{"type":"boolean"},"python_grader_runtime_error_details":{"anyOf":[{"type":"string"},{"type":"null"}]},"model_grader_server_error":{"type":"boolean"},"model_grader_refusal_error":{"type":"boolean"},"model_grader_parse_error":{"type":"boolean"},"model_grader_server_error_details":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["formula_parse_error","sample_parse_error","truncated_observation_error","unresponsive_reward_error","invalid_variable_error","other_error","python_grader_server_error","python_grader_server_error_type","python_grader_runtime_error","python_grader_runtime_error_details","model_grader_server_error","model_grader_refusal_error","model_grader_parse_error","model_grader_server_error_details"]},"execution_time":{"type":"number"},"scores":{"type":"object","additionalProperties":{}},"token_usage":{"anyOf":[{"type":"integer"},{"type":"null"}]},"sampled_model_name":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["name","type","errors","execution_time","scores","token_usage","sampled_model_name"]},"sub_rewards":{"type":"object","additionalProperties":{}},"model_grader_token_usage_per_model":{"type":"object","additionalProperties":{}}},"required":["reward","metadata","sub_rewards","model_grader_token_usage_per_model"]},"RunObject":{"type":"object","title":"A run on a thread","description":"Represents an execution run on a [thread](/docs/api-reference/threads).","properties":{"id":{"description":"The identifier, which can be referenced in API endpoints.","type":"string"},"object":{"description":"The object type, which is always `thread.run`.","type":"string","enum":["thread.run"],"x-stainless-const":true},"created_at":{"description":"The Unix timestamp (in seconds) for when the run was created.","type":"integer"},"thread_id":{"description":"The ID of the [thread](/docs/api-reference/threads) that was executed on as a part of this run.","type":"string"},"assistant_id":{"description":"The ID of the [assistant](/docs/api-reference/assistants) used for execution of this run.","type":"string"},"status":{"description":"The status of the run, which can be either `queued`, `in_progress`, `requires_action`, `cancelling`, `cancelled`, `failed`, `completed`, `incomplete`, or `expired`.","type":"string","enum":["queued","in_progress","requires_action","cancelling","cancelled","failed","completed","incomplete","expired"]},"required_action":{"type":"object","description":"Details on the action required to continue the run. Will be `null` if no action is required.","nullable":true,"properties":{"type":{"description":"For now, this is always `submit_tool_outputs`.","type":"string","enum":["submit_tool_outputs"],"x-stainless-const":true},"submit_tool_outputs":{"type":"object","description":"Details on the tool outputs needed for this run to continue.","properties":{"tool_calls":{"type":"array","description":"A list of the relevant tool calls.","items":{"$ref":"#/components/schemas/RunToolCallObject"}}},"required":["tool_calls"]}},"required":["type","submit_tool_outputs"]},"last_error":{"type":"object","description":"The last error associated with this run. Will be `null` if there are no errors.","nullable":true,"properties":{"code":{"type":"string","description":"One of `server_error`, `rate_limit_exceeded`, or `invalid_prompt`.","enum":["server_error","rate_limit_exceeded","invalid_prompt"]},"message":{"type":"string","description":"A human-readable description of the error."}},"required":["code","message"]},"expires_at":{"description":"The Unix timestamp (in seconds) for when the run will expire.","type":"integer","nullable":true},"started_at":{"description":"The Unix timestamp (in seconds) for when the run was started.","type":"integer","nullable":true},"cancelled_at":{"description":"The Unix timestamp (in seconds) for when the run was cancelled.","type":"integer","nullable":true},"failed_at":{"description":"The Unix timestamp (in seconds) for when the run failed.","type":"integer","nullable":true},"completed_at":{"description":"The Unix timestamp (in seconds) for when the run was completed.","type":"integer","nullable":true},"incomplete_details":{"description":"Details on why the run is incomplete. Will be `null` if the run is not incomplete.","type":"object","nullable":true,"properties":{"reason":{"description":"The reason why the run is incomplete. This will point to which specific token limit was reached over the course of the run.","type":"string","enum":["max_completion_tokens","max_prompt_tokens"]}}},"model":{"description":"The model that the [assistant](/docs/api-reference/assistants) used for this run.","type":"string"},"instructions":{"description":"The instructions that the [assistant](/docs/api-reference/assistants) used for this run.","type":"string"},"tools":{"description":"The list of tools that the [assistant](/docs/api-reference/assistants) used for this run.","default":[],"type":"array","maxItems":20,"items":{"oneOf":[{"$ref":"#/components/schemas/AssistantToolsCode"},{"$ref":"#/components/schemas/AssistantToolsFileSearch"},{"$ref":"#/components/schemas/AssistantToolsFunction"}]}},"metadata":{"$ref":"#/components/schemas/Metadata"},"usage":{"$ref":"#/components/schemas/RunCompletionUsage"},"temperature":{"description":"The sampling temperature used for this run. If not set, defaults to 1.","type":"number","nullable":true},"top_p":{"description":"The nucleus sampling value used for this run. If not set, defaults to 1.","type":"number","nullable":true},"max_prompt_tokens":{"type":"integer","nullable":true,"description":"The maximum number of prompt tokens specified to have been used over the course of the run.\n","minimum":256},"max_completion_tokens":{"type":"integer","nullable":true,"description":"The maximum number of completion tokens specified to have been used over the course of the run.\n","minimum":256},"truncation_strategy":{"allOf":[{"$ref":"#/components/schemas/TruncationObject"},{"nullable":true}]},"tool_choice":{"allOf":[{"$ref":"#/components/schemas/AssistantsApiToolChoiceOption"},{"nullable":true}]},"parallel_tool_calls":{"$ref":"#/components/schemas/ParallelToolCalls"},"response_format":{"$ref":"#/components/schemas/AssistantsApiResponseFormatOption","nullable":true}},"required":["id","object","created_at","thread_id","assistant_id","status","required_action","last_error","expires_at","started_at","cancelled_at","failed_at","completed_at","model","instructions","tools","metadata","usage","incomplete_details","max_prompt_tokens","max_completion_tokens","truncation_strategy","tool_choice","parallel_tool_calls","response_format"],"x-oaiMeta":{"name":"The run object","beta":true,"example":"{\n \"id\": \"run_abc123\",\n \"object\": \"thread.run\",\n \"created_at\": 1698107661,\n \"assistant_id\": \"asst_abc123\",\n \"thread_id\": \"thread_abc123\",\n \"status\": \"completed\",\n \"started_at\": 1699073476,\n \"expires_at\": null,\n \"cancelled_at\": null,\n \"failed_at\": null,\n \"completed_at\": 1699073498,\n \"last_error\": null,\n \"model\": \"gpt-4o\",\n \"instructions\": null,\n \"tools\": [{\"type\": \"file_search\"}, {\"type\": \"code_interpreter\"}],\n \"metadata\": {},\n \"incomplete_details\": null,\n \"usage\": {\n \"prompt_tokens\": 123,\n \"completion_tokens\": 456,\n \"total_tokens\": 579\n },\n \"temperature\": 1.0,\n \"top_p\": 1.0,\n \"max_prompt_tokens\": 1000,\n \"max_completion_tokens\": 1000,\n \"truncation_strategy\": {\n \"type\": \"auto\",\n \"last_messages\": null\n },\n \"response_format\": \"auto\",\n \"tool_choice\": \"auto\",\n \"parallel_tool_calls\": true\n}\n"}},"RunStepCompletionUsage":{"anyOf":[{"type":"object","description":"Usage statistics related to the run step. This value will be `null` while the run step's status is `in_progress`.","properties":{"completion_tokens":{"type":"integer","description":"Number of completion tokens used over the course of the run step."},"prompt_tokens":{"type":"integer","description":"Number of prompt tokens used over the course of the run step."},"total_tokens":{"type":"integer","description":"Total number of tokens used (prompt + completion)."}},"required":["prompt_tokens","completion_tokens","total_tokens"]},{"type":"null"}]},"RunStepDeltaObject":{"type":"object","title":"Run step delta object","description":"Represents a run step delta i.e. any changed fields on a run step during streaming.\n","properties":{"id":{"description":"The identifier of the run step, which can be referenced in API endpoints.","type":"string"},"object":{"description":"The object type, which is always `thread.run.step.delta`.","type":"string","enum":["thread.run.step.delta"],"x-stainless-const":true},"delta":{"description":"The delta containing the fields that have changed on the run step.","type":"object","properties":{"step_details":{"type":"object","description":"The details of the run step.","oneOf":[{"$ref":"#/components/schemas/RunStepDeltaStepDetailsMessageCreationObject"},{"$ref":"#/components/schemas/RunStepDeltaStepDetailsToolCallsObject"}]}}}},"required":["id","object","delta"],"x-oaiMeta":{"name":"The run step delta object","beta":true,"example":"{\n \"id\": \"step_123\",\n \"object\": \"thread.run.step.delta\",\n \"delta\": {\n \"step_details\": {\n \"type\": \"tool_calls\",\n \"tool_calls\": [\n {\n \"index\": 0,\n \"id\": \"call_123\",\n \"type\": \"code_interpreter\",\n \"code_interpreter\": { \"input\": \"\", \"outputs\": [] }\n }\n ]\n }\n }\n}\n"}},"RunStepDeltaStepDetailsMessageCreationObject":{"title":"Message creation","type":"object","description":"Details of the message creation by the run step.","properties":{"type":{"description":"Always `message_creation`.","type":"string","enum":["message_creation"],"x-stainless-const":true},"message_creation":{"type":"object","properties":{"message_id":{"type":"string","description":"The ID of the message that was created by this run step."}}}},"required":["type"]},"RunStepDeltaStepDetailsToolCallsCodeObject":{"title":"Code interpreter tool call","type":"object","description":"Details of the Code Interpreter tool call the run step was involved in.","properties":{"index":{"type":"integer","description":"The index of the tool call in the tool calls array."},"id":{"type":"string","description":"The ID of the tool call."},"type":{"type":"string","description":"The type of tool call. This is always going to be `code_interpreter` for this type of tool call.","enum":["code_interpreter"],"x-stainless-const":true},"code_interpreter":{"type":"object","description":"The Code Interpreter tool call definition.","properties":{"input":{"type":"string","description":"The input to the Code Interpreter tool call."},"outputs":{"type":"array","description":"The outputs from the Code Interpreter tool call. Code Interpreter can output one or more items, including text (`logs`) or images (`image`). Each of these are represented by a different object type.","items":{"type":"object","oneOf":[{"$ref":"#/components/schemas/RunStepDeltaStepDetailsToolCallsCodeOutputLogsObject"},{"$ref":"#/components/schemas/RunStepDeltaStepDetailsToolCallsCodeOutputImageObject"}]}}}}},"required":["index","type"]},"RunStepDeltaStepDetailsToolCallsCodeOutputImageObject":{"title":"Code interpreter image output","type":"object","properties":{"index":{"type":"integer","description":"The index of the output in the outputs array."},"type":{"description":"Always `image`.","type":"string","enum":["image"],"x-stainless-const":true},"image":{"type":"object","properties":{"file_id":{"description":"The [file](/docs/api-reference/files) ID of the image.","type":"string"}}}},"required":["index","type"]},"RunStepDeltaStepDetailsToolCallsCodeOutputLogsObject":{"title":"Code interpreter log output","type":"object","description":"Text output from the Code Interpreter tool call as part of a run step.","properties":{"index":{"type":"integer","description":"The index of the output in the outputs array."},"type":{"description":"Always `logs`.","type":"string","enum":["logs"],"x-stainless-const":true},"logs":{"type":"string","description":"The text output from the Code Interpreter tool call."}},"required":["index","type"]},"RunStepDeltaStepDetailsToolCallsFileSearchObject":{"title":"File search tool call","type":"object","properties":{"index":{"type":"integer","description":"The index of the tool call in the tool calls array."},"id":{"type":"string","description":"The ID of the tool call object."},"type":{"type":"string","description":"The type of tool call. This is always going to be `file_search` for this type of tool call.","enum":["file_search"],"x-stainless-const":true},"file_search":{"type":"object","description":"For now, this is always going to be an empty object.","x-oaiTypeLabel":"map"}},"required":["index","type","file_search"]},"RunStepDeltaStepDetailsToolCallsFunctionObject":{"type":"object","title":"Function tool call","properties":{"index":{"type":"integer","description":"The index of the tool call in the tool calls array."},"id":{"type":"string","description":"The ID of the tool call object."},"type":{"type":"string","description":"The type of tool call. This is always going to be `function` for this type of tool call.","enum":["function"],"x-stainless-const":true},"function":{"type":"object","description":"The definition of the function that was called.","properties":{"name":{"type":"string","description":"The name of the function."},"arguments":{"type":"string","description":"The arguments passed to the function."},"output":{"anyOf":[{"type":"string","description":"The output of the function. This will be `null` if the outputs have not been [submitted](/docs/api-reference/runs/submitToolOutputs) yet."},{"type":"null"}]}}}},"required":["index","type"]},"RunStepDeltaStepDetailsToolCallsObject":{"title":"Tool calls","type":"object","description":"Details of the tool call.","properties":{"type":{"description":"Always `tool_calls`.","type":"string","enum":["tool_calls"],"x-stainless-const":true},"tool_calls":{"type":"array","description":"An array of tool calls the run step was involved in. These can be associated with one of three types of tools: `code_interpreter`, `file_search`, or `function`.\n","items":{"oneOf":[{"$ref":"#/components/schemas/RunStepDeltaStepDetailsToolCallsCodeObject"},{"$ref":"#/components/schemas/RunStepDeltaStepDetailsToolCallsFileSearchObject"},{"$ref":"#/components/schemas/RunStepDeltaStepDetailsToolCallsFunctionObject"}]}}},"required":["type"]},"RunStepDetailsMessageCreationObject":{"title":"Message creation","type":"object","description":"Details of the message creation by the run step.","properties":{"type":{"description":"Always `message_creation`.","type":"string","enum":["message_creation"],"x-stainless-const":true},"message_creation":{"type":"object","properties":{"message_id":{"type":"string","description":"The ID of the message that was created by this run step."}},"required":["message_id"]}},"required":["type","message_creation"]},"RunStepDetailsToolCallsCodeObject":{"title":"Code Interpreter tool call","type":"object","description":"Details of the Code Interpreter tool call the run step was involved in.","properties":{"id":{"type":"string","description":"The ID of the tool call."},"type":{"type":"string","description":"The type of tool call. This is always going to be `code_interpreter` for this type of tool call.","enum":["code_interpreter"],"x-stainless-const":true},"code_interpreter":{"type":"object","description":"The Code Interpreter tool call definition.","required":["input","outputs"],"properties":{"input":{"type":"string","description":"The input to the Code Interpreter tool call."},"outputs":{"type":"array","description":"The outputs from the Code Interpreter tool call. Code Interpreter can output one or more items, including text (`logs`) or images (`image`). Each of these are represented by a different object type.","items":{"type":"object","oneOf":[{"$ref":"#/components/schemas/RunStepDetailsToolCallsCodeOutputLogsObject"},{"$ref":"#/components/schemas/RunStepDetailsToolCallsCodeOutputImageObject"}]}}}}},"required":["id","type","code_interpreter"]},"RunStepDetailsToolCallsCodeOutputImageObject":{"title":"Code Interpreter image output","type":"object","properties":{"type":{"description":"Always `image`.","type":"string","enum":["image"],"x-stainless-const":true},"image":{"type":"object","properties":{"file_id":{"description":"The [file](/docs/api-reference/files) ID of the image.","type":"string"}},"required":["file_id"]}},"required":["type","image"]},"RunStepDetailsToolCallsCodeOutputLogsObject":{"title":"Code Interpreter log output","type":"object","description":"Text output from the Code Interpreter tool call as part of a run step.","properties":{"type":{"description":"Always `logs`.","type":"string","enum":["logs"],"x-stainless-const":true},"logs":{"type":"string","description":"The text output from the Code Interpreter tool call."}},"required":["type","logs"]},"RunStepDetailsToolCallsFileSearchObject":{"title":"File search tool call","type":"object","properties":{"id":{"type":"string","description":"The ID of the tool call object."},"type":{"type":"string","description":"The type of tool call. This is always going to be `file_search` for this type of tool call.","enum":["file_search"],"x-stainless-const":true},"file_search":{"type":"object","description":"For now, this is always going to be an empty object.","x-oaiTypeLabel":"map","properties":{"ranking_options":{"$ref":"#/components/schemas/RunStepDetailsToolCallsFileSearchRankingOptionsObject"},"results":{"type":"array","description":"The results of the file search.","items":{"$ref":"#/components/schemas/RunStepDetailsToolCallsFileSearchResultObject"}}}}},"required":["id","type","file_search"]},"RunStepDetailsToolCallsFileSearchRankingOptionsObject":{"title":"File search tool call ranking options","type":"object","description":"The ranking options for the file search.","properties":{"ranker":{"$ref":"#/components/schemas/FileSearchRanker"},"score_threshold":{"type":"number","description":"The score threshold for the file search. All values must be a floating point number between 0 and 1.","minimum":0,"maximum":1}},"required":["ranker","score_threshold"]},"RunStepDetailsToolCallsFileSearchResultObject":{"title":"File search tool call result","type":"object","description":"A result instance of the file search.","x-oaiTypeLabel":"map","properties":{"file_id":{"type":"string","description":"The ID of the file that result was found in."},"file_name":{"type":"string","description":"The name of the file that result was found in."},"score":{"type":"number","description":"The score of the result. All values must be a floating point number between 0 and 1.","minimum":0,"maximum":1},"content":{"type":"array","description":"The content of the result that was found. The content is only included if requested via the include query parameter.","items":{"type":"object","properties":{"type":{"type":"string","description":"The type of the content.","enum":["text"],"x-stainless-const":true},"text":{"type":"string","description":"The text content of the file."}}}}},"required":["file_id","file_name","score"]},"RunStepDetailsToolCallsFunctionObject":{"type":"object","title":"Function tool call","properties":{"id":{"type":"string","description":"The ID of the tool call object."},"type":{"type":"string","description":"The type of tool call. This is always going to be `function` for this type of tool call.","enum":["function"],"x-stainless-const":true},"function":{"type":"object","description":"The definition of the function that was called.","properties":{"name":{"type":"string","description":"The name of the function."},"arguments":{"type":"string","description":"The arguments passed to the function."},"output":{"anyOf":[{"type":"string","description":"The output of the function. This will be `null` if the outputs have not been [submitted](/docs/api-reference/runs/submitToolOutputs) yet."},{"type":"null"}]}},"required":["name","arguments","output"]}},"required":["id","type","function"]},"RunStepDetailsToolCallsObject":{"title":"Tool calls","type":"object","description":"Details of the tool call.","properties":{"type":{"description":"Always `tool_calls`.","type":"string","enum":["tool_calls"],"x-stainless-const":true},"tool_calls":{"type":"array","description":"An array of tool calls the run step was involved in. These can be associated with one of three types of tools: `code_interpreter`, `file_search`, or `function`.\n","items":{"oneOf":[{"$ref":"#/components/schemas/RunStepDetailsToolCallsCodeObject"},{"$ref":"#/components/schemas/RunStepDetailsToolCallsFileSearchObject"},{"$ref":"#/components/schemas/RunStepDetailsToolCallsFunctionObject"}]}}},"required":["type","tool_calls"]},"RunStepObject":{"type":"object","title":"Run steps","description":"Represents a step in execution of a run.\n","properties":{"id":{"description":"The identifier of the run step, which can be referenced in API endpoints.","type":"string"},"object":{"description":"The object type, which is always `thread.run.step`.","type":"string","enum":["thread.run.step"],"x-stainless-const":true},"created_at":{"description":"The Unix timestamp (in seconds) for when the run step was created.","type":"integer"},"assistant_id":{"description":"The ID of the [assistant](/docs/api-reference/assistants) associated with the run step.","type":"string"},"thread_id":{"description":"The ID of the [thread](/docs/api-reference/threads) that was run.","type":"string"},"run_id":{"description":"The ID of the [run](/docs/api-reference/runs) that this run step is a part of.","type":"string"},"type":{"description":"The type of run step, which can be either `message_creation` or `tool_calls`.","type":"string","enum":["message_creation","tool_calls"]},"status":{"description":"The status of the run step, which can be either `in_progress`, `cancelled`, `failed`, `completed`, or `expired`.","type":"string","enum":["in_progress","cancelled","failed","completed","expired"]},"step_details":{"type":"object","description":"The details of the run step.","oneOf":[{"$ref":"#/components/schemas/RunStepDetailsMessageCreationObject"},{"$ref":"#/components/schemas/RunStepDetailsToolCallsObject"}]},"last_error":{"anyOf":[{"type":"object","description":"The last error associated with this run step. Will be `null` if there are no errors.","properties":{"code":{"type":"string","description":"One of `server_error` or `rate_limit_exceeded`.","enum":["server_error","rate_limit_exceeded"]},"message":{"type":"string","description":"A human-readable description of the error."}},"required":["code","message"]},{"type":"null"}]},"expired_at":{"anyOf":[{"description":"The Unix timestamp (in seconds) for when the run step expired. A step is considered expired if the parent run is expired.","type":"integer"},{"type":"null"}]},"cancelled_at":{"anyOf":[{"description":"The Unix timestamp (in seconds) for when the run step was cancelled.","type":"integer"},{"type":"null"}]},"failed_at":{"anyOf":[{"description":"The Unix timestamp (in seconds) for when the run step failed.","type":"integer"},{"type":"null"}]},"completed_at":{"anyOf":[{"description":"The Unix timestamp (in seconds) for when the run step completed.","type":"integer"},{"type":"null"}]},"metadata":{"$ref":"#/components/schemas/Metadata"},"usage":{"$ref":"#/components/schemas/RunStepCompletionUsage"}},"required":["id","object","created_at","assistant_id","thread_id","run_id","type","status","step_details","last_error","expired_at","cancelled_at","failed_at","completed_at","metadata","usage"],"x-oaiMeta":{"name":"The run step object","beta":true,"example":"{\n \"id\": \"step_abc123\",\n \"object\": \"thread.run.step\",\n \"created_at\": 1699063291,\n \"run_id\": \"run_abc123\",\n \"assistant_id\": \"asst_abc123\",\n \"thread_id\": \"thread_abc123\",\n \"type\": \"message_creation\",\n \"status\": \"completed\",\n \"cancelled_at\": null,\n \"completed_at\": 1699063291,\n \"expired_at\": null,\n \"failed_at\": null,\n \"last_error\": null,\n \"step_details\": {\n \"type\": \"message_creation\",\n \"message_creation\": {\n \"message_id\": \"msg_abc123\"\n }\n },\n \"usage\": {\n \"prompt_tokens\": 123,\n \"completion_tokens\": 456,\n \"total_tokens\": 579\n }\n}\n"}},"RunStepStreamEvent":{"oneOf":[{"type":"object","properties":{"event":{"type":"string","enum":["thread.run.step.created"],"x-stainless-const":true},"data":{"$ref":"#/components/schemas/RunStepObject"}},"required":["event","data"],"description":"Occurs when a [run step](/docs/api-reference/run-steps/step-object) is created.","x-oaiMeta":{"dataDescription":"`data` is a [run step](/docs/api-reference/run-steps/step-object)"}},{"type":"object","properties":{"event":{"type":"string","enum":["thread.run.step.in_progress"],"x-stainless-const":true},"data":{"$ref":"#/components/schemas/RunStepObject"}},"required":["event","data"],"description":"Occurs when a [run step](/docs/api-reference/run-steps/step-object) moves to an `in_progress` state.","x-oaiMeta":{"dataDescription":"`data` is a [run step](/docs/api-reference/run-steps/step-object)"}},{"type":"object","properties":{"event":{"type":"string","enum":["thread.run.step.delta"],"x-stainless-const":true},"data":{"$ref":"#/components/schemas/RunStepDeltaObject"}},"required":["event","data"],"description":"Occurs when parts of a [run step](/docs/api-reference/run-steps/step-object) are being streamed.","x-oaiMeta":{"dataDescription":"`data` is a [run step delta](/docs/api-reference/assistants-streaming/run-step-delta-object)"}},{"type":"object","properties":{"event":{"type":"string","enum":["thread.run.step.completed"],"x-stainless-const":true},"data":{"$ref":"#/components/schemas/RunStepObject"}},"required":["event","data"],"description":"Occurs when a [run step](/docs/api-reference/run-steps/step-object) is completed.","x-oaiMeta":{"dataDescription":"`data` is a [run step](/docs/api-reference/run-steps/step-object)"}},{"type":"object","properties":{"event":{"type":"string","enum":["thread.run.step.failed"],"x-stainless-const":true},"data":{"$ref":"#/components/schemas/RunStepObject"}},"required":["event","data"],"description":"Occurs when a [run step](/docs/api-reference/run-steps/step-object) fails.","x-oaiMeta":{"dataDescription":"`data` is a [run step](/docs/api-reference/run-steps/step-object)"}},{"type":"object","properties":{"event":{"type":"string","enum":["thread.run.step.cancelled"],"x-stainless-const":true},"data":{"$ref":"#/components/schemas/RunStepObject"}},"required":["event","data"],"description":"Occurs when a [run step](/docs/api-reference/run-steps/step-object) is cancelled.","x-oaiMeta":{"dataDescription":"`data` is a [run step](/docs/api-reference/run-steps/step-object)"}},{"type":"object","properties":{"event":{"type":"string","enum":["thread.run.step.expired"],"x-stainless-const":true},"data":{"$ref":"#/components/schemas/RunStepObject"}},"required":["event","data"],"description":"Occurs when a [run step](/docs/api-reference/run-steps/step-object) expires.","x-oaiMeta":{"dataDescription":"`data` is a [run step](/docs/api-reference/run-steps/step-object)"}}]},"RunStreamEvent":{"oneOf":[{"type":"object","properties":{"event":{"type":"string","enum":["thread.run.created"],"x-stainless-const":true},"data":{"$ref":"#/components/schemas/RunObject"}},"required":["event","data"],"description":"Occurs when a new [run](/docs/api-reference/runs/object) is created.","x-oaiMeta":{"dataDescription":"`data` is a [run](/docs/api-reference/runs/object)"}},{"type":"object","properties":{"event":{"type":"string","enum":["thread.run.queued"],"x-stainless-const":true},"data":{"$ref":"#/components/schemas/RunObject"}},"required":["event","data"],"description":"Occurs when a [run](/docs/api-reference/runs/object) moves to a `queued` status.","x-oaiMeta":{"dataDescription":"`data` is a [run](/docs/api-reference/runs/object)"}},{"type":"object","properties":{"event":{"type":"string","enum":["thread.run.in_progress"],"x-stainless-const":true},"data":{"$ref":"#/components/schemas/RunObject"}},"required":["event","data"],"description":"Occurs when a [run](/docs/api-reference/runs/object) moves to an `in_progress` status.","x-oaiMeta":{"dataDescription":"`data` is a [run](/docs/api-reference/runs/object)"}},{"type":"object","properties":{"event":{"type":"string","enum":["thread.run.requires_action"],"x-stainless-const":true},"data":{"$ref":"#/components/schemas/RunObject"}},"required":["event","data"],"description":"Occurs when a [run](/docs/api-reference/runs/object) moves to a `requires_action` status.","x-oaiMeta":{"dataDescription":"`data` is a [run](/docs/api-reference/runs/object)"}},{"type":"object","properties":{"event":{"type":"string","enum":["thread.run.completed"],"x-stainless-const":true},"data":{"$ref":"#/components/schemas/RunObject"}},"required":["event","data"],"description":"Occurs when a [run](/docs/api-reference/runs/object) is completed.","x-oaiMeta":{"dataDescription":"`data` is a [run](/docs/api-reference/runs/object)"}},{"type":"object","properties":{"event":{"type":"string","enum":["thread.run.incomplete"],"x-stainless-const":true},"data":{"$ref":"#/components/schemas/RunObject"}},"required":["event","data"],"description":"Occurs when a [run](/docs/api-reference/runs/object) ends with status `incomplete`.","x-oaiMeta":{"dataDescription":"`data` is a [run](/docs/api-reference/runs/object)"}},{"type":"object","properties":{"event":{"type":"string","enum":["thread.run.failed"],"x-stainless-const":true},"data":{"$ref":"#/components/schemas/RunObject"}},"required":["event","data"],"description":"Occurs when a [run](/docs/api-reference/runs/object) fails.","x-oaiMeta":{"dataDescription":"`data` is a [run](/docs/api-reference/runs/object)"}},{"type":"object","properties":{"event":{"type":"string","enum":["thread.run.cancelling"],"x-stainless-const":true},"data":{"$ref":"#/components/schemas/RunObject"}},"required":["event","data"],"description":"Occurs when a [run](/docs/api-reference/runs/object) moves to a `cancelling` status.","x-oaiMeta":{"dataDescription":"`data` is a [run](/docs/api-reference/runs/object)"}},{"type":"object","properties":{"event":{"type":"string","enum":["thread.run.cancelled"],"x-stainless-const":true},"data":{"$ref":"#/components/schemas/RunObject"}},"required":["event","data"],"description":"Occurs when a [run](/docs/api-reference/runs/object) is cancelled.","x-oaiMeta":{"dataDescription":"`data` is a [run](/docs/api-reference/runs/object)"}},{"type":"object","properties":{"event":{"type":"string","enum":["thread.run.expired"],"x-stainless-const":true},"data":{"$ref":"#/components/schemas/RunObject"}},"required":["event","data"],"description":"Occurs when a [run](/docs/api-reference/runs/object) expires.","x-oaiMeta":{"dataDescription":"`data` is a [run](/docs/api-reference/runs/object)"}}]},"RunToolCallObject":{"type":"object","description":"Tool call objects","properties":{"id":{"type":"string","description":"The ID of the tool call. This ID must be referenced when you submit the tool outputs in using the [Submit tool outputs to run](/docs/api-reference/runs/submitToolOutputs) endpoint."},"type":{"type":"string","description":"The type of tool call the output is required for. For now, this is always `function`.","enum":["function"],"x-stainless-const":true},"function":{"type":"object","description":"The function definition.","properties":{"name":{"type":"string","description":"The name of the function."},"arguments":{"type":"string","description":"The arguments that the model expects you to pass to the function."}},"required":["name","arguments"]}},"required":["id","type","function"]},"ServiceTier":{"anyOf":[{"type":"string","description":"Specifies the processing type used for serving the request.\n - If set to 'auto', then the request will be processed with the service tier configured in the Project settings. Unless otherwise configured, the Project will use 'default'.\n - If set to 'default', then the request will be processed with the standard pricing and performance for the selected model.\n - If set to '[flex](/docs/guides/flex-processing)' or '[priority](https://openai.com/api-priority-processing/)', then the request will be processed with the corresponding service tier.\n - When not set, the default behavior is 'auto'.\n\n When the `service_tier` parameter is set, the response body will include the `service_tier` value based on the processing mode actually used to serve the request. This response value may be different from the value set in the parameter.\n","enum":["auto","default","flex","scale","priority"],"default":"auto"},{"type":"null"}]},"SpeechAudioDeltaEvent":{"type":"object","description":"Emitted for each chunk of audio data generated during speech synthesis.","properties":{"type":{"type":"string","description":"The type of the event. Always `speech.audio.delta`.\n","enum":["speech.audio.delta"],"x-stainless-const":true},"audio":{"type":"string","description":"A chunk of Base64-encoded audio data.\n"}},"required":["type","audio"],"x-oaiMeta":{"name":"Stream Event (speech.audio.delta)","group":"speech","example":"{\n \"type\": \"speech.audio.delta\",\n \"audio\": \"base64-encoded-audio-data\"\n}\n"}},"SpeechAudioDoneEvent":{"type":"object","description":"Emitted when the speech synthesis is complete and all audio has been streamed.","properties":{"type":{"type":"string","description":"The type of the event. Always `speech.audio.done`.\n","enum":["speech.audio.done"],"x-stainless-const":true},"usage":{"type":"object","description":"Token usage statistics for the request.\n","properties":{"input_tokens":{"type":"integer","description":"Number of input tokens in the prompt."},"output_tokens":{"type":"integer","description":"Number of output tokens generated."},"total_tokens":{"type":"integer","description":"Total number of tokens used (input + output)."}},"required":["input_tokens","output_tokens","total_tokens"]}},"required":["type","usage"],"x-oaiMeta":{"name":"Stream Event (speech.audio.done)","group":"speech","example":"{\n \"type\": \"speech.audio.done\",\n \"usage\": {\n \"input_tokens\": 14,\n \"output_tokens\": 101,\n \"total_tokens\": 115\n }\n}\n"}},"StaticChunkingStrategy":{"type":"object","additionalProperties":false,"properties":{"max_chunk_size_tokens":{"type":"integer","minimum":100,"maximum":4096,"description":"The maximum number of tokens in each chunk. The default value is `800`. The minimum value is `100` and the maximum value is `4096`."},"chunk_overlap_tokens":{"type":"integer","description":"The number of tokens that overlap between chunks. The default value is `400`.\n\nNote that the overlap must not exceed half of `max_chunk_size_tokens`.\n"}},"required":["max_chunk_size_tokens","chunk_overlap_tokens"]},"StaticChunkingStrategyRequestParam":{"type":"object","title":"Static Chunking Strategy","description":"Customize your own chunking strategy by setting chunk size and chunk overlap.","additionalProperties":false,"properties":{"type":{"type":"string","description":"Always `static`.","enum":["static"],"x-stainless-const":true},"static":{"$ref":"#/components/schemas/StaticChunkingStrategy"}},"required":["type","static"]},"StaticChunkingStrategyResponseParam":{"type":"object","title":"Static Chunking Strategy","additionalProperties":false,"properties":{"type":{"type":"string","description":"Always `static`.","enum":["static"],"x-stainless-const":true},"static":{"$ref":"#/components/schemas/StaticChunkingStrategy"}},"required":["type","static"]},"StopConfiguration":{"description":"Not supported with latest reasoning models `o3` and `o4-mini`.\n\nUp to 4 sequences where the API will stop generating further tokens. The\nreturned text will not contain the stop sequence.\n","default":null,"nullable":true,"oneOf":[{"type":"string","default":"<|endoftext|>","example":"\n","nullable":true},{"type":"array","minItems":1,"maxItems":4,"items":{"type":"string","example":"[\"\\n\"]"}}]},"SubmitToolOutputsRunRequest":{"type":"object","additionalProperties":false,"properties":{"tool_outputs":{"description":"A list of tools for which the outputs are being submitted.","type":"array","items":{"type":"object","properties":{"tool_call_id":{"type":"string","description":"The ID of the tool call in the `required_action` object within the run object the output is being submitted for."},"output":{"type":"string","description":"The output of the tool call to be submitted to continue the run."}}}},"stream":{"anyOf":[{"type":"boolean","description":"If `true`, returns a stream of events that happen during the Run as server-sent events, terminating when the Run enters a terminal state with a `data: [DONE]` message.\n"},{"type":"null"}]}},"required":["tool_outputs"]},"TextResponseFormatConfiguration":{"description":"An object specifying the format that the model must output.\n\nConfiguring `{ \"type\": \"json_schema\" }` enables Structured Outputs, \nwhich ensures the model will match your supplied JSON schema. Learn more in the \n[Structured Outputs guide](/docs/guides/structured-outputs).\n\nThe default format is `{ \"type\": \"text\" }` with no additional options.\n\n**Not recommended for gpt-4o and newer models:**\n\nSetting to `{ \"type\": \"json_object\" }` enables the older JSON mode, which\nensures the message the model generates is valid JSON. Using `json_schema`\nis preferred for models that support it.\n","oneOf":[{"$ref":"#/components/schemas/ResponseFormatText"},{"$ref":"#/components/schemas/TextResponseFormatJsonSchema"},{"$ref":"#/components/schemas/ResponseFormatJsonObject"}]},"TextResponseFormatJsonSchema":{"type":"object","title":"JSON schema","description":"JSON Schema response format. Used to generate structured JSON responses.\nLearn more about [Structured Outputs](/docs/guides/structured-outputs).\n","properties":{"type":{"type":"string","description":"The type of response format being defined. Always `json_schema`.","enum":["json_schema"],"x-stainless-const":true},"description":{"type":"string","description":"A description of what the response format is for, used by the model to\ndetermine how to respond in the format.\n"},"name":{"type":"string","description":"The name of the response format. Must be a-z, A-Z, 0-9, or contain\nunderscores and dashes, with a maximum length of 64.\n"},"schema":{"$ref":"#/components/schemas/ResponseFormatJsonSchemaSchema"},"strict":{"anyOf":[{"type":"boolean","default":false,"description":"Whether to enable strict schema adherence when generating the output.\nIf set to true, the model will always follow the exact schema defined\nin the `schema` field. Only a subset of JSON Schema is supported when\n`strict` is `true`. To learn more, read the [Structured Outputs\nguide](/docs/guides/structured-outputs).\n"},{"type":"null"}]}},"required":["type","schema","name"]},"ThreadObject":{"type":"object","title":"Thread","description":"Represents a thread that contains [messages](/docs/api-reference/messages).","properties":{"id":{"description":"The identifier, which can be referenced in API endpoints.","type":"string"},"object":{"description":"The object type, which is always `thread`.","type":"string","enum":["thread"],"x-stainless-const":true},"created_at":{"description":"The Unix timestamp (in seconds) for when the thread was created.","type":"integer"},"tool_resources":{"anyOf":[{"type":"object","description":"A set of resources that are made available to the assistant's tools in this thread. The resources are specific to the type of tool. For example, the `code_interpreter` tool requires a list of file IDs, while the `file_search` tool requires a list of vector store IDs.\n","properties":{"code_interpreter":{"type":"object","properties":{"file_ids":{"type":"array","description":"A list of [file](/docs/api-reference/files) IDs made available to the `code_interpreter` tool. There can be a maximum of 20 files associated with the tool.\n","default":[],"maxItems":20,"items":{"type":"string"}}}},"file_search":{"type":"object","properties":{"vector_store_ids":{"type":"array","description":"The [vector store](/docs/api-reference/vector-stores/object) attached to this thread. There can be a maximum of 1 vector store attached to the thread.\n","maxItems":1,"items":{"type":"string"}}}}}},{"type":"null"}]},"metadata":{"$ref":"#/components/schemas/Metadata"}},"required":["id","object","created_at","tool_resources","metadata"],"x-oaiMeta":{"name":"The thread object","beta":true,"example":"{\n \"id\": \"thread_abc123\",\n \"object\": \"thread\",\n \"created_at\": 1698107661,\n \"metadata\": {}\n}\n"}},"ThreadStreamEvent":{"oneOf":[{"type":"object","properties":{"enabled":{"type":"boolean","description":"Whether to enable input audio transcription."},"event":{"type":"string","enum":["thread.created"],"x-stainless-const":true},"data":{"$ref":"#/components/schemas/ThreadObject"}},"required":["event","data"],"description":"Occurs when a new [thread](/docs/api-reference/threads/object) is created.","x-oaiMeta":{"dataDescription":"`data` is a [thread](/docs/api-reference/threads/object)"}}]},"ToggleCertificatesRequest":{"type":"object","properties":{"certificate_ids":{"type":"array","items":{"type":"string","example":"cert_abc"},"minItems":1,"maxItems":10}},"required":["certificate_ids"]},"Tool":{"description":"A tool that can be used to generate a response.\n","discriminator":{"propertyName":"type"},"oneOf":[{"$ref":"#/components/schemas/FunctionTool"},{"$ref":"#/components/schemas/FileSearchTool"},{"$ref":"#/components/schemas/ComputerTool"},{"$ref":"#/components/schemas/ComputerUsePreviewTool"},{"$ref":"#/components/schemas/WebSearchTool"},{"$ref":"#/components/schemas/MCPTool"},{"$ref":"#/components/schemas/CodeInterpreterTool"},{"$ref":"#/components/schemas/ImageGenTool"},{"$ref":"#/components/schemas/LocalShellToolParam"},{"$ref":"#/components/schemas/FunctionShellToolParam"},{"$ref":"#/components/schemas/CustomToolParam"},{"$ref":"#/components/schemas/NamespaceToolParam"},{"$ref":"#/components/schemas/ToolSearchToolParam"},{"$ref":"#/components/schemas/WebSearchPreviewTool"},{"$ref":"#/components/schemas/ApplyPatchToolParam"}]},"ToolChoiceAllowed":{"type":"object","title":"Allowed tools","description":"Constrains the tools available to the model to a pre-defined set.\n","properties":{"type":{"type":"string","enum":["allowed_tools"],"description":"Allowed tool configuration type. Always `allowed_tools`.","x-stainless-const":true},"mode":{"type":"string","enum":["auto","required"],"description":"Constrains the tools available to the model to a pre-defined set.\n\n`auto` allows the model to pick from among the allowed tools and generate a\nmessage.\n\n`required` requires the model to call one or more of the allowed tools.\n"},"tools":{"type":"array","description":"A list of tool definitions that the model should be allowed to call.\n\nFor the Responses API, the list of tool definitions might look like:\n```json\n[\n { \"type\": \"function\", \"name\": \"get_weather\" },\n { \"type\": \"mcp\", \"server_label\": \"deepwiki\" },\n { \"type\": \"image_generation\" }\n]\n```\n","items":{"type":"object","description":"A tool definition that the model should be allowed to call.\n","additionalProperties":true,"x-oaiExpandable":false}}},"required":["type","mode","tools"]},"ToolChoiceCustom":{"type":"object","title":"Custom tool","description":"Use this option to force the model to call a specific custom tool.\n","properties":{"type":{"type":"string","enum":["custom"],"description":"For custom tool calling, the type is always `custom`.","x-stainless-const":true},"name":{"type":"string","description":"The name of the custom tool to call."}},"required":["type","name"]},"ToolChoiceFunction":{"type":"object","title":"Function tool","description":"Use this option to force the model to call a specific function.\n","properties":{"type":{"type":"string","enum":["function"],"description":"For function calling, the type is always `function`.","x-stainless-const":true},"name":{"type":"string","description":"The name of the function to call."}},"required":["type","name"]},"ToolChoiceMCP":{"type":"object","title":"MCP tool","description":"Use this option to force the model to call a specific tool on a remote MCP server.\n","properties":{"type":{"type":"string","enum":["mcp"],"description":"For MCP tools, the type is always `mcp`.","x-stainless-const":true},"server_label":{"type":"string","description":"The label of the MCP server to use.\n"},"name":{"anyOf":[{"type":"string","description":"The name of the tool to call on the server.\n"},{"type":"null"}]}},"required":["type","server_label"]},"ToolChoiceOptions":{"type":"string","title":"Tool choice mode","description":"Controls which (if any) tool is called by the model.\n\n`none` means the model will not call any tool and instead generates a message.\n\n`auto` means the model can pick between generating a message or calling one or\nmore tools.\n\n`required` means the model must call one or more tools.\n","enum":["none","auto","required"]},"ToolChoiceParam":{"description":"How the model should select which tool (or tools) to use when generating\na response. See the `tools` parameter to see how to specify which tools\nthe model can call.\n","oneOf":[{"$ref":"#/components/schemas/ToolChoiceOptions"},{"$ref":"#/components/schemas/ToolChoiceAllowed"},{"$ref":"#/components/schemas/ToolChoiceTypes"},{"$ref":"#/components/schemas/ToolChoiceFunction"},{"$ref":"#/components/schemas/ToolChoiceMCP"},{"$ref":"#/components/schemas/ToolChoiceCustom"},{"$ref":"#/components/schemas/SpecificApplyPatchParam"},{"$ref":"#/components/schemas/SpecificFunctionShellParam"}]},"ToolChoiceTypes":{"type":"object","title":"Hosted tool","description":"Indicates that the model should use a built-in tool to generate a response.\n[Learn more about built-in tools](/docs/guides/tools).\n","properties":{"type":{"type":"string","description":"The type of hosted tool the model should to use. Learn more about\n[built-in tools](/docs/guides/tools).\n\nAllowed values are:\n- `file_search`\n- `web_search_preview`\n- `computer`\n- `computer_use_preview`\n- `computer_use`\n- `code_interpreter`\n- `image_generation`\n","enum":["file_search","web_search_preview","computer","computer_use_preview","computer_use","web_search_preview_2025_03_11","image_generation","code_interpreter"]}},"required":["type"]},"ToolsArray":{"type":"array","description":"An array of tools the model may call while generating a response. You\ncan specify which tool to use by setting the `tool_choice` parameter.\n\nWe support the following categories of tools:\n- **Built-in tools**: Tools that are provided by OpenAI that extend the\n model's capabilities, like [web search](/docs/guides/tools-web-search)\n or [file search](/docs/guides/tools-file-search). Learn more about\n [built-in tools](/docs/guides/tools).\n- **MCP Tools**: Integrations with third-party systems via custom MCP servers\n or predefined connectors such as Google Drive and SharePoint. Learn more about\n [MCP Tools](/docs/guides/tools-connectors-mcp).\n- **Function calls (custom tools)**: Functions that are defined by you,\n enabling the model to call your own code with strongly typed arguments\n and outputs. Learn more about\n [function calling](/docs/guides/function-calling). You can also use\n custom tools to call your own code.\n","items":{"$ref":"#/components/schemas/Tool"}},"TranscriptTextDeltaEvent":{"type":"object","description":"Emitted when there is an additional text delta. This is also the first event emitted when the transcription starts. Only emitted when you [create a transcription](/docs/api-reference/audio/create-transcription) with the `Stream` parameter set to `true`.","properties":{"type":{"type":"string","description":"The type of the event. Always `transcript.text.delta`.\n","enum":["transcript.text.delta"],"x-stainless-const":true},"delta":{"type":"string","description":"The text delta that was additionally transcribed.\n"},"logprobs":{"type":"array","description":"The log probabilities of the delta. Only included if you [create a transcription](/docs/api-reference/audio/create-transcription) with the `include[]` parameter set to `logprobs`.\n","items":{"type":"object","properties":{"token":{"type":"string","description":"The token that was used to generate the log probability.\n"},"logprob":{"type":"number","description":"The log probability of the token.\n"},"bytes":{"type":"array","items":{"type":"integer"},"description":"The bytes that were used to generate the log probability.\n"}}}},"segment_id":{"type":"string","description":"Identifier of the diarized segment that this delta belongs to. Only present when using `gpt-4o-transcribe-diarize`.\n"}},"required":["type","delta"],"x-oaiMeta":{"name":"Stream Event (transcript.text.delta)","group":"transcript","example":"{\n \"type\": \"transcript.text.delta\",\n \"delta\": \" wonderful\"\n}\n"}},"TranscriptTextDoneEvent":{"type":"object","description":"Emitted when the transcription is complete. Contains the complete transcription text. Only emitted when you [create a transcription](/docs/api-reference/audio/create-transcription) with the `Stream` parameter set to `true`.","properties":{"type":{"type":"string","description":"The type of the event. Always `transcript.text.done`.\n","enum":["transcript.text.done"],"x-stainless-const":true},"text":{"type":"string","description":"The text that was transcribed.\n"},"logprobs":{"type":"array","description":"The log probabilities of the individual tokens in the transcription. Only included if you [create a transcription](/docs/api-reference/audio/create-transcription) with the `include[]` parameter set to `logprobs`.\n","items":{"type":"object","properties":{"token":{"type":"string","description":"The token that was used to generate the log probability.\n"},"logprob":{"type":"number","description":"The log probability of the token.\n"},"bytes":{"type":"array","items":{"type":"integer"},"description":"The bytes that were used to generate the log probability.\n"}}}},"usage":{"$ref":"#/components/schemas/TranscriptTextUsageTokens"}},"required":["type","text"],"x-oaiMeta":{"name":"Stream Event (transcript.text.done)","group":"transcript","example":"{\n \"type\": \"transcript.text.done\",\n \"text\": \"I see skies of blue and clouds of white, the bright blessed days, the dark sacred nights, and I think to myself, what a wonderful world.\",\n \"usage\": {\n \"type\": \"tokens\",\n \"input_tokens\": 14,\n \"input_token_details\": {\n \"text_tokens\": 10,\n \"audio_tokens\": 4\n },\n \"output_tokens\": 31,\n \"total_tokens\": 45\n }\n}\n"}},"TranscriptTextSegmentEvent":{"type":"object","description":"Emitted when a diarized transcription returns a completed segment with speaker information. Only emitted when you [create a transcription](/docs/api-reference/audio/create-transcription) with `stream` set to `true` and `response_format` set to `diarized_json`.\n","properties":{"type":{"type":"string","description":"The type of the event. Always `transcript.text.segment`.","enum":["transcript.text.segment"],"x-stainless-const":true},"id":{"type":"string","description":"Unique identifier for the segment."},"start":{"type":"number","format":"float","description":"Start timestamp of the segment in seconds."},"end":{"type":"number","format":"float","description":"End timestamp of the segment in seconds."},"text":{"type":"string","description":"Transcript text for this segment."},"speaker":{"type":"string","description":"Speaker label for this segment."}},"required":["type","id","start","end","text","speaker"],"x-oaiMeta":{"name":"Stream Event (transcript.text.segment)","group":"transcript","example":"{\n \"type\": \"transcript.text.segment\",\n \"id\": \"seg_002\",\n \"start\": 5.2,\n \"end\": 12.8,\n \"text\": \"Hi, I need help with diarization.\",\n \"speaker\": \"A\"\n}\n"}},"TranscriptTextUsageDuration":{"type":"object","title":"Duration Usage","description":"Usage statistics for models billed by audio input duration.","properties":{"type":{"type":"string","enum":["duration"],"description":"The type of the usage object. Always `duration` for this variant.","x-stainless-const":true},"seconds":{"type":"number","description":"Duration of the input audio in seconds."}},"required":["type","seconds"]},"TranscriptTextUsageTokens":{"type":"object","title":"Token Usage","description":"Usage statistics for models billed by token usage.","properties":{"type":{"type":"string","enum":["tokens"],"description":"The type of the usage object. Always `tokens` for this variant.","x-stainless-const":true},"input_tokens":{"type":"integer","description":"Number of input tokens billed for this request."},"input_token_details":{"type":"object","description":"Details about the input tokens billed for this request.","properties":{"text_tokens":{"type":"integer","description":"Number of text tokens billed for this request."},"audio_tokens":{"type":"integer","description":"Number of audio tokens billed for this request."}}},"output_tokens":{"type":"integer","description":"Number of output tokens generated."},"total_tokens":{"type":"integer","description":"Total number of tokens used (input + output)."}},"required":["type","input_tokens","output_tokens","total_tokens"]},"TranscriptionChunkingStrategy":{"type":"object","description":"Controls how the audio is cut into chunks. When set to `\"auto\"`, the\nserver first normalizes loudness and then uses voice activity detection (VAD) to\nchoose boundaries. `server_vad` object can be provided to tweak VAD detection\nparameters manually. If unset, the audio is transcribed as a single block. ","oneOf":[{"type":"string","enum":["auto"],"default":["auto"],"description":"Automatically set chunking parameters based on the audio. Must be set to `\"auto\"`.\n","x-stainless-const":true},{"$ref":"#/components/schemas/VadConfig"}]},"TranscriptionDiarizedSegment":{"type":"object","description":"A segment of diarized transcript text with speaker metadata.","properties":{"type":{"type":"string","description":"The type of the segment. Always `transcript.text.segment`.\n","enum":["transcript.text.segment"],"x-stainless-const":true},"id":{"type":"string","description":"Unique identifier for the segment."},"start":{"type":"number","format":"float","description":"Start timestamp of the segment in seconds."},"end":{"type":"number","format":"float","description":"End timestamp of the segment in seconds."},"text":{"type":"string","description":"Transcript text for this segment."},"speaker":{"type":"string","description":"Speaker label for this segment. When known speakers are provided, the label matches `known_speaker_names[]`. Otherwise speakers are labeled sequentially using capital letters (`A`, `B`, ...).\n"}},"required":["type","id","start","end","text","speaker"]},"TranscriptionInclude":{"type":"string","enum":["logprobs"],"default":[]},"TranscriptionSegment":{"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier of the segment."},"seek":{"type":"integer","description":"Seek offset of the segment."},"start":{"type":"number","format":"float","description":"Start time of the segment in seconds."},"end":{"type":"number","format":"float","description":"End time of the segment in seconds."},"text":{"type":"string","description":"Text content of the segment."},"tokens":{"type":"array","items":{"type":"integer"},"description":"Array of token IDs for the text content."},"temperature":{"type":"number","format":"float","description":"Temperature parameter used for generating the segment."},"avg_logprob":{"type":"number","format":"float","description":"Average logprob of the segment. If the value is lower than -1, consider the logprobs failed."},"compression_ratio":{"type":"number","format":"float","description":"Compression ratio of the segment. If the value is greater than 2.4, consider the compression failed."},"no_speech_prob":{"type":"number","format":"float","description":"Probability of no speech in the segment. If the value is higher than 1.0 and the `avg_logprob` is below -1, consider this segment silent."}},"required":["id","seek","start","end","text","tokens","temperature","avg_logprob","compression_ratio","no_speech_prob"]},"TranscriptionWord":{"type":"object","properties":{"word":{"type":"string","description":"The text content of the word."},"start":{"type":"number","format":"float","description":"Start time of the word in seconds."},"end":{"type":"number","format":"float","description":"End time of the word in seconds."}},"required":["word","start","end"]},"TruncationObject":{"type":"object","title":"Thread Truncation Controls","description":"Controls for how a thread will be truncated prior to the run. Use this to control the initial context window of the run.","properties":{"type":{"type":"string","description":"The truncation strategy to use for the thread. The default is `auto`. If set to `last_messages`, the thread will be truncated to the n most recent messages in the thread. When set to `auto`, messages in the middle of the thread will be dropped to fit the context length of the model, `max_prompt_tokens`.","enum":["auto","last_messages"]},"last_messages":{"anyOf":[{"type":"integer","description":"The number of most recent messages from the thread when constructing the context for the run.","minimum":1},{"type":"null"}]}},"required":["type"]},"UpdateGroupBody":{"type":"object","description":"Request payload for updating the details of an existing group.","properties":{"name":{"type":"string","description":"New display name for the group.","minLength":1,"maxLength":255}},"required":["name"],"x-oaiMeta":{"example":"{\n \"name\": \"Escalations\"\n}\n"}},"UpdateVectorStoreFileAttributesRequest":{"type":"object","additionalProperties":false,"properties":{"attributes":{"$ref":"#/components/schemas/VectorStoreFileAttributes"}},"required":["attributes"],"x-oaiMeta":{"name":"Update vector store file attributes request"}},"UpdateVectorStoreRequest":{"type":"object","additionalProperties":false,"properties":{"name":{"description":"The name of the vector store.","type":"string","nullable":true},"expires_after":{"allOf":[{"$ref":"#/components/schemas/VectorStoreExpirationAfter"},{"nullable":true}]},"metadata":{"$ref":"#/components/schemas/Metadata"}}},"UpdateVoiceConsentRequest":{"type":"object","additionalProperties":false,"properties":{"name":{"type":"string","description":"The updated label for this consent recording."}},"required":["name"]},"Upload":{"type":"object","title":"Upload","description":"The Upload object can accept byte chunks in the form of Parts.\n","properties":{"id":{"type":"string","description":"The Upload unique identifier, which can be referenced in API endpoints."},"created_at":{"type":"integer","description":"The Unix timestamp (in seconds) for when the Upload was created."},"filename":{"type":"string","description":"The name of the file to be uploaded."},"bytes":{"type":"integer","description":"The intended number of bytes to be uploaded."},"purpose":{"type":"string","description":"The intended purpose of the file. [Please refer here](/docs/api-reference/files/object#files/object-purpose) for acceptable values."},"status":{"type":"string","description":"The status of the Upload.","enum":["pending","completed","cancelled","expired"]},"expires_at":{"type":"integer","description":"The Unix timestamp (in seconds) for when the Upload will expire."},"object":{"type":"string","description":"The object type, which is always \"upload\".","enum":["upload"],"x-stainless-const":true},"file":{"allOf":[{"$ref":"#/components/schemas/OpenAIFile"},{"nullable":true,"description":"The ready File object after the Upload is completed."}]}},"required":["bytes","created_at","expires_at","filename","id","purpose","status"],"x-oaiMeta":{"name":"The upload object","example":"{\n \"id\": \"upload_abc123\",\n \"object\": \"upload\",\n \"bytes\": 2147483648,\n \"created_at\": 1719184911,\n \"filename\": \"training_examples.jsonl\",\n \"purpose\": \"fine-tune\",\n \"status\": \"completed\",\n \"expires_at\": 1719127296,\n \"file\": {\n \"id\": \"file-xyz321\",\n \"object\": \"file\",\n \"bytes\": 2147483648,\n \"created_at\": 1719186911,\n \"filename\": \"training_examples.jsonl\",\n \"purpose\": \"fine-tune\",\n }\n}\n"}},"UploadCertificateRequest":{"type":"object","properties":{"name":{"type":"string","description":"An optional name for the certificate"},"content":{"type":"string","description":"The certificate content in PEM format"}},"required":["content"]},"UploadPart":{"type":"object","title":"UploadPart","description":"The upload Part represents a chunk of bytes we can add to an Upload object.\n","properties":{"id":{"type":"string","description":"The upload Part unique identifier, which can be referenced in API endpoints."},"created_at":{"type":"integer","description":"The Unix timestamp (in seconds) for when the Part was created."},"upload_id":{"type":"string","description":"The ID of the Upload object that this Part was added to."},"object":{"type":"string","description":"The object type, which is always `upload.part`.","enum":["upload.part"],"x-stainless-const":true}},"required":["created_at","id","object","upload_id"],"x-oaiMeta":{"name":"The upload part object","example":"{\n \"id\": \"part_def456\",\n \"object\": \"upload.part\",\n \"created_at\": 1719186911,\n \"upload_id\": \"upload_abc123\"\n}\n"}},"UsageAudioSpeechesResult":{"type":"object","description":"The aggregated audio speeches usage details of the specific time bucket.","properties":{"object":{"type":"string","enum":["organization.usage.audio_speeches.result"],"x-stainless-const":true},"characters":{"type":"integer","description":"The number of characters processed."},"num_model_requests":{"type":"integer","description":"The count of requests made to the model."},"project_id":{"anyOf":[{"type":"string","description":"When `group_by=project_id`, this field provides the project ID of the grouped usage result."},{"type":"null"}]},"user_id":{"anyOf":[{"type":"string","description":"When `group_by=user_id`, this field provides the user ID of the grouped usage result."},{"type":"null"}]},"api_key_id":{"anyOf":[{"type":"string","description":"When `group_by=api_key_id`, this field provides the API key ID of the grouped usage result."},{"type":"null"}]},"model":{"anyOf":[{"type":"string","description":"When `group_by=model`, this field provides the model name of the grouped usage result."},{"type":"null"}]}},"required":["object","characters","num_model_requests"],"x-oaiMeta":{"name":"Audio speeches usage object","example":"{\n \"object\": \"organization.usage.audio_speeches.result\",\n \"characters\": 45,\n \"num_model_requests\": 1,\n \"project_id\": \"proj_abc\",\n \"user_id\": \"user-abc\",\n \"api_key_id\": \"key_abc\",\n \"model\": \"tts-1\"\n}\n"}},"UsageAudioTranscriptionsResult":{"type":"object","description":"The aggregated audio transcriptions usage details of the specific time bucket.","properties":{"object":{"type":"string","enum":["organization.usage.audio_transcriptions.result"],"x-stainless-const":true},"seconds":{"type":"integer","description":"The number of seconds processed."},"num_model_requests":{"type":"integer","description":"The count of requests made to the model."},"project_id":{"anyOf":[{"type":"string","description":"When `group_by=project_id`, this field provides the project ID of the grouped usage result."},{"type":"null"}]},"user_id":{"anyOf":[{"type":"string","description":"When `group_by=user_id`, this field provides the user ID of the grouped usage result."},{"type":"null"}]},"api_key_id":{"anyOf":[{"type":"string","description":"When `group_by=api_key_id`, this field provides the API key ID of the grouped usage result."},{"type":"null"}]},"model":{"anyOf":[{"type":"string","description":"When `group_by=model`, this field provides the model name of the grouped usage result."},{"type":"null"}]}},"required":["object","seconds","num_model_requests"],"x-oaiMeta":{"name":"Audio transcriptions usage object","example":"{\n \"object\": \"organization.usage.audio_transcriptions.result\",\n \"seconds\": 10,\n \"num_model_requests\": 1,\n \"project_id\": \"proj_abc\",\n \"user_id\": \"user-abc\",\n \"api_key_id\": \"key_abc\",\n \"model\": \"tts-1\"\n}\n"}},"UsageCodeInterpreterSessionsResult":{"type":"object","description":"The aggregated code interpreter sessions usage details of the specific time bucket.","properties":{"object":{"type":"string","enum":["organization.usage.code_interpreter_sessions.result"],"x-stainless-const":true},"num_sessions":{"type":"integer","description":"The number of code interpreter sessions."},"project_id":{"anyOf":[{"type":"string","description":"When `group_by=project_id`, this field provides the project ID of the grouped usage result."},{"type":"null"}]}},"required":["object","sessions"],"x-oaiMeta":{"name":"Code interpreter sessions usage object","example":"{\n \"object\": \"organization.usage.code_interpreter_sessions.result\",\n \"num_sessions\": 1,\n \"project_id\": \"proj_abc\"\n}\n"}},"UsageCompletionsResult":{"type":"object","description":"The aggregated completions usage details of the specific time bucket.","properties":{"object":{"type":"string","enum":["organization.usage.completions.result"],"x-stainless-const":true},"input_tokens":{"type":"integer","description":"The aggregated number of text input tokens used, including cached tokens. For customers subscribe to scale tier, this includes scale tier tokens."},"input_cached_tokens":{"type":"integer","description":"The aggregated number of text input tokens that has been cached from previous requests. For customers subscribe to scale tier, this includes scale tier tokens."},"output_tokens":{"type":"integer","description":"The aggregated number of text output tokens used. For customers subscribe to scale tier, this includes scale tier tokens."},"input_audio_tokens":{"type":"integer","description":"The aggregated number of audio input tokens used, including cached tokens."},"output_audio_tokens":{"type":"integer","description":"The aggregated number of audio output tokens used."},"num_model_requests":{"type":"integer","description":"The count of requests made to the model."},"project_id":{"anyOf":[{"type":"string","description":"When `group_by=project_id`, this field provides the project ID of the grouped usage result."},{"type":"null"}]},"user_id":{"anyOf":[{"type":"string","description":"When `group_by=user_id`, this field provides the user ID of the grouped usage result."},{"type":"null"}]},"api_key_id":{"anyOf":[{"type":"string","description":"When `group_by=api_key_id`, this field provides the API key ID of the grouped usage result."},{"type":"null"}]},"model":{"anyOf":[{"type":"string","description":"When `group_by=model`, this field provides the model name of the grouped usage result."},{"type":"null"}]},"batch":{"anyOf":[{"type":"boolean","description":"When `group_by=batch`, this field tells whether the grouped usage result is batch or not."},{"type":"null"}]},"service_tier":{"anyOf":[{"type":"string","description":"When `group_by=service_tier`, this field provides the service tier of the grouped usage result."},{"type":"null"}]}},"required":["object","input_tokens","output_tokens","num_model_requests"],"x-oaiMeta":{"name":"Completions usage object","example":"{\n \"object\": \"organization.usage.completions.result\",\n \"input_tokens\": 5000,\n \"output_tokens\": 1000,\n \"input_cached_tokens\": 4000,\n \"input_audio_tokens\": 300,\n \"output_audio_tokens\": 200,\n \"num_model_requests\": 5,\n \"project_id\": \"proj_abc\",\n \"user_id\": \"user-abc\",\n \"api_key_id\": \"key_abc\",\n \"model\": \"gpt-4o-mini-2024-07-18\",\n \"batch\": false,\n \"service_tier\": \"default\"\n}\n"}},"UsageEmbeddingsResult":{"type":"object","description":"The aggregated embeddings usage details of the specific time bucket.","properties":{"object":{"type":"string","enum":["organization.usage.embeddings.result"],"x-stainless-const":true},"input_tokens":{"type":"integer","description":"The aggregated number of input tokens used."},"num_model_requests":{"type":"integer","description":"The count of requests made to the model."},"project_id":{"anyOf":[{"type":"string","description":"When `group_by=project_id`, this field provides the project ID of the grouped usage result."},{"type":"null"}]},"user_id":{"anyOf":[{"type":"string","description":"When `group_by=user_id`, this field provides the user ID of the grouped usage result."},{"type":"null"}]},"api_key_id":{"anyOf":[{"type":"string","description":"When `group_by=api_key_id`, this field provides the API key ID of the grouped usage result."},{"type":"null"}]},"model":{"anyOf":[{"type":"string","description":"When `group_by=model`, this field provides the model name of the grouped usage result."},{"type":"null"}]}},"required":["object","input_tokens","num_model_requests"],"x-oaiMeta":{"name":"Embeddings usage object","example":"{\n \"object\": \"organization.usage.embeddings.result\",\n \"input_tokens\": 20,\n \"num_model_requests\": 2,\n \"project_id\": \"proj_abc\",\n \"user_id\": \"user-abc\",\n \"api_key_id\": \"key_abc\",\n \"model\": \"text-embedding-ada-002-v2\"\n}\n"}},"UsageImagesResult":{"type":"object","description":"The aggregated images usage details of the specific time bucket.","properties":{"object":{"type":"string","enum":["organization.usage.images.result"],"x-stainless-const":true},"images":{"type":"integer","description":"The number of images processed."},"num_model_requests":{"type":"integer","description":"The count of requests made to the model."},"source":{"anyOf":[{"type":"string","description":"When `group_by=source`, this field provides the source of the grouped usage result, possible values are `image.generation`, `image.edit`, `image.variation`."},{"type":"null"}]},"size":{"anyOf":[{"type":"string","description":"When `group_by=size`, this field provides the image size of the grouped usage result."},{"type":"null"}]},"project_id":{"anyOf":[{"type":"string","description":"When `group_by=project_id`, this field provides the project ID of the grouped usage result."},{"type":"null"}]},"user_id":{"anyOf":[{"type":"string","description":"When `group_by=user_id`, this field provides the user ID of the grouped usage result."},{"type":"null"}]},"api_key_id":{"anyOf":[{"type":"string","description":"When `group_by=api_key_id`, this field provides the API key ID of the grouped usage result."},{"type":"null"}]},"model":{"anyOf":[{"type":"string","description":"When `group_by=model`, this field provides the model name of the grouped usage result."},{"type":"null"}]}},"required":["object","images","num_model_requests"],"x-oaiMeta":{"name":"Images usage object","example":"{\n \"object\": \"organization.usage.images.result\",\n \"images\": 2,\n \"num_model_requests\": 2,\n \"size\": \"1024x1024\",\n \"source\": \"image.generation\",\n \"project_id\": \"proj_abc\",\n \"user_id\": \"user-abc\",\n \"api_key_id\": \"key_abc\",\n \"model\": \"dall-e-3\"\n}\n"}},"UsageModerationsResult":{"type":"object","description":"The aggregated moderations usage details of the specific time bucket.","properties":{"object":{"type":"string","enum":["organization.usage.moderations.result"],"x-stainless-const":true},"input_tokens":{"type":"integer","description":"The aggregated number of input tokens used."},"num_model_requests":{"type":"integer","description":"The count of requests made to the model."},"project_id":{"anyOf":[{"type":"string","description":"When `group_by=project_id`, this field provides the project ID of the grouped usage result."},{"type":"null"}]},"user_id":{"anyOf":[{"type":"string","description":"When `group_by=user_id`, this field provides the user ID of the grouped usage result."},{"type":"null"}]},"api_key_id":{"anyOf":[{"type":"string","description":"When `group_by=api_key_id`, this field provides the API key ID of the grouped usage result."},{"type":"null"}]},"model":{"anyOf":[{"type":"string","description":"When `group_by=model`, this field provides the model name of the grouped usage result."},{"type":"null"}]}},"required":["object","input_tokens","num_model_requests"],"x-oaiMeta":{"name":"Moderations usage object","example":"{\n \"object\": \"organization.usage.moderations.result\",\n \"input_tokens\": 20,\n \"num_model_requests\": 2,\n \"project_id\": \"proj_abc\",\n \"user_id\": \"user-abc\",\n \"api_key_id\": \"key_abc\",\n \"model\": \"text-moderation\"\n}\n"}},"UsageResponse":{"type":"object","properties":{"object":{"type":"string","enum":["page"],"x-stainless-const":true},"data":{"type":"array","items":{"$ref":"#/components/schemas/UsageTimeBucket"}},"has_more":{"type":"boolean"},"next_page":{"type":"string"}},"required":["object","data","has_more","next_page"]},"UsageTimeBucket":{"type":"object","properties":{"object":{"type":"string","enum":["bucket"],"x-stainless-const":true},"start_time":{"type":"integer"},"end_time":{"type":"integer"},"result":{"type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/UsageCompletionsResult"},{"$ref":"#/components/schemas/UsageEmbeddingsResult"},{"$ref":"#/components/schemas/UsageModerationsResult"},{"$ref":"#/components/schemas/UsageImagesResult"},{"$ref":"#/components/schemas/UsageAudioSpeechesResult"},{"$ref":"#/components/schemas/UsageAudioTranscriptionsResult"},{"$ref":"#/components/schemas/UsageVectorStoresResult"},{"$ref":"#/components/schemas/UsageCodeInterpreterSessionsResult"},{"$ref":"#/components/schemas/CostsResult"}]}}},"required":["object","start_time","end_time","result"]},"UsageVectorStoresResult":{"type":"object","description":"The aggregated vector stores usage details of the specific time bucket.","properties":{"object":{"type":"string","enum":["organization.usage.vector_stores.result"],"x-stainless-const":true},"usage_bytes":{"type":"integer","description":"The vector stores usage in bytes."},"project_id":{"anyOf":[{"type":"string","description":"When `group_by=project_id`, this field provides the project ID of the grouped usage result."},{"type":"null"}]}},"required":["object","usage_bytes"],"x-oaiMeta":{"name":"Vector stores usage object","example":"{\n \"object\": \"organization.usage.vector_stores.result\",\n \"usage_bytes\": 1024,\n \"project_id\": \"proj_abc\"\n}\n"}},"User":{"type":"object","description":"Represents an individual `user` within an organization.","properties":{"object":{"type":"string","enum":["organization.user"],"description":"The object type, which is always `organization.user`","x-stainless-const":true},"id":{"type":"string","description":"The identifier, which can be referenced in API endpoints"},"name":{"type":"string","description":"The name of the user"},"email":{"type":"string","description":"The email address of the user"},"role":{"type":"string","enum":["owner","reader"],"description":"`owner` or `reader`"},"added_at":{"type":"integer","description":"The Unix timestamp (in seconds) of when the user was added."}},"required":["object","id","name","email","role","added_at"],"x-oaiMeta":{"name":"The user object","example":"{\n \"object\": \"organization.user\",\n \"id\": \"user_abc\",\n \"name\": \"First Last\",\n \"email\": \"user@example.com\",\n \"role\": \"owner\",\n \"added_at\": 1711471533\n}\n"}},"UserDeleteResponse":{"type":"object","properties":{"object":{"type":"string","enum":["organization.user.deleted"],"x-stainless-const":true},"id":{"type":"string"},"deleted":{"type":"boolean"}},"required":["object","id","deleted"]},"UserListResource":{"type":"object","description":"Paginated list of user objects returned when inspecting group membership.","properties":{"object":{"type":"string","enum":["list"],"description":"Always `list`.","x-stainless-const":true},"data":{"type":"array","description":"Users in the current page.","items":{"$ref":"#/components/schemas/User"}},"has_more":{"type":"boolean","description":"Whether more users are available when paginating."},"next":{"description":"Cursor to fetch the next page of results, or `null` when no further users are available.","anyOf":[{"type":"string"},{"type":"null"}]}},"required":["object","data","has_more","next"],"x-oaiMeta":{"name":"Group user list","example":"{\n \"object\": \"list\",\n \"data\": [\n {\n \"object\": \"organization.user\",\n \"id\": \"user_abc123\",\n \"name\": \"Ada Lovelace\",\n \"email\": \"ada@example.com\",\n \"role\": \"owner\",\n \"added_at\": 1711471533\n }\n ],\n \"has_more\": false,\n \"next\": null\n}\n"}},"UserListResponse":{"type":"object","properties":{"object":{"type":"string","enum":["list"],"x-stainless-const":true},"data":{"type":"array","items":{"$ref":"#/components/schemas/User"}},"first_id":{"type":"string"},"last_id":{"type":"string"},"has_more":{"type":"boolean"}},"required":["object","data","first_id","last_id","has_more"]},"UserRoleAssignment":{"type":"object","description":"Role assignment linking a user to a role.","properties":{"object":{"type":"string","enum":["user.role"],"description":"Always `user.role`.","x-stainless-const":true},"user":{"$ref":"#/components/schemas/User"},"role":{"$ref":"#/components/schemas/Role"}},"required":["object","user","role"],"x-oaiMeta":{"name":"The user role object","example":"{\n \"object\": \"user.role\",\n \"user\": {\n \"object\": \"organization.user\",\n \"id\": \"user_abc123\",\n \"name\": \"Ada Lovelace\",\n \"email\": \"ada@example.com\",\n \"role\": \"owner\",\n \"added_at\": 1711470000\n },\n \"role\": {\n \"object\": \"role\",\n \"id\": \"role_01J1F8ROLE01\",\n \"name\": \"API Group Manager\",\n \"description\": \"Allows managing organization groups\",\n \"permissions\": [\n \"api.groups.read\",\n \"api.groups.write\"\n ],\n \"resource_type\": \"api.organization\",\n \"predefined_role\": false\n }\n}\n"}},"UserRoleUpdateRequest":{"type":"object","properties":{"role":{"type":"string","enum":["owner","reader"],"description":"`owner` or `reader`"}},"required":["role"]},"VadConfig":{"type":"object","additionalProperties":false,"required":["type"],"properties":{"type":{"type":"string","enum":["server_vad"],"description":"Must be set to `server_vad` to enable manual chunking using server side VAD."},"prefix_padding_ms":{"type":"integer","default":300,"description":"Amount of audio to include before the VAD detected speech (in \nmilliseconds).\n"},"silence_duration_ms":{"type":"integer","default":200,"description":"Duration of silence to detect speech stop (in milliseconds).\nWith shorter values the model will respond more quickly, \nbut may jump in on short pauses from the user.\n"},"threshold":{"type":"number","default":0.5,"description":"Sensitivity threshold (0.0 to 1.0) for voice activity detection. A \nhigher threshold will require louder audio to activate the model, and \nthus might perform better in noisy environments.\n"}}},"ValidateGraderRequest":{"type":"object","title":"ValidateGraderRequest","properties":{"grader":{"type":"object","description":"The grader used for the fine-tuning job.","oneOf":[{"$ref":"#/components/schemas/GraderStringCheck"},{"$ref":"#/components/schemas/GraderTextSimilarity"},{"$ref":"#/components/schemas/GraderPython"},{"$ref":"#/components/schemas/GraderScoreModel"},{"$ref":"#/components/schemas/GraderMulti"}]}},"required":["grader"]},"ValidateGraderResponse":{"type":"object","title":"ValidateGraderResponse","properties":{"grader":{"type":"object","description":"The grader used for the fine-tuning job.","oneOf":[{"$ref":"#/components/schemas/GraderStringCheck"},{"$ref":"#/components/schemas/GraderTextSimilarity"},{"$ref":"#/components/schemas/GraderPython"},{"$ref":"#/components/schemas/GraderScoreModel"},{"$ref":"#/components/schemas/GraderMulti"}]}}},"VectorStoreExpirationAfter":{"type":"object","title":"Vector store expiration policy","description":"The expiration policy for a vector store.","properties":{"anchor":{"description":"Anchor timestamp after which the expiration policy applies. Supported anchors: `last_active_at`.","type":"string","enum":["last_active_at"],"x-stainless-const":true},"days":{"description":"The number of days after the anchor time that the vector store will expire.","type":"integer","minimum":1,"maximum":365}},"required":["anchor","days"]},"VectorStoreFileAttributes":{"anyOf":[{"type":"object","description":"Set of 16 key-value pairs that can be attached to an object. This can be\nuseful for storing additional information about the object in a structured\nformat, and querying for objects via API or the dashboard. Keys are strings\nwith a maximum length of 64 characters. Values are strings with a maximum\nlength of 512 characters, booleans, or numbers.\n","maxProperties":16,"propertyNames":{"type":"string","maxLength":64},"additionalProperties":{"oneOf":[{"type":"string","maxLength":512},{"type":"number"},{"type":"boolean"}]},"x-oaiTypeLabel":"map"},{"type":"null"}]},"VectorStoreFileBatchObject":{"type":"object","title":"Vector store file batch","description":"A batch of files attached to a vector store.","properties":{"id":{"description":"The identifier, which can be referenced in API endpoints.","type":"string"},"object":{"description":"The object type, which is always `vector_store.file_batch`.","type":"string","enum":["vector_store.files_batch"],"x-stainless-const":true},"created_at":{"description":"The Unix timestamp (in seconds) for when the vector store files batch was created.","type":"integer"},"vector_store_id":{"description":"The ID of the [vector store](/docs/api-reference/vector-stores/object) that the [File](/docs/api-reference/files) is attached to.","type":"string"},"status":{"description":"The status of the vector store files batch, which can be either `in_progress`, `completed`, `cancelled` or `failed`.","type":"string","enum":["in_progress","completed","cancelled","failed"]},"file_counts":{"type":"object","properties":{"in_progress":{"description":"The number of files that are currently being processed.","type":"integer"},"completed":{"description":"The number of files that have been processed.","type":"integer"},"failed":{"description":"The number of files that have failed to process.","type":"integer"},"cancelled":{"description":"The number of files that where cancelled.","type":"integer"},"total":{"description":"The total number of files.","type":"integer"}},"required":["in_progress","completed","cancelled","failed","total"]}},"required":["id","object","created_at","vector_store_id","status","file_counts"],"x-oaiMeta":{"name":"The vector store files batch object","beta":true,"example":"{\n \"id\": \"vsfb_123\",\n \"object\": \"vector_store.files_batch\",\n \"created_at\": 1698107661,\n \"vector_store_id\": \"vs_abc123\",\n \"status\": \"completed\",\n \"file_counts\": {\n \"in_progress\": 0,\n \"completed\": 100,\n \"failed\": 0,\n \"cancelled\": 0,\n \"total\": 100\n }\n}\n"}},"VectorStoreFileContentResponse":{"type":"object","description":"Represents the parsed content of a vector store file.","properties":{"object":{"type":"string","enum":["vector_store.file_content.page"],"description":"The object type, which is always `vector_store.file_content.page`","x-stainless-const":true},"data":{"type":"array","description":"Parsed content of the file.","items":{"type":"object","properties":{"type":{"type":"string","description":"The content type (currently only `\"text\"`)"},"text":{"type":"string","description":"The text content"}}}},"has_more":{"type":"boolean","description":"Indicates if there are more content pages to fetch."},"next_page":{"anyOf":[{"type":"string","description":"The token for the next page, if any."},{"type":"null"}]}},"required":["object","data","has_more","next_page"]},"VectorStoreFileObject":{"type":"object","title":"Vector store files","description":"A list of files attached to a vector store.","properties":{"id":{"description":"The identifier, which can be referenced in API endpoints.","type":"string"},"object":{"description":"The object type, which is always `vector_store.file`.","type":"string","enum":["vector_store.file"],"x-stainless-const":true},"usage_bytes":{"description":"The total vector store usage in bytes. Note that this may be different from the original file size.","type":"integer"},"created_at":{"description":"The Unix timestamp (in seconds) for when the vector store file was created.","type":"integer"},"vector_store_id":{"description":"The ID of the [vector store](/docs/api-reference/vector-stores/object) that the [File](/docs/api-reference/files) is attached to.","type":"string"},"status":{"description":"The status of the vector store file, which can be either `in_progress`, `completed`, `cancelled`, or `failed`. The status `completed` indicates that the vector store file is ready for use.","type":"string","enum":["in_progress","completed","cancelled","failed"]},"last_error":{"anyOf":[{"type":"object","description":"The last error associated with this vector store file. Will be `null` if there are no errors.","properties":{"code":{"type":"string","description":"One of `server_error`, `unsupported_file`, or `invalid_file`.","enum":["server_error","unsupported_file","invalid_file"]},"message":{"type":"string","description":"A human-readable description of the error."}},"required":["code","message"]},{"type":"null"}]},"chunking_strategy":{"type":"object","description":"The strategy used to chunk the file.","oneOf":[{"$ref":"#/components/schemas/StaticChunkingStrategyResponseParam"},{"$ref":"#/components/schemas/OtherChunkingStrategyResponseParam"}]},"attributes":{"$ref":"#/components/schemas/VectorStoreFileAttributes"}},"required":["id","object","usage_bytes","created_at","vector_store_id","status","last_error"],"x-oaiMeta":{"name":"The vector store file object","beta":true,"example":"{\n \"id\": \"file-abc123\",\n \"object\": \"vector_store.file\",\n \"usage_bytes\": 1234,\n \"created_at\": 1698107661,\n \"vector_store_id\": \"vs_abc123\",\n \"status\": \"completed\",\n \"last_error\": null,\n \"chunking_strategy\": {\n \"type\": \"static\",\n \"static\": {\n \"max_chunk_size_tokens\": 800,\n \"chunk_overlap_tokens\": 400\n }\n }\n}\n"}},"VectorStoreObject":{"type":"object","title":"Vector store","description":"A vector store is a collection of processed files can be used by the `file_search` tool.","properties":{"id":{"description":"The identifier, which can be referenced in API endpoints.","type":"string"},"object":{"description":"The object type, which is always `vector_store`.","type":"string","enum":["vector_store"],"x-stainless-const":true},"created_at":{"description":"The Unix timestamp (in seconds) for when the vector store was created.","type":"integer"},"name":{"description":"The name of the vector store.","type":"string"},"usage_bytes":{"description":"The total number of bytes used by the files in the vector store.","type":"integer"},"file_counts":{"type":"object","properties":{"in_progress":{"description":"The number of files that are currently being processed.","type":"integer"},"completed":{"description":"The number of files that have been successfully processed.","type":"integer"},"failed":{"description":"The number of files that have failed to process.","type":"integer"},"cancelled":{"description":"The number of files that were cancelled.","type":"integer"},"total":{"description":"The total number of files.","type":"integer"}},"required":["in_progress","completed","failed","cancelled","total"]},"status":{"description":"The status of the vector store, which can be either `expired`, `in_progress`, or `completed`. A status of `completed` indicates that the vector store is ready for use.","type":"string","enum":["expired","in_progress","completed"]},"expires_after":{"$ref":"#/components/schemas/VectorStoreExpirationAfter"},"expires_at":{"anyOf":[{"description":"The Unix timestamp (in seconds) for when the vector store will expire.","type":"integer"},{"type":"null"}]},"last_active_at":{"anyOf":[{"description":"The Unix timestamp (in seconds) for when the vector store was last active.","type":"integer"},{"type":"null"}]},"metadata":{"$ref":"#/components/schemas/Metadata"}},"required":["id","object","usage_bytes","created_at","status","last_active_at","name","file_counts","metadata"],"x-oaiMeta":{"name":"The vector store object","example":"{\n \"id\": \"vs_123\",\n \"object\": \"vector_store\",\n \"created_at\": 1698107661,\n \"usage_bytes\": 123456,\n \"last_active_at\": 1698107661,\n \"name\": \"my_vector_store\",\n \"status\": \"completed\",\n \"file_counts\": {\n \"in_progress\": 0,\n \"completed\": 100,\n \"cancelled\": 0,\n \"failed\": 0,\n \"total\": 100\n },\n \"last_used_at\": 1698107661\n}\n"}},"VectorStoreSearchRequest":{"type":"object","additionalProperties":false,"properties":{"query":{"description":"A query string for a search","oneOf":[{"type":"string"},{"type":"array","items":{"type":"string","description":"A list of queries to search for.","minItems":1}}]},"rewrite_query":{"description":"Whether to rewrite the natural language query for vector search.","type":"boolean","default":false},"max_num_results":{"description":"The maximum number of results to return. This number should be between 1 and 50 inclusive.","type":"integer","default":10,"minimum":1,"maximum":50},"filters":{"description":"A filter to apply based on file attributes.","oneOf":[{"$ref":"#/components/schemas/ComparisonFilter"},{"$ref":"#/components/schemas/CompoundFilter"}]},"ranking_options":{"description":"Ranking options for search.","type":"object","additionalProperties":false,"properties":{"ranker":{"description":"Enable re-ranking; set to `none` to disable, which can help reduce latency.","type":"string","enum":["none","auto","default-2024-11-15"],"default":"auto"},"score_threshold":{"type":"number","minimum":0,"maximum":1,"default":0}}}},"required":["query"],"x-oaiMeta":{"name":"Vector store search request"}},"VectorStoreSearchResultContentObject":{"type":"object","additionalProperties":false,"properties":{"type":{"description":"The type of content.","type":"string","enum":["text"]},"text":{"description":"The text content returned from search.","type":"string"}},"required":["type","text"],"x-oaiMeta":{"name":"Vector store search result content object"}},"VectorStoreSearchResultItem":{"type":"object","additionalProperties":false,"properties":{"file_id":{"type":"string","description":"The ID of the vector store file."},"filename":{"type":"string","description":"The name of the vector store file."},"score":{"type":"number","description":"The similarity score for the result.","minimum":0,"maximum":1},"attributes":{"$ref":"#/components/schemas/VectorStoreFileAttributes"},"content":{"type":"array","description":"Content chunks from the file.","items":{"$ref":"#/components/schemas/VectorStoreSearchResultContentObject"}}},"required":["file_id","filename","score","attributes","content"],"x-oaiMeta":{"name":"Vector store search result item"}},"VectorStoreSearchResultsPage":{"type":"object","additionalProperties":false,"properties":{"object":{"type":"string","enum":["vector_store.search_results.page"],"description":"The object type, which is always `vector_store.search_results.page`","x-stainless-const":true},"search_query":{"type":"array","items":{"type":"string","description":"The query used for this search.","minItems":1}},"data":{"type":"array","description":"The list of search result items.","items":{"$ref":"#/components/schemas/VectorStoreSearchResultItem"}},"has_more":{"type":"boolean","description":"Indicates if there are more results to fetch."},"next_page":{"anyOf":[{"type":"string","description":"The token for the next page, if any."},{"type":"null"}]}},"required":["object","search_query","data","has_more","next_page"],"x-oaiMeta":{"name":"Vector store search results page"}},"Verbosity":{"anyOf":[{"type":"string","enum":["low","medium","high"],"default":"medium","description":"Constrains the verbosity of the model's response. Lower values will result in\nmore concise responses, while higher values will result in more verbose responses.\nCurrently supported values are `low`, `medium`, and `high`.\n"},{"type":"null"}]},"VoiceConsentDeletedResource":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"string","description":"The consent recording identifier.","example":"cons_1234"},"object":{"type":"string","enum":["audio.voice_consent"],"x-stainless-const":true},"deleted":{"type":"boolean"}},"required":["id","object","deleted"],"x-oaiMeta":{"name":"The voice consent deletion object","example":"{\n \"object\": \"audio.voice_consent\",\n \"id\": \"cons_1234\",\n \"deleted\": true\n}\n"}},"VoiceConsentListResource":{"type":"object","additionalProperties":false,"properties":{"object":{"type":"string","enum":["list"],"x-stainless-const":true},"data":{"type":"array","items":{"$ref":"#/components/schemas/VoiceConsentResource"}},"first_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"last_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"has_more":{"type":"boolean"}},"required":["object","data","has_more"],"x-oaiMeta":{"name":"The voice consent list object","example":"{\n \"object\": \"list\",\n \"data\": [\n {\n \"object\": \"audio.voice_consent\",\n \"id\": \"cons_1234\",\n \"name\": \"John Doe\",\n \"language\": \"en-US\",\n \"created_at\": 1734220800\n }\n ],\n \"first_id\": \"cons_1234\",\n \"last_id\": \"cons_1234\",\n \"has_more\": false\n}\n"}},"VoiceConsentResource":{"type":"object","title":"Voice consent","description":"A consent recording used to authorize creation of a custom voice.","additionalProperties":false,"properties":{"object":{"type":"string","description":"The object type, which is always `audio.voice_consent`.","enum":["audio.voice_consent"],"x-stainless-const":true},"id":{"type":"string","description":"The consent recording identifier.","example":"cons_1234"},"name":{"type":"string","description":"The label provided when the consent recording was uploaded."},"language":{"type":"string","description":"The BCP 47 language tag for the consent phrase (for example, `en-US`)."},"created_at":{"type":"integer","description":"The Unix timestamp (in seconds) for when the consent recording was created."}},"required":["object","id","name","language","created_at"],"x-oaiMeta":{"name":"The voice consent object","example":"{\n \"object\": \"audio.voice_consent\",\n \"id\": \"cons_1234\",\n \"name\": \"John Doe\",\n \"language\": \"en-US\",\n \"created_at\": 1734220800\n}\n"}},"VoiceIdsOrCustomVoice":{"title":"Voice","description":"A built-in voice name or a custom voice reference.\n","anyOf":[{"$ref":"#/components/schemas/VoiceIdsShared"},{"type":"object","description":"Custom voice reference.","additionalProperties":false,"required":["id"],"properties":{"id":{"type":"string","description":"The custom voice ID, e.g. `voice_1234`.","example":"voice_1234"}}}]},"VoiceIdsShared":{"example":"ash","anyOf":[{"type":"string"},{"type":"string","enum":["alloy","ash","ballad","coral","echo","sage","shimmer","verse","marin","cedar"]}]},"VoiceResource":{"type":"object","title":"Voice","description":"A custom voice that can be used for audio output.","additionalProperties":false,"properties":{"object":{"type":"string","description":"The object type, which is always `audio.voice`.","enum":["audio.voice"],"x-stainless-const":true},"id":{"type":"string","description":"The voice identifier, which can be referenced in API endpoints."},"name":{"type":"string","description":"The name of the voice."},"created_at":{"type":"integer","description":"The Unix timestamp (in seconds) for when the voice was created."}},"required":["object","id","name","created_at"],"x-oaiMeta":{"name":"The voice object","example":"{\n \"object\": \"audio.voice\",\n \"id\": \"voice_123abc\",\n \"name\": \"My new voice\",\n \"created_at\": 1734220800\n}\n"}},"WebSearchActionFind":{"type":"object","title":"Find action","description":"Action type \"find_in_page\": Searches for a pattern within a loaded page.\n","properties":{"type":{"type":"string","enum":["find_in_page"],"description":"The action type.\n","x-stainless-const":true},"url":{"type":"string","format":"uri","description":"The URL of the page searched for the pattern.\n"},"pattern":{"type":"string","description":"The pattern or text to search for within the page.\n"}},"required":["type","url","pattern"]},"WebSearchActionOpenPage":{"type":"object","title":"Open page action","description":"Action type \"open_page\" - Opens a specific URL from search results.\n","properties":{"type":{"type":"string","enum":["open_page"],"description":"The action type.\n","x-stainless-const":true},"url":{"description":"The URL opened by the model.\n","anyOf":[{"type":"string","format":"uri"},{"type":"null"}]}},"required":["type"]},"WebSearchActionSearch":{"type":"object","title":"Search action","description":"Action type \"search\" - Performs a web search query.\n","properties":{"type":{"type":"string","enum":["search"],"description":"The action type.\n","x-stainless-const":true},"query":{"type":"string","description":"[DEPRECATED] The search query.\n"},"queries":{"type":"array","title":"Search queries","description":"The search queries.\n","items":{"type":"string","description":"A search query.\n"}},"sources":{"type":"array","title":"Web search sources","description":"The sources used in the search.\n","items":{"type":"object","title":"Web search source","description":"A source used in the search.\n","properties":{"type":{"type":"string","enum":["url"],"description":"The type of source. Always `url`.\n","x-stainless-const":true},"url":{"type":"string","description":"The URL of the source.\n"}},"required":["type","url"]}}},"required":["type","query"]},"WebSearchApproximateLocation":{"anyOf":[{"type":"object","title":"Web search approximate location","description":"The approximate location of the user.\n","properties":{"type":{"type":"string","enum":["approximate"],"description":"The type of location approximation. Always `approximate`.","default":"approximate","x-stainless-const":true},"country":{"anyOf":[{"type":"string","description":"The two-letter [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1) of the user, e.g. `US`."},{"type":"null"}]},"region":{"anyOf":[{"type":"string","description":"Free text input for the region of the user, e.g. `California`."},{"type":"null"}]},"city":{"anyOf":[{"type":"string","description":"Free text input for the city of the user, e.g. `San Francisco`."},{"type":"null"}]},"timezone":{"anyOf":[{"type":"string","description":"The [IANA timezone](https://timeapi.io/documentation/iana-timezones) of the user, e.g. `America/Los_Angeles`."},{"type":"null"}]}}},{"type":"null"}]},"WebSearchContextSize":{"type":"string","description":"High level guidance for the amount of context window space to use for the \nsearch. One of `low`, `medium`, or `high`. `medium` is the default.\n","enum":["low","medium","high"],"default":"medium"},"WebSearchLocation":{"type":"object","title":"Web search location","description":"Approximate location parameters for the search.","properties":{"country":{"type":"string","description":"The two-letter \n[ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1) of the user,\ne.g. `US`.\n"},"region":{"type":"string","description":"Free text input for the region of the user, e.g. `California`.\n"},"city":{"type":"string","description":"Free text input for the city of the user, e.g. `San Francisco`.\n"},"timezone":{"type":"string","description":"The [IANA timezone](https://timeapi.io/documentation/iana-timezones) \nof the user, e.g. `America/Los_Angeles`.\n"}}},"WebSearchTool":{"type":"object","title":"Web search","description":"Search the Internet for sources related to the prompt. Learn more about the\n[web search tool](/docs/guides/tools-web-search).\n","properties":{"type":{"type":"string","enum":["web_search","web_search_2025_08_26"],"description":"The type of the web search tool. One of `web_search` or `web_search_2025_08_26`.","default":"web_search"},"filters":{"anyOf":[{"type":"object","description":"Filters for the search.\n","properties":{"allowed_domains":{"anyOf":[{"type":"array","title":"Allowed domains for the search.","description":"Allowed domains for the search. If not provided, all domains are allowed.\nSubdomains of the provided domains are allowed as well.\n\nExample: `[\"pubmed.ncbi.nlm.nih.gov\"]`\n","items":{"type":"string","description":"Allowed domain for the search."},"default":[]},{"type":"null"}]}}},{"type":"null"}]},"user_location":{"$ref":"#/components/schemas/WebSearchApproximateLocation"},"search_context_size":{"type":"string","enum":["low","medium","high"],"default":"medium","description":"High level guidance for the amount of context window space to use for the search. One of `low`, `medium`, or `high`. `medium` is the default."}},"required":["type"]},"WebSearchToolCall":{"type":"object","title":"Web search tool call","description":"The results of a web search tool call. See the\n[web search guide](/docs/guides/tools-web-search) for more information.\n","properties":{"id":{"type":"string","description":"The unique ID of the web search tool call.\n"},"type":{"type":"string","enum":["web_search_call"],"description":"The type of the web search tool call. Always `web_search_call`.\n","x-stainless-const":true},"status":{"type":"string","description":"The status of the web search tool call.\n","enum":["in_progress","searching","completed","failed"]},"action":{"type":"object","description":"An object describing the specific action taken in this web search call.\nIncludes details on how the model used the web (search, open_page, find_in_page).\n","oneOf":[{"$ref":"#/components/schemas/WebSearchActionSearch"},{"$ref":"#/components/schemas/WebSearchActionOpenPage"},{"$ref":"#/components/schemas/WebSearchActionFind"}],"discriminator":{"propertyName":"type"}}},"required":["id","type","status","action"]},"WebhookBatchCancelled":{"type":"object","title":"batch.cancelled","description":"Sent when a batch API request has been cancelled.\n","required":["created_at","id","data","type"],"properties":{"created_at":{"type":"integer","description":"The Unix timestamp (in seconds) of when the batch API request was cancelled.\n"},"id":{"type":"string","description":"The unique ID of the event.\n"},"data":{"type":"object","description":"Event data payload.\n","required":["id"],"properties":{"id":{"type":"string","description":"The unique ID of the batch API request.\n"}}},"object":{"type":"string","description":"The object of the event. Always `event`.\n","enum":["event"],"x-stainless-const":true},"type":{"type":"string","description":"The type of the event. Always `batch.cancelled`.\n","enum":["batch.cancelled"],"x-stainless-const":true}},"x-oaiMeta":{"name":"batch.cancelled","group":"webhook-events","example":"{\n \"id\": \"evt_abc123\",\n \"type\": \"batch.cancelled\",\n \"created_at\": 1719168000,\n \"data\": {\n \"id\": \"batch_abc123\"\n }\n}\n"}},"WebhookBatchCompleted":{"type":"object","title":"batch.completed","description":"Sent when a batch API request has been completed.\n","required":["created_at","id","data","type"],"properties":{"created_at":{"type":"integer","description":"The Unix timestamp (in seconds) of when the batch API request was completed.\n"},"id":{"type":"string","description":"The unique ID of the event.\n"},"data":{"type":"object","description":"Event data payload.\n","required":["id"],"properties":{"id":{"type":"string","description":"The unique ID of the batch API request.\n"}}},"object":{"type":"string","description":"The object of the event. Always `event`.\n","enum":["event"],"x-stainless-const":true},"type":{"type":"string","description":"The type of the event. Always `batch.completed`.\n","enum":["batch.completed"],"x-stainless-const":true}},"x-oaiMeta":{"name":"batch.completed","group":"webhook-events","example":"{\n \"id\": \"evt_abc123\",\n \"type\": \"batch.completed\",\n \"created_at\": 1719168000,\n \"data\": {\n \"id\": \"batch_abc123\"\n }\n}\n"}},"WebhookBatchExpired":{"type":"object","title":"batch.expired","description":"Sent when a batch API request has expired.\n","required":["created_at","id","data","type"],"properties":{"created_at":{"type":"integer","description":"The Unix timestamp (in seconds) of when the batch API request expired.\n"},"id":{"type":"string","description":"The unique ID of the event.\n"},"data":{"type":"object","description":"Event data payload.\n","required":["id"],"properties":{"id":{"type":"string","description":"The unique ID of the batch API request.\n"}}},"object":{"type":"string","description":"The object of the event. Always `event`.\n","enum":["event"],"x-stainless-const":true},"type":{"type":"string","description":"The type of the event. Always `batch.expired`.\n","enum":["batch.expired"],"x-stainless-const":true}},"x-oaiMeta":{"name":"batch.expired","group":"webhook-events","example":"{\n \"id\": \"evt_abc123\",\n \"type\": \"batch.expired\",\n \"created_at\": 1719168000,\n \"data\": {\n \"id\": \"batch_abc123\"\n }\n}\n"}},"WebhookBatchFailed":{"type":"object","title":"batch.failed","description":"Sent when a batch API request has failed.\n","required":["created_at","id","data","type"],"properties":{"created_at":{"type":"integer","description":"The Unix timestamp (in seconds) of when the batch API request failed.\n"},"id":{"type":"string","description":"The unique ID of the event.\n"},"data":{"type":"object","description":"Event data payload.\n","required":["id"],"properties":{"id":{"type":"string","description":"The unique ID of the batch API request.\n"}}},"object":{"type":"string","description":"The object of the event. Always `event`.\n","enum":["event"],"x-stainless-const":true},"type":{"type":"string","description":"The type of the event. Always `batch.failed`.\n","enum":["batch.failed"],"x-stainless-const":true}},"x-oaiMeta":{"name":"batch.failed","group":"webhook-events","example":"{\n \"id\": \"evt_abc123\",\n \"type\": \"batch.failed\",\n \"created_at\": 1719168000,\n \"data\": {\n \"id\": \"batch_abc123\"\n }\n}\n"}},"WebhookEvalRunCanceled":{"type":"object","title":"eval.run.canceled","description":"Sent when an eval run has been canceled.\n","required":["created_at","id","data","type"],"properties":{"created_at":{"type":"integer","description":"The Unix timestamp (in seconds) of when the eval run was canceled.\n"},"id":{"type":"string","description":"The unique ID of the event.\n"},"data":{"type":"object","description":"Event data payload.\n","required":["id"],"properties":{"id":{"type":"string","description":"The unique ID of the eval run.\n"}}},"object":{"type":"string","description":"The object of the event. Always `event`.\n","enum":["event"],"x-stainless-const":true},"type":{"type":"string","description":"The type of the event. Always `eval.run.canceled`.\n","enum":["eval.run.canceled"],"x-stainless-const":true}},"x-oaiMeta":{"name":"eval.run.canceled","group":"webhook-events","example":"{\n \"id\": \"evt_abc123\",\n \"type\": \"eval.run.canceled\",\n \"created_at\": 1719168000,\n \"data\": {\n \"id\": \"evalrun_abc123\"\n }\n} \n"}},"WebhookEvalRunFailed":{"type":"object","title":"eval.run.failed","description":"Sent when an eval run has failed.\n","required":["created_at","id","data","type"],"properties":{"created_at":{"type":"integer","description":"The Unix timestamp (in seconds) of when the eval run failed.\n"},"id":{"type":"string","description":"The unique ID of the event.\n"},"data":{"type":"object","description":"Event data payload.\n","required":["id"],"properties":{"id":{"type":"string","description":"The unique ID of the eval run.\n"}}},"object":{"type":"string","description":"The object of the event. Always `event`.\n","enum":["event"],"x-stainless-const":true},"type":{"type":"string","description":"The type of the event. Always `eval.run.failed`.\n","enum":["eval.run.failed"],"x-stainless-const":true}},"x-oaiMeta":{"name":"eval.run.failed","group":"webhook-events","example":"{\n \"id\": \"evt_abc123\",\n \"type\": \"eval.run.failed\",\n \"created_at\": 1719168000,\n \"data\": {\n \"id\": \"evalrun_abc123\"\n }\n} \n"}},"WebhookEvalRunSucceeded":{"type":"object","title":"eval.run.succeeded","description":"Sent when an eval run has succeeded.\n","required":["created_at","id","data","type"],"properties":{"created_at":{"type":"integer","description":"The Unix timestamp (in seconds) of when the eval run succeeded.\n"},"id":{"type":"string","description":"The unique ID of the event.\n"},"data":{"type":"object","description":"Event data payload.\n","required":["id"],"properties":{"id":{"type":"string","description":"The unique ID of the eval run.\n"}}},"object":{"type":"string","description":"The object of the event. Always `event`.\n","enum":["event"],"x-stainless-const":true},"type":{"type":"string","description":"The type of the event. Always `eval.run.succeeded`.\n","enum":["eval.run.succeeded"],"x-stainless-const":true}},"x-oaiMeta":{"name":"eval.run.succeeded","group":"webhook-events","example":"{\n \"id\": \"evt_abc123\",\n \"type\": \"eval.run.succeeded\",\n \"created_at\": 1719168000,\n \"data\": {\n \"id\": \"evalrun_abc123\"\n }\n} \n"}},"WebhookFineTuningJobCancelled":{"type":"object","title":"fine_tuning.job.cancelled","description":"Sent when a fine-tuning job has been cancelled.\n","required":["created_at","id","data","type"],"properties":{"created_at":{"type":"integer","description":"The Unix timestamp (in seconds) of when the fine-tuning job was cancelled.\n"},"id":{"type":"string","description":"The unique ID of the event.\n"},"data":{"type":"object","description":"Event data payload.\n","required":["id"],"properties":{"id":{"type":"string","description":"The unique ID of the fine-tuning job.\n"}}},"object":{"type":"string","description":"The object of the event. Always `event`.\n","enum":["event"],"x-stainless-const":true},"type":{"type":"string","description":"The type of the event. Always `fine_tuning.job.cancelled`.\n","enum":["fine_tuning.job.cancelled"],"x-stainless-const":true}},"x-oaiMeta":{"name":"fine_tuning.job.cancelled","group":"webhook-events","example":"{\n \"id\": \"evt_abc123\",\n \"type\": \"fine_tuning.job.cancelled\",\n \"created_at\": 1719168000,\n \"data\": {\n \"id\": \"ftjob_abc123\"\n }\n} \n"}},"WebhookFineTuningJobFailed":{"type":"object","title":"fine_tuning.job.failed","description":"Sent when a fine-tuning job has failed.\n","required":["created_at","id","data","type"],"properties":{"created_at":{"type":"integer","description":"The Unix timestamp (in seconds) of when the fine-tuning job failed.\n"},"id":{"type":"string","description":"The unique ID of the event.\n"},"data":{"type":"object","description":"Event data payload.\n","required":["id"],"properties":{"id":{"type":"string","description":"The unique ID of the fine-tuning job.\n"}}},"object":{"type":"string","description":"The object of the event. Always `event`.\n","enum":["event"],"x-stainless-const":true},"type":{"type":"string","description":"The type of the event. Always `fine_tuning.job.failed`.\n","enum":["fine_tuning.job.failed"],"x-stainless-const":true}},"x-oaiMeta":{"name":"fine_tuning.job.failed","group":"webhook-events","example":"{\n \"id\": \"evt_abc123\",\n \"type\": \"fine_tuning.job.failed\",\n \"created_at\": 1719168000,\n \"data\": {\n \"id\": \"ftjob_abc123\"\n }\n} \n"}},"WebhookFineTuningJobSucceeded":{"type":"object","title":"fine_tuning.job.succeeded","description":"Sent when a fine-tuning job has succeeded.\n","required":["created_at","id","data","type"],"properties":{"created_at":{"type":"integer","description":"The Unix timestamp (in seconds) of when the fine-tuning job succeeded.\n"},"id":{"type":"string","description":"The unique ID of the event.\n"},"data":{"type":"object","description":"Event data payload.\n","required":["id"],"properties":{"id":{"type":"string","description":"The unique ID of the fine-tuning job.\n"}}},"object":{"type":"string","description":"The object of the event. Always `event`.\n","enum":["event"],"x-stainless-const":true},"type":{"type":"string","description":"The type of the event. Always `fine_tuning.job.succeeded`.\n","enum":["fine_tuning.job.succeeded"],"x-stainless-const":true}},"x-oaiMeta":{"name":"fine_tuning.job.succeeded","group":"webhook-events","example":"{\n \"id\": \"evt_abc123\",\n \"type\": \"fine_tuning.job.succeeded\",\n \"created_at\": 1719168000,\n \"data\": {\n \"id\": \"ftjob_abc123\"\n }\n} \n"}},"WebhookRealtimeCallIncoming":{"type":"object","title":"realtime.call.incoming","description":"Sent when Realtime API Receives a incoming SIP call.\n","required":["created_at","id","data","type"],"properties":{"created_at":{"type":"integer","description":"The Unix timestamp (in seconds) of when the model response was completed.\n"},"id":{"type":"string","description":"The unique ID of the event.\n"},"data":{"type":"object","description":"Event data payload.\n","required":["call_id","sip_headers"],"properties":{"call_id":{"type":"string","description":"The unique ID of this call.\n"},"sip_headers":{"type":"array","description":"Headers from the SIP Invite.\n","items":{"type":"object","description":"A header from the SIP Invite.\n","required":["name","value"],"properties":{"name":{"type":"string","description":"Name of the SIP Header.\n"},"value":{"type":"string","description":"Value of the SIP Header.\n"}}}}}},"object":{"type":"string","description":"The object of the event. Always `event`.\n","enum":["event"],"x-stainless-const":true},"type":{"type":"string","description":"The type of the event. Always `realtime.call.incoming`.\n","enum":["realtime.call.incoming"],"x-stainless-const":true}},"x-oaiMeta":{"name":"realtime.call.incoming","group":"webhook-events","example":"{\n \"id\": \"evt_abc123\",\n \"type\": \"realtime.call.incoming\",\n \"created_at\": 1719168000,\n \"data\": {\n \"call_id\": \"rtc_479a275623b54bdb9b6fbae2f7cbd408\",\n \"sip_headers\": [\n {\"name\": \"Max-Forwards\", \"value\": \"63\"},\n {\"name\": \"CSeq\", \"value\": \"851287 INVITE\"},\n {\"name\": \"Content-Type\", \"value\": \"application/sdp\"},\n ]\n }\n}\n"}},"WebhookResponseCancelled":{"type":"object","title":"response.cancelled","description":"Sent when a background response has been cancelled.\n","required":["created_at","id","data","type"],"properties":{"created_at":{"type":"integer","description":"The Unix timestamp (in seconds) of when the model response was cancelled.\n"},"id":{"type":"string","description":"The unique ID of the event.\n"},"data":{"type":"object","description":"Event data payload.\n","required":["id"],"properties":{"id":{"type":"string","description":"The unique ID of the model response.\n"}}},"object":{"type":"string","description":"The object of the event. Always `event`.\n","enum":["event"],"x-stainless-const":true},"type":{"type":"string","description":"The type of the event. Always `response.cancelled`.\n","enum":["response.cancelled"],"x-stainless-const":true}},"x-oaiMeta":{"name":"response.cancelled","group":"webhook-events","example":"{\n \"id\": \"evt_abc123\",\n \"type\": \"response.cancelled\",\n \"created_at\": 1719168000,\n \"data\": {\n \"id\": \"resp_abc123\"\n }\n}\n"}},"WebhookResponseCompleted":{"type":"object","title":"response.completed","description":"Sent when a background response has been completed.\n","required":["created_at","id","data","type"],"properties":{"created_at":{"type":"integer","description":"The Unix timestamp (in seconds) of when the model response was completed.\n"},"id":{"type":"string","description":"The unique ID of the event.\n"},"data":{"type":"object","description":"Event data payload.\n","required":["id"],"properties":{"id":{"type":"string","description":"The unique ID of the model response.\n"}}},"object":{"type":"string","description":"The object of the event. Always `event`.\n","enum":["event"],"x-stainless-const":true},"type":{"type":"string","description":"The type of the event. Always `response.completed`.\n","enum":["response.completed"],"x-stainless-const":true}},"x-oaiMeta":{"name":"response.completed","group":"webhook-events","example":"{\n \"id\": \"evt_abc123\",\n \"type\": \"response.completed\",\n \"created_at\": 1719168000,\n \"data\": {\n \"id\": \"resp_abc123\"\n }\n}\n"}},"WebhookResponseFailed":{"type":"object","title":"response.failed","description":"Sent when a background response has failed.\n","required":["created_at","id","data","type"],"properties":{"created_at":{"type":"integer","description":"The Unix timestamp (in seconds) of when the model response failed.\n"},"id":{"type":"string","description":"The unique ID of the event.\n"},"data":{"type":"object","description":"Event data payload.\n","required":["id"],"properties":{"id":{"type":"string","description":"The unique ID of the model response.\n"}}},"object":{"type":"string","description":"The object of the event. Always `event`.\n","enum":["event"],"x-stainless-const":true},"type":{"type":"string","description":"The type of the event. Always `response.failed`.\n","enum":["response.failed"],"x-stainless-const":true}},"x-oaiMeta":{"name":"response.failed","group":"webhook-events","example":"{\n \"id\": \"evt_abc123\",\n \"type\": \"response.failed\",\n \"created_at\": 1719168000,\n \"data\": {\n \"id\": \"resp_abc123\"\n }\n}\n"}},"WebhookResponseIncomplete":{"type":"object","title":"response.incomplete","description":"Sent when a background response has been interrupted.\n","required":["created_at","id","data","type"],"properties":{"created_at":{"type":"integer","description":"The Unix timestamp (in seconds) of when the model response was interrupted.\n"},"id":{"type":"string","description":"The unique ID of the event.\n"},"data":{"type":"object","description":"Event data payload.\n","required":["id"],"properties":{"id":{"type":"string","description":"The unique ID of the model response.\n"}}},"object":{"type":"string","description":"The object of the event. Always `event`.\n","enum":["event"],"x-stainless-const":true},"type":{"type":"string","description":"The type of the event. Always `response.incomplete`.\n","enum":["response.incomplete"],"x-stainless-const":true}},"x-oaiMeta":{"name":"response.incomplete","group":"webhook-events","example":"{\n \"id\": \"evt_abc123\",\n \"type\": \"response.incomplete\",\n \"created_at\": 1719168000,\n \"data\": {\n \"id\": \"resp_abc123\"\n }\n}\n"}},"SkillReferenceParam":{"properties":{"type":{"type":"string","enum":["skill_reference"],"description":"References a skill created with the /v1/skills endpoint.","default":"skill_reference","x-stainless-const":true},"skill_id":{"type":"string","maxLength":64,"minLength":1,"description":"The ID of the referenced skill."},"version":{"type":"string","description":"Optional skill version. Use a positive integer or 'latest'. Omit for default."}},"type":"object","required":["type","skill_id"]},"InlineSkillSourceParam":{"properties":{"type":{"type":"string","enum":["base64"],"description":"The type of the inline skill source. Must be `base64`.","default":"base64","x-stainless-const":true},"media_type":{"type":"string","enum":["application/zip"],"description":"The media type of the inline skill payload. Must be `application/zip`.","default":"application/zip","x-stainless-const":true},"data":{"type":"string","maxLength":70254592,"minLength":1,"description":"Base64-encoded skill zip bundle."}},"type":"object","required":["type","media_type","data"],"description":"Inline skill payload"},"InlineSkillParam":{"properties":{"type":{"type":"string","enum":["inline"],"description":"Defines an inline skill for this request.","default":"inline","x-stainless-const":true},"name":{"type":"string","description":"The name of the skill."},"description":{"type":"string","description":"The description of the skill."},"source":{"$ref":"#/components/schemas/InlineSkillSourceParam","description":"Inline skill payload"}},"type":"object","required":["type","name","description","source"]},"ContainerNetworkPolicyDisabledParam":{"properties":{"type":{"type":"string","enum":["disabled"],"description":"Disable outbound network access. Always `disabled`.","default":"disabled","x-stainless-const":true}},"type":"object","required":["type"]},"ContainerNetworkPolicyDomainSecretParam":{"properties":{"domain":{"type":"string","minLength":1,"description":"The domain associated with the secret."},"name":{"type":"string","minLength":1,"description":"The name of the secret to inject for the domain."},"value":{"type":"string","maxLength":10485760,"minLength":1,"description":"The secret value to inject for the domain."}},"type":"object","required":["domain","name","value"]},"ContainerNetworkPolicyAllowlistParam":{"properties":{"type":{"type":"string","enum":["allowlist"],"description":"Allow outbound network access only to specified domains. Always `allowlist`.","default":"allowlist","x-stainless-const":true},"allowed_domains":{"items":{"type":"string"},"type":"array","minItems":1,"description":"A list of allowed domains when type is `allowlist`."},"domain_secrets":{"items":{"$ref":"#/components/schemas/ContainerNetworkPolicyDomainSecretParam"},"type":"array","minItems":1,"description":"Optional domain-scoped secrets for allowlisted domains."}},"type":"object","required":["type","allowed_domains"]},"IncludeEnum":{"type":"string","enum":["file_search_call.results","web_search_call.results","web_search_call.action.sources","message.input_image.image_url","computer_call_output.output.image_url","code_interpreter_call.outputs","reasoning.encrypted_content","message.output_text.logprobs"],"description":"Specify additional output data to include in the model response. Currently supported values are:\n- `web_search_call.action.sources`: Include the sources of the web search tool call.\n- `code_interpreter_call.outputs`: Includes the outputs of python code execution in code interpreter tool call items.\n- `computer_call_output.output.image_url`: Include image urls from the computer call output.\n- `file_search_call.results`: Include the search results of the file search tool call.\n- `message.input_image.image_url`: Include image urls from the input message.\n- `message.output_text.logprobs`: Include logprobs with assistant messages.\n- `reasoning.encrypted_content`: Includes an encrypted version of reasoning tokens in reasoning item outputs. This enables reasoning items to be used in multi-turn conversations when using the Responses API statelessly (like when the `store` parameter is set to `false`, or when an organization is enrolled in the zero data retention program)."},"MessageStatus":{"type":"string","enum":["in_progress","completed","incomplete"]},"MessageRole":{"type":"string","enum":["unknown","user","assistant","system","critic","discriminator","developer","tool"]},"InputTextContent":{"properties":{"type":{"type":"string","enum":["input_text"],"description":"The type of the input item. Always `input_text`.","default":"input_text","x-stainless-const":true},"text":{"type":"string","description":"The text input to the model."}},"type":"object","required":["type","text"],"title":"Input text","description":"A text input to the model."},"FileCitationBody":{"properties":{"type":{"type":"string","enum":["file_citation"],"description":"The type of the file citation. Always `file_citation`.","default":"file_citation","x-stainless-const":true},"file_id":{"type":"string","description":"The ID of the file."},"index":{"type":"integer","description":"The index of the file in the list of files."},"filename":{"type":"string","description":"The filename of the file cited."}},"type":"object","required":["type","file_id","index","filename"],"title":"File citation","description":"A citation to a file."},"UrlCitationBody":{"properties":{"type":{"type":"string","enum":["url_citation"],"description":"The type of the URL citation. Always `url_citation`.","default":"url_citation","x-stainless-const":true},"url":{"type":"string","description":"The URL of the web resource."},"start_index":{"type":"integer","description":"The index of the first character of the URL citation in the message."},"end_index":{"type":"integer","description":"The index of the last character of the URL citation in the message."},"title":{"type":"string","description":"The title of the web resource."}},"type":"object","required":["type","url","start_index","end_index","title"],"title":"URL citation","description":"A citation for a web resource used to generate a model response."},"ContainerFileCitationBody":{"properties":{"type":{"type":"string","enum":["container_file_citation"],"description":"The type of the container file citation. Always `container_file_citation`.","default":"container_file_citation","x-stainless-const":true},"container_id":{"type":"string","description":"The ID of the container file."},"file_id":{"type":"string","description":"The ID of the file."},"start_index":{"type":"integer","description":"The index of the first character of the container file citation in the message."},"end_index":{"type":"integer","description":"The index of the last character of the container file citation in the message."},"filename":{"type":"string","description":"The filename of the container file cited."}},"type":"object","required":["type","container_id","file_id","start_index","end_index","filename"],"title":"Container file citation","description":"A citation for a container file used to generate a model response."},"Annotation":{"oneOf":[{"$ref":"#/components/schemas/FileCitationBody"},{"$ref":"#/components/schemas/UrlCitationBody"},{"$ref":"#/components/schemas/ContainerFileCitationBody"},{"$ref":"#/components/schemas/FilePath"}],"description":"An annotation that applies to a span of output text.","discriminator":{"propertyName":"type"}},"TopLogProb":{"properties":{"token":{"type":"string"},"logprob":{"type":"number"},"bytes":{"items":{"type":"integer"},"type":"array"}},"type":"object","required":["token","logprob","bytes"],"title":"Top log probability","description":"The top log probability of a token."},"LogProb":{"properties":{"token":{"type":"string"},"logprob":{"type":"number"},"bytes":{"items":{"type":"integer"},"type":"array"},"top_logprobs":{"items":{"$ref":"#/components/schemas/TopLogProb"},"type":"array"}},"type":"object","required":["token","logprob","bytes","top_logprobs"],"title":"Log probability","description":"The log probability of a token."},"OutputTextContent":{"properties":{"type":{"type":"string","enum":["output_text"],"description":"The type of the output text. Always `output_text`.","default":"output_text","x-stainless-const":true},"text":{"type":"string","description":"The text output from the model."},"annotations":{"items":{"$ref":"#/components/schemas/Annotation"},"type":"array","description":"The annotations of the text output."},"logprobs":{"items":{"$ref":"#/components/schemas/LogProb"},"type":"array"}},"type":"object","required":["type","text","annotations","logprobs"],"title":"Output text","description":"A text output from the model."},"TextContent":{"properties":{"type":{"type":"string","enum":["text"],"default":"text","x-stainless-const":true},"text":{"type":"string"}},"type":"object","required":["type","text"],"title":"Text Content","description":"A text content."},"SummaryTextContent":{"properties":{"type":{"type":"string","enum":["summary_text"],"description":"The type of the object. Always `summary_text`.","default":"summary_text","x-stainless-const":true},"text":{"type":"string","description":"A summary of the reasoning output from the model so far."}},"type":"object","required":["type","text"],"title":"Summary text","description":"A summary text from the model."},"ReasoningTextContent":{"properties":{"type":{"type":"string","enum":["reasoning_text"],"description":"The type of the reasoning text. Always `reasoning_text`.","default":"reasoning_text","x-stainless-const":true},"text":{"type":"string","description":"The reasoning text from the model."}},"type":"object","required":["type","text"],"title":"Reasoning text","description":"Reasoning text from the model."},"RefusalContent":{"properties":{"type":{"type":"string","enum":["refusal"],"description":"The type of the refusal. Always `refusal`.","default":"refusal","x-stainless-const":true},"refusal":{"type":"string","description":"The refusal explanation from the model."}},"type":"object","required":["type","refusal"],"title":"Refusal","description":"A refusal from the model."},"ImageDetail":{"type":"string","enum":["low","high","auto","original"]},"InputImageContent":{"properties":{"type":{"type":"string","enum":["input_image"],"description":"The type of the input item. Always `input_image`.","default":"input_image","x-stainless-const":true},"image_url":{"anyOf":[{"type":"string","description":"The URL of the image to be sent to the model. A fully qualified URL or base64 encoded image in a data URL."},{"type":"null"}]},"file_id":{"anyOf":[{"type":"string","description":"The ID of the file to be sent to the model."},{"type":"null"}]},"detail":{"$ref":"#/components/schemas/ImageDetail","description":"The detail level of the image to be sent to the model. One of `high`, `low`, `auto`, or `original`. Defaults to `auto`."}},"type":"object","required":["type","detail"],"title":"Input image","description":"An image input to the model. Learn about [image inputs](/docs/guides/vision)."},"ComputerScreenshotContent":{"properties":{"type":{"type":"string","enum":["computer_screenshot"],"description":"Specifies the event type. For a computer screenshot, this property is always set to `computer_screenshot`.","default":"computer_screenshot","x-stainless-const":true},"image_url":{"anyOf":[{"type":"string","description":"The URL of the screenshot image."},{"type":"null"}]},"file_id":{"anyOf":[{"type":"string","description":"The identifier of an uploaded file that contains the screenshot."},{"type":"null"}]},"detail":{"$ref":"#/components/schemas/ImageDetail","description":"The detail level of the screenshot image to be sent to the model. One of `high`, `low`, `auto`, or `original`. Defaults to `auto`."}},"type":"object","required":["type","image_url","file_id","detail"],"title":"Computer screenshot","description":"A screenshot of a computer."},"FileInputDetail":{"type":"string","enum":["low","high"]},"InputFileContent":{"properties":{"type":{"type":"string","enum":["input_file"],"description":"The type of the input item. Always `input_file`.","default":"input_file","x-stainless-const":true},"file_id":{"anyOf":[{"type":"string","description":"The ID of the file to be sent to the model."},{"type":"null"}]},"filename":{"type":"string","description":"The name of the file to be sent to the model."},"file_data":{"type":"string","description":"The content of the file to be sent to the model.\n"},"file_url":{"type":"string","description":"The URL of the file to be sent to the model."},"detail":{"$ref":"#/components/schemas/FileInputDetail","description":"The detail level of the file to be sent to the model. Use `low` for the default rendering behavior, or `high` to render the file at higher quality. Defaults to `low`."}},"type":"object","required":["type"],"title":"Input file","description":"A file input to the model."},"MessagePhase-2":{"type":"string","enum":["commentary","final_answer"]},"Message":{"properties":{"type":{"type":"string","enum":["message"],"description":"The type of the message. Always set to `message`.","default":"message","x-stainless-const":true},"id":{"type":"string","description":"The unique ID of the message."},"status":{"$ref":"#/components/schemas/MessageStatus","description":"The status of item. One of `in_progress`, `completed`, or `incomplete`. Populated when items are returned via API."},"role":{"$ref":"#/components/schemas/MessageRole","description":"The role of the message. One of `unknown`, `user`, `assistant`, `system`, `critic`, `discriminator`, `developer`, or `tool`."},"content":{"items":{"oneOf":[{"$ref":"#/components/schemas/InputTextContent"},{"$ref":"#/components/schemas/OutputTextContent"},{"$ref":"#/components/schemas/TextContent"},{"$ref":"#/components/schemas/SummaryTextContent"},{"$ref":"#/components/schemas/ReasoningTextContent"},{"$ref":"#/components/schemas/RefusalContent"},{"$ref":"#/components/schemas/InputImageContent"},{"$ref":"#/components/schemas/ComputerScreenshotContent"},{"$ref":"#/components/schemas/InputFileContent"}],"description":"A content part that makes up an input or output item.","discriminator":{"propertyName":"type"}},"type":"array","description":"The content of the message"},"phase":{"anyOf":[{"$ref":"#/components/schemas/MessagePhase-2","description":"Labels an `assistant` message as intermediate commentary (`commentary`) or the final answer (`final_answer`). For models like `gpt-5.3-codex` and beyond, when sending follow-up requests, preserve and resend phase on all assistant messages — dropping it can degrade performance. Not used for user messages."},{"type":"null"}]}},"type":"object","required":["type","id","status","role","content"],"title":"Message","description":"A message to or from the model."},"FunctionCallStatus":{"type":"string","enum":["in_progress","completed","incomplete"]},"FunctionCallOutputStatusEnum":{"type":"string","enum":["in_progress","completed","incomplete"]},"ClickButtonType":{"type":"string","enum":["left","right","wheel","back","forward"]},"ClickParam":{"properties":{"type":{"type":"string","enum":["click"],"description":"Specifies the event type. For a click action, this property is always `click`.","default":"click","x-stainless-const":true},"button":{"$ref":"#/components/schemas/ClickButtonType","description":"Indicates which mouse button was pressed during the click. One of `left`, `right`, `wheel`, `back`, or `forward`."},"x":{"type":"integer","description":"The x-coordinate where the click occurred."},"y":{"type":"integer","description":"The y-coordinate where the click occurred."},"keys":{"anyOf":[{"items":{"type":"string"},"type":"array","description":"The keys being held while clicking."},{"type":"null"}]}},"type":"object","required":["type","button","x","y"],"title":"Click","description":"A click action."},"DoubleClickAction":{"properties":{"type":{"type":"string","enum":["double_click"],"description":"Specifies the event type. For a double click action, this property is always set to `double_click`.","default":"double_click","x-stainless-const":true},"x":{"type":"integer","description":"The x-coordinate where the double click occurred."},"y":{"type":"integer","description":"The y-coordinate where the double click occurred."},"keys":{"anyOf":[{"items":{"type":"string"},"type":"array","description":"The keys being held while double-clicking."},{"type":"null"}]}},"type":"object","required":["type","x","y","keys"],"title":"DoubleClick","description":"A double click action."},"CoordParam":{"properties":{"x":{"type":"integer","description":"The x-coordinate."},"y":{"type":"integer","description":"The y-coordinate."}},"type":"object","required":["x","y"],"title":"Coordinate","description":"An x/y coordinate pair, e.g. `{ x: 100, y: 200 }`."},"DragParam":{"properties":{"type":{"type":"string","enum":["drag"],"description":"Specifies the event type. For a drag action, this property is always set to `drag`.","default":"drag","x-stainless-const":true},"path":{"items":{"$ref":"#/components/schemas/CoordParam"},"type":"array","description":"An array of coordinates representing the path of the drag action. Coordinates will appear as an array of objects, eg\n```\n[\n { x: 100, y: 200 },\n { x: 200, y: 300 }\n]\n```"},"keys":{"anyOf":[{"items":{"type":"string"},"type":"array","description":"The keys being held while dragging the mouse."},{"type":"null"}]}},"type":"object","required":["type","path"],"title":"Drag","description":"A drag action."},"KeyPressAction":{"properties":{"type":{"type":"string","enum":["keypress"],"description":"Specifies the event type. For a keypress action, this property is always set to `keypress`.","default":"keypress","x-stainless-const":true},"keys":{"items":{"type":"string","description":"One of the keys the model is requesting to be pressed."},"type":"array","description":"The combination of keys the model is requesting to be pressed. This is an array of strings, each representing a key."}},"type":"object","required":["type","keys"],"title":"KeyPress","description":"A collection of keypresses the model would like to perform."},"MoveParam":{"properties":{"type":{"type":"string","enum":["move"],"description":"Specifies the event type. For a move action, this property is always set to `move`.","default":"move","x-stainless-const":true},"x":{"type":"integer","description":"The x-coordinate to move to."},"y":{"type":"integer","description":"The y-coordinate to move to."},"keys":{"anyOf":[{"items":{"type":"string"},"type":"array","description":"The keys being held while moving the mouse."},{"type":"null"}]}},"type":"object","required":["type","x","y"],"title":"Move","description":"A mouse move action."},"ScreenshotParam":{"properties":{"type":{"type":"string","enum":["screenshot"],"description":"Specifies the event type. For a screenshot action, this property is always set to `screenshot`.","default":"screenshot","x-stainless-const":true}},"type":"object","required":["type"],"title":"Screenshot","description":"A screenshot action."},"ScrollParam":{"properties":{"type":{"type":"string","enum":["scroll"],"description":"Specifies the event type. For a scroll action, this property is always set to `scroll`.","default":"scroll","x-stainless-const":true},"x":{"type":"integer","description":"The x-coordinate where the scroll occurred."},"y":{"type":"integer","description":"The y-coordinate where the scroll occurred."},"scroll_x":{"type":"integer","description":"The horizontal scroll distance."},"scroll_y":{"type":"integer","description":"The vertical scroll distance."},"keys":{"anyOf":[{"items":{"type":"string"},"type":"array","description":"The keys being held while scrolling."},{"type":"null"}]}},"type":"object","required":["type","x","y","scroll_x","scroll_y"],"title":"Scroll","description":"A scroll action."},"TypeParam":{"properties":{"type":{"type":"string","enum":["type"],"description":"Specifies the event type. For a type action, this property is always set to `type`.","default":"type","x-stainless-const":true},"text":{"type":"string","description":"The text to type."}},"type":"object","required":["type","text"],"title":"Type","description":"An action to type in text."},"WaitParam":{"properties":{"type":{"type":"string","enum":["wait"],"description":"Specifies the event type. For a wait action, this property is always set to `wait`.","default":"wait","x-stainless-const":true}},"type":"object","required":["type"],"title":"Wait","description":"A wait action."},"ComputerCallSafetyCheckParam":{"properties":{"id":{"type":"string","description":"The ID of the pending safety check."},"code":{"anyOf":[{"type":"string","description":"The type of the pending safety check."},{"type":"null"}]},"message":{"anyOf":[{"type":"string","description":"Details about the pending safety check."},{"type":"null"}]}},"type":"object","required":["id"],"description":"A pending safety check for the computer call."},"ComputerCallOutputStatus":{"type":"string","enum":["completed","incomplete","failed"]},"ToolSearchExecutionType":{"type":"string","enum":["server","client"]},"ToolSearchCall":{"properties":{"type":{"type":"string","enum":["tool_search_call"],"description":"The type of the item. Always `tool_search_call`.","default":"tool_search_call","x-stainless-const":true},"id":{"type":"string","description":"The unique ID of the tool search call item."},"call_id":{"anyOf":[{"type":"string","description":"The unique ID of the tool search call generated by the model."},{"type":"null"}]},"execution":{"$ref":"#/components/schemas/ToolSearchExecutionType","description":"Whether tool search was executed by the server or by the client."},"arguments":{"description":"Arguments used for the tool search call."},"status":{"$ref":"#/components/schemas/FunctionCallStatus","description":"The status of the tool search call item that was recorded."},"created_by":{"type":"string","description":"The identifier of the actor that created the item."}},"type":"object","required":["type","id","call_id","execution","arguments","status"]},"FunctionTool":{"properties":{"type":{"type":"string","enum":["function"],"description":"The type of the function tool. Always `function`.","default":"function","x-stainless-const":true},"name":{"type":"string","description":"The name of the function to call."},"description":{"anyOf":[{"type":"string","description":"A description of the function. Used by the model to determine whether or not to call the function."},{"type":"null"}]},"parameters":{"anyOf":[{"additionalProperties":{},"type":"object","description":"A JSON schema object describing the parameters of the function.","x-oaiTypeLabel":"map"},{"type":"null"}]},"strict":{"anyOf":[{"type":"boolean","description":"Whether to enforce strict parameter validation. Default `true`."},{"type":"null"}]},"defer_loading":{"type":"boolean","description":"Whether this function is deferred and loaded via tool search."}},"type":"object","required":["type","name","strict","parameters"],"title":"Function","description":"Defines a function in your own code the model can choose to call. Learn more about [function calling](https://platform.openai.com/docs/guides/function-calling)."},"RankerVersionType":{"type":"string","enum":["auto","default-2024-11-15"]},"HybridSearchOptions":{"properties":{"embedding_weight":{"type":"number","description":"The weight of the embedding in the reciprocal ranking fusion."},"text_weight":{"type":"number","description":"The weight of the text in the reciprocal ranking fusion."}},"type":"object","required":["embedding_weight","text_weight"]},"RankingOptions":{"properties":{"ranker":{"$ref":"#/components/schemas/RankerVersionType","description":"The ranker to use for the file search."},"score_threshold":{"type":"number","description":"The score threshold for the file search, a number between 0 and 1. Numbers closer to 1 will attempt to return only the most relevant results, but may return fewer results."},"hybrid_search":{"$ref":"#/components/schemas/HybridSearchOptions","description":"Weights that control how reciprocal rank fusion balances semantic embedding matches versus sparse keyword matches when hybrid search is enabled."}},"type":"object","required":[]},"Filters":{"anyOf":[{"$ref":"#/components/schemas/ComparisonFilter"},{"$ref":"#/components/schemas/CompoundFilter"}]},"FileSearchTool":{"properties":{"type":{"type":"string","enum":["file_search"],"description":"The type of the file search tool. Always `file_search`.","default":"file_search","x-stainless-const":true},"vector_store_ids":{"items":{"type":"string"},"type":"array","description":"The IDs of the vector stores to search."},"max_num_results":{"type":"integer","description":"The maximum number of results to return. This number should be between 1 and 50 inclusive."},"ranking_options":{"$ref":"#/components/schemas/RankingOptions","description":"Ranking options for search."},"filters":{"anyOf":[{"$ref":"#/components/schemas/Filters","description":"A filter to apply."},{"type":"null"}]}},"type":"object","required":["type","vector_store_ids"],"title":"File search","description":"A tool that searches for relevant content from uploaded files. Learn more about the [file search tool](https://platform.openai.com/docs/guides/tools-file-search)."},"ComputerTool":{"properties":{"type":{"type":"string","enum":["computer"],"description":"The type of the computer tool. Always `computer`.","default":"computer","x-stainless-const":true}},"type":"object","required":["type"],"title":"Computer","description":"A tool that controls a virtual computer. Learn more about the [computer tool](https://platform.openai.com/docs/guides/tools-computer-use)."},"ComputerEnvironment":{"type":"string","enum":["windows","mac","linux","ubuntu","browser"]},"ComputerUsePreviewTool":{"properties":{"type":{"type":"string","enum":["computer_use_preview"],"description":"The type of the computer use tool. Always `computer_use_preview`.","default":"computer_use_preview","x-stainless-const":true},"environment":{"$ref":"#/components/schemas/ComputerEnvironment","description":"The type of computer environment to control."},"display_width":{"type":"integer","description":"The width of the computer display."},"display_height":{"type":"integer","description":"The height of the computer display."}},"type":"object","required":["type","environment","display_width","display_height"],"title":"Computer use preview","description":"A tool that controls a virtual computer. Learn more about the [computer tool](https://platform.openai.com/docs/guides/tools-computer-use)."},"ContainerMemoryLimit":{"type":"string","enum":["1g","4g","16g","64g"]},"AutoCodeInterpreterToolParam":{"properties":{"type":{"type":"string","enum":["auto"],"description":"Always `auto`.","default":"auto","x-stainless-const":true},"file_ids":{"items":{"type":"string","example":"file-123"},"type":"array","maxItems":50,"description":"An optional list of uploaded files to make available to your code."},"memory_limit":{"anyOf":[{"$ref":"#/components/schemas/ContainerMemoryLimit","description":"The memory limit for the code interpreter container."},{"type":"null"}]},"network_policy":{"oneOf":[{"$ref":"#/components/schemas/ContainerNetworkPolicyDisabledParam"},{"$ref":"#/components/schemas/ContainerNetworkPolicyAllowlistParam"}],"description":"Network access policy for the container.","discriminator":{"propertyName":"type"}}},"type":"object","required":["type"],"title":"CodeInterpreterToolAuto","description":"Configuration for a code interpreter container. Optionally specify the IDs of the files to run the code on."},"InputFidelity":{"type":"string","enum":["high","low"],"description":"Control how much effort the model will exert to match the style and features, especially facial features, of input images. This parameter is only supported for `gpt-image-1` and `gpt-image-1.5` and later models, unsupported for `gpt-image-1-mini`. Supports `high` and `low`. Defaults to `low`."},"ImageGenActionEnum":{"type":"string","enum":["generate","edit","auto"]},"LocalShellToolParam":{"properties":{"type":{"type":"string","enum":["local_shell"],"description":"The type of the local shell tool. Always `local_shell`.","default":"local_shell","x-stainless-const":true}},"type":"object","required":["type"],"title":"Local shell tool","description":"A tool that allows the model to execute shell commands in a local environment."},"ContainerAutoParam":{"properties":{"type":{"type":"string","enum":["container_auto"],"description":"Automatically creates a container for this request","default":"container_auto","x-stainless-const":true},"file_ids":{"items":{"type":"string","example":"file-123"},"type":"array","maxItems":50,"description":"An optional list of uploaded files to make available to your code."},"memory_limit":{"anyOf":[{"$ref":"#/components/schemas/ContainerMemoryLimit","description":"The memory limit for the container."},{"type":"null"}]},"network_policy":{"oneOf":[{"$ref":"#/components/schemas/ContainerNetworkPolicyDisabledParam"},{"$ref":"#/components/schemas/ContainerNetworkPolicyAllowlistParam"}],"description":"Network access policy for the container.","discriminator":{"propertyName":"type"}},"skills":{"items":{"oneOf":[{"$ref":"#/components/schemas/SkillReferenceParam"},{"$ref":"#/components/schemas/InlineSkillParam"}],"discriminator":{"propertyName":"type"}},"type":"array","maxItems":200,"description":"An optional list of skills referenced by id or inline data."}},"type":"object","required":["type"]},"LocalSkillParam":{"properties":{"name":{"type":"string","description":"The name of the skill."},"description":{"type":"string","description":"The description of the skill."},"path":{"type":"string","description":"The path to the directory containing the skill."}},"type":"object","required":["name","description","path"]},"LocalEnvironmentParam":{"properties":{"type":{"type":"string","enum":["local"],"description":"Use a local computer environment.","default":"local","x-stainless-const":true},"skills":{"items":{"$ref":"#/components/schemas/LocalSkillParam"},"type":"array","maxItems":200,"description":"An optional list of skills."}},"type":"object","required":["type"]},"ContainerReferenceParam":{"properties":{"type":{"type":"string","enum":["container_reference"],"description":"References a container created with the /v1/containers endpoint","default":"container_reference","x-stainless-const":true},"container_id":{"type":"string","description":"The ID of the referenced container.","example":"cntr_123"}},"type":"object","required":["type","container_id"]},"FunctionShellToolParam":{"properties":{"type":{"type":"string","enum":["shell"],"description":"The type of the shell tool. Always `shell`.","default":"shell","x-stainless-const":true},"environment":{"anyOf":[{"oneOf":[{"$ref":"#/components/schemas/ContainerAutoParam"},{"$ref":"#/components/schemas/LocalEnvironmentParam"},{"$ref":"#/components/schemas/ContainerReferenceParam"}],"discriminator":{"propertyName":"type"}},{"type":"null"}]}},"type":"object","required":["type"],"title":"Shell tool","description":"A tool that allows the model to execute shell commands."},"CustomTextFormatParam":{"properties":{"type":{"type":"string","enum":["text"],"description":"Unconstrained text format. Always `text`.","default":"text","x-stainless-const":true}},"type":"object","required":["type"],"title":"Text format","description":"Unconstrained free-form text."},"GrammarSyntax1":{"type":"string","enum":["lark","regex"]},"CustomGrammarFormatParam":{"properties":{"type":{"type":"string","enum":["grammar"],"description":"Grammar format. Always `grammar`.","default":"grammar","x-stainless-const":true},"syntax":{"$ref":"#/components/schemas/GrammarSyntax1","description":"The syntax of the grammar definition. One of `lark` or `regex`."},"definition":{"type":"string","description":"The grammar definition."}},"type":"object","required":["type","syntax","definition"],"title":"Grammar format","description":"A grammar defined by the user."},"CustomToolParam":{"properties":{"type":{"type":"string","enum":["custom"],"description":"The type of the custom tool. Always `custom`.","default":"custom","x-stainless-const":true},"name":{"type":"string","description":"The name of the custom tool, used to identify it in tool calls."},"description":{"type":"string","description":"Optional description of the custom tool, used to provide more context."},"format":{"oneOf":[{"$ref":"#/components/schemas/CustomTextFormatParam"},{"$ref":"#/components/schemas/CustomGrammarFormatParam"}],"description":"The input format for the custom tool. Default is unconstrained text.","discriminator":{"propertyName":"type"}},"defer_loading":{"type":"boolean","description":"Whether this tool should be deferred and discovered via tool search."}},"type":"object","required":["type","name"],"title":"Custom tool","description":"A custom tool that processes input using a specified format. Learn more about [custom tools](/docs/guides/function-calling#custom-tools)"},"EmptyModelParam":{"properties":{},"type":"object","required":[]},"FunctionToolParam":{"properties":{"name":{"type":"string","maxLength":128,"minLength":1,"pattern":"^[a-zA-Z0-9_-]+$"},"description":{"anyOf":[{"type":"string"},{"type":"null"}]},"parameters":{"anyOf":[{"$ref":"#/components/schemas/EmptyModelParam"},{"type":"null"}]},"strict":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"type":{"type":"string","enum":["function"],"default":"function","x-stainless-const":true},"defer_loading":{"type":"boolean","description":"Whether this function should be deferred and discovered via tool search."}},"type":"object","required":["name","type"]},"NamespaceToolParam":{"properties":{"type":{"type":"string","enum":["namespace"],"description":"The type of the tool. Always `namespace`.","default":"namespace","x-stainless-const":true},"name":{"type":"string","minLength":1,"description":"The namespace name used in tool calls (for example, `crm`)."},"description":{"type":"string","minLength":1,"description":"A description of the namespace shown to the model."},"tools":{"items":{"oneOf":[{"$ref":"#/components/schemas/FunctionToolParam"},{"$ref":"#/components/schemas/CustomToolParam"}],"description":"A function or custom tool that belongs to a namespace.","discriminator":{"propertyName":"type"}},"type":"array","minItems":1,"description":"The function/custom tools available inside this namespace."}},"type":"object","required":["type","name","description","tools"],"title":"Namespace","description":"Groups function/custom tools under a shared namespace."},"ToolSearchToolParam":{"properties":{"type":{"type":"string","enum":["tool_search"],"description":"The type of the tool. Always `tool_search`.","default":"tool_search","x-stainless-const":true},"execution":{"$ref":"#/components/schemas/ToolSearchExecutionType","description":"Whether tool search is executed by the server or by the client."},"description":{"anyOf":[{"type":"string","description":"Description shown to the model for a client-executed tool search tool."},{"type":"null"}]},"parameters":{"anyOf":[{"$ref":"#/components/schemas/EmptyModelParam","description":"Parameter schema for a client-executed tool search tool."},{"type":"null"}]}},"type":"object","required":["type"],"title":"Tool search tool","description":"Hosted or BYOT tool search configuration for deferred tools."},"ApproximateLocation":{"properties":{"type":{"type":"string","enum":["approximate"],"description":"The type of location approximation. Always `approximate`.","default":"approximate","x-stainless-const":true},"country":{"anyOf":[{"type":"string","description":"The two-letter [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1) of the user, e.g. `US`."},{"type":"null"}]},"region":{"anyOf":[{"type":"string","description":"Free text input for the region of the user, e.g. `California`."},{"type":"null"}]},"city":{"anyOf":[{"type":"string","description":"Free text input for the city of the user, e.g. `San Francisco`."},{"type":"null"}]},"timezone":{"anyOf":[{"type":"string","description":"The [IANA timezone](https://timeapi.io/documentation/iana-timezones) of the user, e.g. `America/Los_Angeles`."},{"type":"null"}]}},"type":"object","required":["type"]},"SearchContextSize":{"type":"string","enum":["low","medium","high"]},"SearchContentType":{"type":"string","enum":["text","image"]},"WebSearchPreviewTool":{"properties":{"type":{"type":"string","enum":["web_search_preview","web_search_preview_2025_03_11"],"description":"The type of the web search tool. One of `web_search_preview` or `web_search_preview_2025_03_11`.","default":"web_search_preview","x-stainless-const":true},"user_location":{"anyOf":[{"$ref":"#/components/schemas/ApproximateLocation","description":"The user's location."},{"type":"null"}]},"search_context_size":{"$ref":"#/components/schemas/SearchContextSize","description":"High level guidance for the amount of context window space to use for the search. One of `low`, `medium`, or `high`. `medium` is the default."},"search_content_types":{"items":{"$ref":"#/components/schemas/SearchContentType"},"type":"array"}},"type":"object","required":["type"],"title":"Web search preview","description":"This tool searches the web for relevant results to use in a response. Learn more about the [web search tool](https://platform.openai.com/docs/guides/tools-web-search)."},"ApplyPatchToolParam":{"properties":{"type":{"type":"string","enum":["apply_patch"],"description":"The type of the tool. Always `apply_patch`.","default":"apply_patch","x-stainless-const":true}},"type":"object","required":["type"],"title":"Apply patch tool","description":"Allows the assistant to create, delete, or update files using unified diffs."},"ToolSearchOutput":{"properties":{"type":{"type":"string","enum":["tool_search_output"],"description":"The type of the item. Always `tool_search_output`.","default":"tool_search_output","x-stainless-const":true},"id":{"type":"string","description":"The unique ID of the tool search output item."},"call_id":{"anyOf":[{"type":"string","description":"The unique ID of the tool search call generated by the model."},{"type":"null"}]},"execution":{"$ref":"#/components/schemas/ToolSearchExecutionType","description":"Whether tool search was executed by the server or by the client."},"tools":{"items":{"$ref":"#/components/schemas/Tool"},"type":"array","description":"The loaded tool definitions returned by tool search."},"status":{"$ref":"#/components/schemas/FunctionCallOutputStatusEnum","description":"The status of the tool search output item that was recorded."},"created_by":{"type":"string","description":"The identifier of the actor that created the item."}},"type":"object","required":["type","id","call_id","execution","tools","status"]},"CompactionBody":{"properties":{"type":{"type":"string","enum":["compaction"],"description":"The type of the item. Always `compaction`.","default":"compaction","x-stainless-const":true},"id":{"type":"string","description":"The unique ID of the compaction item."},"encrypted_content":{"type":"string","description":"The encrypted content that was produced by compaction."},"created_by":{"type":"string","description":"The identifier of the actor that created the item."}},"type":"object","required":["type","id","encrypted_content"],"title":"Compaction item","description":"A compaction item generated by the [`v1/responses/compact` API](/docs/api-reference/responses/compact)."},"CodeInterpreterOutputLogs":{"properties":{"type":{"type":"string","enum":["logs"],"description":"The type of the output. Always `logs`.","default":"logs","x-stainless-const":true},"logs":{"type":"string","description":"The logs output from the code interpreter."}},"type":"object","required":["type","logs"],"title":"Code interpreter output logs","description":"The logs output from the code interpreter."},"CodeInterpreterOutputImage":{"properties":{"type":{"type":"string","enum":["image"],"description":"The type of the output. Always `image`.","default":"image","x-stainless-const":true},"url":{"type":"string","description":"The URL of the image output from the code interpreter."}},"type":"object","required":["type","url"],"title":"Code interpreter output image","description":"The image output from the code interpreter."},"LocalShellExecAction":{"properties":{"type":{"type":"string","enum":["exec"],"description":"The type of the local shell action. Always `exec`.","default":"exec","x-stainless-const":true},"command":{"items":{"type":"string"},"type":"array","description":"The command to run."},"timeout_ms":{"anyOf":[{"type":"integer","description":"Optional timeout in milliseconds for the command."},{"type":"null"}]},"working_directory":{"anyOf":[{"type":"string","description":"Optional working directory to run the command in."},{"type":"null"}]},"env":{"additionalProperties":{"type":"string"},"type":"object","description":"Environment variables to set for the command.","x-oaiTypeLabel":"map"},"user":{"anyOf":[{"type":"string","description":"Optional user to run the command as."},{"type":"null"}]}},"type":"object","required":["type","command","env"],"title":"Local shell exec action","description":"Execute a shell command on the server."},"FunctionShellAction":{"properties":{"commands":{"items":{"type":"string","description":"A list of commands to run."},"type":"array"},"timeout_ms":{"anyOf":[{"type":"integer","description":"Optional timeout in milliseconds for the commands."},{"type":"null"}]},"max_output_length":{"anyOf":[{"type":"integer","description":"Optional maximum number of characters to return from each command."},{"type":"null"}]}},"type":"object","required":["commands","timeout_ms","max_output_length"],"title":"Shell exec action","description":"Execute a shell command."},"FunctionShellCallStatus":{"type":"string","enum":["in_progress","completed","incomplete"]},"LocalEnvironmentResource":{"properties":{"type":{"type":"string","enum":["local"],"description":"The environment type. Always `local`.","default":"local","x-stainless-const":true}},"type":"object","required":["type"],"title":"Local Environment","description":"Represents the use of a local environment to perform shell actions."},"ContainerReferenceResource":{"properties":{"type":{"type":"string","enum":["container_reference"],"description":"The environment type. Always `container_reference`.","default":"container_reference","x-stainless-const":true},"container_id":{"type":"string"}},"type":"object","required":["type","container_id"],"title":"Container Reference","description":"Represents a container created with /v1/containers."},"FunctionShellCall":{"properties":{"type":{"type":"string","enum":["shell_call"],"description":"The type of the item. Always `shell_call`.","default":"shell_call","x-stainless-const":true},"id":{"type":"string","description":"The unique ID of the shell tool call. Populated when this item is returned via API."},"call_id":{"type":"string","description":"The unique ID of the shell tool call generated by the model."},"action":{"$ref":"#/components/schemas/FunctionShellAction","description":"The shell commands and limits that describe how to run the tool call."},"status":{"$ref":"#/components/schemas/FunctionShellCallStatus","description":"The status of the shell call. One of `in_progress`, `completed`, or `incomplete`."},"environment":{"anyOf":[{"oneOf":[{"$ref":"#/components/schemas/LocalEnvironmentResource"},{"$ref":"#/components/schemas/ContainerReferenceResource"}],"discriminator":{"propertyName":"type"}},{"type":"null"}]},"created_by":{"type":"string","description":"The ID of the entity that created this tool call."}},"type":"object","required":["type","id","call_id","action","status","environment"],"title":"Shell tool call","description":"A tool call that executes one or more shell commands in a managed environment."},"FunctionShellCallOutputStatusEnum":{"type":"string","enum":["in_progress","completed","incomplete"]},"FunctionShellCallOutputTimeoutOutcome":{"properties":{"type":{"type":"string","enum":["timeout"],"description":"The outcome type. Always `timeout`.","default":"timeout","x-stainless-const":true}},"type":"object","required":["type"],"title":"Shell call timeout outcome","description":"Indicates that the shell call exceeded its configured time limit."},"FunctionShellCallOutputExitOutcome":{"properties":{"type":{"type":"string","enum":["exit"],"description":"The outcome type. Always `exit`.","default":"exit","x-stainless-const":true},"exit_code":{"type":"integer","description":"Exit code from the shell process."}},"type":"object","required":["type","exit_code"],"title":"Shell call exit outcome","description":"Indicates that the shell commands finished and returned an exit code."},"FunctionShellCallOutputContent":{"properties":{"stdout":{"type":"string","description":"The standard output that was captured."},"stderr":{"type":"string","description":"The standard error output that was captured."},"outcome":{"oneOf":[{"$ref":"#/components/schemas/FunctionShellCallOutputTimeoutOutcome"},{"$ref":"#/components/schemas/FunctionShellCallOutputExitOutcome"}],"title":"Shell call outcome","description":"Represents either an exit outcome (with an exit code) or a timeout outcome for a shell call output chunk.","discriminator":{"propertyName":"type"}},"created_by":{"type":"string","description":"The identifier of the actor that created the item."}},"type":"object","required":["stdout","stderr","outcome"],"title":"Shell call output content","description":"The content of a shell tool call output that was emitted."},"FunctionShellCallOutput":{"properties":{"type":{"type":"string","enum":["shell_call_output"],"description":"The type of the shell call output. Always `shell_call_output`.","default":"shell_call_output","x-stainless-const":true},"id":{"type":"string","description":"The unique ID of the shell call output. Populated when this item is returned via API."},"call_id":{"type":"string","description":"The unique ID of the shell tool call generated by the model."},"status":{"$ref":"#/components/schemas/FunctionShellCallOutputStatusEnum","description":"The status of the shell call output. One of `in_progress`, `completed`, or `incomplete`."},"output":{"items":{"$ref":"#/components/schemas/FunctionShellCallOutputContent"},"type":"array","description":"An array of shell call output contents"},"max_output_length":{"anyOf":[{"type":"integer","description":"The maximum length of the shell command output. This is generated by the model and should be passed back with the raw output."},{"type":"null"}]},"created_by":{"type":"string","description":"The identifier of the actor that created the item."}},"type":"object","required":["type","id","call_id","status","output","max_output_length"],"title":"Shell call output","description":"The output of a shell tool call that was emitted."},"ApplyPatchCallStatus":{"type":"string","enum":["in_progress","completed"]},"ApplyPatchCreateFileOperation":{"properties":{"type":{"type":"string","enum":["create_file"],"description":"Create a new file with the provided diff.","default":"create_file","x-stainless-const":true},"path":{"type":"string","description":"Path of the file to create."},"diff":{"type":"string","description":"Diff to apply."}},"type":"object","required":["type","path","diff"],"title":"Apply patch create file operation","description":"Instruction describing how to create a file via the apply_patch tool."},"ApplyPatchDeleteFileOperation":{"properties":{"type":{"type":"string","enum":["delete_file"],"description":"Delete the specified file.","default":"delete_file","x-stainless-const":true},"path":{"type":"string","description":"Path of the file to delete."}},"type":"object","required":["type","path"],"title":"Apply patch delete file operation","description":"Instruction describing how to delete a file via the apply_patch tool."},"ApplyPatchUpdateFileOperation":{"properties":{"type":{"type":"string","enum":["update_file"],"description":"Update an existing file with the provided diff.","default":"update_file","x-stainless-const":true},"path":{"type":"string","description":"Path of the file to update."},"diff":{"type":"string","description":"Diff to apply."}},"type":"object","required":["type","path","diff"],"title":"Apply patch update file operation","description":"Instruction describing how to update a file via the apply_patch tool."},"ApplyPatchToolCall":{"properties":{"type":{"type":"string","enum":["apply_patch_call"],"description":"The type of the item. Always `apply_patch_call`.","default":"apply_patch_call","x-stainless-const":true},"id":{"type":"string","description":"The unique ID of the apply patch tool call. Populated when this item is returned via API."},"call_id":{"type":"string","description":"The unique ID of the apply patch tool call generated by the model."},"status":{"$ref":"#/components/schemas/ApplyPatchCallStatus","description":"The status of the apply patch tool call. One of `in_progress` or `completed`."},"operation":{"oneOf":[{"$ref":"#/components/schemas/ApplyPatchCreateFileOperation"},{"$ref":"#/components/schemas/ApplyPatchDeleteFileOperation"},{"$ref":"#/components/schemas/ApplyPatchUpdateFileOperation"}],"title":"Apply patch operation","description":"One of the create_file, delete_file, or update_file operations applied via apply_patch.","discriminator":{"propertyName":"type"}},"created_by":{"type":"string","description":"The ID of the entity that created this tool call."}},"type":"object","required":["type","id","call_id","status","operation"],"title":"Apply patch tool call","description":"A tool call that applies file diffs by creating, deleting, or updating files."},"ApplyPatchCallOutputStatus":{"type":"string","enum":["completed","failed"]},"ApplyPatchToolCallOutput":{"properties":{"type":{"type":"string","enum":["apply_patch_call_output"],"description":"The type of the item. Always `apply_patch_call_output`.","default":"apply_patch_call_output","x-stainless-const":true},"id":{"type":"string","description":"The unique ID of the apply patch tool call output. Populated when this item is returned via API."},"call_id":{"type":"string","description":"The unique ID of the apply patch tool call generated by the model."},"status":{"$ref":"#/components/schemas/ApplyPatchCallOutputStatus","description":"The status of the apply patch tool call output. One of `completed` or `failed`."},"output":{"anyOf":[{"type":"string","description":"Optional textual output returned by the apply patch tool."},{"type":"null"}]},"created_by":{"type":"string","description":"The ID of the entity that created this tool call output."}},"type":"object","required":["type","id","call_id","status"],"title":"Apply patch tool call output","description":"The output emitted by an apply patch tool call."},"MCPToolCallStatus":{"type":"string","enum":["in_progress","completed","incomplete","calling","failed"]},"DetailEnum":{"type":"string","enum":["low","high","auto","original"]},"FunctionCallItemStatus":{"type":"string","enum":["in_progress","completed","incomplete"]},"ComputerCallOutputItemParam":{"properties":{"id":{"anyOf":[{"type":"string","description":"The ID of the computer tool call output.","example":"cuo_123"},{"type":"null"}]},"call_id":{"type":"string","maxLength":64,"minLength":1,"description":"The ID of the computer tool call that produced the output."},"type":{"type":"string","enum":["computer_call_output"],"description":"The type of the computer tool call output. Always `computer_call_output`.","default":"computer_call_output","x-stainless-const":true},"output":{"$ref":"#/components/schemas/ComputerScreenshotImage"},"acknowledged_safety_checks":{"anyOf":[{"items":{"$ref":"#/components/schemas/ComputerCallSafetyCheckParam"},"type":"array","description":"The safety checks reported by the API that have been acknowledged by the developer."},{"type":"null"}]},"status":{"anyOf":[{"$ref":"#/components/schemas/FunctionCallItemStatus","description":"The status of the message input. One of `in_progress`, `completed`, or `incomplete`. Populated when input items are returned via API."},{"type":"null"}]}},"type":"object","required":["call_id","type","output"],"title":"Computer tool call output","description":"The output of a computer tool call."},"InputTextContentParam":{"properties":{"type":{"type":"string","enum":["input_text"],"description":"The type of the input item. Always `input_text`.","default":"input_text","x-stainless-const":true},"text":{"type":"string","maxLength":10485760,"description":"The text input to the model."}},"type":"object","required":["type","text"],"title":"Input text","description":"A text input to the model."},"InputImageContentParamAutoParam":{"properties":{"type":{"type":"string","enum":["input_image"],"description":"The type of the input item. Always `input_image`.","default":"input_image","x-stainless-const":true},"image_url":{"anyOf":[{"type":"string","maxLength":20971520,"description":"The URL of the image to be sent to the model. A fully qualified URL or base64 encoded image in a data URL."},{"type":"null"}]},"file_id":{"anyOf":[{"type":"string","description":"The ID of the file to be sent to the model.","example":"file-123"},{"type":"null"}]},"detail":{"anyOf":[{"$ref":"#/components/schemas/DetailEnum","description":"The detail level of the image to be sent to the model. One of `high`, `low`, `auto`, or `original`. Defaults to `auto`."},{"type":"null"}]}},"type":"object","required":["type"],"title":"Input image","description":"An image input to the model. Learn about [image inputs](/docs/guides/vision)"},"FileDetailEnum":{"type":"string","enum":["low","high"]},"InputFileContentParam":{"properties":{"type":{"type":"string","enum":["input_file"],"description":"The type of the input item. Always `input_file`.","default":"input_file","x-stainless-const":true},"file_id":{"anyOf":[{"type":"string","description":"The ID of the file to be sent to the model.","example":"file-123"},{"type":"null"}]},"filename":{"anyOf":[{"type":"string","description":"The name of the file to be sent to the model."},{"type":"null"}]},"file_data":{"anyOf":[{"type":"string","maxLength":73400320,"description":"The base64-encoded data of the file to be sent to the model."},{"type":"null"}]},"file_url":{"anyOf":[{"type":"string","description":"The URL of the file to be sent to the model."},{"type":"null"}]},"detail":{"$ref":"#/components/schemas/FileDetailEnum","description":"The detail level of the file to be sent to the model. Use `low` for the default rendering behavior, or `high` to render the file at higher quality. Defaults to `low`."}},"type":"object","required":["type"],"title":"Input file","description":"A file input to the model."},"FunctionCallOutputItemParam":{"properties":{"id":{"anyOf":[{"type":"string","description":"The unique ID of the function tool call output. Populated when this item is returned via API.","example":"fc_123"},{"type":"null"}]},"call_id":{"type":"string","maxLength":64,"minLength":1,"description":"The unique ID of the function tool call generated by the model."},"type":{"type":"string","enum":["function_call_output"],"description":"The type of the function tool call output. Always `function_call_output`.","default":"function_call_output","x-stainless-const":true},"output":{"oneOf":[{"type":"string","maxLength":10485760,"description":"A JSON string of the output of the function tool call."},{"items":{"oneOf":[{"$ref":"#/components/schemas/InputTextContentParam"},{"$ref":"#/components/schemas/InputImageContentParamAutoParam"},{"$ref":"#/components/schemas/InputFileContentParam"}],"description":"A piece of message content, such as text, an image, or a file.","discriminator":{"propertyName":"type"}},"type":"array","description":"An array of content outputs (text, image, file) for the function tool call."}],"description":"Text, image, or file output of the function tool call."},"status":{"anyOf":[{"$ref":"#/components/schemas/FunctionCallItemStatus","description":"The status of the item. One of `in_progress`, `completed`, or `incomplete`. Populated when items are returned via API."},{"type":"null"}]}},"type":"object","required":["call_id","type","output"],"title":"Function tool call output","description":"The output of a function tool call."},"ToolSearchCallItemParam":{"properties":{"id":{"anyOf":[{"type":"string","description":"The unique ID of this tool search call.","example":"tsc_123"},{"type":"null"}]},"call_id":{"anyOf":[{"type":"string","maxLength":64,"minLength":1,"description":"The unique ID of the tool search call generated by the model."},{"type":"null"}]},"type":{"type":"string","enum":["tool_search_call"],"description":"The item type. Always `tool_search_call`.","default":"tool_search_call","x-stainless-const":true},"execution":{"$ref":"#/components/schemas/ToolSearchExecutionType","description":"Whether tool search was executed by the server or by the client."},"arguments":{"$ref":"#/components/schemas/EmptyModelParam","description":"The arguments supplied to the tool search call."},"status":{"anyOf":[{"$ref":"#/components/schemas/FunctionCallItemStatus","description":"The status of the tool search call."},{"type":"null"}]}},"type":"object","required":["type","arguments"]},"ToolSearchOutputItemParam":{"properties":{"id":{"anyOf":[{"type":"string","description":"The unique ID of this tool search output.","example":"tso_123"},{"type":"null"}]},"call_id":{"anyOf":[{"type":"string","maxLength":64,"minLength":1,"description":"The unique ID of the tool search call generated by the model."},{"type":"null"}]},"type":{"type":"string","enum":["tool_search_output"],"description":"The item type. Always `tool_search_output`.","default":"tool_search_output","x-stainless-const":true},"execution":{"$ref":"#/components/schemas/ToolSearchExecutionType","description":"Whether tool search was executed by the server or by the client."},"tools":{"items":{"$ref":"#/components/schemas/Tool"},"type":"array","description":"The loaded tool definitions returned by the tool search output."},"status":{"anyOf":[{"$ref":"#/components/schemas/FunctionCallItemStatus","description":"The status of the tool search output."},{"type":"null"}]}},"type":"object","required":["type","tools"]},"CompactionSummaryItemParam":{"properties":{"id":{"anyOf":[{"type":"string","description":"The ID of the compaction item.","example":"cmp_123"},{"type":"null"}]},"type":{"type":"string","enum":["compaction"],"description":"The type of the item. Always `compaction`.","default":"compaction","x-stainless-const":true},"encrypted_content":{"type":"string","maxLength":10485760,"description":"The encrypted content of the compaction summary."}},"type":"object","required":["type","encrypted_content"],"title":"Compaction item","description":"A compaction item generated by the [`v1/responses/compact` API](/docs/api-reference/responses/compact)."},"FunctionShellActionParam":{"properties":{"commands":{"items":{"type":"string"},"type":"array","description":"Ordered shell commands for the execution environment to run."},"timeout_ms":{"anyOf":[{"type":"integer","description":"Maximum wall-clock time in milliseconds to allow the shell commands to run."},{"type":"null"}]},"max_output_length":{"anyOf":[{"type":"integer","description":"Maximum number of UTF-8 characters to capture from combined stdout and stderr output."},{"type":"null"}]}},"type":"object","required":["commands"],"title":"Shell action","description":"Commands and limits describing how to run the shell tool call."},"FunctionShellCallItemStatus":{"type":"string","enum":["in_progress","completed","incomplete"],"title":"Shell call status","description":"Status values reported for shell tool calls."},"FunctionShellCallItemParam":{"properties":{"id":{"anyOf":[{"type":"string","description":"The unique ID of the shell tool call. Populated when this item is returned via API.","example":"sh_123"},{"type":"null"}]},"call_id":{"type":"string","maxLength":64,"minLength":1,"description":"The unique ID of the shell tool call generated by the model."},"type":{"type":"string","enum":["shell_call"],"description":"The type of the item. Always `shell_call`.","default":"shell_call","x-stainless-const":true},"action":{"$ref":"#/components/schemas/FunctionShellActionParam","description":"The shell commands and limits that describe how to run the tool call."},"status":{"anyOf":[{"$ref":"#/components/schemas/FunctionShellCallItemStatus","description":"The status of the shell call. One of `in_progress`, `completed`, or `incomplete`."},{"type":"null"}]},"environment":{"anyOf":[{"oneOf":[{"$ref":"#/components/schemas/LocalEnvironmentParam"},{"$ref":"#/components/schemas/ContainerReferenceParam"}],"description":"The environment to execute the shell commands in.","discriminator":{"propertyName":"type"}},{"type":"null"}]}},"type":"object","required":["call_id","type","action"],"title":"Shell tool call","description":"A tool representing a request to execute one or more shell commands."},"FunctionShellCallOutputTimeoutOutcomeParam":{"properties":{"type":{"type":"string","enum":["timeout"],"description":"The outcome type. Always `timeout`.","default":"timeout","x-stainless-const":true}},"type":"object","required":["type"],"title":"Shell call timeout outcome","description":"Indicates that the shell call exceeded its configured time limit."},"FunctionShellCallOutputExitOutcomeParam":{"properties":{"type":{"type":"string","enum":["exit"],"description":"The outcome type. Always `exit`.","default":"exit","x-stainless-const":true},"exit_code":{"type":"integer","description":"The exit code returned by the shell process."}},"type":"object","required":["type","exit_code"],"title":"Shell call exit outcome","description":"Indicates that the shell commands finished and returned an exit code."},"FunctionShellCallOutputOutcomeParam":{"oneOf":[{"$ref":"#/components/schemas/FunctionShellCallOutputTimeoutOutcomeParam"},{"$ref":"#/components/schemas/FunctionShellCallOutputExitOutcomeParam"}],"title":"Shell call outcome","description":"The exit or timeout outcome associated with this shell call.","discriminator":{"propertyName":"type"}},"FunctionShellCallOutputContentParam":{"properties":{"stdout":{"type":"string","maxLength":10485760,"description":"Captured stdout output for the shell call."},"stderr":{"type":"string","maxLength":10485760,"description":"Captured stderr output for the shell call."},"outcome":{"$ref":"#/components/schemas/FunctionShellCallOutputOutcomeParam","description":"The exit or timeout outcome associated with this shell call."}},"type":"object","required":["stdout","stderr","outcome"],"title":"Shell output content","description":"Captured stdout and stderr for a portion of a shell tool call output."},"FunctionShellCallOutputItemParam":{"properties":{"id":{"anyOf":[{"type":"string","description":"The unique ID of the shell tool call output. Populated when this item is returned via API.","example":"sho_123"},{"type":"null"}]},"call_id":{"type":"string","maxLength":64,"minLength":1,"description":"The unique ID of the shell tool call generated by the model."},"type":{"type":"string","enum":["shell_call_output"],"description":"The type of the item. Always `shell_call_output`.","default":"shell_call_output","x-stainless-const":true},"output":{"items":{"$ref":"#/components/schemas/FunctionShellCallOutputContentParam"},"type":"array","description":"Captured chunks of stdout and stderr output, along with their associated outcomes."},"status":{"anyOf":[{"$ref":"#/components/schemas/FunctionShellCallItemStatus","description":"The status of the shell call output."},{"type":"null"}]},"max_output_length":{"anyOf":[{"type":"integer","description":"The maximum number of UTF-8 characters captured for this shell call's combined output."},{"type":"null"}]}},"type":"object","required":["call_id","type","output"],"title":"Shell tool call output","description":"The streamed output items emitted by a shell tool call."},"ApplyPatchCallStatusParam":{"type":"string","enum":["in_progress","completed"],"title":"Apply patch call status","description":"Status values reported for apply_patch tool calls."},"ApplyPatchCreateFileOperationParam":{"properties":{"type":{"type":"string","enum":["create_file"],"description":"The operation type. Always `create_file`.","default":"create_file","x-stainless-const":true},"path":{"type":"string","minLength":1,"description":"Path of the file to create relative to the workspace root."},"diff":{"type":"string","maxLength":10485760,"description":"Unified diff content to apply when creating the file."}},"type":"object","required":["type","path","diff"],"title":"Apply patch create file operation","description":"Instruction for creating a new file via the apply_patch tool."},"ApplyPatchDeleteFileOperationParam":{"properties":{"type":{"type":"string","enum":["delete_file"],"description":"The operation type. Always `delete_file`.","default":"delete_file","x-stainless-const":true},"path":{"type":"string","minLength":1,"description":"Path of the file to delete relative to the workspace root."}},"type":"object","required":["type","path"],"title":"Apply patch delete file operation","description":"Instruction for deleting an existing file via the apply_patch tool."},"ApplyPatchUpdateFileOperationParam":{"properties":{"type":{"type":"string","enum":["update_file"],"description":"The operation type. Always `update_file`.","default":"update_file","x-stainless-const":true},"path":{"type":"string","minLength":1,"description":"Path of the file to update relative to the workspace root."},"diff":{"type":"string","maxLength":10485760,"description":"Unified diff content to apply to the existing file."}},"type":"object","required":["type","path","diff"],"title":"Apply patch update file operation","description":"Instruction for updating an existing file via the apply_patch tool."},"ApplyPatchOperationParam":{"oneOf":[{"$ref":"#/components/schemas/ApplyPatchCreateFileOperationParam"},{"$ref":"#/components/schemas/ApplyPatchDeleteFileOperationParam"},{"$ref":"#/components/schemas/ApplyPatchUpdateFileOperationParam"}],"title":"Apply patch operation","description":"One of the create_file, delete_file, or update_file operations supplied to the apply_patch tool.","discriminator":{"propertyName":"type"}},"ApplyPatchToolCallItemParam":{"properties":{"type":{"type":"string","enum":["apply_patch_call"],"description":"The type of the item. Always `apply_patch_call`.","default":"apply_patch_call","x-stainless-const":true},"id":{"anyOf":[{"type":"string","description":"The unique ID of the apply patch tool call. Populated when this item is returned via API.","example":"apc_123"},{"type":"null"}]},"call_id":{"type":"string","maxLength":64,"minLength":1,"description":"The unique ID of the apply patch tool call generated by the model."},"status":{"$ref":"#/components/schemas/ApplyPatchCallStatusParam","description":"The status of the apply patch tool call. One of `in_progress` or `completed`."},"operation":{"$ref":"#/components/schemas/ApplyPatchOperationParam","description":"The specific create, delete, or update instruction for the apply_patch tool call."}},"type":"object","required":["type","call_id","status","operation"],"title":"Apply patch tool call","description":"A tool call representing a request to create, delete, or update files using diff patches."},"ApplyPatchCallOutputStatusParam":{"type":"string","enum":["completed","failed"],"title":"Apply patch call output status","description":"Outcome values reported for apply_patch tool call outputs."},"ApplyPatchToolCallOutputItemParam":{"properties":{"type":{"type":"string","enum":["apply_patch_call_output"],"description":"The type of the item. Always `apply_patch_call_output`.","default":"apply_patch_call_output","x-stainless-const":true},"id":{"anyOf":[{"type":"string","description":"The unique ID of the apply patch tool call output. Populated when this item is returned via API.","example":"apco_123"},{"type":"null"}]},"call_id":{"type":"string","maxLength":64,"minLength":1,"description":"The unique ID of the apply patch tool call generated by the model."},"status":{"$ref":"#/components/schemas/ApplyPatchCallOutputStatusParam","description":"The status of the apply patch tool call output. One of `completed` or `failed`."},"output":{"anyOf":[{"type":"string","maxLength":10485760,"description":"Optional human-readable log text from the apply patch tool (e.g., patch results or errors)."},{"type":"null"}]}},"type":"object","required":["type","call_id","status"],"title":"Apply patch tool call output","description":"The streamed output emitted by an apply patch tool call."},"ItemReferenceParam":{"properties":{"type":{"anyOf":[{"type":"string","enum":["item_reference"],"description":"The type of item to reference. Always `item_reference`.","default":"item_reference","x-stainless-const":true},{"type":"null"}]},"id":{"type":"string","description":"The ID of the item to reference."}},"type":"object","required":["id"],"title":"Item reference","description":"An internal identifier for an item to reference."},"ConversationResource":{"properties":{"id":{"type":"string","description":"The unique ID of the conversation."},"object":{"type":"string","enum":["conversation"],"description":"The object type, which is always `conversation`.","default":"conversation","x-stainless-const":true},"metadata":{"description":"Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format, and querying for objects via API or the dashboard.\n Keys are strings with a maximum length of 64 characters. Values are strings with a maximum length of 512 characters."},"created_at":{"type":"integer","description":"The time at which the conversation was created, measured in seconds since the Unix epoch."}},"type":"object","required":["id","object","metadata","created_at"]},"ImageGenOutputTokensDetails":{"properties":{"image_tokens":{"type":"integer","description":"The number of image output tokens generated by the model."},"text_tokens":{"type":"integer","description":"The number of text output tokens generated by the model."}},"type":"object","required":["image_tokens","text_tokens"],"title":"Image generation output token details","description":"The output token details for the image generation."},"ImageGenInputUsageDetails":{"properties":{"text_tokens":{"type":"integer","description":"The number of text tokens in the input prompt."},"image_tokens":{"type":"integer","description":"The number of image tokens in the input prompt."}},"type":"object","required":["text_tokens","image_tokens"],"title":"Input usage details","description":"The input tokens detailed information for the image generation."},"ImageGenUsage":{"properties":{"input_tokens":{"type":"integer","description":"The number of tokens (images and text) in the input prompt."},"total_tokens":{"type":"integer","description":"The total number of tokens (images and text) used for the image generation."},"output_tokens":{"type":"integer","description":"The number of output tokens generated by the model."},"output_tokens_details":{"$ref":"#/components/schemas/ImageGenOutputTokensDetails"},"input_tokens_details":{"$ref":"#/components/schemas/ImageGenInputUsageDetails"}},"type":"object","required":["input_tokens","total_tokens","output_tokens","input_tokens_details"],"title":"Image generation usage","description":"For `gpt-image-1` only, the token usage information for the image generation."},"SpecificApplyPatchParam":{"properties":{"type":{"type":"string","enum":["apply_patch"],"description":"The tool to call. Always `apply_patch`.","default":"apply_patch","x-stainless-const":true}},"type":"object","required":["type"],"title":"Specific apply patch tool choice","description":"Forces the model to call the apply_patch tool when executing a tool call."},"SpecificFunctionShellParam":{"properties":{"type":{"type":"string","enum":["shell"],"description":"The tool to call. Always `shell`.","default":"shell","x-stainless-const":true}},"type":"object","required":["type"],"title":"Specific shell tool choice","description":"Forces the model to call the shell tool when a tool call is required."},"ConversationParam-2":{"properties":{"id":{"type":"string","description":"The unique ID of the conversation.","example":"conv_123"}},"type":"object","required":["id"],"title":"Conversation object","description":"The conversation that this response belongs to."},"ContextManagementParam":{"properties":{"type":{"type":"string","description":"The context management entry type. Currently only 'compaction' is supported."},"compact_threshold":{"anyOf":[{"type":"integer","minimum":1000,"description":"Token threshold at which compaction should be triggered for this entry."},{"type":"null"}]}},"type":"object","required":["type"]},"Conversation-2":{"properties":{"id":{"type":"string","description":"The unique ID of the conversation that this response was associated with."}},"type":"object","required":["id"],"title":"Conversation","description":"The conversation that this response belonged to. Input items and output items from this response were automatically added to this conversation."},"CreateConversationBody":{"properties":{"metadata":{"anyOf":[{"$ref":"#/components/schemas/Metadata","description":"Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format, and querying for objects via API or the dashboard.\n Keys are strings with a maximum length of 64 characters. Values are strings with a maximum length of 512 characters."},{"type":"null"}]},"items":{"anyOf":[{"items":{"$ref":"#/components/schemas/InputItem"},"type":"array","maxItems":20,"description":"Initial items to include in the conversation context. You may add up to 20 items at a time."},{"type":"null"}]}},"type":"object","required":[]},"UpdateConversationBody":{"properties":{"metadata":{"$ref":"#/components/schemas/Metadata","description":"Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format, and querying for objects via API or the dashboard.\n Keys are strings with a maximum length of 64 characters. Values are strings with a maximum length of 512 characters."}},"type":"object","required":["metadata"]},"DeletedConversationResource":{"properties":{"object":{"type":"string","enum":["conversation.deleted"],"default":"conversation.deleted","x-stainless-const":true},"deleted":{"type":"boolean"},"id":{"type":"string"}},"type":"object","required":["object","deleted","id"]},"OrderEnum":{"type":"string","enum":["asc","desc"]},"VideoModel":{"anyOf":[{"type":"string"},{"type":"string","enum":["sora-2","sora-2-pro","sora-2-2025-10-06","sora-2-pro-2025-10-06","sora-2-2025-12-08"]}]},"VideoStatus":{"type":"string","enum":["queued","in_progress","completed","failed"]},"VideoSize":{"type":"string","enum":["720x1280","1280x720","1024x1792","1792x1024"]},"Error-2":{"properties":{"code":{"type":"string","description":"A machine-readable error code that was returned."},"message":{"type":"string","description":"A human-readable description of the error that was returned."}},"type":"object","required":["code","message"],"title":"Error","description":"An error that occurred while generating the response."},"VideoResource":{"properties":{"id":{"type":"string","description":"Unique identifier for the video job."},"object":{"type":"string","enum":["video"],"description":"The object type, which is always `video`.","default":"video","x-stainless-const":true},"model":{"$ref":"#/components/schemas/VideoModel","description":"The video generation model that produced the job."},"status":{"$ref":"#/components/schemas/VideoStatus","description":"Current lifecycle status of the video job."},"progress":{"type":"integer","description":"Approximate completion percentage for the generation task."},"created_at":{"type":"integer","description":"Unix timestamp (seconds) for when the job was created."},"completed_at":{"anyOf":[{"type":"integer","description":"Unix timestamp (seconds) for when the job completed, if finished."},{"type":"null"}]},"expires_at":{"anyOf":[{"type":"integer","description":"Unix timestamp (seconds) for when the downloadable assets expire, if set."},{"type":"null"}]},"prompt":{"anyOf":[{"type":"string","description":"The prompt that was used to generate the video."},{"type":"null"}]},"size":{"$ref":"#/components/schemas/VideoSize","description":"The resolution of the generated video."},"seconds":{"type":"string","description":"Duration of the generated clip in seconds. For extensions, this is the stitched total duration."},"remixed_from_video_id":{"anyOf":[{"type":"string","description":"Identifier of the source video if this video is a remix."},{"type":"null"}]},"error":{"anyOf":[{"$ref":"#/components/schemas/Error-2","description":"Error payload that explains why generation failed, if applicable."},{"type":"null"}]}},"type":"object","required":["id","object","model","status","progress","created_at","completed_at","expires_at","prompt","size","seconds","remixed_from_video_id","error"],"title":"Video job","description":"Structured information describing a generated video job."},"VideoListResource":{"properties":{"object":{"type":"string","enum":["list"],"description":"The type of object returned, must be `list`.","default":"list","x-stainless-const":true},"data":{"items":{"$ref":"#/components/schemas/VideoResource"},"type":"array","description":"A list of items"},"first_id":{"anyOf":[{"type":"string","description":"The ID of the first item in the list."},{"type":"null"}]},"last_id":{"anyOf":[{"type":"string","description":"The ID of the last item in the list."},{"type":"null"}]},"has_more":{"type":"boolean","description":"Whether there are more items available."}},"type":"object","required":["object","data","first_id","last_id","has_more"]},"ImageRefParam-2":{"properties":{"image_url":{"type":"string","maxLength":20971520,"description":"A fully qualified URL or base64-encoded data URL."},"file_id":{"type":"string","example":"file-123"}},"type":"object","required":[]},"VideoSeconds":{"type":"string","enum":["4","8","12"]},"CreateVideoMultipartBody":{"properties":{"model":{"$ref":"#/components/schemas/VideoModel","description":"The video generation model to use (allowed values: sora-2, sora-2-pro). Defaults to `sora-2`."},"prompt":{"type":"string","maxLength":32000,"minLength":1,"description":"Text prompt that describes the video to generate."},"input_reference":{"oneOf":[{"type":"string","format":"binary","description":"Optional reference asset upload or reference object that guides generation."},{"$ref":"#/components/schemas/ImageRefParam-2"}]},"seconds":{"$ref":"#/components/schemas/VideoSeconds","description":"Clip duration in seconds (allowed values: 4, 8, 12). Defaults to 4 seconds."},"size":{"$ref":"#/components/schemas/VideoSize","description":"Output resolution formatted as width x height (allowed values: 720x1280, 1280x720, 1024x1792, 1792x1024). Defaults to 720x1280."}},"type":"object","required":["prompt"],"title":"Create video multipart request","description":"Multipart parameters for creating a new video generation job."},"CreateVideoJsonBody":{"properties":{"model":{"$ref":"#/components/schemas/VideoModel","description":"The video generation model to use (allowed values: sora-2, sora-2-pro). Defaults to `sora-2`."},"prompt":{"type":"string","maxLength":32000,"minLength":1,"description":"Text prompt that describes the video to generate."},"input_reference":{"$ref":"#/components/schemas/ImageRefParam-2","description":"Optional reference object that guides generation. Provide exactly one of `image_url` or `file_id`."},"seconds":{"$ref":"#/components/schemas/VideoSeconds","description":"Clip duration in seconds (allowed values: 4, 8, 12). Defaults to 4 seconds."},"size":{"$ref":"#/components/schemas/VideoSize","description":"Output resolution formatted as width x height (allowed values: 720x1280, 1280x720, 1024x1792, 1792x1024). Defaults to 720x1280."}},"type":"object","required":["prompt"],"title":"Create video JSON request","description":"JSON parameters for creating a new video generation job."},"CreateVideoCharacterBody":{"properties":{"video":{"type":"string","format":"binary","description":"Video file used to create a character."},"name":{"type":"string","maxLength":80,"minLength":1,"description":"Display name for this API character."}},"type":"object","required":["video","name"],"title":"Create character request","description":"Parameters for creating a character from an uploaded video."},"VideoCharacterResource":{"properties":{"id":{"anyOf":[{"type":"string","description":"Identifier for the character creation cameo."},{"type":"null"}]},"name":{"anyOf":[{"type":"string","description":"Display name for the character."},{"type":"null"}]},"created_at":{"type":"integer","description":"Unix timestamp (in seconds) when the character was created."}},"type":"object","required":["id","name","created_at"]},"VideoReferenceInputParam":{"properties":{"id":{"type":"string","description":"The identifier of the completed video.","example":"video_123"}},"type":"object","required":["id"],"description":"Reference to the completed video."},"CreateVideoEditMultipartBody":{"properties":{"video":{"oneOf":[{"type":"string","format":"binary","description":"Reference to the completed video to edit."},{"$ref":"#/components/schemas/VideoReferenceInputParam"}]},"prompt":{"type":"string","maxLength":32000,"minLength":1,"description":"Text prompt that describes how to edit the source video."}},"type":"object","required":["video","prompt"],"title":"Create video edit multipart request","description":"Parameters for editing an existing generated video."},"CreateVideoEditJsonBody":{"properties":{"video":{"$ref":"#/components/schemas/VideoReferenceInputParam","description":"Reference to the completed video to edit."},"prompt":{"type":"string","maxLength":32000,"minLength":1,"description":"Text prompt that describes how to edit the source video."}},"type":"object","required":["video","prompt"],"title":"Create video edit JSON request","description":"JSON parameters for editing an existing generated video."},"CreateVideoExtendMultipartBody":{"properties":{"video":{"oneOf":[{"$ref":"#/components/schemas/VideoReferenceInputParam"},{"type":"string","format":"binary","description":"Reference to the completed video to extend."}]},"prompt":{"type":"string","maxLength":32000,"minLength":1,"description":"Updated text prompt that directs the extension generation."},"seconds":{"$ref":"#/components/schemas/VideoSeconds","description":"Length of the newly generated extension segment in seconds (allowed values: 4, 8, 12, 16, 20)."}},"type":"object","required":["video","prompt","seconds"],"title":"Create video extension multipart request","description":"Multipart parameters for extending an existing generated video."},"CreateVideoExtendJsonBody":{"properties":{"video":{"$ref":"#/components/schemas/VideoReferenceInputParam","description":"Reference to the completed video to extend."},"prompt":{"type":"string","maxLength":32000,"minLength":1,"description":"Updated text prompt that directs the extension generation."},"seconds":{"$ref":"#/components/schemas/VideoSeconds","description":"Length of the newly generated extension segment in seconds (allowed values: 4, 8, 12, 16, 20)."}},"type":"object","required":["video","prompt","seconds"],"title":"Create video extension JSON request","description":"JSON parameters for extending an existing generated video."},"DeletedVideoResource":{"properties":{"object":{"type":"string","enum":["video.deleted"],"description":"The object type that signals the deletion response.","default":"video.deleted","x-stainless-const":true},"deleted":{"type":"boolean","description":"Indicates that the video resource was deleted."},"id":{"type":"string","description":"Identifier of the deleted video."}},"type":"object","required":["object","deleted","id"],"title":"Deleted video response","description":"Confirmation payload returned after deleting a video."},"VideoContentVariant":{"type":"string","enum":["video","thumbnail","spritesheet"]},"CreateVideoRemixBody":{"properties":{"prompt":{"type":"string","maxLength":32000,"minLength":1,"description":"Updated text prompt that directs the remix generation."}},"type":"object","required":["prompt"],"title":"Create video remix request","description":"Parameters for remixing an existing generated video."},"TruncationEnum":{"type":"string","enum":["auto","disabled"]},"TokenCountsBody":{"properties":{"model":{"anyOf":[{"type":"string","description":"Model ID used to generate the response, like `gpt-4o` or `o3`. OpenAI offers a wide range of models with different capabilities, performance characteristics, and price points. Refer to the [model guide](/docs/models) to browse and compare available models."},{"type":"null"}]},"input":{"anyOf":[{"oneOf":[{"type":"string","maxLength":10485760,"description":"A text input to the model, equivalent to a text input with the `user` role."},{"items":{"$ref":"#/components/schemas/InputItem"},"type":"array","description":"A list of one or many input items to the model, containing different content types."}],"description":"Text, image, or file inputs to the model, used to generate a response"},{"type":"null"}]},"previous_response_id":{"anyOf":[{"type":"string","description":"The unique ID of the previous response to the model. Use this to create multi-turn conversations. Learn more about [conversation state](/docs/guides/conversation-state). Cannot be used in conjunction with `conversation`.","example":"resp_123"},{"type":"null"}]},"tools":{"anyOf":[{"items":{"$ref":"#/components/schemas/Tool"},"type":"array","description":"An array of tools the model may call while generating a response. You can specify which tool to use by setting the `tool_choice` parameter."},{"type":"null"}]},"text":{"anyOf":[{"$ref":"#/components/schemas/ResponseTextParam"},{"type":"null"}]},"reasoning":{"anyOf":[{"$ref":"#/components/schemas/Reasoning","description":"**gpt-5 and o-series models only** Configuration options for [reasoning models](https://platform.openai.com/docs/guides/reasoning)."},{"type":"null"}]},"truncation":{"$ref":"#/components/schemas/TruncationEnum","description":"The truncation strategy to use for the model response. - `auto`: If the input to this Response exceeds the model's context window size, the model will truncate the response to fit the context window by dropping items from the beginning of the conversation. - `disabled` (default): If the input size will exceed the context window size for a model, the request will fail with a 400 error."},"instructions":{"anyOf":[{"type":"string","description":"A system (or developer) message inserted into the model's context.\nWhen used along with `previous_response_id`, the instructions from a previous response will not be carried over to the next response. This makes it simple to swap out system (or developer) messages in new responses."},{"type":"null"}]},"conversation":{"anyOf":[{"$ref":"#/components/schemas/ConversationParam"},{"type":"null"}]},"tool_choice":{"anyOf":[{"$ref":"#/components/schemas/ToolChoiceParam","description":"Controls which tool the model should use, if any."},{"type":"null"}]},"parallel_tool_calls":{"anyOf":[{"type":"boolean","description":"Whether to allow the model to run tool calls in parallel."},{"type":"null"}]}},"type":"object","required":[]},"TokenCountsResource":{"properties":{"object":{"type":"string","enum":["response.input_tokens"],"default":"response.input_tokens","x-stainless-const":true},"input_tokens":{"type":"integer"}},"type":"object","required":["object","input_tokens"],"title":"Token counts","example":{"object":"response.input_tokens","input_tokens":123}},"PromptCacheRetentionEnum":{"type":"string","enum":["in_memory","24h"]},"CompactResponseMethodPublicBody":{"properties":{"model":{"$ref":"#/components/schemas/ModelIdsCompaction"},"input":{"anyOf":[{"oneOf":[{"type":"string","maxLength":10485760,"description":"A text input to the model, equivalent to a text input with the `user` role."},{"items":{"$ref":"#/components/schemas/InputItem"},"type":"array","description":"A list of one or many input items to the model, containing different content types."}],"description":"Text, image, or file inputs to the model, used to generate a response"},{"type":"null"}]},"previous_response_id":{"anyOf":[{"type":"string","description":"The unique ID of the previous response to the model. Use this to create multi-turn conversations. Learn more about [conversation state](/docs/guides/conversation-state). Cannot be used in conjunction with `conversation`.","example":"resp_123"},{"type":"null"}]},"instructions":{"anyOf":[{"type":"string","description":"A system (or developer) message inserted into the model's context.\nWhen used along with `previous_response_id`, the instructions from a previous response will not be carried over to the next response. This makes it simple to swap out system (or developer) messages in new responses."},{"type":"null"}]},"prompt_cache_key":{"anyOf":[{"type":"string","maxLength":64,"description":"A key to use when reading from or writing to the prompt cache."},{"type":"null"}]},"prompt_cache_retention":{"anyOf":[{"$ref":"#/components/schemas/PromptCacheRetentionEnum","description":"How long to retain a prompt cache entry created by this request."},{"type":"null"}]}},"type":"object","required":["model"]},"ItemField":{"oneOf":[{"$ref":"#/components/schemas/Message"},{"$ref":"#/components/schemas/FunctionToolCall"},{"$ref":"#/components/schemas/ToolSearchCall"},{"$ref":"#/components/schemas/ToolSearchOutput"},{"$ref":"#/components/schemas/FunctionToolCallOutput"},{"$ref":"#/components/schemas/FileSearchToolCall"},{"$ref":"#/components/schemas/WebSearchToolCall"},{"$ref":"#/components/schemas/ImageGenToolCall"},{"$ref":"#/components/schemas/ComputerToolCall"},{"$ref":"#/components/schemas/ComputerToolCallOutputResource"},{"$ref":"#/components/schemas/ReasoningItem"},{"$ref":"#/components/schemas/CompactionBody"},{"$ref":"#/components/schemas/CodeInterpreterToolCall"},{"$ref":"#/components/schemas/LocalShellToolCall","deprecated":true},{"$ref":"#/components/schemas/LocalShellToolCallOutput","deprecated":true},{"$ref":"#/components/schemas/FunctionShellCall"},{"$ref":"#/components/schemas/FunctionShellCallOutput"},{"$ref":"#/components/schemas/ApplyPatchToolCall"},{"$ref":"#/components/schemas/ApplyPatchToolCallOutput"},{"$ref":"#/components/schemas/MCPListTools"},{"$ref":"#/components/schemas/MCPApprovalRequest"},{"$ref":"#/components/schemas/MCPApprovalResponseResource"},{"$ref":"#/components/schemas/MCPToolCall"},{"$ref":"#/components/schemas/CustomToolCall"},{"$ref":"#/components/schemas/CustomToolCallOutput"}],"description":"An item representing a message, tool call, tool output, reasoning, or other response element.","discriminator":{"propertyName":"type"}},"CompactResource":{"properties":{"id":{"type":"string","description":"The unique identifier for the compacted response."},"object":{"type":"string","enum":["response.compaction"],"description":"The object type. Always `response.compaction`.","default":"response.compaction","x-stainless-const":true},"output":{"items":{"$ref":"#/components/schemas/ItemField"},"type":"array","description":"The compacted list of output items."},"created_at":{"type":"integer","description":"Unix timestamp (in seconds) when the compacted conversation was created."},"usage":{"$ref":"#/components/schemas/ResponseUsage","description":"Token accounting for the compaction pass, including cached, reasoning, and total tokens."}},"type":"object","required":["id","object","output","created_at","usage"],"title":"The compacted response object","example":{"id":"resp_001","object":"response.compaction","output":[{"type":"message","role":"user","content":[{"type":"input_text","text":"Summarize our launch checklist from last week."}]},{"type":"message","role":"user","content":[{"type":"input_text","text":"You are performing a CONTEXT CHECKPOINT COMPACTION..."}]},{"type":"compaction","id":"cmp_001","encrypted_content":"encrypted-summary"}],"created_at":1731459200,"usage":{"input_tokens":42897,"output_tokens":12000,"total_tokens":54912}}},"SkillResource":{"properties":{"id":{"type":"string","description":"Unique identifier for the skill."},"object":{"type":"string","enum":["skill"],"description":"The object type, which is `skill`.","default":"skill","x-stainless-const":true},"name":{"type":"string","description":"Name of the skill."},"description":{"type":"string","description":"Description of the skill."},"created_at":{"type":"integer","description":"Unix timestamp (seconds) for when the skill was created."},"default_version":{"type":"string","description":"Default version for the skill."},"latest_version":{"type":"string","description":"Latest version for the skill."}},"type":"object","required":["id","object","name","description","created_at","default_version","latest_version"]},"SkillListResource":{"properties":{"object":{"type":"string","enum":["list"],"description":"The type of object returned, must be `list`.","default":"list","x-stainless-const":true},"data":{"items":{"$ref":"#/components/schemas/SkillResource"},"type":"array","description":"A list of items"},"first_id":{"anyOf":[{"type":"string","description":"The ID of the first item in the list."},{"type":"null"}]},"last_id":{"anyOf":[{"type":"string","description":"The ID of the last item in the list."},{"type":"null"}]},"has_more":{"type":"boolean","description":"Whether there are more items available."}},"type":"object","required":["object","data","first_id","last_id","has_more"]},"CreateSkillBody":{"properties":{"files":{"oneOf":[{"items":{"type":"string","format":"binary"},"type":"array","maxItems":500,"description":"Skill files to upload (directory upload) or a single zip file."},{"type":"string","format":"binary","description":"Skill zip file to upload."}]}},"type":"object","required":["files"],"title":"Create skill request","description":"Uploads a skill either as a directory (multipart `files[]`) or as a single zip file."},"SetDefaultSkillVersionBody":{"properties":{"default_version":{"type":"string","description":"The skill version number to set as default."}},"type":"object","required":["default_version"],"title":"Update skill request","description":"Updates the default version pointer for a skill."},"DeletedSkillResource":{"properties":{"object":{"type":"string","enum":["skill.deleted"],"default":"skill.deleted","x-stainless-const":true},"deleted":{"type":"boolean"},"id":{"type":"string"}},"type":"object","required":["object","deleted","id"]},"SkillVersionResource":{"properties":{"object":{"type":"string","enum":["skill.version"],"description":"The object type, which is `skill.version`.","default":"skill.version","x-stainless-const":true},"id":{"type":"string","description":"Unique identifier for the skill version."},"skill_id":{"type":"string","description":"Identifier of the skill for this version."},"version":{"type":"string","description":"Version number for this skill."},"created_at":{"type":"integer","description":"Unix timestamp (seconds) for when the version was created."},"name":{"type":"string","description":"Name of the skill version."},"description":{"type":"string","description":"Description of the skill version."}},"type":"object","required":["object","id","skill_id","version","created_at","name","description"]},"SkillVersionListResource":{"properties":{"object":{"type":"string","enum":["list"],"description":"The type of object returned, must be `list`.","default":"list","x-stainless-const":true},"data":{"items":{"$ref":"#/components/schemas/SkillVersionResource"},"type":"array","description":"A list of items"},"first_id":{"anyOf":[{"type":"string","description":"The ID of the first item in the list."},{"type":"null"}]},"last_id":{"anyOf":[{"type":"string","description":"The ID of the last item in the list."},{"type":"null"}]},"has_more":{"type":"boolean","description":"Whether there are more items available."}},"type":"object","required":["object","data","first_id","last_id","has_more"]},"CreateSkillVersionBody":{"properties":{"files":{"oneOf":[{"items":{"type":"string","format":"binary"},"type":"array","maxItems":500,"description":"Skill files to upload (directory upload) or a single zip file."},{"type":"string","format":"binary","description":"Skill zip file to upload."}]},"default":{"type":"boolean","description":"Whether to set this version as the default."}},"type":"object","required":["files"],"title":"Create skill version request","description":"Uploads a new immutable version of a skill."},"DeletedSkillVersionResource":{"properties":{"object":{"type":"string","enum":["skill.version.deleted"],"default":"skill.version.deleted","x-stainless-const":true},"deleted":{"type":"boolean"},"id":{"type":"string"},"version":{"type":"string","description":"The deleted skill version."}},"type":"object","required":["object","deleted","id","version"]},"ChatkitWorkflowTracing":{"properties":{"enabled":{"type":"boolean","description":"Indicates whether tracing is enabled."}},"type":"object","required":["enabled"],"title":"Tracing Configuration","description":"Controls diagnostic tracing during the session."},"ChatkitWorkflow":{"properties":{"id":{"type":"string","description":"Identifier of the workflow backing the session."},"version":{"anyOf":[{"type":"string","description":"Specific workflow version used for the session. Defaults to null when using the latest deployment."},{"type":"null"}]},"state_variables":{"anyOf":[{"additionalProperties":{"oneOf":[{"type":"string"},{"type":"integer"},{"type":"boolean"},{"type":"number"}]},"type":"object","description":"State variable key-value pairs applied when invoking the workflow. Defaults to null when no overrides were provided.","x-oaiTypeLabel":"map"},{"type":"null"}]},"tracing":{"$ref":"#/components/schemas/ChatkitWorkflowTracing","description":"Tracing settings applied to the workflow."}},"type":"object","required":["id","version","state_variables","tracing"],"title":"Workflow","description":"Workflow metadata and state returned for the session."},"ChatSessionRateLimits":{"properties":{"max_requests_per_1_minute":{"type":"integer","description":"Maximum allowed requests per one-minute window."}},"type":"object","required":["max_requests_per_1_minute"],"title":"Rate limits","description":"Active per-minute request limit for the session."},"ChatSessionStatus":{"type":"string","enum":["active","expired","cancelled"]},"ChatSessionAutomaticThreadTitling":{"properties":{"enabled":{"type":"boolean","description":"Whether automatic thread titling is enabled."}},"type":"object","required":["enabled"],"title":"Automatic thread titling","description":"Automatic thread title preferences for the session."},"ChatSessionFileUpload":{"properties":{"enabled":{"type":"boolean","description":"Indicates if uploads are enabled for the session."},"max_file_size":{"anyOf":[{"type":"integer","description":"Maximum upload size in megabytes."},{"type":"null"}]},"max_files":{"anyOf":[{"type":"integer","description":"Maximum number of uploads allowed during the session."},{"type":"null"}]}},"type":"object","required":["enabled","max_file_size","max_files"],"title":"File upload settings","description":"Upload permissions and limits applied to the session."},"ChatSessionHistory":{"properties":{"enabled":{"type":"boolean","description":"Indicates if chat history is persisted for the session."},"recent_threads":{"anyOf":[{"type":"integer","description":"Number of prior threads surfaced in history views. Defaults to null when all history is retained."},{"type":"null"}]}},"type":"object","required":["enabled","recent_threads"],"title":"History settings","description":"History retention preferences returned for the session."},"ChatSessionChatkitConfiguration":{"properties":{"automatic_thread_titling":{"$ref":"#/components/schemas/ChatSessionAutomaticThreadTitling","description":"Automatic thread titling preferences."},"file_upload":{"$ref":"#/components/schemas/ChatSessionFileUpload","description":"Upload settings for the session."},"history":{"$ref":"#/components/schemas/ChatSessionHistory","description":"History retention configuration."}},"type":"object","required":["automatic_thread_titling","file_upload","history"],"title":"ChatKit configuration","description":"ChatKit configuration for the session."},"ChatSessionResource":{"properties":{"id":{"type":"string","description":"Identifier for the ChatKit session."},"object":{"type":"string","enum":["chatkit.session"],"description":"Type discriminator that is always `chatkit.session`.","default":"chatkit.session","x-stainless-const":true},"expires_at":{"type":"integer","description":"Unix timestamp (in seconds) for when the session expires."},"client_secret":{"type":"string","description":"Ephemeral client secret that authenticates session requests."},"workflow":{"$ref":"#/components/schemas/ChatkitWorkflow","description":"Workflow metadata for the session."},"user":{"type":"string","description":"User identifier associated with the session."},"rate_limits":{"$ref":"#/components/schemas/ChatSessionRateLimits","description":"Resolved rate limit values."},"max_requests_per_1_minute":{"type":"integer","description":"Convenience copy of the per-minute request limit."},"status":{"$ref":"#/components/schemas/ChatSessionStatus","description":"Current lifecycle state of the session."},"chatkit_configuration":{"$ref":"#/components/schemas/ChatSessionChatkitConfiguration","description":"Resolved ChatKit feature configuration for the session."}},"type":"object","required":["id","object","expires_at","client_secret","workflow","user","rate_limits","max_requests_per_1_minute","status","chatkit_configuration"],"title":"The chat session object","description":"Represents a ChatKit session and its resolved configuration.","example":{"id":"cksess_123","object":"chatkit.session","client_secret":"ek_token_123","expires_at":1712349876,"workflow":{"id":"workflow_alpha","version":"2024-10-01T00:00:00.000Z"},"user":"user_789","rate_limits":{"max_requests_per_1_minute":60},"max_requests_per_1_minute":60,"status":"cancelled","chatkit_configuration":{"automatic_thread_titling":{"enabled":true},"file_upload":{"enabled":true,"max_file_size":16,"max_files":20},"history":{"enabled":true,"recent_threads":10}}}},"WorkflowTracingParam":{"properties":{"enabled":{"type":"boolean","description":"Whether tracing is enabled during the session. Defaults to true."}},"type":"object","required":[],"title":"Tracing Configuration","description":"Controls diagnostic tracing during the session."},"WorkflowParam":{"properties":{"id":{"type":"string","description":"Identifier for the workflow invoked by the session."},"version":{"type":"string","description":"Specific workflow version to run. Defaults to the latest deployed version."},"state_variables":{"additionalProperties":{"oneOf":[{"type":"string","maxLength":10485760},{"type":"integer"},{"type":"boolean"},{"type":"number"}]},"type":"object","maxProperties":64,"description":"State variables forwarded to the workflow. Keys may be up to 64 characters, values must be primitive types, and the map defaults to an empty object.","x-oaiTypeLabel":"map"},"tracing":{"$ref":"#/components/schemas/WorkflowTracingParam","description":"Optional tracing overrides for the workflow invocation. When omitted, tracing is enabled by default."}},"type":"object","required":["id"],"title":"Workflow settings","description":"Workflow reference and overrides applied to the chat session."},"ExpiresAfterParam":{"properties":{"anchor":{"type":"string","enum":["created_at"],"description":"Base timestamp used to calculate expiration. Currently fixed to `created_at`.","default":"created_at","x-stainless-const":true},"seconds":{"type":"integer","maximum":600,"minimum":1,"description":"Number of seconds after the anchor when the session expires."}},"type":"object","required":["anchor","seconds"],"title":"Expiration overrides","description":"Controls when the session expires relative to an anchor timestamp."},"RateLimitsParam":{"properties":{"max_requests_per_1_minute":{"type":"integer","minimum":1,"description":"Maximum number of requests allowed per minute for the session. Defaults to 10."}},"type":"object","required":[],"title":"Rate limit overrides","description":"Controls request rate limits for the session."},"AutomaticThreadTitlingParam":{"properties":{"enabled":{"type":"boolean","description":"Enable automatic thread title generation. Defaults to true."}},"type":"object","required":[],"title":"Automatic thread titling configuration","description":"Controls whether ChatKit automatically generates thread titles."},"FileUploadParam":{"properties":{"enabled":{"type":"boolean","description":"Enable uploads for this session. Defaults to false."},"max_file_size":{"type":"integer","maximum":512,"minimum":1,"description":"Maximum size in megabytes for each uploaded file. Defaults to 512 MB, which is the maximum allowable size."},"max_files":{"type":"integer","minimum":1,"description":"Maximum number of files that can be uploaded to the session. Defaults to 10."}},"type":"object","required":[],"title":"File upload configuration","description":"Controls whether users can upload files."},"HistoryParam":{"properties":{"enabled":{"type":"boolean","description":"Enables chat users to access previous ChatKit threads. Defaults to true."},"recent_threads":{"type":"integer","minimum":1,"description":"Number of recent ChatKit threads users have access to. Defaults to unlimited when unset."}},"type":"object","required":[],"title":"Chat history configuration","description":"Controls how much historical context is retained for the session."},"ChatkitConfigurationParam":{"properties":{"automatic_thread_titling":{"$ref":"#/components/schemas/AutomaticThreadTitlingParam","description":"Configuration for automatic thread titling. When omitted, automatic thread titling is enabled by default."},"file_upload":{"$ref":"#/components/schemas/FileUploadParam","description":"Configuration for upload enablement and limits. When omitted, uploads are disabled by default (max_files 10, max_file_size 512 MB)."},"history":{"$ref":"#/components/schemas/HistoryParam","description":"Configuration for chat history retention. When omitted, history is enabled by default with no limit on recent_threads (null)."}},"type":"object","required":[],"title":"ChatKit configuration overrides","description":"Optional per-session configuration settings for ChatKit behavior."},"CreateChatSessionBody":{"properties":{"workflow":{"$ref":"#/components/schemas/WorkflowParam","description":"Workflow that powers the session."},"user":{"type":"string","minLength":1,"description":"A free-form string that identifies your end user; ensures this Session can access other objects that have the same `user` scope."},"expires_after":{"$ref":"#/components/schemas/ExpiresAfterParam","description":"Optional override for session expiration timing in seconds from creation. Defaults to 10 minutes."},"rate_limits":{"$ref":"#/components/schemas/RateLimitsParam","description":"Optional override for per-minute request limits. When omitted, defaults to 10."},"chatkit_configuration":{"$ref":"#/components/schemas/ChatkitConfigurationParam","description":"Optional overrides for ChatKit runtime configuration features"}},"type":"object","required":["workflow","user"],"title":"Create chat session request","description":"Parameters for provisioning a new ChatKit session."},"UserMessageInputText":{"properties":{"type":{"type":"string","enum":["input_text"],"description":"Type discriminator that is always `input_text`.","default":"input_text","x-stainless-const":true},"text":{"type":"string","description":"Plain-text content supplied by the user."}},"type":"object","required":["type","text"],"title":"User message input","description":"Text block that a user contributed to the thread."},"UserMessageQuotedText":{"properties":{"type":{"type":"string","enum":["quoted_text"],"description":"Type discriminator that is always `quoted_text`.","default":"quoted_text","x-stainless-const":true},"text":{"type":"string","description":"Quoted text content."}},"type":"object","required":["type","text"],"title":"User message quoted text","description":"Quoted snippet that the user referenced in their message."},"AttachmentType":{"type":"string","enum":["image","file"]},"Attachment":{"properties":{"type":{"$ref":"#/components/schemas/AttachmentType","description":"Attachment discriminator."},"id":{"type":"string","description":"Identifier for the attachment."},"name":{"type":"string","description":"Original display name for the attachment."},"mime_type":{"type":"string","description":"MIME type of the attachment."},"preview_url":{"anyOf":[{"type":"string","description":"Preview URL for rendering the attachment inline."},{"type":"null"}]}},"type":"object","required":["type","id","name","mime_type","preview_url"],"title":"Attachment","description":"Attachment metadata included on thread items."},"ToolChoice":{"properties":{"id":{"type":"string","description":"Identifier of the requested tool."}},"type":"object","required":["id"],"title":"Tool choice","description":"Tool selection that the assistant should honor when executing the item."},"InferenceOptions":{"properties":{"tool_choice":{"anyOf":[{"$ref":"#/components/schemas/ToolChoice","description":"Preferred tool to invoke. Defaults to null when ChatKit should auto-select."},{"type":"null"}]},"model":{"anyOf":[{"type":"string","description":"Model name that generated the response. Defaults to null when using the session default."},{"type":"null"}]}},"type":"object","required":["tool_choice","model"],"title":"Inference options","description":"Model and tool overrides applied when generating the assistant response."},"UserMessageItem":{"properties":{"id":{"type":"string","description":"Identifier of the thread item."},"object":{"type":"string","enum":["chatkit.thread_item"],"description":"Type discriminator that is always `chatkit.thread_item`.","default":"chatkit.thread_item","x-stainless-const":true},"created_at":{"type":"integer","description":"Unix timestamp (in seconds) for when the item was created."},"thread_id":{"type":"string","description":"Identifier of the parent thread."},"type":{"type":"string","enum":["chatkit.user_message"],"default":"chatkit.user_message","x-stainless-const":true},"content":{"items":{"oneOf":[{"$ref":"#/components/schemas/UserMessageInputText"},{"$ref":"#/components/schemas/UserMessageQuotedText"}],"description":"Content blocks that comprise a user message.","discriminator":{"propertyName":"type"}},"type":"array","description":"Ordered content elements supplied by the user."},"attachments":{"items":{"$ref":"#/components/schemas/Attachment"},"type":"array","description":"Attachments associated with the user message. Defaults to an empty list."},"inference_options":{"anyOf":[{"$ref":"#/components/schemas/InferenceOptions","description":"Inference overrides applied to the message. Defaults to null when unset."},{"type":"null"}]}},"type":"object","required":["id","object","created_at","thread_id","type","content","attachments","inference_options"],"title":"User Message Item","description":"User-authored messages within a thread."},"FileAnnotationSource":{"properties":{"type":{"type":"string","enum":["file"],"description":"Type discriminator that is always `file`.","default":"file","x-stainless-const":true},"filename":{"type":"string","description":"Filename referenced by the annotation."}},"type":"object","required":["type","filename"],"title":"File annotation source","description":"Attachment source referenced by an annotation."},"FileAnnotation":{"properties":{"type":{"type":"string","enum":["file"],"description":"Type discriminator that is always `file` for this annotation.","default":"file","x-stainless-const":true},"source":{"$ref":"#/components/schemas/FileAnnotationSource","description":"File attachment referenced by the annotation."}},"type":"object","required":["type","source"],"title":"File annotation","description":"Annotation that references an uploaded file."},"UrlAnnotationSource":{"properties":{"type":{"type":"string","enum":["url"],"description":"Type discriminator that is always `url`.","default":"url","x-stainless-const":true},"url":{"type":"string","description":"URL referenced by the annotation."}},"type":"object","required":["type","url"],"title":"URL annotation source","description":"URL backing an annotation entry."},"UrlAnnotation":{"properties":{"type":{"type":"string","enum":["url"],"description":"Type discriminator that is always `url` for this annotation.","default":"url","x-stainless-const":true},"source":{"$ref":"#/components/schemas/UrlAnnotationSource","description":"URL referenced by the annotation."}},"type":"object","required":["type","source"],"title":"URL annotation","description":"Annotation that references a URL."},"ResponseOutputText":{"properties":{"type":{"type":"string","enum":["output_text"],"description":"Type discriminator that is always `output_text`.","default":"output_text","x-stainless-const":true},"text":{"type":"string","description":"Assistant generated text."},"annotations":{"items":{"oneOf":[{"$ref":"#/components/schemas/FileAnnotation"},{"$ref":"#/components/schemas/UrlAnnotation"}],"description":"Annotation object describing a cited source.","discriminator":{"propertyName":"type"}},"type":"array","description":"Ordered list of annotations attached to the response text."}},"type":"object","required":["type","text","annotations"],"title":"Assistant message content","description":"Assistant response text accompanied by optional annotations."},"AssistantMessageItem":{"properties":{"id":{"type":"string","description":"Identifier of the thread item."},"object":{"type":"string","enum":["chatkit.thread_item"],"description":"Type discriminator that is always `chatkit.thread_item`.","default":"chatkit.thread_item","x-stainless-const":true},"created_at":{"type":"integer","description":"Unix timestamp (in seconds) for when the item was created."},"thread_id":{"type":"string","description":"Identifier of the parent thread."},"type":{"type":"string","enum":["chatkit.assistant_message"],"description":"Type discriminator that is always `chatkit.assistant_message`.","default":"chatkit.assistant_message","x-stainless-const":true},"content":{"items":{"$ref":"#/components/schemas/ResponseOutputText"},"type":"array","description":"Ordered assistant response segments."}},"type":"object","required":["id","object","created_at","thread_id","type","content"],"title":"Assistant message","description":"Assistant-authored message within a thread."},"WidgetMessageItem":{"properties":{"id":{"type":"string","description":"Identifier of the thread item."},"object":{"type":"string","enum":["chatkit.thread_item"],"description":"Type discriminator that is always `chatkit.thread_item`.","default":"chatkit.thread_item","x-stainless-const":true},"created_at":{"type":"integer","description":"Unix timestamp (in seconds) for when the item was created."},"thread_id":{"type":"string","description":"Identifier of the parent thread."},"type":{"type":"string","enum":["chatkit.widget"],"description":"Type discriminator that is always `chatkit.widget`.","default":"chatkit.widget","x-stainless-const":true},"widget":{"type":"string","description":"Serialized widget payload rendered in the UI."}},"type":"object","required":["id","object","created_at","thread_id","type","widget"],"title":"Widget message","description":"Thread item that renders a widget payload."},"ClientToolCallStatus":{"type":"string","enum":["in_progress","completed"]},"ClientToolCallItem":{"properties":{"id":{"type":"string","description":"Identifier of the thread item."},"object":{"type":"string","enum":["chatkit.thread_item"],"description":"Type discriminator that is always `chatkit.thread_item`.","default":"chatkit.thread_item","x-stainless-const":true},"created_at":{"type":"integer","description":"Unix timestamp (in seconds) for when the item was created."},"thread_id":{"type":"string","description":"Identifier of the parent thread."},"type":{"type":"string","enum":["chatkit.client_tool_call"],"description":"Type discriminator that is always `chatkit.client_tool_call`.","default":"chatkit.client_tool_call","x-stainless-const":true},"status":{"$ref":"#/components/schemas/ClientToolCallStatus","description":"Execution status for the tool call."},"call_id":{"type":"string","description":"Identifier for the client tool call."},"name":{"type":"string","description":"Tool name that was invoked."},"arguments":{"type":"string","description":"JSON-encoded arguments that were sent to the tool."},"output":{"anyOf":[{"type":"string","description":"JSON-encoded output captured from the tool. Defaults to null while execution is in progress."},{"type":"null"}]}},"type":"object","required":["id","object","created_at","thread_id","type","status","call_id","name","arguments","output"],"title":"Client tool call","description":"Record of a client side tool invocation initiated by the assistant."},"TaskType":{"type":"string","enum":["custom","thought"]},"TaskItem":{"properties":{"id":{"type":"string","description":"Identifier of the thread item."},"object":{"type":"string","enum":["chatkit.thread_item"],"description":"Type discriminator that is always `chatkit.thread_item`.","default":"chatkit.thread_item","x-stainless-const":true},"created_at":{"type":"integer","description":"Unix timestamp (in seconds) for when the item was created."},"thread_id":{"type":"string","description":"Identifier of the parent thread."},"type":{"type":"string","enum":["chatkit.task"],"description":"Type discriminator that is always `chatkit.task`.","default":"chatkit.task","x-stainless-const":true},"task_type":{"$ref":"#/components/schemas/TaskType","description":"Subtype for the task."},"heading":{"anyOf":[{"type":"string","description":"Optional heading for the task. Defaults to null when not provided."},{"type":"null"}]},"summary":{"anyOf":[{"type":"string","description":"Optional summary that describes the task. Defaults to null when omitted."},{"type":"null"}]}},"type":"object","required":["id","object","created_at","thread_id","type","task_type","heading","summary"],"title":"Task item","description":"Task emitted by the workflow to show progress and status updates."},"TaskGroupTask":{"properties":{"type":{"$ref":"#/components/schemas/TaskType","description":"Subtype for the grouped task."},"heading":{"anyOf":[{"type":"string","description":"Optional heading for the grouped task. Defaults to null when not provided."},{"type":"null"}]},"summary":{"anyOf":[{"type":"string","description":"Optional summary that describes the grouped task. Defaults to null when omitted."},{"type":"null"}]}},"type":"object","required":["type","heading","summary"],"title":"Task group task","description":"Task entry that appears within a TaskGroup."},"TaskGroupItem":{"properties":{"id":{"type":"string","description":"Identifier of the thread item."},"object":{"type":"string","enum":["chatkit.thread_item"],"description":"Type discriminator that is always `chatkit.thread_item`.","default":"chatkit.thread_item","x-stainless-const":true},"created_at":{"type":"integer","description":"Unix timestamp (in seconds) for when the item was created."},"thread_id":{"type":"string","description":"Identifier of the parent thread."},"type":{"type":"string","enum":["chatkit.task_group"],"description":"Type discriminator that is always `chatkit.task_group`.","default":"chatkit.task_group","x-stainless-const":true},"tasks":{"items":{"$ref":"#/components/schemas/TaskGroupTask"},"type":"array","description":"Tasks included in the group."}},"type":"object","required":["id","object","created_at","thread_id","type","tasks"],"title":"Task group","description":"Collection of workflow tasks grouped together in the thread."},"ThreadItem":{"oneOf":[{"$ref":"#/components/schemas/UserMessageItem"},{"$ref":"#/components/schemas/AssistantMessageItem"},{"$ref":"#/components/schemas/WidgetMessageItem"},{"$ref":"#/components/schemas/ClientToolCallItem"},{"$ref":"#/components/schemas/TaskItem"},{"$ref":"#/components/schemas/TaskGroupItem"}],"title":"The thread item","discriminator":{"propertyName":"type"}},"ThreadItemListResource":{"properties":{"object":{"type":"string","enum":["list"],"description":"The type of object returned, must be `list`.","default":"list","x-stainless-const":true},"data":{"items":{"$ref":"#/components/schemas/ThreadItem"},"type":"array","description":"A list of items"},"first_id":{"anyOf":[{"type":"string","description":"The ID of the first item in the list."},{"type":"null"}]},"last_id":{"anyOf":[{"type":"string","description":"The ID of the last item in the list."},{"type":"null"}]},"has_more":{"type":"boolean","description":"Whether there are more items available."}},"type":"object","required":["object","data","first_id","last_id","has_more"],"title":"Thread Items","description":"A paginated list of thread items rendered for the ChatKit API."},"ActiveStatus":{"properties":{"type":{"type":"string","enum":["active"],"description":"Status discriminator that is always `active`.","default":"active","x-stainless-const":true}},"type":"object","required":["type"],"title":"Active thread status","description":"Indicates that a thread is active."},"LockedStatus":{"properties":{"type":{"type":"string","enum":["locked"],"description":"Status discriminator that is always `locked`.","default":"locked","x-stainless-const":true},"reason":{"anyOf":[{"type":"string","description":"Reason that the thread was locked. Defaults to null when no reason is recorded."},{"type":"null"}]}},"type":"object","required":["type","reason"],"title":"Locked thread status","description":"Indicates that a thread is locked and cannot accept new input."},"ClosedStatus":{"properties":{"type":{"type":"string","enum":["closed"],"description":"Status discriminator that is always `closed`.","default":"closed","x-stainless-const":true},"reason":{"anyOf":[{"type":"string","description":"Reason that the thread was closed. Defaults to null when no reason is recorded."},{"type":"null"}]}},"type":"object","required":["type","reason"],"title":"Closed thread status","description":"Indicates that a thread has been closed."},"ThreadResource":{"properties":{"id":{"type":"string","description":"Identifier of the thread."},"object":{"type":"string","enum":["chatkit.thread"],"description":"Type discriminator that is always `chatkit.thread`.","default":"chatkit.thread","x-stainless-const":true},"created_at":{"type":"integer","description":"Unix timestamp (in seconds) for when the thread was created."},"title":{"anyOf":[{"type":"string","description":"Optional human-readable title for the thread. Defaults to null when no title has been generated."},{"type":"null"}]},"status":{"oneOf":[{"$ref":"#/components/schemas/ActiveStatus"},{"$ref":"#/components/schemas/LockedStatus"},{"$ref":"#/components/schemas/ClosedStatus"}],"description":"Current status for the thread. Defaults to `active` for newly created threads.","discriminator":{"propertyName":"type"}},"user":{"type":"string","description":"Free-form string that identifies your end user who owns the thread."}},"type":"object","required":["id","object","created_at","title","status","user"],"title":"The thread object","description":"Represents a ChatKit thread and its current status.","example":{"id":"cthr_def456","object":"chatkit.thread","created_at":1712345600,"title":"Demo feedback","status":{"type":"active"},"user":"user_456"}},"DeletedThreadResource":{"properties":{"id":{"type":"string","description":"Identifier of the deleted thread."},"object":{"type":"string","enum":["chatkit.thread.deleted"],"description":"Type discriminator that is always `chatkit.thread.deleted`.","default":"chatkit.thread.deleted","x-stainless-const":true},"deleted":{"type":"boolean","description":"Indicates that the thread has been deleted."}},"type":"object","required":["id","object","deleted"],"title":"Deleted thread","description":"Confirmation payload returned after deleting a thread."},"ThreadListResource":{"properties":{"object":{"type":"string","enum":["list"],"description":"The type of object returned, must be `list`.","default":"list","x-stainless-const":true},"data":{"items":{"$ref":"#/components/schemas/ThreadResource"},"type":"array","description":"A list of items"},"first_id":{"anyOf":[{"type":"string","description":"The ID of the first item in the list."},{"type":"null"}]},"last_id":{"anyOf":[{"type":"string","description":"The ID of the last item in the list."},{"type":"null"}]},"has_more":{"type":"boolean","description":"Whether there are more items available."}},"type":"object","required":["object","data","first_id","last_id","has_more"],"title":"Threads","description":"A paginated list of ChatKit threads."},"DragPoint":{"properties":{"x":{"type":"integer","description":"The x-coordinate."},"y":{"type":"integer","description":"The y-coordinate."}},"type":"object","required":["x","y"],"title":"Coordinate","description":"An x/y coordinate pair, e.g. `{ x: 100, y: 200 }`."}},"securitySchemes":{"ApiKeyAuth":{"type":"http","scheme":"bearer"}}},"x-oaiMeta":{"navigationGroups":[{"id":"responses","title":"Responses API"},{"id":"webhooks","title":"Webhooks"},{"id":"endpoints","title":"Platform APIs"},{"id":"vector_stores","title":"Vector stores"},{"id":"chatkit","title":"ChatKit","beta":true},{"id":"containers","title":"Containers"},{"id":"realtime","title":"Realtime"},{"id":"chat","title":"Chat Completions"},{"id":"assistants","title":"Assistants","deprecated":true},{"id":"administration","title":"Administration"},{"id":"legacy","title":"Legacy"}],"groups":[{"id":"responses-streaming","title":"Streaming events","description":"When you [create a Response](/docs/api-reference/responses/create) with\n`stream` set to `true`, the server will emit server-sent events to the\nclient as the Response is generated. This section contains the events that\nare emitted by the server.\n\n[Learn more about streaming responses](/docs/guides/streaming-responses?api-mode=responses).\n","navigationGroup":"responses","sections":[{"type":"object","key":"ResponseCreatedEvent","path":"<auto>"},{"type":"object","key":"ResponseInProgressEvent","path":"<auto>"},{"type":"object","key":"ResponseCompletedEvent","path":"<auto>"},{"type":"object","key":"ResponseFailedEvent","path":"<auto>"},{"type":"object","key":"ResponseIncompleteEvent","path":"<auto>"},{"type":"object","key":"ResponseOutputItemAddedEvent","path":"<auto>"},{"type":"object","key":"ResponseOutputItemDoneEvent","path":"<auto>"},{"type":"object","key":"ResponseContentPartAddedEvent","path":"<auto>"},{"type":"object","key":"ResponseContentPartDoneEvent","path":"<auto>"},{"type":"object","key":"ResponseTextDeltaEvent","path":"response/output_text/delta"},{"type":"object","key":"ResponseTextDoneEvent","path":"response/output_text/done"},{"type":"object","key":"ResponseRefusalDeltaEvent","path":"<auto>"},{"type":"object","key":"ResponseRefusalDoneEvent","path":"<auto>"},{"type":"object","key":"ResponseFunctionCallArgumentsDeltaEvent","path":"<auto>"},{"type":"object","key":"ResponseFunctionCallArgumentsDoneEvent","path":"<auto>"},{"type":"object","key":"ResponseFileSearchCallInProgressEvent","path":"<auto>"},{"type":"object","key":"ResponseFileSearchCallSearchingEvent","path":"<auto>"},{"type":"object","key":"ResponseFileSearchCallCompletedEvent","path":"<auto>"},{"type":"object","key":"ResponseWebSearchCallInProgressEvent","path":"<auto>"},{"type":"object","key":"ResponseWebSearchCallSearchingEvent","path":"<auto>"},{"type":"object","key":"ResponseWebSearchCallCompletedEvent","path":"<auto>"},{"type":"object","key":"ResponseReasoningSummaryPartAddedEvent","path":"<auto>"},{"type":"object","key":"ResponseReasoningSummaryPartDoneEvent","path":"<auto>"},{"type":"object","key":"ResponseReasoningSummaryTextDeltaEvent","path":"<auto>"},{"type":"object","key":"ResponseReasoningSummaryTextDoneEvent","path":"<auto>"},{"type":"object","key":"ResponseReasoningTextDeltaEvent","path":"<auto>"},{"type":"object","key":"ResponseReasoningTextDoneEvent","path":"<auto>"},{"type":"object","key":"ResponseImageGenCallCompletedEvent","path":"<auto>"},{"type":"object","key":"ResponseImageGenCallGeneratingEvent","path":"<auto>"},{"type":"object","key":"ResponseImageGenCallInProgressEvent","path":"<auto>"},{"type":"object","key":"ResponseImageGenCallPartialImageEvent","path":"<auto>"},{"type":"object","key":"ResponseMCPCallArgumentsDeltaEvent","path":"<auto>"},{"type":"object","key":"ResponseMCPCallArgumentsDoneEvent","path":"<auto>"},{"type":"object","key":"ResponseMCPCallCompletedEvent","path":"<auto>"},{"type":"object","key":"ResponseMCPCallFailedEvent","path":"<auto>"},{"type":"object","key":"ResponseMCPCallInProgressEvent","path":"<auto>"},{"type":"object","key":"ResponseMCPListToolsCompletedEvent","path":"<auto>"},{"type":"object","key":"ResponseMCPListToolsFailedEvent","path":"<auto>"},{"type":"object","key":"ResponseMCPListToolsInProgressEvent","path":"<auto>"},{"type":"object","key":"ResponseCodeInterpreterCallInProgressEvent","path":"<auto>"},{"type":"object","key":"ResponseCodeInterpreterCallInterpretingEvent","path":"<auto>"},{"type":"object","key":"ResponseCodeInterpreterCallCompletedEvent","path":"<auto>"},{"type":"object","key":"ResponseCodeInterpreterCallCodeDeltaEvent","path":"<auto>"},{"type":"object","key":"ResponseCodeInterpreterCallCodeDoneEvent","path":"<auto>"},{"type":"object","key":"ResponseOutputTextAnnotationAddedEvent","path":"<auto>"},{"type":"object","key":"ResponseQueuedEvent","path":"<auto>"},{"type":"object","key":"ResponseCustomToolCallInputDeltaEvent","path":"<auto>"},{"type":"object","key":"ResponseCustomToolCallInputDoneEvent","path":"<auto>"},{"type":"object","key":"ResponseErrorEvent","path":"<auto>"}]},{"id":"webhook-events","title":"Webhook Events","description":"Webhooks are HTTP requests sent by OpenAI to a URL you specify when certain\nevents happen during the course of API usage.\n\n[Learn more about webhooks](/docs/guides/webhooks).\n","navigationGroup":"webhooks","sections":[{"type":"object","key":"WebhookResponseCompleted","path":"<auto>"},{"type":"object","key":"WebhookResponseCancelled","path":"<auto>"},{"type":"object","key":"WebhookResponseFailed","path":"<auto>"},{"type":"object","key":"WebhookResponseIncomplete","path":"<auto>"},{"type":"object","key":"WebhookBatchCompleted","path":"<auto>"},{"type":"object","key":"WebhookBatchCancelled","path":"<auto>"},{"type":"object","key":"WebhookBatchExpired","path":"<auto>"},{"type":"object","key":"WebhookBatchFailed","path":"<auto>"},{"type":"object","key":"WebhookFineTuningJobSucceeded","path":"<auto>"},{"type":"object","key":"WebhookFineTuningJobFailed","path":"<auto>"},{"type":"object","key":"WebhookFineTuningJobCancelled","path":"<auto>"},{"type":"object","key":"WebhookEvalRunSucceeded","path":"<auto>"},{"type":"object","key":"WebhookEvalRunFailed","path":"<auto>"},{"type":"object","key":"WebhookEvalRunCanceled","path":"<auto>"},{"type":"object","key":"WebhookRealtimeCallIncoming","path":"<auto>"}]},{"id":"images-streaming","title":"Image Streaming","description":"Stream image generation and editing in real time with server-sent events.\n[Learn more about image streaming](/docs/guides/image-generation).\n","navigationGroup":"endpoints","sections":[{"type":"object","key":"ImageGenPartialImageEvent","path":"<auto>"},{"type":"object","key":"ImageGenCompletedEvent","path":"<auto>"},{"type":"object","key":"ImageEditPartialImageEvent","path":"<auto>"},{"type":"object","key":"ImageEditCompletedEvent","path":"<auto>"}]},{"id":"realtime-client-events","title":"Client events","description":"These are events that the OpenAI Realtime WebSocket server will accept from the client.\n","navigationGroup":"realtime","sections":[{"type":"object","key":"RealtimeClientEventSessionUpdate","path":"<auto>"},{"type":"object","key":"RealtimeClientEventInputAudioBufferAppend","path":"<auto>"},{"type":"object","key":"RealtimeClientEventInputAudioBufferCommit","path":"<auto>"},{"type":"object","key":"RealtimeClientEventInputAudioBufferClear","path":"<auto>"},{"type":"object","key":"RealtimeClientEventConversationItemCreate","path":"<auto>"},{"type":"object","key":"RealtimeClientEventConversationItemRetrieve","path":"<auto>"},{"type":"object","key":"RealtimeClientEventConversationItemTruncate","path":"<auto>"},{"type":"object","key":"RealtimeClientEventConversationItemDelete","path":"<auto>"},{"type":"object","key":"RealtimeClientEventResponseCreate","path":"<auto>"},{"type":"object","key":"RealtimeClientEventResponseCancel","path":"<auto>"},{"type":"object","key":"RealtimeClientEventOutputAudioBufferClear","path":"<auto>"}]},{"id":"realtime-server-events","title":"Server events","description":"These are events emitted from the OpenAI Realtime WebSocket server to the client.\n","navigationGroup":"realtime","sections":[{"type":"object","key":"RealtimeServerEventError","path":"<auto>"},{"type":"object","key":"RealtimeServerEventSessionCreated","path":"<auto>"},{"type":"object","key":"RealtimeServerEventSessionUpdated","path":"<auto>"},{"type":"object","key":"RealtimeServerEventConversationItemAdded","path":"<auto>"},{"type":"object","key":"RealtimeServerEventConversationItemDone","path":"<auto>"},{"type":"object","key":"RealtimeServerEventConversationItemRetrieved","path":"<auto>"},{"type":"object","key":"RealtimeServerEventConversationItemInputAudioTranscriptionCompleted","path":"<auto>"},{"type":"object","key":"RealtimeServerEventConversationItemInputAudioTranscriptionDelta","path":"<auto>"},{"type":"object","key":"RealtimeServerEventConversationItemInputAudioTranscriptionSegment","path":"<auto>"},{"type":"object","key":"RealtimeServerEventConversationItemInputAudioTranscriptionFailed","path":"<auto>"},{"type":"object","key":"RealtimeServerEventConversationItemTruncated","path":"<auto>"},{"type":"object","key":"RealtimeServerEventConversationItemDeleted","path":"<auto>"},{"type":"object","key":"RealtimeServerEventInputAudioBufferCommitted","path":"<auto>"},{"type":"object","key":"RealtimeServerEventInputAudioBufferDtmfEventReceived","path":"<auto>"},{"type":"object","key":"RealtimeServerEventInputAudioBufferCleared","path":"<auto>"},{"type":"object","key":"RealtimeServerEventInputAudioBufferSpeechStarted","path":"<auto>"},{"type":"object","key":"RealtimeServerEventInputAudioBufferSpeechStopped","path":"<auto>"},{"type":"object","key":"RealtimeServerEventInputAudioBufferTimeoutTriggered","path":"<auto>"},{"type":"object","key":"RealtimeServerEventOutputAudioBufferStarted","path":"<auto>"},{"type":"object","key":"RealtimeServerEventOutputAudioBufferStopped","path":"<auto>"},{"type":"object","key":"RealtimeServerEventOutputAudioBufferCleared","path":"<auto>"},{"type":"object","key":"RealtimeServerEventResponseCreated","path":"<auto>"},{"type":"object","key":"RealtimeServerEventResponseDone","path":"<auto>"},{"type":"object","key":"RealtimeServerEventResponseOutputItemAdded","path":"<auto>"},{"type":"object","key":"RealtimeServerEventResponseOutputItemDone","path":"<auto>"},{"type":"object","key":"RealtimeServerEventResponseContentPartAdded","path":"<auto>"},{"type":"object","key":"RealtimeServerEventResponseContentPartDone","path":"<auto>"},{"type":"object","key":"RealtimeServerEventResponseTextDelta","path":"<auto>"},{"type":"object","key":"RealtimeServerEventResponseTextDone","path":"<auto>"},{"type":"object","key":"RealtimeServerEventResponseAudioTranscriptDelta","path":"<auto>"},{"type":"object","key":"RealtimeServerEventResponseAudioTranscriptDone","path":"<auto>"},{"type":"object","key":"RealtimeServerEventResponseAudioDelta","path":"<auto>"},{"type":"object","key":"RealtimeServerEventResponseAudioDone","path":"<auto>"},{"type":"object","key":"RealtimeServerEventResponseFunctionCallArgumentsDelta","path":"<auto>"},{"type":"object","key":"RealtimeServerEventResponseFunctionCallArgumentsDone","path":"<auto>"},{"type":"object","key":"RealtimeServerEventResponseMCPCallArgumentsDelta","path":"<auto>"},{"type":"object","key":"RealtimeServerEventResponseMCPCallArgumentsDone","path":"<auto>"},{"type":"object","key":"RealtimeServerEventResponseMCPCallInProgress","path":"<auto>"},{"type":"object","key":"RealtimeServerEventResponseMCPCallCompleted","path":"<auto>"},{"type":"object","key":"RealtimeServerEventResponseMCPCallFailed","path":"<auto>"},{"type":"object","key":"RealtimeServerEventMCPListToolsInProgress","path":"<auto>"},{"type":"object","key":"RealtimeServerEventMCPListToolsCompleted","path":"<auto>"},{"type":"object","key":"RealtimeServerEventMCPListToolsFailed","path":"<auto>"},{"type":"object","key":"RealtimeServerEventRateLimitsUpdated","path":"<auto>"}]},{"id":"chat-streaming","title":"Streaming","description":"Stream Chat Completions in real time. Receive chunks of completions\nreturned from the model using server-sent events.\n[Learn more](/docs/guides/streaming-responses?api-mode=chat).\n","navigationGroup":"chat","sections":[{"type":"object","key":"CreateChatCompletionStreamResponse","path":"streaming"}]},{"id":"assistants-streaming","title":"Streaming","beta":true,"description":"Stream the result of executing a Run or resuming a Run after submitting tool outputs.\nYou can stream events from the [Create Thread and Run](/docs/api-reference/runs/createThreadAndRun),\n[Create Run](/docs/api-reference/runs/createRun), and [Submit Tool Outputs](/docs/api-reference/runs/submitToolOutputs)\nendpoints by passing `\"stream\": true`. The response will be a [Server-Sent events](https://html.spec.whatwg.org/multipage/server-sent-events.html#server-sent-events) stream.\nOur Node and Python SDKs provide helpful utilities to make streaming easy. Reference the\n[Assistants API quickstart](/docs/assistants/overview) to learn more.\n","navigationGroup":"assistants","sections":[{"type":"object","key":"AssistantStreamEvent","path":"events"}]},{"id":"realtime-beta-client-events","title":"Realtime Beta client events","description":"These are events that the OpenAI Realtime WebSocket server will accept from the client.\n","navigationGroup":"legacy","sections":[{"type":"object","key":"RealtimeBetaClientEventSessionUpdate","path":"<auto>"},{"type":"object","key":"RealtimeBetaClientEventInputAudioBufferAppend","path":"<auto>"},{"type":"object","key":"RealtimeBetaClientEventInputAudioBufferCommit","path":"<auto>"},{"type":"object","key":"RealtimeBetaClientEventInputAudioBufferClear","path":"<auto>"},{"type":"object","key":"RealtimeBetaClientEventConversationItemCreate","path":"<auto>"},{"type":"object","key":"RealtimeBetaClientEventConversationItemRetrieve","path":"<auto>"},{"type":"object","key":"RealtimeBetaClientEventConversationItemTruncate","path":"<auto>"},{"type":"object","key":"RealtimeBetaClientEventConversationItemDelete","path":"<auto>"},{"type":"object","key":"RealtimeBetaClientEventResponseCreate","path":"<auto>"},{"type":"object","key":"RealtimeBetaClientEventResponseCancel","path":"<auto>"},{"type":"object","key":"RealtimeBetaClientEventTranscriptionSessionUpdate","path":"<auto>"},{"type":"object","key":"RealtimeBetaClientEventOutputAudioBufferClear","path":"<auto>"}]},{"id":"realtime-beta-server-events","title":"Realtime Beta server events","description":"These are events emitted from the OpenAI Realtime WebSocket server to the client.\n","navigationGroup":"legacy","sections":[{"type":"object","key":"RealtimeBetaServerEventError","path":"<auto>"},{"type":"object","key":"RealtimeBetaServerEventSessionCreated","path":"<auto>"},{"type":"object","key":"RealtimeBetaServerEventSessionUpdated","path":"<auto>"},{"type":"object","key":"RealtimeBetaServerEventTranscriptionSessionCreated","path":"<auto>"},{"type":"object","key":"RealtimeBetaServerEventTranscriptionSessionUpdated","path":"<auto>"},{"type":"object","key":"RealtimeBetaServerEventConversationItemCreated","path":"<auto>"},{"type":"object","key":"RealtimeBetaServerEventConversationItemRetrieved","path":"<auto>"},{"type":"object","key":"RealtimeBetaServerEventConversationItemInputAudioTranscriptionCompleted","path":"<auto>"},{"type":"object","key":"RealtimeBetaServerEventConversationItemInputAudioTranscriptionDelta","path":"<auto>"},{"type":"object","key":"RealtimeBetaServerEventConversationItemInputAudioTranscriptionSegment","path":"<auto>"},{"type":"object","key":"RealtimeBetaServerEventConversationItemInputAudioTranscriptionFailed","path":"<auto>"},{"type":"object","key":"RealtimeBetaServerEventConversationItemTruncated","path":"<auto>"},{"type":"object","key":"RealtimeBetaServerEventConversationItemDeleted","path":"<auto>"},{"type":"object","key":"RealtimeBetaServerEventInputAudioBufferCommitted","path":"<auto>"},{"type":"object","key":"RealtimeBetaServerEventInputAudioBufferCleared","path":"<auto>"},{"type":"object","key":"RealtimeBetaServerEventInputAudioBufferSpeechStarted","path":"<auto>"},{"type":"object","key":"RealtimeBetaServerEventInputAudioBufferSpeechStopped","path":"<auto>"},{"type":"object","key":"RealtimeServerEventInputAudioBufferTimeoutTriggered","path":"<auto>"},{"type":"object","key":"RealtimeBetaServerEventResponseCreated","path":"<auto>"},{"type":"object","key":"RealtimeBetaServerEventResponseDone","path":"<auto>"},{"type":"object","key":"RealtimeBetaServerEventResponseOutputItemAdded","path":"<auto>"},{"type":"object","key":"RealtimeBetaServerEventResponseOutputItemDone","path":"<auto>"},{"type":"object","key":"RealtimeBetaServerEventResponseContentPartAdded","path":"<auto>"},{"type":"object","key":"RealtimeBetaServerEventResponseContentPartDone","path":"<auto>"},{"type":"object","key":"RealtimeBetaServerEventResponseTextDelta","path":"<auto>"},{"type":"object","key":"RealtimeBetaServerEventResponseTextDone","path":"<auto>"},{"type":"object","key":"RealtimeBetaServerEventResponseAudioTranscriptDelta","path":"<auto>"},{"type":"object","key":"RealtimeBetaServerEventResponseAudioTranscriptDone","path":"<auto>"},{"type":"object","key":"RealtimeBetaServerEventResponseAudioDelta","path":"<auto>"},{"type":"object","key":"RealtimeBetaServerEventResponseAudioDone","path":"<auto>"},{"type":"object","key":"RealtimeBetaServerEventResponseFunctionCallArgumentsDelta","path":"<auto>"},{"type":"object","key":"RealtimeBetaServerEventResponseFunctionCallArgumentsDone","path":"<auto>"},{"type":"object","key":"RealtimeBetaServerEventResponseMCPCallArgumentsDelta","path":"<auto>"},{"type":"object","key":"RealtimeBetaServerEventResponseMCPCallArgumentsDone","path":"<auto>"},{"type":"object","key":"RealtimeBetaServerEventResponseMCPCallInProgress","path":"<auto>"},{"type":"object","key":"RealtimeBetaServerEventResponseMCPCallCompleted","path":"<auto>"},{"type":"object","key":"RealtimeBetaServerEventResponseMCPCallFailed","path":"<auto>"},{"type":"object","key":"RealtimeBetaServerEventMCPListToolsInProgress","path":"<auto>"},{"type":"object","key":"RealtimeBetaServerEventMCPListToolsCompleted","path":"<auto>"},{"type":"object","key":"RealtimeBetaServerEventMCPListToolsFailed","path":"<auto>"},{"type":"object","key":"RealtimeBetaServerEventRateLimitsUpdated","path":"<auto>"}]}]}}},"searchIndex":{"store":["tag/Assistants","tag/Assistants/operation/listAssistants","tag/Assistants/operation/createAssistant","tag/Assistants/operation/getAssistant","tag/Assistants/operation/modifyAssistant","tag/Assistants/operation/deleteAssistant","tag/Assistants/operation/createThread","tag/Assistants/operation/createThreadAndRun","tag/Assistants/operation/getThread","tag/Assistants/operation/modifyThread","tag/Assistants/operation/deleteThread","tag/Assistants/operation/listMessages","tag/Assistants/operation/createMessage","tag/Assistants/operation/getMessage","tag/Assistants/operation/modifyMessage","tag/Assistants/operation/deleteMessage","tag/Assistants/operation/listRuns","tag/Assistants/operation/createRun","tag/Assistants/operation/getRun","tag/Assistants/operation/modifyRun","tag/Assistants/operation/cancelRun","tag/Assistants/operation/listRunSteps","tag/Assistants/operation/getRunStep","tag/Assistants/operation/submitToolOuputsToRun","tag/Audio","tag/Audio/operation/createSpeech","tag/Audio/operation/createTranscription","tag/Audio/operation/createTranslation","tag/Audio/operation/createVoiceConsent","tag/Audio/operation/listVoiceConsents","tag/Audio/operation/getVoiceConsent","tag/Audio/operation/updateVoiceConsent","tag/Audio/operation/deleteVoiceConsent","tag/Audio/operation/createVoice","tag/Chat","tag/Chat/operation/listChatCompletions","tag/Chat/operation/createChatCompletion","tag/Chat/operation/getChatCompletion","tag/Chat/operation/updateChatCompletion","tag/Chat/operation/deleteChatCompletion","tag/Chat/operation/getChatCompletionMessages","tag/Conversations","tag/Conversations/operation/createConversationItems","tag/Conversations/operation/listConversationItems","tag/Conversations/operation/getConversationItem","tag/Conversations/operation/deleteConversationItem","tag/Conversations/operation/createConversation","tag/Conversations/operation/getConversation","tag/Conversations/operation/deleteConversation","tag/Conversations/operation/updateConversation","tag/Completions","tag/Completions/operation/createCompletion","tag/Embeddings","tag/Embeddings/operation/createEmbedding","tag/Evals","tag/Evals/operation/listEvals","tag/Evals/operation/createEval","tag/Evals/operation/getEval","tag/Evals/operation/updateEval","tag/Evals/operation/deleteEval","tag/Evals/operation/getEvalRuns","tag/Evals/operation/createEvalRun","tag/Evals/operation/getEvalRun","tag/Evals/operation/cancelEvalRun","tag/Evals/operation/deleteEvalRun","tag/Evals/operation/getEvalRunOutputItems","tag/Evals/operation/getEvalRunOutputItem","tag/Fine-tuning","tag/Fine-tuning/operation/runGrader","tag/Fine-tuning/operation/validateGrader","tag/Fine-tuning/operation/listFineTuningCheckpointPermissions","tag/Fine-tuning/operation/createFineTuningCheckpointPermission","tag/Fine-tuning/operation/deleteFineTuningCheckpointPermission","tag/Fine-tuning/operation/createFineTuningJob","tag/Fine-tuning/operation/listPaginatedFineTuningJobs","tag/Fine-tuning/operation/retrieveFineTuningJob","tag/Fine-tuning/operation/cancelFineTuningJob","tag/Fine-tuning/operation/listFineTuningJobCheckpoints","tag/Fine-tuning/operation/listFineTuningEvents","tag/Fine-tuning/operation/pauseFineTuningJob","tag/Fine-tuning/operation/resumeFineTuningJob","tag/Graders","tag/Batch","tag/Batch/operation/createBatch","tag/Batch/operation/listBatches","tag/Batch/operation/retrieveBatch","tag/Batch/operation/cancelBatch","tag/Files","tag/Files/operation/listFiles","tag/Files/operation/createFile","tag/Files/operation/deleteFile","tag/Files/operation/retrieveFile","tag/Files/operation/downloadFile","tag/Uploads","tag/Uploads/operation/createUpload","tag/Uploads/operation/cancelUpload","tag/Uploads/operation/completeUpload","tag/Uploads/operation/addUploadPart","tag/Images","tag/Images/operation/createImageEdit","tag/Images/operation/createImage","tag/Images/operation/createImageVariation","tag/Models","tag/Models/operation/listModels","tag/Models/operation/retrieveModel","tag/Models/operation/deleteModel","tag/Moderations","tag/Moderations/operation/createModeration","tag/Audit-Logs","tag/Audit-Logs/operation/list-audit-logs","/paths/batch_cancelled/post","/paths/batch_completed/post","/paths/batch_expired/post","/paths/batch_failed/post","/paths/eval_run_canceled/post","/paths/eval_run_failed/post","/paths/eval_run_succeeded/post","/paths/fine_tuning_job_cancelled/post","/paths/fine_tuning_job_failed/post","/paths/fine_tuning_job_succeeded/post","/paths/realtime_call_incoming/post","/paths/response_cancelled/post","/paths/response_completed/post","/paths/response_failed/post","/paths/response_incomplete/post","operation/ListContainers","operation/CreateContainer","operation/RetrieveContainer","operation/DeleteContainer","operation/CreateContainerFile","operation/ListContainerFiles","operation/RetrieveContainerFile","operation/DeleteContainerFile","operation/RetrieveContainerFileContent","operation/admin-api-keys-list","operation/admin-api-keys-create","operation/admin-api-keys-get","operation/admin-api-keys-delete","operation/Getinputtokencounts","operation/Compactconversation","operation/CancelChatSessionMethod","operation/CreateChatSessionMethod","operation/ListThreadItemsMethod","operation/GetThreadMethod","operation/DeleteThreadMethod","operation/ListThreadsMethod","tag/Certificates","tag/Certificates/operation/listOrganizationCertificates","tag/Certificates/operation/uploadCertificate","tag/Certificates/operation/activateOrganizationCertificates","tag/Certificates/operation/deactivateOrganizationCertificates","tag/Certificates/operation/getCertificate","tag/Certificates/operation/modifyCertificate","tag/Certificates/operation/deleteCertificate","tag/Certificates/operation/listProjectCertificates","tag/Certificates/operation/activateProjectCertificates","tag/Certificates/operation/deactivateProjectCertificates","tag/Usage","tag/Usage/operation/usage-costs","tag/Usage/operation/usage-audio-speeches","tag/Usage/operation/usage-audio-transcriptions","tag/Usage/operation/usage-code-interpreter-sessions","tag/Usage/operation/usage-completions","tag/Usage/operation/usage-embeddings","tag/Usage/operation/usage-images","tag/Usage/operation/usage-moderations","tag/Usage/operation/usage-vector-stores","tag/Groups","tag/Groups/operation/list-groups","tag/Groups/operation/create-group","tag/Groups/operation/update-group","tag/Groups/operation/delete-group","tag/Group-organization-role-assignments","tag/Group-organization-role-assignments/operation/list-group-role-assignments","tag/Group-organization-role-assignments/operation/assign-group-role","tag/Group-organization-role-assignments/operation/unassign-group-role","tag/Group-users","tag/Group-users/operation/list-group-users","tag/Group-users/operation/add-group-user","tag/Group-users/operation/remove-group-user","tag/Invites","tag/Invites/operation/list-invites","tag/Invites/operation/inviteUser","tag/Invites/operation/retrieve-invite","tag/Invites/operation/delete-invite","tag/Projects","tag/Projects/operation/list-projects","tag/Projects/operation/create-project","tag/Projects/operation/retrieve-project","tag/Projects/operation/modify-project","tag/Projects/operation/list-project-api-keys","tag/Projects/operation/retrieve-project-api-key","tag/Projects/operation/delete-project-api-key","tag/Projects/operation/archive-project","tag/Projects/operation/list-project-rate-limits","tag/Projects/operation/update-project-rate-limits","tag/Projects/operation/list-project-service-accounts","tag/Projects/operation/create-project-service-account","tag/Projects/operation/retrieve-project-service-account","tag/Projects/operation/delete-project-service-account","tag/Projects/operation/list-project-users","tag/Projects/operation/create-project-user","tag/Projects/operation/retrieve-project-user","tag/Projects/operation/modify-project-user","tag/Projects/operation/delete-project-user","tag/Project-groups","tag/Project-groups/operation/list-project-groups","tag/Project-groups/operation/add-project-group","tag/Project-groups/operation/remove-project-group","tag/Roles","tag/Roles/operation/list-roles","tag/Roles/operation/create-role","tag/Roles/operation/update-role","tag/Roles/operation/delete-role","tag/Roles/operation/list-project-roles","tag/Roles/operation/create-project-role","tag/Roles/operation/update-project-role","tag/Roles/operation/delete-project-role","tag/Users","tag/Users/operation/list-users","tag/Users/operation/retrieve-user","tag/Users/operation/modify-user","tag/Users/operation/delete-user","tag/User-organization-role-assignments","tag/User-organization-role-assignments/operation/list-user-role-assignments","tag/User-organization-role-assignments/operation/assign-user-role","tag/User-organization-role-assignments/operation/unassign-user-role","tag/Project-group-role-assignments","tag/Project-group-role-assignments/operation/list-project-group-role-assignments","tag/Project-group-role-assignments/operation/assign-project-group-role","tag/Project-group-role-assignments/operation/unassign-project-group-role","tag/Project-user-role-assignments","tag/Project-user-role-assignments/operation/list-project-user-role-assignments","tag/Project-user-role-assignments/operation/assign-project-user-role","tag/Project-user-role-assignments/operation/unassign-project-user-role","tag/Realtime","tag/Realtime/operation/create-realtime-call","tag/Realtime/operation/accept-realtime-call","tag/Realtime/operation/hangup-realtime-call","tag/Realtime/operation/refer-realtime-call","tag/Realtime/operation/reject-realtime-call","tag/Realtime/operation/create-realtime-client-secret","tag/Realtime/operation/create-realtime-session","tag/Realtime/operation/create-realtime-transcription-session","tag/Responses","tag/Responses/operation/createResponse","tag/Responses/operation/getResponse","tag/Responses/operation/deleteResponse","tag/Responses/operation/cancelResponse","tag/Responses/operation/listInputItems","tag/Vector-stores","tag/Vector-stores/operation/listVectorStores","tag/Vector-stores/operation/createVectorStore","tag/Vector-stores/operation/getVectorStore","tag/Vector-stores/operation/modifyVectorStore","tag/Vector-stores/operation/deleteVectorStore","tag/Vector-stores/operation/createVectorStoreFileBatch","tag/Vector-stores/operation/getVectorStoreFileBatch","tag/Vector-stores/operation/cancelVectorStoreFileBatch","tag/Vector-stores/operation/listFilesInVectorStoreBatch","tag/Vector-stores/operation/listVectorStoreFiles","tag/Vector-stores/operation/createVectorStoreFile","tag/Vector-stores/operation/getVectorStoreFile","tag/Vector-stores/operation/deleteVectorStoreFile","tag/Vector-stores/operation/updateVectorStoreFileAttributes","tag/Vector-stores/operation/retrieveVectorStoreFileContent","tag/Vector-stores/operation/searchVectorStore","tag/Videos","tag/Videos/operation/createVideo","tag/Videos/operation/ListVideos","tag/Videos/operation/CreateVideoCharacter","tag/Videos/operation/GetVideoCharacter","tag/Videos/operation/CreateVideoEdit","tag/Videos/operation/CreateVideoExtend","tag/Videos/operation/GetVideo","tag/Videos/operation/DeleteVideo","tag/Videos/operation/RetrieveVideoContent","tag/Videos/operation/CreateVideoRemix","tag/Skills","tag/Skills/operation/CreateSkill","tag/Skills/operation/ListSkills","tag/Skills/operation/DeleteSkill","tag/Skills/operation/GetSkill","tag/Skills/operation/UpdateSkillDefaultVersion","tag/Skills/operation/GetSkillContent","tag/Skills/operation/CreateSkillVersion","tag/Skills/operation/ListSkillVersions","tag/Skills/operation/GetSkillVersion","tag/Skills/operation/DeleteSkillVersion","tag/Skills/operation/GetSkillVersionContent"],"index":{"version":"2.3.9","fields":["title","description"],"fieldVectors":[["title/0",[0,4.979]],["description/0",[0,2,1,3.262,2,2,3,1.461,4,1.484,5,2.737]],["title/1",[0,4.224,6,2.546,7,2.214]],["description/1",[0,4.242]],["title/2",[0,3.926,3,2.867,8,1.949,9,6.401]],["description/2",[0,4.242]],["title/3",[0,4.57,10,3.191]],["description/3",[11,5.804]],["title/4",[0,4.57,12,4.699]],["description/4",[11,5.804]],["title/5",[0,4.57,13,2.937]],["description/5",[11,5.804]],["title/6",[8,2.269,14,4.452]],["description/6",[14,4.133]],["title/7",[8,1.821,14,3.573,15,2.678,16,4.505,17,3.486]],["description/7",[18,6.917]],["title/8",[10,3.191,14,4.452]],["description/8",[19,5.804]],["title/9",[12,4.699,14,4.452]],["description/9",[19,5.804]],["title/10",[13,2.937,14,4.452]],["description/10",[19,5.804]],["title/11",[6,2.211,7,1.922,14,3.573,20,4.153,21,3.011]],["description/11",[22,6.246]],["title/12",[8,2.269,20,5.175]],["description/12",[22,6.246]],["title/13",[10,3.191,20,5.175]],["description/13",[23,5.804]],["title/14",[12,4.699,20,5.175]],["description/14",[23,5.804]],["title/15",[13,2.937,20,5.175]],["description/15",[23,5.804]],["title/16",[6,2.211,7,1.922,14,3.573,15,2.678,24,4.733]],["description/16",[25,6.246]],["title/17",[8,2.269,15,3.337]],["description/17",[25,6.246]],["title/18",[10,3.191,15,3.337]],["description/18",[26,6.246]],["title/19",[12,4.699,15,3.337]],["description/19",[26,6.246]],["title/20",[15,3.084,27,3.752,28,6.887]],["description/20",[29,6.917]],["title/21",[6,2.074,7,1.804,15,3.386,24,4.44,30,5.066]],["description/21",[31,6.917]],["title/22",[10,2.949,15,3.084,30,6.219]],["description/22",[32,6.917]],["title/23",[2,1.976,4,1.465,5,2.703,15,1.443,17,1.878,33,2.161,34,3.222,35,3.222,36,3.222,37,1.925,38,5.042,39,3.638,40,2.703,41,3.222,42,1.465,43,2.55]],["description/23",[44,6.917]],["title/24",[45,5.273]],["description/24",[45,3.604,46,3.647,47,4.004]],["title/25",[6,1.585,45,4.801,47,3.093,48,2.784,49,2.629,50,1.605,51,2.977,52,3.229,53,3.392]],["description/25",[54,6.917]],["title/26",[6,1.388,45,2.439,49,2.303,52,2.828,53,2.971,55,3.754,56,3.754,57,4.759,58,2.243,59,3.151,60,3.754,61,3.754,62,3.39]],["description/26",[63,6.917]],["title/27",[45,4.474,64,6.887,65,6.887]],["description/27",[66,6.917]],["title/28",[67,3.224,68,3.825,69,3.926,70,3.926]],["description/28",[67,0.662,68,1.922,69,0.807,70,0.807,71,1.315,72,1.315,73,2.288,74,0.854,75,0.949,76,0.949,77,1.188,78,1.188,79,0.807,80,0.949,81,1.188]],["title/29",[6,2.211,7,1.922,68,3.573,69,3.668,70,3.668]],["description/29",[7,0.462,8,0.438,68,2.065,69,0.882,70,0.882,73,2.443,74,0.934,75,1.038,79,0.882,80,1.038,81,1.298,82,1.138,83,0.457]],["title/30",[10,2.741,68,3.825,69,3.926,70,3.926]],["description/30",[4,0.654,8,0.438,10,0.616,68,2.065,69,0.882,70,0.882,73,2.443,74,0.934,75,1.038,79,0.882,80,1.038,84,1.038,85,1.207]],["title/31",[68,3.573,69,3.668,70,3.668,84,4.315,86,3.486]],["description/31",[4,0.511,8,0.342,37,0.671,45,0.73,68,1.687,69,0.689,70,0.689,73,2.03,74,0.73,75,0.811,79,0.689,80,0.811,84,1.479,85,0.943,86,1.194,87,1.124,88,1.124]],["title/32",[13,2.523,68,3.825,69,3.926,70,3.926]],["description/32",[8,0.459,13,0.594,67,0.76,68,2.145,69,0.925,70,0.925,73,2.529,74,0.98,75,1.088,79,0.925,80,1.088,85,1.266]],["title/33",[8,2.097,68,4.115,73,4.014]],["description/33",[4,0.42,8,0.281,39,0.666,45,1.11,67,0.464,68,1.426,69,0.566,70,0.566,73,1.736,74,0.599,75,0.666,76,1.233,77,0.833,78,0.833,79,0.566,80,0.666,89,0.922,90,0.922,91,0.582,92,0.42,93,0.922,94,0.922,95,0.922]],["title/34",[96,5.638]],["description/34",[3,1.206,6,0.995,7,0.866,20,1.87,21,1.356,97,2.692,98,1.533,99,1.381]],["title/35",[6,1.513,7,1.316,42,2.752,96,4.201,100,3.127,101,2.51,102,2.745,103,2.954]],["description/35",[104,6.246]],["title/36",[3,1.84,4,0.522,6,0.424,8,0.349,17,0.668,21,0.577,42,1.306,47,0.828,48,0.745,52,1.572,58,1.247,96,2.456,98,0.653,99,1.071,101,1.761,105,1.147,106,0.638,107,0.399,108,1.036,109,1.036,110,1.147,111,1.147,112,1.147,113,1.036,114,0.962,115,0.864,116,1.036,117,1.147,118,1.147,119,0.962,120,0.745,121,0.769,122,1.147,123,1.147,124,1.147,125,1.147,126,1.449,127,1.036,128,1.147,129,1.147,130,1.147,131,3.537,132,0.828,133,1.147,134,0.828,135,1.036,136,1.147,137,0.864,138,1.147,139,1.036,140,0.962]],["description/36",[104,6.246]],["title/37",[6,1.585,8,1.305,42,2.847,96,4.346,100,2.719,101,2.629,102,2.875,103,3.093]],["description/37",[141,5.804]],["title/38",[8,0.981,12,3.179,42,2.293,84,2.325,86,1.878,96,3.501,100,2.191,101,1.976,102,2.161,103,2.325,126,2.237,134,2.325,142,3.222,143,2.909]],["description/38",[141,5.804]],["title/39",[8,1.246,13,2.384,42,2.752,96,4.201,100,2.629,101,2.51,102,2.745,103,2.954]],["description/39",[141,5.804]],["title/40",[6,1.513,8,1.246,20,2.842,42,2.752,96,4.201,100,2.629,101,2.51,102,2.745,103,2.954]],["description/40",[144,6.917]],["title/41",[98,4.622]],["description/41",[98,3.471,145,3.273,146,2.537]],["title/42",[8,1.821,21,3.011,98,3.404,146,3.668,147,3.258]],["description/42",[148,6.246]],["title/43",[7,1.922,21,3.011,98,3.404,146,3.668,147,3.258]],["description/43",[148,6.246]],["title/44",[21,3.011,43,4.733,98,3.404,146,3.668,147,3.258]],["description/44",[149,6.246]],["title/45",[13,2.356,21,3.011,98,3.404,146,3.668,147,3.258]],["description/45",[149,6.246]],["title/46",[8,2.269,98,4.243]],["description/46",[98,3.938]],["title/47",[98,4.622]],["description/47",[150,5.804]],["title/48",[13,3.109,98,4.491,146,3.668]],["description/48",[150,5.804]],["title/49",[86,4.344,98,4.243]],["description/49",[150,5.804]],["title/50",[42,3.693]],["description/50",[3,0.791,6,1.134,16,1.331,21,0.89,42,0.804,121,1.185,151,1.227,152,1.767,153,1.767,154,1.767,155,1.275,156,1.275,157,1.767]],["title/51",[6,1.448,8,1.193,17,2.283,42,3.189,52,2.95,58,3.498,101,2.402,139,3.537,151,2.72,158,3.1]],["description/51",[42,3.146]],["title/52",[159,6.425]],["description/52",[3,1.027,21,1.154,49,1.406,120,1.489,160,1.077,161,2.292,162,2.292,163,2.292,164,2.292,165,2.292]],["title/53",[8,1.709,47,4.049,49,3.441,159,4.44,160,2.635,166,5.066]],["description/53",[159,5.474]],["title/54",[167,4.85]],["description/54",[15,1.633,114,3.06,115,2.748,145,2.886,167,2.179]],["title/55",[7,2.214,107,2.397,168,4.224]],["description/55",[167,4.133]],["title/56",[3,1.506,4,1.529,8,1.024,15,0.88,74,1.277,101,1.206,102,1.319,121,1.319,126,1.365,127,1.775,167,1.175,168,3.197,169,1.966,170,3.036,171,1.775,172,1.966,173,1.966,174,1.775,175,2.661,176,1.556,177,1.966,178,1.775,179,1.966,180,1.65,181,1.481,182,1.775,183,1.481,184,1.966]],["description/56",[167,4.133]],["title/57",[147,4.06,168,4.57]],["description/57",[185,5.804]],["title/58",[86,3.731,168,3.926,186,5.372,187,5.78]],["description/58",[185,5.804]],["title/59",[13,2.937,168,4.57]],["description/59",[185,5.804]],["title/60",[7,2.214,15,3.084,168,4.224]],["description/60",[188,6.246]],["title/61",[3,1.393,4,1.415,15,1.393,21,1.567,106,1.732,168,3.009,170,2.81,174,2.81,175,2.462,176,2.462,178,2.81,182,2.81,189,3.111,190,3.54,191,2.021,192,2.81,193,3.111]],["description/61",[188,6.246]],["title/62",[15,3.084,147,3.752,168,4.224]],["description/62",[194,5.804]],["title/63",[15,2.867,27,3.487,168,3.926,195,6.401]],["description/63",[194,5.804]],["title/64",[13,2.714,15,3.084,167,4.115]],["description/64",[194,5.804]],["title/65",[7,1.922,15,2.678,39,4.315,146,3.668,168,3.668]],["description/65",[196,6.917]],["title/66",[15,2.678,39,4.315,146,3.668,147,3.258,168,3.668]],["description/66",[197,6.917]],["title/67",[198,3.945]],["description/67",[3,1.206,145,2.131,175,2.131,198,1.308,199,1.408,200,2.692,201,1.943,202,2.692]],["title/68",[15,3.337,181,5.614]],["description/68",[203,6.917]],["title/69",[181,5.614,192,6.729]],["description/69",[204,6.917]],["title/70",[3,1.615,4,1.64,37,3.286,76,2.602,83,1.146,92,1.64,132,2.602,198,1.752,205,2.504,206,3.025,207,2.602,208,3.605,209,3.025,210,3.025]],["description/70",[211,6.246]],["title/71",[2,2.211,3,1.615,37,2.154,76,2.602,83,1.749,92,1.64,107,1.255,132,2.602,198,1.752,205,2.504,206,3.025,207,2.602,212,3.605,213,3.256]],["description/71",[211,6.246]],["title/72",[3,1.615,4,1.64,13,1.421,37,3.286,76,2.602,83,1.146,92,1.64,132,2.602,198,1.752,205,2.504,206,3.025,207,2.602,209,3.025,210,3.025]],["description/72",[214,6.917]],["title/73",[3,1.848,8,1.256,21,1.264,33,1.683,40,2.106,42,1.141,99,1.288,106,1.397,120,1.63,121,1.683,198,2.005,199,2.748,215,2.509,216,1.986,217,2.509,218,3.462,219,1.463,220,2.509,221,2.266,222,2.266]],["description/73",[223,6.246]],["title/74",[7,2.058,198,3.11,199,3.348,224,5.78]],["description/74",[223,6.246]],["title/75",[120,3.644,121,3.763,198,2.726,199,2.935,222,5.066,225,5.61]],["description/75",[226,6.917]],["title/76",[27,3.487,198,3.11,199,3.348,227,6.401]],["description/76",[228,6.917]],["title/77",[7,2.058,198,3.11,199,3.348,210,5.372]],["description/77",[229,6.917]],["title/78",[33,4.293,86,3.731,198,3.11,199,3.348]],["description/78",[230,6.917]],["title/79",[198,3.346,199,3.602,231,6.887]],["description/79",[232,6.917]],["title/80",[198,3.346,199,3.602,233,6.887]],["description/80",[234,6.917]],["title/81",[181,6.116]],["description/81",[15,1.633,114,3.06,115,2.748,145,2.886,181,2.748]],["title/82",[235,3.878]],["description/82",[8,0.898,15,1.321,17,1.719,92,1.342,235,1.409,236,2.664,237,2.95]],["title/83",[8,1.709,17,3.27,50,2.1,67,2.825,235,2.68,238,5.61]],["description/83",[235,3.304]],["title/84",[7,2.214,224,6.219,235,3.29]],["description/84",[235,3.304]],["title/85",[10,3.191,235,3.559]],["description/85",[239,6.917]],["title/86",[27,3.463,33,2.24,39,2.41,50,1.25,82,2.644,235,2.477,240,3.34,241,2.32,242,2.516,243,2.644,244,2.644,245,2.803,246,3.34,247,3.34]],["description/86",[248,6.917]],["title/87",[50,3.039]],["description/87",[0,1.651,4,1.988,50,1.008,67,1.356,116,2.431,198,1.308,249,2.431]],["title/88",[6,2.546,7,2.214,50,2.578]],["description/88",[50,2.589]],["title/89",[0,0.807,3,0.312,4,0.599,5,0.585,10,0.299,16,0.991,17,0.407,37,0.786,49,0.807,50,1.793,62,0.63,67,1.416,74,0.453,76,0.95,79,1.146,83,0.222,92,0.85,100,0.812,107,0.243,119,1.983,126,1.297,155,0.503,156,0.503,160,0.618,180,0.585,186,0.585,198,0.639,201,0.95,218,0.585,219,0.407,235,0.333,241,1.641,243,1.041,250,0.63,251,0.698,252,0.698,253,1.188,254,0.698,255,0.698,256,0.63,257,0.698,258,1.316,259,0.698,260,0.698,261,1.87,262,0.552,263,0.322,264,0.698,265,0.698,266,0.698,267,1.316,268,0.698,269,0.698,270,0.698,271,0.698,272,0.698,273,0.698,274,0.63,275,0.698,276,0.698,277,1.188,278,1.78,279,0.525,280,0.525,281,0.698,282,0.63,283,0.698,284,0.698,285,0.63,286,0.698,287,0.698,288,0.698]],["description/89",[50,2.589]],["title/90",[13,2.356,50,2.238,100,2.598,160,2.809,289,5.018]],["description/90",[290,6.246]],["title/91",[6,2.367,50,2.396,183,4.822,201,4.619]],["description/91",[290,6.246]],["title/92",[6,2.367,50,2.396,51,4.445,190,4.619]],["description/92",[291,6.917]],["title/93",[67,4.088]],["description/93",[4,1.342,50,1.104,67,2.368,236,2.664,279,2.222,292,2.222]],["title/94",[4,0.58,6,0.472,8,1.168,33,0.856,40,1.07,42,0.58,50,0.86,58,2.292,67,1.932,115,0.961,126,0.886,134,0.921,137,0.961,156,0.921,180,1.07,186,1.07,190,0.921,249,2.075,256,1.152,285,2.075,292,0.961,293,1.276,294,1.07,295,1.01,296,1.276,297,1.01,298,1.152,299,1.152,300,1.07,301,1.276,302,1.152,303,0.62,304,1.01,305,1.152,306,1.276,307,2.298,308,1.276,309,1.276,310,1.276,311,1.276,312,1.276,313,1.276,314,1.276,315,1.276,316,1.152,317,1.276,318,1.276,319,1.276]],["description/94",[67,3.483]],["title/95",[6,1.585,27,4.027,33,2.875,58,2.561,67,3.722,292,3.229,320,3.597]],["description/95",[321,6.917]],["title/96",[4,0.664,6,0.959,7,0.469,8,0.79,33,0.979,42,1.928,50,0.971,58,2.901,67,2.445,115,1.1,147,0.796,187,1.319,190,1.872,218,1.225,292,2.636,294,1.225,302,1.319,303,0.71,304,1.156,305,1.319,320,1.225,322,0.813,323,1.46,324,1.46,325,2.342,326,1.319,327,2.342,328,2.176,329,1.46,330,1.46,331,1.319,332,1.46]],["description/96",[333,6.917]],["title/97",[42,0.935,50,0.769,58,1.228,67,1.758,109,1.856,140,1.725,156,1.483,166,1.856,253,1.856,279,1.548,292,4.529,294,1.725,295,3.602,298,1.856,299,1.856,325,1.856,328,1.725,334,2.055,335,2.055,336,2.055,337,2.055,338,1.856,339,1.856,340,2.055,341,2.055,342,2.055,343,2.055]],["description/97",[344,6.917]],["title/98",[345,5.273]],["description/98",[3,1.109,21,1.247,48,1.609,49,1.519,106,1.379,151,1.72,345,2.651,346,2.078]],["title/99",[3,1.347,8,0.916,16,2.266,21,1.515,37,1.797,121,2.018,126,2.089,151,2.089,176,2.381,345,3.859,347,2.716,348,3.008,349,3.008,350,3.008,351,3.008,352,3.008,353,3.008,354,2.716]],["description/99",[2,0.549,4,1.058,17,0.522,37,0.535,59,0.751,67,0.451,119,1.395,132,0.646,137,0.675,143,0.809,282,0.809,345,1.889,355,0.809,356,0.895,357,0.895,358,1.316,359,1.663,360,0.895,361,0.895,362,0.895,363,0.895,364,0.895,365,0.895]],["title/100",[8,1.709,21,2.825,120,3.644,151,3.896,345,3.644,366,5.61]],["description/100",[367,6.917]],["title/101",[8,1.609,21,2.661,37,3.157,126,3.669,345,3.432,354,4.771,368,5.284]],["description/101",[369,6.917]],["title/102",[3,3.635]],["description/102",[3,1.461,7,1.049,82,2.581,92,1.484,250,2.945,370,3.262]],["title/103",[3,1.833,7,1.316,16,3.083,82,4.788,134,2.954,156,2.954,158,3.239,183,3.083,207,2.954,371,3.696,372,3.435]],["description/103",[3,3.098]],["title/104",[3,2.903,10,1.926,158,3.56,183,3.389,207,3.246,209,3.775,371,4.062,372,3.775,373,4.498]],["description/104",[374,6.246]],["title/105",[3,3.126,13,2.75,83,1.588,198,2.426,207,3.603,375,2.202]],["description/105",[374,6.246]],["title/106",[376,6.425]],["description/106",[21,1.154,47,1.654,49,2.348,345,1.489,346,1.924,377,2.07,378,2.292,379,2.07,380,2.07]],["title/107",[47,3.093,49,2.629,120,2.784,121,2.875,345,2.784,346,3.597,376,3.392,377,3.87,379,3.87,380,3.87,381,4.286]],["description/107",[376,5.474]],["title/108",[382,7.452,383,7.452]],["description/108",[7,0.948,83,0.938,191,1.916,245,2.475,263,1.363,322,1.642,384,2.664]],["title/109",[7,1.699,83,1.68,191,3.432,245,4.434,263,2.442,322,2.941,384,4.771]],["description/109",[385,6.917]],["title/110",[27,3.752,235,3.29,386,2.949]],["description/110",[27,2.253,235,1.976,386,1.771,387,4.136]],["title/111",[42,2.912,216,5.066,235,3.058,386,2.741]],["description/111",[42,1.659,216,2.886,235,1.742,386,1.562,388,3.647]],["title/112",[42,2.72,235,2.856,244,4.733,300,5.018,386,2.56]],["description/112",[42,1.484,235,1.558,244,2.581,300,2.737,386,1.397,389,3.262]],["title/113",[235,3.29,386,2.949,390,4.474]],["description/113",[235,1.976,386,1.771,390,2.687,391,4.136]],["title/114",[15,2.867,27,3.487,167,3.825,386,2.741]],["description/114",[15,1.633,27,1.987,167,2.179,386,1.562,392,3.647]],["title/115",[15,2.867,167,3.825,386,2.741,390,4.158]],["description/115",[15,1.633,167,2.179,386,1.562,390,2.369,393,3.647]],["title/116",[15,2.867,167,3.825,386,2.741,394,5.066]],["description/116",[15,1.633,167,2.179,386,1.562,394,2.886,395,3.647]],["title/117",[27,3.487,198,3.11,199,3.348,386,2.741]],["description/117",[27,1.987,198,1.772,199,1.908,386,1.562,396,3.647]],["title/118",[198,3.11,199,3.348,386,2.741,390,4.158]],["description/118",[198,1.772,199,1.908,386,1.562,390,2.369,397,3.647]],["title/119",[198,3.11,199,3.348,386,2.741,394,5.066]],["description/119",[198,1.772,199,1.908,386,1.562,394,2.886,398,3.647]],["title/120",[91,3.332,92,2.403,386,2.262,399,4.434,400,4.182,401,3.813,402,5.284]],["description/120",[2,1.651,91,1.698,92,1.225,386,1.153,399,2.259,400,2.131,401,1.943,403,2.692]],["title/121",[27,3.487,99,3.284,386,2.741,404,4.158]],["description/121",[27,1.987,99,1.871,386,1.562,404,2.369,405,3.647]],["title/122",[42,2.72,99,3.068,386,2.56,404,3.884,406,5.98]],["description/122",[42,1.484,99,1.674,386,1.397,404,2.119,407,3.262,408,3.262]],["title/123",[99,3.284,386,2.741,390,4.158,404,4.158]],["description/123",[99,1.871,386,1.562,390,2.369,404,2.369,409,3.647]],["title/124",[99,3.284,386,2.741,404,4.158,410,5.78]],["description/124",[99,1.871,386,1.562,404,2.369,410,3.293,411,3.647]],["title/125",[7,2.396,303,3.621]],["description/125",[7,1.535,303,3.287]],["title/126",[8,2.269,303,3.621]],["description/126",[8,1.454,303,3.287]],["title/127",[10,3.191,303,3.621]],["description/127",[10,2.045,303,2.321,412,4.313]],["title/128",[13,2.937,303,3.621]],["description/128",[13,1.882,303,2.321,412,4.313]],["title/129",[8,1.193,17,3.413,50,2.625,51,2.72,59,3.286,147,2.134,303,1.903,355,3.537,413,3.916,414,3.916]],["description/129",[8,1.26,50,1.548,303,2.01,415,3.735]],["title/130",[7,2.214,50,2.578,303,3.346]],["description/130",[7,1.33,50,1.548,303,2.01,415,3.735]],["title/131",[10,2.949,50,2.578,303,3.346]],["description/131",[10,1.771,50,1.548,303,2.01,416,3.735]],["title/132",[13,2.714,50,2.578,303,3.346]],["description/132",[13,1.63,50,1.548,303,2.01,416,3.735]],["title/133",[10,2.741,50,2.396,51,4.445,303,3.11]],["description/133",[10,1.562,50,1.365,51,2.533,303,1.772,417,3.647]],["title/134",[7,2.058,83,2.035,92,2.912,418,3.563]],["description/134",[7,0.866,10,1.153,83,0.856,92,1.225,205,1.87,418,1.499,419,2.431,420,2.431]],["title/135",[8,1.821,83,1.901,92,2.72,205,4.153,418,3.329]],["description/135",[8,0.898,83,0.938,92,1.342,106,1.642,418,1.642,420,2.664,421,2.95]],["title/136",[10,2.56,43,4.733,83,1.901,92,2.72,418,3.329]],["description/136",[83,0.938,92,1.342,147,1.607,201,2.129,219,1.719,418,1.642,422,2.664]],["title/137",[13,2.356,83,1.901,92,2.72,205,4.153,418,3.329]],["description/137",[13,1.285,92,1.484,190,2.354,205,2.265,418,1.816,422,2.945]],["title/138",[6,2.237,17,2.386,49,2.51,58,3.615,102,2.745,155,2.954,423,6.049,424,4.093,425,4.093]],["description/138",[426,6.917]],["title/139",[6,1.15,58,1.859,74,2.021,98,3.458,99,1.596,120,2.021,135,2.81,219,1.814,427,7.501,428,3.111,429,3.111,430,3.111,431,3.111]],["description/139",[432,6.917]],["title/140",[4,1.64,6,1.333,17,2.102,27,2.996,84,2.602,106,2.007,433,2.504,434,2.602,435,2.504,436,3.256,437,3.605,438,3.605,439,2.853,440,3.256]],["description/140",[441,6.917]],["title/141",[8,2.097,434,4.97,435,4.783]],["description/141",[442,6.917]],["title/142",[7,1.922,14,3.573,24,4.733,146,3.668,434,4.315]],["description/142",[443,6.917]],["title/143",[10,2.741,14,3.825,434,4.619,444,5.78]],["description/143",[445,6.246]],["title/144",[13,2.082,14,3.157,100,2.296,146,3.241,278,3.981,434,3.813,446,5.284]],["description/144",[445,6.246]],["title/145",[7,1.699,14,3.157,263,2.442,358,4.182,419,4.771,434,3.813,447,4.771]],["description/145",[448,6.917]],["title/146",[449,4.979]],["description/146",[]],["title/147",[7,2.058,67,3.224,83,2.035,449,3.926]],["description/147",[450,6.246]],["title/148",[67,3.151,83,1.99,241,2.977,433,2.977,449,4.533,451,4.286,452,4.286]],["description/148",[450,6.246]],["title/149",[83,1.363,241,2.977,242,3.229,433,4.346,449,3.838,453,3.392,454,3.392,455,3.392,456,3.392]],["description/149",[457,6.917]],["title/150",[83,1.363,241,2.977,242,3.229,449,3.838,453,3.392,454,3.392,455,3.392,456,3.392,458,5.651]],["description/150",[459,6.917]],["title/151",[67,2.661,83,1.68,433,3.669,449,4.452,460,5.284,461,4.771]],["description/151",[462,5.804]],["title/152",[12,4.975,132,4.315,221,5.4,449,3.668]],["description/152",[462,5.804]],["title/153",[13,2.082,83,2.308,107,1.839,449,4.452,463,5.284]],["description/153",[462,5.804]],["title/154",[7,2.214,107,2.397,449,4.224]],["description/154",[464,6.917]],["title/155",[107,1.492,241,2.977,242,3.229,433,4.346,449,3.838,453,3.392,454,3.392,455,3.392,456,3.392]],["description/155",[465,6.917]],["title/156",[107,1.492,241,2.977,242,3.229,449,3.838,453,3.392,454,3.392,455,3.392,456,3.392,458,5.651]],["description/156",[466,6.917]],["title/157",[467,5.273]],["description/157",[]],["title/158",[83,2.19,219,4.014,468,6.887]],["description/158",[469,6.917]],["title/159",[45,3.884,83,1.901,219,3.486,467,3.884,470,5.98]],["description/159",[471,6.917]],["title/160",[45,3.884,57,5.018,83,1.901,219,3.486,467,3.884]],["description/160",[472,6.917]],["title/161",[83,1.784,219,3.27,435,3.896,467,3.644,473,5.066,474,5.61]],["description/161",[475,6.917]],["title/162",[42,2.912,83,2.035,219,3.731,467,4.158]],["description/162",[476,6.917]],["title/163",[83,2.035,159,5.066,219,3.731,467,4.158]],["description/163",[477,6.917]],["title/164",[83,2.035,219,3.731,345,4.158,467,4.158]],["description/164",[478,6.917]],["title/165",[83,2.035,219,3.731,376,5.066,467,4.158]],["description/165",[479,6.917]],["title/166",[83,1.901,100,2.598,160,2.809,219,3.486,467,3.884]],["description/166",[480,6.917]],["title/167",[481,4.165]],["description/167",[]],["title/168",[7,2.214,83,2.19,481,3.533]],["description/168",[482,6.246]],["title/169",[8,1.949,83,2.035,106,3.563,481,3.284]],["description/169",[482,6.246]],["title/170",[86,4.014,183,5.188,483,6.219]],["description/170",[484,6.246]],["title/171",[13,2.714,83,2.19,481,3.533]],["description/171",[484,6.246]],["title/172",[83,2.035,375,2.823,481,3.284,485,3.731]],["description/172",[]],["title/173",[7,1.699,83,2.308,322,2.941,375,2.33,481,2.711,485,3.08]],["description/173",[486,6.246]],["title/174",[83,2.404,322,3.123,375,2.474,481,2.879,485,3.27]],["description/174",[486,6.246]],["title/175",[83,2.404,322,3.123,375,2.474,481,2.879,487,4.44]],["description/175",[488,6.917]],["title/176",[263,3.444,481,3.823]],["description/176",[]],["title/177",[7,2.058,263,2.958,481,3.284,485,3.731]],["description/177",[489,6.246]],["title/178",[263,3.183,295,5.45,481,3.533]],["description/178",[489,6.246]],["title/179",[263,3.183,289,5.779,481,3.533]],["description/179",[490,6.917]],["title/180",[491,6.116]],["description/180",[]],["title/181",[6,2.367,7,2.058,83,2.035,491,4.822]],["description/181",[492,6.246]],["title/182",[8,1.37,83,2.061,244,3.56,263,2.995,297,3.56,491,4.883,493,3.389]],["description/182",[492,6.246]],["title/183",[10,3.191,491,5.614]],["description/183",[494,6.246]],["title/184",[13,2.979,297,4.44,491,5.696,495,5.066]],["description/184",[494,6.246]],["title/185",[107,2.826]],["description/185",[]],["title/186",[6,2.546,7,2.214,107,2.397]],["description/186",[496,6.246]],["title/187",[8,2.126,13,1.968,83,1.588,106,2.78,107,2.43,497,3.952]],["description/187",[496,6.246]],["title/188",[10,3.191,107,2.594]],["description/188",[498,6.246]],["title/189",[12,4.343,83,2.19,107,2.397]],["description/189",[498,6.246]],["title/190",[6,2.211,7,1.922,92,2.72,107,2.082,418,3.329]],["description/190",[499,6.917]],["title/191",[10,2.741,92,2.912,107,2.228,418,3.563]],["description/191",[500,6.246]],["title/192",[6,1.448,13,2.307,24,3.1,92,1.781,107,1.363,418,3.903,501,3.286,502,3.286,503,2.95,504,2.95]],["description/192",[500,6.246]],["title/193",[4,2.403,83,1.68,86,3.08,107,2.527,497,5.745]],["description/193",[505,6.917]],["title/194",[3,2.512,6,2.074,79,3.441,107,1.953,261,4.44,506,4.44]],["description/194",[507,6.917]],["title/195",[79,3.926,86,3.731,107,2.228,506,5.066]],["description/195",[508,6.917]],["title/196",[6,2.211,7,1.922,107,2.082,503,4.505,504,4.505]],["description/196",[509,6.246]],["title/197",[6,1.585,8,1.305,92,1.95,106,2.386,107,1.492,418,2.386,503,4.714,504,4.714,510,4.286]],["description/197",[509,6.246]],["title/198",[10,2.741,107,2.228,503,4.822,504,4.822]],["description/198",[511,6.246]],["title/199",[6,1.282,13,2.104,107,2.266,497,4.225,501,2.91,502,2.91,503,4.903,504,4.903]],["description/199",[511,6.246]],["title/200",[6,2.367,7,2.058,107,2.228,263,2.958]],["description/200",[512,6.246]],["title/201",[83,1.505,107,2.34,263,3.106,295,3.746,320,3.972,495,4.274,513,4.733]],["description/201",[512,6.246]],["title/202",[10,2.949,107,2.397,263,3.183]],["description/202",[514,5.804]],["title/203",[12,4.037,107,2.228,375,2.823,515,5.78]],["description/203",[514,5.804]],["title/204",[6,1.388,13,2.235,107,2.651,263,3.159,497,4.489,501,3.151,502,3.151]],["description/204",[514,5.804]],["title/205",[107,2.594,481,3.823]],["description/205",[]],["title/206",[7,2.058,107,2.228,481,3.284,493,4.822]],["description/206",[516,6.246]],["title/207",[107,2.228,481,3.284,493,4.822,517,5.78]],["description/207",[516,6.246]],["title/208",[107,2.228,483,5.78,493,4.822,518,6.401]],["description/208",[519,6.917]],["title/209",[375,3.58]],["description/209",[]],["title/210",[7,2.058,83,2.035,191,4.158,375,2.823]],["description/210",[520,6.246]],["title/211",[8,1.949,73,3.731,83,2.035,375,2.823]],["description/211",[520,6.246]],["title/212",[83,2.035,86,3.731,375,2.823,521,5.372]],["description/212",[522,6.246]],["title/213",[13,2.523,73,3.731,83,2.035,375,2.823]],["description/213",[522,6.246]],["title/214",[7,2.058,107,2.228,191,4.158,375,2.823]],["description/214",[523,6.246]],["title/215",[8,1.949,73,3.731,107,2.228,375,2.823]],["description/215",[523,6.246]],["title/216",[86,3.731,107,2.228,375,2.823,521,5.372]],["description/216",[524,6.246]],["title/217",[13,2.523,73,3.731,107,2.228,375,2.823]],["description/217",[524,6.246]],["title/218",[263,3.752]],["description/218",[]],["title/219",[7,2.214,83,2.19,263,3.183]],["description/219",[525,6.917]],["title/220",[10,2.949,263,3.183,444,6.219]],["description/220",[526,5.804]],["title/221",[12,4.037,83,2.035,375,2.823,515,5.78]],["description/221",[526,5.804]],["title/222",[13,2.714,83,2.19,263,3.183]],["description/222",[526,5.804]],["title/223",[83,2.035,263,2.958,375,2.823,485,3.731]],["description/223",[]],["title/224",[7,1.699,83,2.308,263,2.442,322,2.941,375,2.33,485,3.08]],["description/224",[527,6.246]],["title/225",[83,2.404,263,2.593,322,3.123,375,2.474,485,3.27]],["description/225",[527,6.246]],["title/226",[83,2.404,263,2.593,322,3.123,375,2.474,487,4.44]],["description/226",[528,6.917]],["title/227",[107,2.228,375,2.823,481,3.284,485,3.731]],["description/227",[]],["title/228",[7,1.699,107,2.527,322,2.941,375,2.33,481,2.711,485,3.08]],["description/228",[529,6.246]],["title/229",[107,2.632,322,3.123,375,2.474,481,2.879,485,3.27]],["description/229",[529,6.246]],["title/230",[107,2.632,322,3.123,375,2.474,481,2.879,487,4.44]],["description/230",[530,6.917]],["title/231",[107,2.228,263,2.958,375,2.823,485,3.731]],["description/231",[]],["title/232",[7,1.699,107,2.527,263,2.442,322,2.941,375,2.33,485,3.08]],["description/232",[531,6.246]],["title/233",[107,2.632,263,2.593,322,3.123,375,2.474,485,3.27]],["description/233",[531,6.246]],["title/234",[107,2.632,263,2.593,322,3.123,375,2.474,487,4.44]],["description/234",[532,6.917]],["title/235",[91,5.119]],["description/235",[]],["title/236",[2,2.303,8,1.143,42,1.708,91,2.368,92,1.708,106,2.09,277,3.39,399,3.151,533,3.151,534,3.39,535,3.754,536,3.754,537,3.754,538,3.39]],["description/236",[539,6.917]],["title/237",[2,3.063,91,3.149,191,3.244,297,3.952,400,3.952,401,3.603,435,3.468,540,4.993]],["description/237",[541,6.917]],["title/238",[2,2.759,91,2.837,92,2.046,331,4.062,401,3.246,433,3.124,461,4.062,533,3.775,534,4.062,542,4.498]],["description/238",[543,6.917]],["title/239",[2,2.759,4,2.046,106,2.504,137,3.389,401,4.677,433,3.124,544,4.498,545,4.498,546,4.498]],["description/239",[547,6.917]],["title/240",[2,2.903,6,1.75,33,3.174,400,3.746,401,4.85,473,4.274,548,4.733,549,4.733]],["description/240",[550,6.917]],["title/241",[4,0.528,6,0.429,8,0.884,58,0.694,73,0.677,91,1.331,92,0.96,120,0.754,121,0.779,155,0.838,156,0.838,191,1.885,262,0.919,278,0.875,326,1.049,358,0.919,372,0.975,418,0.647,435,2.481,439,5.05,440,4.931,493,0.875,517,1.049,533,0.975,538,1.049,551,1.161,552,1.161,553,1.161,554,1.049,555,1.161,556,1.161,557,1.161,558,1.161,559,1.161,560,1.161,561,1.161,562,1.161,563,1.161,564,1.161,565,1.161,566,1.161,567,1.161]],["description/241",[568,6.917]],["title/242",[4,1.4,6,0.656,8,0.937,53,1.404,58,1.839,91,2.569,92,2.212,101,1.088,155,2.221,191,1.152,262,1.404,280,1.336,303,0.862,304,1.404,418,1.713,435,2.83,439,2.435,569,3.68,570,1.602,571,1.602,572,1.774,573,1.602,574,2.779,575,1.602,576,1.602]],["description/242",[577,6.917]],["title/243",[4,1.311,6,0.608,8,0.878,53,1.302,57,2.418,58,1.722,91,2.911,92,2.1,101,1.009,155,2.08,191,1.069,201,1.187,262,1.302,280,1.24,303,0.8,304,1.302,418,1.604,435,2.67,439,2.281,569,3.472,570,1.486,571,1.486,573,1.486,574,2.602,575,1.486,576,1.486,578,1.645]],["description/243",[579,6.917]],["title/244",[99,4.165]],["description/244",[]],["title/245",[2,1.498,3,1.807,4,1.835,8,0.744,39,1.762,48,1.586,49,2.474,50,0.914,73,1.423,99,2.07,158,1.933,171,2.205,175,1.933,554,2.205,580,4.034,581,2.442,582,2.442,583,2.442,584,2.442,585,2.442,586,2.442,587,2.442]],["description/245",[99,3.549]],["title/246",[3,2.678,10,2.56,21,3.011,99,3.068,147,3.258]],["description/246",[588,6.246]],["title/247",[3,2.678,13,2.356,21,3.011,99,3.068,147,3.258]],["description/247",[588,6.246]],["title/248",[3,1.681,8,1.143,21,1.891,27,3.09,99,2.91,101,2.303,102,2.518,103,2.709,120,2.439,147,2.045,404,2.439,589,3.754]],["description/248",[590,6.917]],["title/249",[6,2.074,7,1.804,21,2.825,49,3.441,99,2.879,146,3.441]],["description/249",[591,6.917]],["title/250",[100,3.238,160,3.501]],["description/250",[]],["title/251",[6,2.367,7,2.058,100,2.781,160,3.007]],["description/251",[592,6.246]],["title/252",[8,2.097,100,2.992,160,3.235]],["description/252",[592,6.246]],["title/253",[10,2.949,100,2.992,160,3.235]],["description/253",[593,5.804]],["title/254",[12,4.343,100,2.992,160,3.235]],["description/254",[593,5.804]],["title/255",[13,2.714,100,2.992,160,3.235]],["description/255",[593,5.804]],["title/256",[8,1.821,50,2.238,100,2.598,160,2.809,235,2.856]],["description/256",[17,1.261,37,0.919,43,0.652,50,0.81,79,0.505,100,0.94,108,0.744,160,1.016,235,0.735,243,0.652,261,1.217,274,0.744,278,0.621,279,0.621,280,0.621,327,0.744,338,0.744,506,0.652,594,0.824,595,0.744,596,0.824,597,0.691,598,0.744]],["title/257",[10,2.56,50,2.238,100,2.598,160,2.809,235,2.856]],["description/257",[599,6.917]],["title/258",[27,3.296,50,2.265,100,1.778,160,1.923,216,3.239,235,2.89,339,3.696,600,4.093,601,4.093]],["description/258",[602,6.917]],["title/259",[6,2.074,7,1.804,50,2.1,100,2.438,160,2.635,235,2.68]],["description/259",[603,6.917]],["title/260",[6,2.211,7,1.922,50,2.238,100,2.598,160,2.809]],["description/260",[597,5.804]],["title/261",[8,1.521,50,1.869,100,2.17,160,3.279,278,3.762,604,4.993,605,4.993]],["description/261",[4,0.476,17,1.12,37,1.148,50,0.719,67,0.528,79,0.642,100,0.455,160,0.492,213,0.946,235,0.5,243,0.829,261,0.829,279,0.789,280,0.789,506,0.829,595,0.946,597,0.879,598,0.946,606,1.047,607,1.047,608,1.047,609,1.047,610,1.047]],["title/262",[10,2.741,50,2.396,100,2.781,160,3.007]],["description/262",[611,5.804]],["title/263",[4,1.519,13,2.824,37,1.996,50,2.682,100,2.253,160,2.436,289,2.803,612,3.34,613,3.34]],["description/263",[611,5.804]],["title/264",[50,2.238,86,3.486,100,2.598,160,2.809,614,5.4]],["description/264",[611,5.804]],["title/265",[10,2.402,50,2.1,51,3.896,100,2.438,160,2.635,615,5.61]],["description/265",[616,6.917]],["title/266",[50,1.684,100,1.955,140,3.775,160,2.113,447,4.062,614,4.062,617,4.498,618,4.498,619,4.498,620,4.498]],["description/266",[621,6.917]],["title/267",[622,4.85]],["description/267",[]],["title/268",[8,1.441,48,3.075,106,2.635,137,3.566,151,3.287,199,2.476,358,3.746,622,2.828,623,3.972]],["description/268",[622,4.133]],["title/269",[7,1.804,48,3.644,107,1.953,134,4.049,436,5.066,622,3.352]],["description/269",[622,4.133]],["title/270",[8,1.949,67,3.224,622,3.825,624,5.78]],["description/270",[625,6.917]],["title/271",[624,6.729,626,6.729]],["description/271",[627,6.917]],["title/272",[8,1.305,48,4.065,106,2.386,176,3.392,199,2.242,347,3.87,521,3.597,622,4.416]],["description/272",[628,6.917]],["title/273",[8,1.949,42,2.912,316,5.78,622,3.825]],["description/273",[629,6.917]],["title/274",[48,3.884,84,4.315,113,5.4,622,3.573,626,5.4]],["description/274",[630,6.246]],["title/275",[13,2.082,42,2.403,100,2.296,390,3.432,622,3.157,623,4.434,631,5.284]],["description/275",[630,6.246]],["title/276",[48,2.439,51,2.607,52,2.828,190,2.709,199,1.964,328,3.151,622,4.084,623,3.151,632,3.151,633,3.754,634,3.754,635,3.754]],["description/276",[636,6.917]],["title/277",[4,2.403,8,1.609,42,2.403,151,3.669,622,3.157,637,5.284,638,5.284]],["description/277",[639,6.917]],["title/278",[640,4.622]],["description/278",[]],["title/279",[8,2.097,106,3.834,640,3.921]],["description/279",[640,3.938]],["title/280",[7,2.058,107,2.228,134,4.619,640,3.644]],["description/280",[640,3.938]],["title/281",[13,2.714,147,3.752,640,3.921]],["description/281",[641,5.804]],["title/282",[147,4.06,640,4.243]],["description/282",[641,5.804]],["title/283",[86,3.486,640,3.404,642,5.98,643,4.315,644,5.98]],["description/283",[641,5.804]],["title/284",[147,3.258,632,5.018,640,3.404,645,5.4,646,5.4]],["description/284",[647,6.917]],["title/285",[8,1.821,106,3.329,640,3.404,643,4.315,648,5.98]],["description/285",[649,6.246]],["title/286",[7,2.058,640,4.695,643,4.619]],["description/286",[649,6.246]],["title/287",[201,4.97,640,3.921,643,4.97]],["description/287",[650,6.246]],["title/288",[13,2.714,640,3.921,643,4.97]],["description/288",[650,6.246]],["title/289",[632,5.018,640,3.404,643,4.315,645,5.4,646,5.4]],["description/289",[651,6.917]]],"invertedIndex":[["",{"_index":119,"title":{"36":{},"89":{}},"description":{"99":{}}}],["1,000",{"_index":260,"title":{"89":{}},"description":{}}],["10",{"_index":242,"title":{"86":{},"149":{},"150":{},"155":{},"156":{}},"description":{}}],["2",{"_index":264,"title":{"89":{}},"description":{}}],["2,000",{"_index":284,"title":{"89":{}},"description":{}}],["2.5",{"_index":254,"title":{"89":{}},"description":{}}],["200",{"_index":270,"title":{"89":{}},"description":{}}],["2000",{"_index":594,"title":{},"description":{"256":{}}}],["300",{"_index":595,"title":{},"description":{"256":{},"261":{}}}],["50",{"_index":452,"title":{"148":{}},"description":{}}],["512",{"_index":252,"title":{"89":{}},"description":{}}],["64",{"_index":335,"title":{"97":{}},"description":{}}],["8",{"_index":298,"title":{"94":{},"97":{}},"description":{}}],["accept",{"_index":297,"title":{"94":{},"182":{},"184":{},"237":{}},"description":{}}],["access",{"_index":493,"title":{"182":{},"206":{},"207":{},"208":{},"241":{}},"description":{}}],["account",{"_index":504,"title":{"192":{},"196":{},"197":{},"198":{},"199":{}},"description":{}}],["action",{"_index":384,"title":{"109":{}},"description":{"108":{}}}],["activ",{"_index":433,"title":{"140":{},"148":{},"149":{},"151":{},"155":{},"238":{},"239":{}},"description":{}}],["ad",{"_index":320,"title":{"95":{},"96":{},"201":{}},"description":{}}],["add",{"_index":295,"title":{"94":{},"97":{},"178":{},"201":{}},"description":{}}],["addit",{"_index":332,"title":{"96":{}},"description":{}}],["admin",{"_index":205,"title":{"70":{},"71":{},"72":{},"135":{},"137":{}},"description":{"134":{},"137":{}}}],["admin-level",{"_index":421,"title":{},"description":{"135":{}}}],["advanced)](/docs/guides/conversation-state#compaction-advanc",{"_index":431,"title":{"139":{}},"description":{}}],["advantag",{"_index":112,"title":{"36":{}},"description":{}}],["against",{"_index":193,"title":{"61":{}},"description":{}}],["algorithm",{"_index":165,"title":{},"description":{"52":{}}}],["along",{"_index":446,"title":{"144":{}},"description":{}}],["alreadi",{"_index":495,"title":{"184":{},"201":{}},"description":{}}],["altern",{"_index":154,"title":{},"description":{"50":{}}}],["and/or",{"_index":346,"title":{"107":{}},"description":{"98":{},"106":{}}}],["answer",{"_index":536,"title":{"236":{}},"description":{}}],["api",{"_index":92,"title":{"70":{},"71":{},"72":{},"89":{},"120":{},"134":{},"135":{},"136":{},"137":{},"190":{},"191":{},"192":{},"197":{},"236":{},"238":{},"241":{},"242":{},"243":{}},"description":{"33":{},"82":{},"102":{},"120":{},"134":{},"135":{},"136":{},"137":{}}}],["app",{"_index":553,"title":{"241":{}},"description":{}}],["appli",{"_index":561,"title":{"241":{}},"description":{}}],["applic",{"_index":571,"title":{"242":{},"243":{}},"description":{}}],["application/json",{"_index":360,"title":{},"description":{"99":{}}}],["archiv",{"_index":497,"title":{"187":{},"193":{},"199":{},"204":{}},"description":{}}],["array",{"_index":363,"title":{},"description":{"99":{}}}],["asset",{"_index":623,"title":{"268":{},"275":{},"276":{}},"description":{}}],["assign",{"_index":485,"title":{"172":{},"173":{},"174":{},"177":{},"223":{},"224":{},"225":{},"227":{},"228":{},"229":{},"231":{},"232":{},"233":{}},"description":{}}],["assist",{"_index":0,"title":{"0":{},"1":{},"2":{},"3":{},"4":{},"5":{},"89":{}},"description":{"0":{},"1":{},"2":{},"87":{}}}],["assistants/{assistant_id",{"_index":11,"title":{},"description":{"3":{},"4":{},"5":{}}}],["associ",{"_index":551,"title":{"241":{}},"description":{}}],["asynchron",{"_index":237,"title":{},"description":{"82":{}}}],["atom",{"_index":454,"title":{"149":{},"150":{},"155":{},"156":{}},"description":{}}],["attach",{"_index":278,"title":{"89":{},"144":{},"241":{},"261":{}},"description":{"256":{}}}],["attempt",{"_index":600,"title":{"258":{}},"description":{}}],["attribut",{"_index":614,"title":{"264":{},"266":{}},"description":{}}],["audio",{"_index":45,"title":{"24":{},"25":{},"26":{},"27":{},"159":{},"160":{}},"description":{"24":{},"31":{},"33":{}}}],["audio/speech",{"_index":54,"title":{},"description":{"25":{}}}],["audio/transcript",{"_index":63,"title":{},"description":{"26":{}}}],["audio/transl",{"_index":66,"title":{},"description":{"27":{}}}],["audio/voic",{"_index":95,"title":{},"description":{"33":{}}}],["audio/voice_cons",{"_index":81,"title":{},"description":{"28":{},"29":{}}}],["audio/voice_consents/{consent_id",{"_index":85,"title":{},"description":{"30":{},"31":{},"32":{}}}],["audio](/docs/guides/audio",{"_index":124,"title":{"36":{}},"description":{}}],["audit",{"_index":382,"title":{"108":{}},"description":{}}],["authent",{"_index":262,"title":{"89":{},"241":{},"242":{},"243":{}},"description":{}}],["author",{"_index":71,"title":{},"description":{"28":{}}}],["automat",{"_index":451,"title":{"148":{}},"description":{}}],["avail",{"_index":82,"title":{"86":{},"103":{}},"description":{"29":{},"102":{}}}],["background",{"_index":404,"title":{"121":{},"122":{},"123":{},"124":{},"248":{}},"description":{"121":{},"122":{},"123":{},"124":{}}}],["base",{"_index":619,"title":{"266":{}},"description":{}}],["basic",{"_index":371,"title":{"103":{},"104":{}},"description":{}}],["batch",{"_index":235,"title":{"82":{},"83":{},"84":{},"85":{},"86":{},"89":{},"110":{},"111":{},"112":{},"113":{},"256":{},"257":{},"258":{},"259":{}},"description":{"82":{},"83":{},"84":{},"110":{},"111":{},"112":{},"113":{},"256":{},"261":{}}}],["batch_cancel",{"_index":387,"title":{},"description":{"110":{}}}],["batch_complet",{"_index":388,"title":{},"description":{"111":{}}}],["batch_expir",{"_index":389,"title":{},"description":{"112":{}}}],["batch_fail",{"_index":391,"title":{},"description":{"113":{}}}],["batches/{batch_id",{"_index":239,"title":{},"description":{"85":{}}}],["batches/{batch_id}/cancel",{"_index":248,"title":{},"description":{"86":{}}}],["befor",{"_index":244,"title":{"86":{},"112":{},"182":{}},"description":{"112":{}}}],["begin",{"_index":215,"title":{"73":{}},"description":{}}],["belong",{"_index":24,"title":{"16":{},"21":{},"142":{},"192":{}},"description":{}}],["below",{"_index":133,"title":{"36":{}},"description":{}}],["best",{"_index":77,"title":{},"description":{"28":{},"33":{}}}],["binari",{"_index":356,"title":{},"description":{"99":{}}}],["both",{"_index":596,"title":{},"description":{"256":{}}}],["browser",{"_index":576,"title":{"242":{},"243":{}},"description":{}}],["build",{"_index":1,"title":{},"description":{"0":{}}}],["built-in",{"_index":584,"title":{"245":{}},"description":{}}],["bundl",{"_index":646,"title":{"284":{},"289":{}},"description":{}}],["byte",{"_index":328,"title":{"96":{},"97":{},"276":{}},"description":{}}],["cal",{"_index":402,"title":{"120":{}},"description":{}}],["call",{"_index":2,"title":{"23":{},"71":{},"236":{},"237":{},"238":{},"239":{},"240":{},"245":{}},"description":{"0":{},"99":{},"120":{}}}],["caller",{"_index":549,"title":{"240":{}},"description":{}}],["cancel",{"_index":27,"title":{"20":{},"63":{},"76":{},"86":{},"95":{},"110":{},"114":{},"117":{},"121":{},"140":{},"248":{},"258":{}},"description":{"110":{},"114":{},"117":{},"121":{}}}],["case](/docs/assistants/tools/file-search#supported-fil",{"_index":312,"title":{"94":{}},"description":{}}],["certain",{"_index":186,"title":{"58":{},"89":{},"94":{}},"description":{}}],["certif",{"_index":449,"title":{"146":{},"147":{},"148":{},"149":{},"150":{},"151":{},"152":{},"153":{},"154":{},"155":{},"156":{}},"description":{}}],["chang",{"_index":245,"title":{"86":{},"109":{}},"description":{"108":{}}}],["charact",{"_index":624,"title":{"270":{},"271":{}},"description":{}}],["chat",{"_index":96,"title":{"34":{},"35":{},"36":{},"37":{},"38":{},"39":{},"40":{}},"description":{}}],["chat/complet",{"_index":104,"title":{},"description":{"35":{},"36":{}}}],["chat/completions/{completion_id",{"_index":141,"title":{},"description":{"37":{},"38":{},"39":{}}}],["chat/completions/{completion_id}/messag",{"_index":144,"title":{},"description":{"40":{}}}],["chat](/docs/api-reference/fine-tuning/chat-input",{"_index":268,"title":{"89":{}},"description":{}}],["chatgpt-image-latest",{"_index":353,"title":{"99":{}},"description":{}}],["chatkit",{"_index":434,"title":{"140":{},"141":{},"142":{},"143":{},"144":{},"145":{}},"description":{}}],["chatkit/sess",{"_index":442,"title":{},"description":{"141":{}}}],["chatkit/sessions/{session_id}/cancel",{"_index":441,"title":{},"description":{"140":{}}}],["chatkit/thread",{"_index":448,"title":{},"description":{"145":{}}}],["chatkit/threads/{thread_id",{"_index":445,"title":{},"description":{"143":{},"144":{}}}],["chatkit/threads/{thread_id}/item",{"_index":443,"title":{},"description":{"142":{}}}],["checkpoint",{"_index":210,"title":{"70":{},"72":{},"77":{}},"description":{}}],["chunk",{"_index":140,"title":{"36":{},"97":{},"266":{}},"description":{}}],["classifi",{"_index":377,"title":{"107":{}},"description":{"106":{}}}],["client",{"_index":439,"title":{"140":{},"241":{},"242":{},"243":{}},"description":{}}],["client-sid",{"_index":570,"title":{"242":{},"243":{}},"description":{}}],["client_secret",{"_index":575,"title":{"242":{},"243":{}},"description":{}}],["code",{"_index":473,"title":{"161":{},"240":{}},"description":{}}],["code](/docs/guides/function-cal",{"_index":583,"title":{"245":{}},"description":{}}],["compact",{"_index":427,"title":{"139":{}},"description":{}}],["compar",{"_index":117,"title":{"36":{}},"description":{}}],["complet",{"_index":42,"title":{"23":{},"35":{},"36":{},"37":{},"38":{},"39":{},"40":{},"50":{},"51":{},"73":{},"94":{},"96":{},"97":{},"111":{},"112":{},"122":{},"162":{},"236":{},"273":{},"275":{},"277":{}},"description":{"50":{},"51":{},"111":{},"112":{},"122":{}}}],["completions](/docs/api-reference/fine-tuning/completions-input",{"_index":269,"title":{"89":{}},"description":{}}],["compris",{"_index":97,"title":{},"description":{"34":{}}}],["config",{"_index":174,"title":{"56":{},"61":{}},"description":{}}],["configur",{"_index":191,"title":{"61":{},"109":{},"210":{},"214":{},"237":{},"241":{},"242":{},"243":{}},"description":{"108":{}}}],["confirm",{"_index":501,"title":{"192":{},"199":{},"204":{}},"description":{}}],["connect",{"_index":538,"title":{"236":{},"241":{}},"description":{}}],["consent",{"_index":69,"title":{"28":{},"29":{},"30":{},"31":{},"32":{}},"description":{"28":{},"29":{},"30":{},"31":{},"32":{},"33":{}}}],["consum",{"_index":163,"title":{},"description":{"52":{}}}],["contact",{"_index":286,"title":{"89":{}},"description":{}}],["contain",{"_index":303,"title":{"94":{},"96":{},"125":{},"126":{},"127":{},"128":{},"129":{},"130":{},"131":{},"132":{},"133":{},"242":{},"243":{}},"description":{"125":{},"126":{},"127":{},"128":{},"129":{},"130":{},"131":{},"132":{},"133":{}}}],["containers/{container_id",{"_index":412,"title":{},"description":{"127":{},"128":{}}}],["containers/{container_id}/fil",{"_index":415,"title":{},"description":{"129":{},"130":{}}}],["containers/{container_id}/files/{file_id",{"_index":416,"title":{},"description":{"131":{},"132":{}}}],["containers/{container_id}/files/{file_id}/cont",{"_index":417,"title":{},"description":{"133":{}}}],["content",{"_index":51,"title":{"25":{},"92":{},"129":{},"133":{},"265":{},"276":{}},"description":{"133":{}}}],["convers",{"_index":98,"title":{"36":{},"41":{},"42":{},"43":{},"44":{},"45":{},"46":{},"47":{},"48":{},"49":{},"139":{}},"description":{"34":{},"41":{},"46":{}}}],["conversations/{conversation_id",{"_index":150,"title":{},"description":{"47":{},"48":{},"49":{}}}],["conversations/{conversation_id}/item",{"_index":148,"title":{},"description":{"42":{},"43":{}}}],["conversations/{conversation_id}/items/{item_id",{"_index":149,"title":{},"description":{"44":{},"45":{}}}],["correct",{"_index":309,"title":{"94":{}},"description":{}}],["cost",{"_index":468,"title":{"158":{}},"description":{}}],["count",{"_index":423,"title":{"138":{}},"description":{}}],["creat",{"_index":8,"title":{"2":{},"6":{},"7":{},"12":{},"17":{},"33":{},"36":{},"37":{},"38":{},"39":{},"40":{},"42":{},"46":{},"51":{},"53":{},"56":{},"73":{},"83":{},"94":{},"96":{},"99":{},"100":{},"101":{},"126":{},"129":{},"135":{},"141":{},"169":{},"182":{},"187":{},"197":{},"211":{},"215":{},"236":{},"241":{},"242":{},"243":{},"245":{},"248":{},"252":{},"256":{},"261":{},"268":{},"270":{},"272":{},"273":{},"277":{},"279":{},"285":{}},"description":{"29":{},"30":{},"31":{},"32":{},"33":{},"82":{},"126":{},"129":{},"135":{}}}],["creation",{"_index":72,"title":{},"description":{"28":{}}}],["criteria",{"_index":173,"title":{"56":{}},"description":{}}],["current",{"_index":134,"title":{"36":{},"38":{},"94":{},"103":{},"269":{},"280":{}},"description":{}}],["custom",{"_index":73,"title":{"33":{},"211":{},"213":{},"215":{},"217":{},"241":{},"245":{}},"description":{"28":{},"29":{},"30":{},"31":{},"32":{},"33":{}}}],["dall-e-2",{"_index":354,"title":{"99":{},"101":{}},"description":{}}],["data",{"_index":175,"title":{"56":{},"61":{},"245":{}},"description":{"67":{}}}],["dataset",{"_index":217,"title":{"73":{}},"description":{}}],["datasourc",{"_index":182,"title":{"56":{},"61":{}},"description":{}}],["deactiv",{"_index":458,"title":{"150":{},"156":{}},"description":{}}],["decid",{"_index":341,"title":{"97":{}},"description":{}}],["declin",{"_index":548,"title":{"240":{}},"description":{}}],["default",{"_index":642,"title":{"283":{}},"description":{}}],["delet",{"_index":13,"title":{"5":{},"10":{},"15":{},"32":{},"39":{},"45":{},"48":{},"59":{},"64":{},"72":{},"90":{},"105":{},"128":{},"132":{},"137":{},"144":{},"153":{},"171":{},"184":{},"187":{},"192":{},"199":{},"204":{},"213":{},"217":{},"222":{},"247":{},"255":{},"263":{},"275":{},"281":{},"288":{}},"description":{"32":{},"128":{},"132":{},"137":{}}}],["depend",{"_index":128,"title":{"36":{}},"description":{}}],["deriv",{"_index":633,"title":{"276":{}},"description":{}}],["describ",{"_index":370,"title":{},"description":{"102":{}}}],["destin",{"_index":545,"title":{"239":{}},"description":{}}],["detail",{"_index":219,"title":{"73":{},"89":{},"139":{},"158":{},"159":{},"160":{},"161":{},"162":{},"163":{},"164":{},"165":{},"166":{}},"description":{"136":{}}}],["diarized_json",{"_index":60,"title":{"26":{}},"description":{}}],["dictat",{"_index":177,"title":{"56":{}},"description":{}}],["differ",{"_index":127,"title":{"36":{},"56":{}},"description":{}}],["document",{"_index":249,"title":{"94":{}},"description":{"87":{}}}],["download",{"_index":632,"title":{"276":{},"284":{},"289":{}},"description":{}}],["each",{"_index":156,"title":{"89":{},"94":{},"97":{},"103":{},"241":{}},"description":{"50":{}}}],["easili",{"_index":162,"title":{},"description":{"52":{}}}],["edit",{"_index":347,"title":{"99":{},"272":{}},"description":{}}],["effect",{"_index":564,"title":{"241":{}},"description":{}}],["ek_1234",{"_index":567,"title":{"241":{}},"description":{}}],["elig",{"_index":80,"title":{},"description":{"28":{},"29":{},"30":{},"31":{},"32":{},"33":{}}}],["embed",{"_index":159,"title":{"52":{},"53":{},"163":{}},"description":{"53":{}}}],["enabl",{"_index":212,"title":{"71":{}},"description":{}}],["end",{"_index":542,"title":{"238":{}},"description":{}}],["endpoint",{"_index":37,"title":{"23":{},"70":{},"71":{},"72":{},"89":{},"99":{},"101":{},"263":{}},"description":{"31":{},"99":{},"256":{},"261":{}}}],["english",{"_index":65,"title":{"27":{}},"description":{}}],["enqueu",{"_index":220,"title":{"73":{}},"description":{}}],["ephemer",{"_index":569,"title":{"242":{},"243":{}},"description":{}}],["error",{"_index":502,"title":{"192":{},"199":{},"204":{}},"description":{}}],["eval",{"_index":167,"title":{"54":{},"56":{},"64":{},"114":{},"115":{},"116":{}},"description":{"54":{},"55":{},"56":{},"114":{},"115":{},"116":{}}}],["eval_run_cancel",{"_index":392,"title":{},"description":{"114":{}}}],["eval_run_fail",{"_index":393,"title":{},"description":{"115":{}}}],["eval_run_succeed",{"_index":395,"title":{},"description":{"116":{}}}],["evals/{eval_id",{"_index":185,"title":{},"description":{"57":{},"58":{},"59":{}}}],["evals/{eval_id}/run",{"_index":188,"title":{},"description":{"60":{},"61":{}}}],["evals/{eval_id}/runs/{run_id",{"_index":194,"title":{},"description":{"62":{},"63":{},"64":{}}}],["evals/{eval_id}/runs/{run_id}/output_item",{"_index":196,"title":{},"description":{"65":{}}}],["evals/{eval_id}/runs/{run_id}/output_items/{output_item_id",{"_index":197,"title":{},"description":{"66":{}}}],["evalu",{"_index":168,"title":{"55":{},"56":{},"57":{},"58":{},"59":{},"60":{},"61":{},"62":{},"63":{},"65":{},"66":{}},"description":{}}],["event",{"_index":53,"title":{"25":{},"26":{},"242":{},"243":{}},"description":{}}],["exampl",{"_index":89,"title":{},"description":{"33":{}}}],["execut",{"_index":238,"title":{"83":{}},"description":{}}],["exist",{"_index":521,"title":{"212":{},"216":{},"272":{}},"description":{}}],["expir",{"_index":300,"title":{"94":{},"112":{}},"description":{"112":{}}}],["extend",{"_index":348,"title":{"99":{}},"description":{}}],["extens",{"_index":316,"title":{"94":{},"273":{}},"description":{}}],["fail",{"_index":390,"title":{"113":{},"115":{},"118":{},"123":{},"275":{}},"description":{"113":{},"115":{},"118":{},"123":{}}}],["featur",{"_index":116,"title":{"36":{}},"description":{"87":{}}}],["fetch",{"_index":626,"title":{"271":{},"274":{}},"description":{}}],["field",{"_index":143,"title":{"38":{}},"description":{"99":{}}}],["file",{"_index":50,"title":{"25":{},"83":{},"86":{},"87":{},"88":{},"89":{},"90":{},"91":{},"92":{},"94":{},"96":{},"97":{},"129":{},"130":{},"131":{},"132":{},"133":{},"245":{},"256":{},"257":{},"258":{},"259":{},"260":{},"261":{},"262":{},"263":{},"264":{},"265":{},"266":{}},"description":{"87":{},"88":{},"89":{},"93":{},"129":{},"130":{},"131":{},"132":{},"133":{},"256":{},"261":{}}}],["file](/docs/api-reference/fil",{"_index":604,"title":{"261":{}},"description":{}}],["file](/docs/api-reference/files/cr",{"_index":318,"title":{"94":{}},"description":{}}],["file](/docs/api-reference/files/delet",{"_index":613,"title":{"263":{}},"description":{}}],["file](/docs/api-reference/files/object",{"_index":302,"title":{"94":{},"96":{}},"description":{}}],["file_id",{"_index":362,"title":{},"description":{"99":{}}}],["file_search",{"_index":273,"title":{"89":{}},"description":{}}],["filenam",{"_index":315,"title":{"94":{}},"description":{}}],["files/{file_id",{"_index":290,"title":{},"description":{"90":{},"91":{}}}],["files/{file_id}/cont",{"_index":291,"title":{},"description":{"92":{}}}],["filter",{"_index":447,"title":{"145":{},"266":{}},"description":{}}],["fine-tun",{"_index":198,"title":{"67":{},"70":{},"71":{},"72":{},"73":{},"74":{},"75":{},"76":{},"77":{},"78":{},"79":{},"80":{},"89":{},"105":{},"117":{},"118":{},"119":{}},"description":{"67":{},"87":{},"117":{},"118":{},"119":{}}}],["fine-tuning](/docs/guides/model-optim",{"_index":222,"title":{"73":{},"75":{}},"description":{}}],["fine_tuning/alpha/graders/run",{"_index":203,"title":{},"description":{"68":{}}}],["fine_tuning/alpha/graders/valid",{"_index":204,"title":{},"description":{"69":{}}}],["fine_tuning/checkpoints/{fine_tuned_model_checkpoint}/permiss",{"_index":211,"title":{},"description":{"70":{},"71":{}}}],["fine_tuning/checkpoints/{fine_tuned_model_checkpoint}/permissions/{permission_id",{"_index":214,"title":{},"description":{"72":{}}}],["fine_tuning/job",{"_index":223,"title":{},"description":{"73":{},"74":{}}}],["fine_tuning/jobs/{fine_tuning_job_id",{"_index":226,"title":{},"description":{"75":{}}}],["fine_tuning/jobs/{fine_tuning_job_id}/cancel",{"_index":228,"title":{},"description":{"76":{}}}],["fine_tuning/jobs/{fine_tuning_job_id}/checkpoint",{"_index":229,"title":{},"description":{"77":{}}}],["fine_tuning/jobs/{fine_tuning_job_id}/ev",{"_index":230,"title":{},"description":{"78":{}}}],["fine_tuning/jobs/{fine_tuning_job_id}/paus",{"_index":232,"title":{},"description":{"79":{}}}],["fine_tuning/jobs/{fine_tuning_job_id}/resum",{"_index":234,"title":{},"description":{"80":{}}}],["fine_tuning_job_cancel",{"_index":396,"title":{},"description":{"117":{}}}],["fine_tuning_job_fail",{"_index":397,"title":{},"description":{"118":{}}}],["fine_tuning_job_succeed",{"_index":398,"title":{},"description":{"119":{}}}],["first",{"_index":276,"title":{"89":{}},"description":{}}],["follow",{"_index":317,"title":{"94":{}},"description":{}}],["format",{"_index":62,"title":{"26":{},"89":{}},"description":{}}],["format](/docs/api-reference/batch/request-input",{"_index":272,"title":{"89":{}},"description":{}}],["frontend",{"_index":555,"title":{"241":{}},"description":{}}],["gb",{"_index":299,"title":{"94":{},"97":{}},"description":{}}],["gener",{"_index":48,"title":{"25":{},"36":{},"245":{},"268":{},"269":{},"272":{},"274":{},"276":{}},"description":{"98":{}}}],["generation](/docs/guides/text-gener",{"_index":122,"title":{"36":{}},"description":{}}],["given",{"_index":21,"title":{"11":{},"36":{},"42":{},"43":{},"44":{},"45":{},"61":{},"73":{},"99":{},"100":{},"101":{},"246":{},"247":{},"248":{},"249":{}},"description":{"34":{},"50":{},"52":{},"98":{},"106":{}}}],["gpt",{"_index":349,"title":{"99":{}},"description":{}}],["gpt-image-1",{"_index":351,"title":{"99":{}},"description":{}}],["gpt-image-1-mini",{"_index":352,"title":{"99":{}},"description":{}}],["gpt-image-1.5",{"_index":350,"title":{"99":{}},"description":{}}],["grader",{"_index":181,"title":{"56":{},"68":{},"69":{},"81":{}},"description":{"81":{}}}],["grant",{"_index":517,"title":{"207":{},"241":{}},"description":{}}],["group",{"_index":481,"title":{"167":{},"168":{},"169":{},"171":{},"172":{},"173":{},"174":{},"175":{},"176":{},"177":{},"178":{},"179":{},"205":{},"206":{},"207":{},"227":{},"228":{},"229":{},"230":{}},"description":{}}],["group'",{"_index":483,"title":{"170":{},"208":{}},"description":{}}],["guid",{"_index":125,"title":{"36":{}},"description":{}}],["guidanc",{"_index":313,"title":{"94":{}},"description":{}}],["guide](/docs/assistants/tool",{"_index":266,"title":{"89":{}},"description":{}}],["guide](/docs/guides/conversation-state#managing-the-context-window",{"_index":429,"title":{"139":{}},"description":{}}],["guide](/docs/guides/ev",{"_index":184,"title":{"56":{}},"description":{}}],["guide](/docs/guides/moder",{"_index":381,"title":{"107":{}},"description":{}}],["guide](/docs/guides/reason",{"_index":138,"title":{"36":{}},"description":{}}],["guide](/docs/guides/text-to-speech#custom-voic",{"_index":75,"title":{},"description":{"28":{},"29":{},"30":{},"31":{},"32":{},"33":{}}}],["handl",{"_index":540,"title":{"237":{}},"description":{}}],["harm",{"_index":380,"title":{"107":{}},"description":{"106":{}}}],["here",{"_index":275,"title":{"89":{}},"description":{}}],["hit",{"_index":337,"title":{"97":{}},"description":{}}],["hour",{"_index":301,"title":{"94":{}},"description":{}}],["id",{"_index":147,"title":{"42":{},"43":{},"44":{},"45":{},"57":{},"62":{},"66":{},"96":{},"129":{},"246":{},"247":{},"248":{},"281":{},"282":{},"284":{}},"description":{"136":{}}}],["idempot",{"_index":455,"title":{"149":{},"150":{},"155":{},"156":{}},"description":{}}],["identifi",{"_index":444,"title":{"143":{},"220":{}},"description":{}}],["imag",{"_index":345,"title":{"98":{},"99":{},"100":{},"101":{},"107":{},"164":{}},"description":{"98":{},"99":{},"106":{}}}],["image](/docs/guides/imag",{"_index":581,"title":{"245":{}},"description":{}}],["image_url",{"_index":361,"title":{},"description":{"99":{}}}],["images/edit",{"_index":365,"title":{},"description":{"99":{}}}],["images/gener",{"_index":367,"title":{},"description":{"100":{}}}],["images/vari",{"_index":369,"title":{},"description":{"101":{}}}],["immedi",{"_index":227,"title":{"76":{}},"description":{}}],["immut",{"_index":648,"title":{"285":{}},"description":{}}],["in-progress",{"_index":240,"title":{"86":{}},"description":{}}],["in_progress",{"_index":28,"title":{"20":{}},"description":{}}],["inact",{"_index":463,"title":{"153":{}},"description":{}}],["includ",{"_index":218,"title":{"73":{},"89":{},"96":{}},"description":{}}],["incom",{"_index":400,"title":{"120":{},"237":{},"240":{}},"description":{"120":{}}}],["incomplet",{"_index":410,"title":{"124":{}},"description":{"124":{}}}],["increas",{"_index":288,"title":{"89":{}},"description":{}}],["individu",{"_index":251,"title":{"89":{}},"description":{}}],["info",{"_index":225,"title":{"75":{}},"description":{}}],["inform",{"_index":183,"title":{"56":{},"91":{},"103":{},"104":{},"170":{}},"description":{}}],["ingest",{"_index":274,"title":{"89":{}},"description":{"256":{}}}],["initi",{"_index":331,"title":{"96":{},"238":{}},"description":{}}],["input",{"_index":49,"title":{"25":{},"26":{},"53":{},"89":{},"107":{},"138":{},"245":{},"249":{}},"description":{"52":{},"98":{},"106":{}}}],["input_token",{"_index":425,"title":{"138":{}},"description":{}}],["instanc",{"_index":373,"title":{"104":{}},"description":{}}],["instead",{"_index":282,"title":{"89":{}},"description":{"99":{}}}],["instruct",{"_index":9,"title":{"2":{}},"description":{}}],["intend",{"_index":342,"title":{"97":{}},"description":{}}],["intermedi",{"_index":293,"title":{"94":{}},"description":{}}],["interpret",{"_index":474,"title":{"161":{}},"description":{}}],["invit",{"_index":491,"title":{"180":{},"181":{},"182":{},"183":{},"184":{}},"description":{}}],["issu",{"_index":438,"title":{"140":{}},"description":{}}],["item",{"_index":146,"title":{"42":{},"43":{},"44":{},"45":{},"48":{},"65":{},"66":{},"142":{},"144":{},"249":{}},"description":{"41":{}}}],["itself",{"_index":612,"title":{"263":{}},"description":{}}],["job",{"_index":199,"title":{"73":{},"74":{},"75":{},"76":{},"77":{},"78":{},"79":{},"80":{},"117":{},"118":{},"119":{},"268":{},"272":{},"276":{}},"description":{"67":{},"117":{},"118":{},"119":{}}}],["json",{"_index":59,"title":{"26":{},"129":{}},"description":{"99":{}}}],["json](/docs/guides/structured-output",{"_index":582,"title":{"245":{}},"description":{}}],["jsonl",{"_index":267,"title":{"89":{}},"description":{}}],["key",{"_index":418,"title":{"134":{},"135":{},"136":{},"137":{},"190":{},"191":{},"192":{},"197":{},"241":{},"242":{},"243":{}},"description":{"134":{},"135":{},"136":{},"137":{}}}],["key](../admin-api-key",{"_index":206,"title":{"70":{},"71":{},"72":{}},"description":{}}],["kick",{"_index":189,"title":{"61":{}},"description":{}}],["languag",{"_index":56,"title":{"26":{}},"description":{}}],["larg",{"_index":236,"title":{},"description":{"82":{},"93":{}}}],["latest",{"_index":113,"title":{"36":{},"274":{}},"description":{}}],["leak",{"_index":558,"title":{"241":{}},"description":{}}],["learn",{"_index":120,"title":{"36":{},"73":{},"75":{},"100":{},"107":{},"139":{},"241":{},"248":{}},"description":{"52":{}}}],["level",{"_index":453,"title":{"149":{},"150":{},"155":{},"156":{}},"description":{}}],["limit",{"_index":79,"title":{"89":{},"194":{},"195":{}},"description":{"28":{},"29":{},"30":{},"31":{},"32":{},"33":{},"256":{},"261":{}}}],["list",{"_index":7,"title":{"1":{},"11":{},"16":{},"21":{},"29":{},"35":{},"43":{},"55":{},"60":{},"65":{},"74":{},"77":{},"84":{},"88":{},"96":{},"103":{},"109":{},"125":{},"130":{},"134":{},"142":{},"145":{},"147":{},"154":{},"168":{},"173":{},"177":{},"181":{},"186":{},"190":{},"196":{},"200":{},"206":{},"210":{},"214":{},"219":{},"224":{},"228":{},"232":{},"249":{},"251":{},"259":{},"260":{},"269":{},"280":{},"286":{}},"description":{"29":{},"34":{},"102":{},"108":{},"125":{},"130":{},"134":{}}}],["log",{"_index":383,"title":{"108":{}},"description":{}}],["long-run",{"_index":428,"title":{"139":{}},"description":{}}],["look",{"_index":566,"title":{"241":{}},"description":{}}],["machin",{"_index":164,"title":{},"description":{"52":{}}}],["main",{"_index":559,"title":{"241":{}},"description":{}}],["manag",{"_index":145,"title":{},"description":{"41":{},"54":{},"67":{},"81":{}}}],["mask",{"_index":359,"title":{},"description":{"99":{}}}],["match",{"_index":330,"title":{"96":{}},"description":{}}],["maximum",{"_index":338,"title":{"97":{}},"description":{"256":{}}}],["mb",{"_index":253,"title":{"89":{},"97":{}},"description":{}}],["member",{"_index":513,"title":{"201":{}},"description":{}}],["messag",{"_index":20,"title":{"11":{},"12":{},"13":{},"14":{},"15":{},"40":{}},"description":{"34":{}}}],["metadata",{"_index":84,"title":{"31":{},"38":{},"140":{},"274":{}},"description":{"30":{},"31":{}}}],["million",{"_index":265,"title":{"89":{}},"description":{}}],["mime",{"_index":311,"title":{"94":{}},"description":{}}],["mime_typ",{"_index":310,"title":{"94":{}},"description":{}}],["minut",{"_index":243,"title":{"86":{},"89":{}},"description":{"256":{},"261":{}}}],["mobil",{"_index":556,"title":{"241":{}},"description":{}}],["model",{"_index":3,"title":{"2":{},"36":{},"56":{},"61":{},"70":{},"71":{},"72":{},"73":{},"89":{},"99":{},"102":{},"103":{},"104":{},"105":{},"194":{},"245":{},"246":{},"247":{},"248":{}},"description":{"0":{},"34":{},"50":{},"52":{},"67":{},"98":{},"102":{},"103":{}}}],["model'",{"_index":171,"title":{"56":{},"245":{}},"description":{}}],["models/{model",{"_index":374,"title":{},"description":{"104":{},"105":{}}}],["moder",{"_index":376,"title":{"106":{},"107":{},"165":{}},"description":{"107":{}}}],["modif",{"_index":142,"title":{"38":{}},"description":{}}],["modifi",{"_index":12,"title":{"4":{},"9":{},"14":{},"19":{},"38":{},"152":{},"189":{},"203":{},"221":{},"254":{}},"description":{}}],["more",{"_index":121,"title":{"36":{},"56":{},"73":{},"75":{},"99":{},"107":{},"241":{}},"description":{"50":{}}}],["more](/docs/guides/background",{"_index":589,"title":{"248":{}},"description":{}}],["more](/docs/guides/imag",{"_index":366,"title":{"100":{}},"description":{}}],["multipart",{"_index":364,"title":{},"description":{"99":{}}}],["multipart/form-data",{"_index":355,"title":{"129":{}},"description":{"99":{}}}],["multipl",{"_index":279,"title":{"89":{},"97":{}},"description":{"93":{},"256":{},"261":{}}}],["name",{"_index":221,"title":{"73":{},"152":{}},"description":{}}],["need",{"_index":277,"title":{"89":{},"236":{}},"description":{}}],["nest",{"_index":323,"title":{"96":{}},"description":{}}],["new",{"_index":106,"title":{"36":{},"61":{},"73":{},"140":{},"169":{},"187":{},"197":{},"236":{},"239":{},"268":{},"272":{},"279":{},"285":{}},"description":{"98":{},"135":{}}}],["newer",{"_index":130,"title":{"36":{}},"description":{}}],["note",{"_index":132,"title":{"36":{},"70":{},"71":{},"72":{},"152":{}},"description":{"99":{}}}],["number",{"_index":327,"title":{"96":{}},"description":{"256":{}}}],["object",{"_index":58,"title":{"26":{},"36":{},"51":{},"94":{},"95":{},"96":{},"97":{},"138":{},"139":{},"241":{},"242":{},"243":{}},"description":{}}],["on",{"_index":16,"title":{"7":{},"89":{},"99":{},"103":{}},"description":{"50":{}}}],["onc",{"_index":40,"title":{"23":{},"73":{},"94":{}},"description":{}}],["ongo",{"_index":195,"title":{"63":{}},"description":{}}],["openai",{"_index":114,"title":{"36":{}},"description":{"54":{},"81":{}}}],["option",{"_index":358,"title":{"145":{},"241":{},"268":{}},"description":{"99":{}}}],["order",{"_index":325,"title":{"96":{},"97":{}},"description":{}}],["organ",{"_index":83,"title":{"70":{},"71":{},"72":{},"89":{},"105":{},"109":{},"134":{},"135":{},"136":{},"137":{},"147":{},"148":{},"149":{},"150":{},"151":{},"153":{},"158":{},"159":{},"160":{},"161":{},"162":{},"163":{},"164":{},"165":{},"166":{},"168":{},"169":{},"171":{},"172":{},"173":{},"174":{},"175":{},"181":{},"182":{},"187":{},"189":{},"193":{},"201":{},"210":{},"211":{},"212":{},"213":{},"219":{},"221":{},"222":{},"223":{},"224":{},"225":{},"226":{}},"description":{"29":{},"108":{},"134":{},"135":{},"136":{}}}],["organization'",{"_index":224,"title":{"74":{},"84":{}},"description":{}}],["organization-wid",{"_index":257,"title":{"89":{}},"description":{}}],["organization/admin_api_key",{"_index":420,"title":{},"description":{"134":{},"135":{}}}],["organization/admin_api_keys/{key_id",{"_index":422,"title":{},"description":{"136":{},"137":{}}}],["organization/audit_log",{"_index":385,"title":{},"description":{"109":{}}}],["organization/certif",{"_index":450,"title":{},"description":{"147":{},"148":{}}}],["organization/certificates/activ",{"_index":457,"title":{},"description":{"149":{}}}],["organization/certificates/deactiv",{"_index":459,"title":{},"description":{"150":{}}}],["organization/certificates/{certificate_id",{"_index":462,"title":{},"description":{"151":{},"152":{},"153":{}}}],["organization/cost",{"_index":469,"title":{},"description":{"158":{}}}],["organization/group",{"_index":482,"title":{},"description":{"168":{},"169":{}}}],["organization/groups/{group_id",{"_index":484,"title":{},"description":{"170":{},"171":{}}}],["organization/groups/{group_id}/rol",{"_index":486,"title":{},"description":{"173":{},"174":{}}}],["organization/groups/{group_id}/roles/{role_id",{"_index":488,"title":{},"description":{"175":{}}}],["organization/groups/{group_id}/us",{"_index":489,"title":{},"description":{"177":{},"178":{}}}],["organization/groups/{group_id}/users/{user_id",{"_index":490,"title":{},"description":{"179":{}}}],["organization/invit",{"_index":492,"title":{},"description":{"181":{},"182":{}}}],["organization/invites/{invite_id",{"_index":494,"title":{},"description":{"183":{},"184":{}}}],["organization/project",{"_index":496,"title":{},"description":{"186":{},"187":{}}}],["organization/projects/{project_id",{"_index":498,"title":{},"description":{"188":{},"189":{}}}],["organization/projects/{project_id}/api_key",{"_index":499,"title":{},"description":{"190":{}}}],["organization/projects/{project_id}/api_keys/{key_id",{"_index":500,"title":{},"description":{"191":{},"192":{}}}],["organization/projects/{project_id}/arch",{"_index":505,"title":{},"description":{"193":{}}}],["organization/projects/{project_id}/certif",{"_index":464,"title":{},"description":{"154":{}}}],["organization/projects/{project_id}/certificates/activ",{"_index":465,"title":{},"description":{"155":{}}}],["organization/projects/{project_id}/certificates/deactiv",{"_index":466,"title":{},"description":{"156":{}}}],["organization/projects/{project_id}/group",{"_index":516,"title":{},"description":{"206":{},"207":{}}}],["organization/projects/{project_id}/groups/{group_id",{"_index":519,"title":{},"description":{"208":{}}}],["organization/projects/{project_id}/rate_limit",{"_index":507,"title":{},"description":{"194":{}}}],["organization/projects/{project_id}/rate_limits/{rate_limit_id",{"_index":508,"title":{},"description":{"195":{}}}],["organization/projects/{project_id}/service_account",{"_index":509,"title":{},"description":{"196":{},"197":{}}}],["organization/projects/{project_id}/service_accounts/{service_account_id",{"_index":511,"title":{},"description":{"198":{},"199":{}}}],["organization/projects/{project_id}/us",{"_index":512,"title":{},"description":{"200":{},"201":{}}}],["organization/projects/{project_id}/users/{user_id",{"_index":514,"title":{},"description":{"202":{},"203":{},"204":{}}}],["organization/rol",{"_index":520,"title":{},"description":{"210":{},"211":{}}}],["organization/roles/{role_id",{"_index":522,"title":{},"description":{"212":{},"213":{}}}],["organization/us",{"_index":525,"title":{},"description":{"219":{}}}],["organization/usage/audio_speech",{"_index":471,"title":{},"description":{"159":{}}}],["organization/usage/audio_transcript",{"_index":472,"title":{},"description":{"160":{}}}],["organization/usage/code_interpreter_sess",{"_index":475,"title":{},"description":{"161":{}}}],["organization/usage/complet",{"_index":476,"title":{},"description":{"162":{}}}],["organization/usage/embed",{"_index":477,"title":{},"description":{"163":{}}}],["organization/usage/imag",{"_index":478,"title":{},"description":{"164":{}}}],["organization/usage/moder",{"_index":479,"title":{},"description":{"165":{}}}],["organization/usage/vector_stor",{"_index":480,"title":{},"description":{"166":{}}}],["organization/users/{user_id",{"_index":526,"title":{},"description":{"220":{},"221":{},"222":{}}}],["organization/users/{user_id}/rol",{"_index":527,"title":{},"description":{"224":{},"225":{}}}],["organization/users/{user_id}/roles/{role_id",{"_index":528,"title":{},"description":{"226":{}}}],["output",{"_index":39,"title":{"23":{},"65":{},"66":{},"86":{},"245":{}},"description":{"33":{}}}],["over",{"_index":533,"title":{"236":{},"238":{},"241":{}},"description":{}}],["overridden",{"_index":562,"title":{"241":{}},"description":{}}],["owner",{"_index":207,"title":{"70":{},"71":{},"72":{},"103":{},"104":{},"105":{}},"description":{}}],["pagin",{"_index":419,"title":{"145":{}},"description":{"134":{}}}],["parallel",{"_index":340,"title":{"97":{}},"description":{}}],["paramet",{"_index":101,"title":{"35":{},"36":{},"37":{},"38":{},"39":{},"40":{},"51":{},"56":{},"242":{},"243":{},"248":{}},"description":{}}],["pars",{"_index":615,"title":{"265":{}},"description":{}}],["part",{"_index":292,"title":{"94":{},"95":{},"96":{},"97":{}},"description":{"93":{}}}],["part](/docs/api-reference/uploads/part-object",{"_index":334,"title":{"97":{}},"description":{}}],["partial",{"_index":246,"title":{"86":{}},"description":{}}],["particularli",{"_index":129,"title":{"36":{}},"description":{}}],["parts](/docs/api-reference/uploads/part-object",{"_index":296,"title":{"94":{}},"description":{}}],["pass",{"_index":326,"title":{"96":{},"241":{}},"description":{}}],["paus",{"_index":231,"title":{"79":{}},"description":{}}],["peer",{"_index":537,"title":{"236":{}},"description":{}}],["pend",{"_index":319,"title":{"94":{}},"description":{}}],["per",{"_index":261,"title":{"89":{},"194":{}},"description":{"256":{},"261":{}}}],["per-vector-stor",{"_index":607,"title":{},"description":{"261":{}}}],["perform",{"_index":172,"title":{"56":{}},"description":{}}],["perman",{"_index":631,"title":{"275":{}},"description":{}}],["permiss",{"_index":209,"title":{"70":{},"72":{},"104":{}},"description":{}}],["platform",{"_index":115,"title":{"36":{},"94":{},"96":{}},"description":{"54":{},"81":{}}}],["pleas",{"_index":285,"title":{"89":{},"94":{}},"description":{}}],["plu",{"_index":574,"title":{"242":{},"243":{}},"description":{}}],["pointer",{"_index":644,"title":{"283":{}},"description":{}}],["posit",{"_index":157,"title":{},"description":{"50":{}}}],["possibl",{"_index":339,"title":{"97":{},"258":{}},"description":{}}],["potenti",{"_index":379,"title":{"107":{}},"description":{"106":{}}}],["practic",{"_index":78,"title":{},"description":{"28":{},"33":{}}}],["predict",{"_index":152,"title":{},"description":{"50":{}}}],["prevent",{"_index":437,"title":{"140":{}},"description":{}}],["preview",{"_index":634,"title":{"276":{}},"description":{}}],["previous",{"_index":94,"title":{},"description":{"33":{}}}],["probabl",{"_index":153,"title":{},"description":{"50":{}}}],["process",{"_index":216,"title":{"73":{},"111":{},"258":{}},"description":{"111":{}}}],["project",{"_index":107,"title":{"36":{},"55":{},"71":{},"89":{},"153":{},"154":{},"155":{},"156":{},"185":{},"186":{},"187":{},"188":{},"189":{},"190":{},"191":{},"192":{},"193":{},"194":{},"195":{},"196":{},"197":{},"198":{},"199":{},"200":{},"201":{},"202":{},"203":{},"204":{},"205":{},"206":{},"207":{},"208":{},"214":{},"215":{},"216":{},"217":{},"227":{},"228":{},"229":{},"230":{},"231":{},"232":{},"233":{},"234":{},"269":{},"280":{}},"description":{}}],["projects/{project_id}/groups/{group_id}/rol",{"_index":529,"title":{},"description":{"228":{},"229":{}}}],["projects/{project_id}/groups/{group_id}/roles/{role_id",{"_index":530,"title":{},"description":{"230":{}}}],["projects/{project_id}/rol",{"_index":523,"title":{},"description":{"214":{},"215":{}}}],["projects/{project_id}/roles/{role_id",{"_index":524,"title":{},"description":{"216":{},"217":{}}}],["projects/{project_id}/users/{user_id}/rol",{"_index":531,"title":{},"description":{"232":{},"233":{}}}],["projects/{project_id}/users/{user_id}/roles/{role_id",{"_index":532,"title":{},"description":{"234":{}}}],["prompt",{"_index":151,"title":{"51":{},"99":{},"100":{},"268":{},"277":{}},"description":{"50":{},"98":{}}}],["proper",{"_index":314,"title":{"94":{}},"description":{}}],["properti",{"_index":187,"title":{"58":{},"96":{}},"description":{}}],["provid",{"_index":158,"title":{"51":{},"103":{},"104":{},"245":{}},"description":{}}],["purpos",{"_index":307,"title":{"94":{}},"description":{}}],["queri",{"_index":620,"title":{"266":{}},"description":{}}],["rate",{"_index":506,"title":{"194":{},"195":{}},"description":{"256":{},"261":{}}}],["rate-limit",{"_index":259,"title":{"89":{}},"description":{}}],["raw",{"_index":414,"title":{"129":{}},"description":{}}],["readi",{"_index":324,"title":{"96":{}},"description":{}}],["realtim",{"_index":91,"title":{"120":{},"235":{},"236":{},"237":{},"238":{},"241":{},"242":{},"243":{}},"description":{"33":{},"120":{}}}],["realtime/cal",{"_index":539,"title":{},"description":{"236":{}}}],["realtime/calls/{call_id}/accept",{"_index":541,"title":{},"description":{"237":{}}}],["realtime/calls/{call_id}/hangup",{"_index":543,"title":{},"description":{"238":{}}}],["realtime/calls/{call_id}/ref",{"_index":547,"title":{},"description":{"239":{}}}],["realtime/calls/{call_id}/reject",{"_index":550,"title":{},"description":{"240":{}}}],["realtime/client_secret",{"_index":568,"title":{},"description":{"241":{}}}],["realtime/sess",{"_index":577,"title":{},"description":{"242":{}}}],["realtime/transcription_sess",{"_index":579,"title":{},"description":{"243":{}}}],["realtime_call_incom",{"_index":403,"title":{},"description":{"120":{}}}],["reason",{"_index":131,"title":{"36":{}},"description":{}}],["receiv",{"_index":399,"title":{"120":{},"236":{}},"description":{"120":{}}}],["recent",{"_index":436,"title":{"140":{},"269":{}},"description":{}}],["recommend",{"_index":108,"title":{"36":{}},"description":{"256":{}}}],["record",{"_index":70,"title":{"28":{},"29":{},"30":{},"31":{},"32":{}},"description":{"28":{},"29":{},"30":{},"31":{},"32":{},"33":{}}}],["reduc",{"_index":609,"title":{},"description":{"261":{}}}],["refer",{"_index":137,"title":{"36":{},"94":{},"239":{},"268":{}},"description":{"99":{}}}],["refresh",{"_index":638,"title":{"277":{}},"description":{}}],["regardless",{"_index":460,"title":{"151":{}},"description":{}}],["regular",{"_index":306,"title":{"94":{}},"description":{}}],["relev",{"_index":618,"title":{"266":{}},"description":{}}],["remix",{"_index":637,"title":{"277":{}},"description":{}}],["remov",{"_index":289,"title":{"90":{},"179":{},"263":{}},"description":{}}],["render",{"_index":635,"title":{"276":{}},"description":{}}],["replac",{"_index":87,"title":{},"description":{"31":{}}}],["repres",{"_index":166,"title":{"53":{},"97":{}},"description":{}}],["represent",{"_index":161,"title":{},"description":{"52":{}}}],["request",{"_index":17,"title":{"7":{},"23":{},"36":{},"51":{},"83":{},"89":{},"129":{},"138":{},"140":{}},"description":{"82":{},"99":{},"256":{},"261":{}}}],["requir",{"_index":76,"title":{"70":{},"71":{},"72":{},"89":{}},"description":{"28":{},"33":{}}}],["required_action.typ",{"_index":35,"title":{"23":{}},"description":{}}],["requires_act",{"_index":34,"title":{"23":{}},"description":{}}],["respond",{"_index":573,"title":{"242":{},"243":{}},"description":{}}],["respons",{"_index":99,"title":{"36":{},"73":{},"121":{},"122":{},"123":{},"124":{},"139":{},"244":{},"245":{},"246":{},"247":{},"248":{},"249":{}},"description":{"34":{},"121":{},"122":{},"123":{},"124":{},"245":{}}}],["response.input_token",{"_index":424,"title":{"138":{}},"description":{}}],["response_cancel",{"_index":405,"title":{},"description":{"121":{}}}],["response_complet",{"_index":408,"title":{},"description":{"122":{}}}],["response_fail",{"_index":409,"title":{},"description":{"123":{}}}],["response_incomplet",{"_index":411,"title":{},"description":{"124":{}}}],["responses/compact",{"_index":432,"title":{},"description":{"139":{}}}],["responses/input_token",{"_index":426,"title":{},"description":{"138":{}}}],["responses/{response_id",{"_index":588,"title":{},"description":{"246":{},"247":{}}}],["responses/{response_id}/cancel",{"_index":590,"title":{},"description":{"248":{}}}],["responses/{response_id}/input_item",{"_index":591,"title":{},"description":{"249":{}}}],["responses](/docs/api-reference/respons",{"_index":110,"title":{"36":{}},"description":{}}],["responses](/docs/guides/responses-vs-chat-completions?api-mode=respons",{"_index":118,"title":{"36":{}},"description":{}}],["rest",{"_index":305,"title":{"94":{},"96":{}},"description":{}}],["result",{"_index":247,"title":{"86":{}},"description":{}}],["resum",{"_index":233,"title":{"80":{}},"description":{}}],["retriev",{"_index":10,"title":{"3":{},"8":{},"13":{},"18":{},"22":{},"30":{},"85":{},"89":{},"104":{},"127":{},"131":{},"133":{},"136":{},"143":{},"183":{},"188":{},"191":{},"198":{},"202":{},"220":{},"246":{},"253":{},"257":{},"262":{},"265":{}},"description":{"30":{},"127":{},"131":{},"133":{},"134":{}}}],["return",{"_index":6,"title":{"1":{},"11":{},"16":{},"21":{},"25":{},"26":{},"29":{},"35":{},"36":{},"37":{},"40":{},"51":{},"88":{},"91":{},"92":{},"94":{},"95":{},"96":{},"138":{},"139":{},"140":{},"181":{},"186":{},"190":{},"192":{},"194":{},"196":{},"197":{},"199":{},"200":{},"204":{},"240":{},"241":{},"242":{},"243":{},"249":{},"251":{},"259":{},"260":{}},"description":{"34":{},"50":{}}}],["revok",{"_index":518,"title":{"208":{}},"description":{}}],["role",{"_index":375,"title":{"105":{},"172":{},"173":{},"174":{},"175":{},"203":{},"209":{},"210":{},"211":{},"212":{},"213":{},"214":{},"215":{},"216":{},"217":{},"221":{},"223":{},"224":{},"225":{},"226":{},"227":{},"228":{},"229":{},"230":{},"231":{},"232":{},"233":{},"234":{}},"description":{}}],["run",{"_index":15,"title":{"7":{},"16":{},"17":{},"18":{},"19":{},"20":{},"21":{},"22":{},"23":{},"56":{},"60":{},"61":{},"62":{},"63":{},"64":{},"65":{},"66":{},"68":{},"114":{},"115":{},"116":{}},"description":{"54":{},"81":{},"82":{},"114":{},"115":{},"116":{}}}],["same",{"_index":280,"title":{"89":{},"242":{},"243":{}},"description":{"256":{},"261":{}}}],["sampl",{"_index":93,"title":{},"description":{"33":{}}}],["schema",{"_index":178,"title":{"56":{},"61":{}},"description":{}}],["sdp",{"_index":535,"title":{"236":{}},"description":{}}],["search",{"_index":617,"title":{"266":{}},"description":{}}],["search](/docs/guides/tools-file-search",{"_index":587,"title":{"245":{}},"description":{}}],["search](/docs/guides/tools-web-search",{"_index":586,"title":{"245":{}},"description":{}}],["secret",{"_index":440,"title":{"140":{},"241":{}},"description":{}}],["see",{"_index":74,"title":{"56":{},"89":{},"139":{}},"description":{"28":{},"29":{},"30":{},"31":{},"32":{},"33":{}}}],["send",{"_index":413,"title":{"129":{}},"description":{}}],["sent",{"_index":386,"title":{"110":{},"111":{},"112":{},"113":{},"114":{},"115":{},"116":{},"117":{},"118":{},"119":{},"120":{},"121":{},"122":{},"123":{},"124":{}},"description":{"110":{},"111":{},"112":{},"113":{},"114":{},"115":{},"116":{},"117":{},"118":{},"119":{},"120":{},"121":{},"122":{},"123":{},"124":{}}}],["separ",{"_index":283,"title":{"89":{}},"description":{}}],["sequenc",{"_index":139,"title":{"36":{},"51":{}},"description":{}}],["servic",{"_index":503,"title":{"192":{},"196":{},"197":{},"198":{},"199":{}},"description":{}}],["session",{"_index":435,"title":{"140":{},"141":{},"161":{},"237":{},"241":{},"242":{},"243":{}},"description":{}}],["session.upd",{"_index":572,"title":{"242":{}},"description":{}}],["set",{"_index":102,"title":{"35":{},"37":{},"38":{},"39":{},"40":{},"56":{},"138":{},"248":{}},"description":{}}],["sever",{"_index":179,"title":{"56":{}},"description":{}}],["share",{"_index":213,"title":{"71":{}},"description":{"261":{}}}],["short-liv",{"_index":552,"title":{"241":{}},"description":{}}],["singl",{"_index":43,"title":{"23":{},"44":{},"136":{}},"description":{"256":{}}}],["sip",{"_index":401,"title":{"120":{},"237":{},"238":{},"239":{},"240":{}},"description":{"120":{}}}],["size",{"_index":271,"title":{"89":{}},"description":{}}],["skill",{"_index":640,"title":{"278":{},"279":{},"280":{},"281":{},"282":{},"283":{},"284":{},"285":{},"286":{},"287":{},"288":{},"289":{}},"description":{"279":{},"280":{}}}],["skills/{skill_id",{"_index":641,"title":{},"description":{"281":{},"282":{},"283":{}}}],["skills/{skill_id}/cont",{"_index":647,"title":{},"description":{"284":{}}}],["skills/{skill_id}/vers",{"_index":649,"title":{},"description":{"285":{},"286":{}}}],["skills/{skill_id}/versions/{vers",{"_index":650,"title":{},"description":{"287":{},"288":{}}}],["skills/{skill_id}/versions/{version}/cont",{"_index":651,"title":{},"description":{"289":{}}}],["soon",{"_index":601,"title":{"258":{}},"description":{}}],["sourc",{"_index":176,"title":{"56":{},"61":{},"99":{},"272":{}},"description":{}}],["specif",{"_index":201,"title":{"89":{},"91":{},"243":{},"287":{}},"description":{"67":{},"136":{}}}],["specifi",{"_index":190,"title":{"61":{},"92":{},"94":{},"96":{},"276":{}},"description":{"137":{}}}],["speech",{"_index":470,"title":{"159":{}},"description":{}}],["start",{"_index":105,"title":{"36":{}},"description":{}}],["state",{"_index":135,"title":{"36":{},"139":{}},"description":{}}],["statu",{"_index":33,"title":{"23":{},"73":{},"78":{},"86":{},"94":{},"95":{},"96":{},"240":{}},"description":{}}],["step",{"_index":30,"title":{"21":{},"22":{}},"description":{}}],["storag",{"_index":258,"title":{"89":{}},"description":{}}],["store",{"_index":100,"title":{"35":{},"37":{},"38":{},"39":{},"40":{},"89":{},"90":{},"144":{},"166":{},"250":{},"251":{},"252":{},"253":{},"254":{},"255":{},"256":{},"257":{},"258":{},"259":{},"260":{},"261":{},"262":{},"263":{},"264":{},"265":{},"266":{},"275":{}},"description":{"256":{},"261":{}}}],["store](/docs/api-reference/vector-stores/object",{"_index":605,"title":{"261":{}},"description":{}}],["stream",{"_index":52,"title":{"25":{},"26":{},"36":{},"51":{},"276":{}},"description":{}}],["string",{"_index":565,"title":{"241":{}},"description":{}}],["structur",{"_index":169,"title":{"56":{}},"description":{}}],["subject",{"_index":606,"title":{},"description":{"261":{}}}],["submit",{"_index":38,"title":{"23":{}},"description":{}}],["submit_tool_output",{"_index":36,"title":{"23":{}},"description":{}}],["succ",{"_index":406,"title":{"122":{}},"description":{}}],["succeed",{"_index":394,"title":{"116":{},"119":{}},"description":{"116":{},"119":{}}}],["successfulli",{"_index":407,"title":{},"description":{"122":{}}}],["such",{"_index":372,"title":{"103":{},"104":{},"241":{}},"description":{}}],["support",{"_index":126,"title":{"36":{},"38":{},"56":{},"89":{},"94":{},"99":{},"101":{}},"description":{}}],["tailor",{"_index":200,"title":{},"description":{"67":{}}}],["take",{"_index":111,"title":{"36":{}},"description":{}}],["tb",{"_index":255,"title":{"89":{}},"description":{}}],["test",{"_index":170,"title":{"56":{},"61":{}},"description":{}}],["text",{"_index":47,"title":{"25":{},"36":{},"53":{},"107":{}},"description":{"24":{},"106":{}}}],["text-to-speech",{"_index":90,"title":{},"description":{"33":{}}}],["text](/docs/guides/text",{"_index":580,"title":{"245":{}},"description":{}}],["they'r",{"_index":41,"title":{"23":{}},"description":{}}],["those",{"_index":378,"title":{},"description":{"106":{}}}],["thread",{"_index":14,"title":{"6":{},"7":{},"8":{},"9":{},"10":{},"11":{},"16":{},"142":{},"143":{},"144":{},"145":{}},"description":{"6":{}}}],["threads/run",{"_index":18,"title":{},"description":{"7":{}}}],["threads/{thread_id",{"_index":19,"title":{},"description":{"8":{},"9":{},"10":{}}}],["threads/{thread_id}/messag",{"_index":22,"title":{},"description":{"11":{},"12":{}}}],["threads/{thread_id}/messages/{message_id",{"_index":23,"title":{},"description":{"13":{},"14":{},"15":{}}}],["threads/{thread_id}/run",{"_index":25,"title":{},"description":{"16":{},"17":{}}}],["threads/{thread_id}/runs/{run_id",{"_index":26,"title":{},"description":{"18":{},"19":{}}}],["threads/{thread_id}/runs/{run_id}/cancel",{"_index":29,"title":{},"description":{"20":{}}}],["threads/{thread_id}/runs/{run_id}/step",{"_index":31,"title":{},"description":{"21":{}}}],["threads/{thread_id}/runs/{run_id}/steps/{step_id",{"_index":32,"title":{},"description":{"22":{}}}],["threads/{thread_id}/runs/{run_id}/submit_tool_output",{"_index":44,"title":{},"description":{"23":{}}}],["time",{"_index":456,"title":{"149":{},"150":{},"155":{},"156":{}},"description":{}}],["token",{"_index":155,"title":{"89":{},"138":{},"241":{},"242":{},"243":{}},"description":{"50":{}}}],["tool",{"_index":5,"title":{"23":{},"89":{}},"description":{"0":{}}}],["tools](/docs/guides/tool",{"_index":585,"title":{"245":{}},"description":{}}],["total",{"_index":256,"title":{"89":{},"94":{}},"description":{}}],["train",{"_index":202,"title":{},"description":{"67":{}}}],["transcrib",{"_index":55,"title":{"26":{}},"description":{}}],["transcript",{"_index":57,"title":{"26":{},"160":{},"243":{}},"description":{}}],["transcription_session.upd",{"_index":578,"title":{"243":{}},"description":{}}],["transfer",{"_index":544,"title":{"239":{}},"description":{}}],["translat",{"_index":64,"title":{"27":{}},"description":{}}],["tri",{"_index":109,"title":{"36":{},"97":{}},"description":{}}],["true",{"_index":103,"title":{"35":{},"37":{},"38":{},"39":{},"40":{},"248":{}},"description":{}}],["ttl",{"_index":560,"title":{"241":{}},"description":{}}],["turn",{"_index":46,"title":{},"description":{"24":{}}}],["type",{"_index":180,"title":{"56":{},"89":{},"94":{}},"description":{}}],["unassign",{"_index":487,"title":{"175":{},"226":{},"230":{},"234":{}},"description":{}}],["underli",{"_index":88,"title":{},"description":{"31":{}}}],["unredact",{"_index":510,"title":{"197":{}},"description":{}}],["unsupport",{"_index":136,"title":{"36":{}},"description":{}}],["until",{"_index":336,"title":{"97":{}},"description":{}}],["up",{"_index":241,"title":{"86":{},"89":{},"148":{},"149":{},"150":{},"155":{},"156":{}},"description":{}}],["updat",{"_index":86,"title":{"31":{},"38":{},"49":{},"58":{},"78":{},"170":{},"193":{},"195":{},"212":{},"216":{},"264":{},"283":{}},"description":{"31":{}}}],["upload",{"_index":67,"title":{"28":{},"83":{},"89":{},"93":{},"94":{},"95":{},"96":{},"97":{},"147":{},"148":{},"151":{},"270":{}},"description":{"28":{},"32":{},"33":{},"87":{},"93":{},"94":{},"99":{},"261":{}}}],["upload](/docs/api-reference/uploads/complet",{"_index":343,"title":{"97":{}},"description":{}}],["upload](/docs/api-reference/uploads/object",{"_index":294,"title":{"94":{},"96":{},"97":{}},"description":{}}],["uploads/{upload_id}/cancel",{"_index":321,"title":{},"description":{"95":{}}}],["uploads/{upload_id}/complet",{"_index":333,"title":{},"description":{"96":{}}}],["uploads/{upload_id}/part",{"_index":344,"title":{},"description":{"97":{}}}],["upon",{"_index":329,"title":{"96":{}},"description":{}}],["us",{"_index":4,"title":{"23":{},"36":{},"56":{},"61":{},"70":{},"72":{},"89":{},"94":{},"96":{},"140":{},"193":{},"239":{},"241":{},"242":{},"243":{},"245":{},"263":{},"277":{}},"description":{"0":{},"30":{},"31":{},"33":{},"87":{},"93":{},"99":{},"261":{}}}],["us](https://help.openai.com",{"_index":287,"title":{"89":{}},"description":{}}],["usabl",{"_index":304,"title":{"94":{},"96":{},"242":{},"243":{}},"description":{}}],["usag",{"_index":467,"title":{"157":{},"159":{},"160":{},"161":{},"162":{},"163":{},"164":{},"165":{},"166":{}},"description":{}}],["user",{"_index":263,"title":{"89":{},"109":{},"145":{},"176":{},"177":{},"178":{},"179":{},"182":{},"200":{},"201":{},"202":{},"204":{},"218":{},"219":{},"220":{},"222":{},"223":{},"224":{},"225":{},"226":{},"231":{},"232":{},"233":{},"234":{}},"description":{"108":{}}}],["user'",{"_index":515,"title":{"203":{},"221":{}},"description":{}}],["valid",{"_index":192,"title":{"61":{},"69":{}},"description":{}}],["valu",{"_index":308,"title":{"94":{}},"description":{}}],["variat",{"_index":368,"title":{"101":{}},"description":{}}],["variou",{"_index":250,"title":{"89":{}},"description":{"102":{}}}],["vector",{"_index":160,"title":{"53":{},"89":{},"90":{},"166":{},"250":{},"251":{},"252":{},"253":{},"254":{},"255":{},"256":{},"257":{},"258":{},"259":{},"260":{},"261":{},"262":{},"263":{},"264":{},"265":{},"266":{}},"description":{"52":{},"256":{},"261":{}}}],["vector_stor",{"_index":592,"title":{},"description":{"251":{},"252":{}}}],["vector_stores/{vector_store_id",{"_index":593,"title":{},"description":{"253":{},"254":{},"255":{}}}],["vector_stores/{vector_store_id}/fil",{"_index":597,"title":{},"description":{"256":{},"260":{},"261":{}}}],["vector_stores/{vector_store_id}/file_batch",{"_index":598,"title":{},"description":{"256":{},"261":{}}}],["vector_stores/{vector_store_id}/file_batches/{batch_id",{"_index":599,"title":{},"description":{"257":{}}}],["vector_stores/{vector_store_id}/file_batches/{batch_id}/cancel",{"_index":602,"title":{},"description":{"258":{}}}],["vector_stores/{vector_store_id}/file_batches/{batch_id}/fil",{"_index":603,"title":{},"description":{"259":{}}}],["vector_stores/{vector_store_id}/file_batches`](/docs/api-reference/vector-stores-file-batches/createbatch",{"_index":281,"title":{"89":{}},"description":{}}],["vector_stores/{vector_store_id}/files/{file_id",{"_index":611,"title":{},"description":{"262":{},"263":{},"264":{}}}],["vector_stores/{vector_store_id}/files/{file_id}/cont",{"_index":616,"title":{},"description":{"265":{}}}],["vector_stores/{vector_store_id}/search",{"_index":621,"title":{},"description":{"266":{}}}],["verb",{"_index":546,"title":{"239":{}},"description":{}}],["verbose_json",{"_index":61,"title":{"26":{}},"description":{}}],["version",{"_index":643,"title":{"283":{},"285":{},"286":{},"287":{},"288":{},"289":{}},"description":{}}],["via",{"_index":357,"title":{},"description":{"99":{}}}],["video",{"_index":622,"title":{"267":{},"268":{},"269":{},"270":{},"272":{},"273":{},"274":{},"275":{},"276":{},"277":{}},"description":{"268":{},"269":{}}}],["videos/charact",{"_index":625,"title":{},"description":{"270":{}}}],["videos/characters/{character_id",{"_index":627,"title":{},"description":{"271":{}}}],["videos/edit",{"_index":628,"title":{},"description":{"272":{}}}],["videos/extens",{"_index":629,"title":{},"description":{"273":{}}}],["videos/{video_id",{"_index":630,"title":{},"description":{"274":{},"275":{}}}],["videos/{video_id}/cont",{"_index":636,"title":{},"description":{"276":{}}}],["videos/{video_id}/remix",{"_index":639,"title":{},"description":{"277":{}}}],["view",{"_index":208,"title":{"70":{}},"description":{}}],["vision](/docs/guides/vis",{"_index":123,"title":{"36":{}},"description":{}}],["voic",{"_index":68,"title":{"28":{},"29":{},"30":{},"31":{},"32":{},"33":{}},"description":{"28":{},"29":{},"30":{},"31":{},"32":{},"33":{}}}],["volum",{"_index":610,"title":{},"description":{"261":{}}}],["web",{"_index":554,"title":{"241":{},"245":{}},"description":{}}],["webrtc",{"_index":534,"title":{"236":{},"238":{}},"description":{}}],["webrtc](/docs/guides/realtime-webrtc",{"_index":563,"title":{"241":{}},"description":{}}],["whether",{"_index":461,"title":{"151":{},"238":{}},"description":{}}],["within",{"_index":322,"title":{"96":{},"109":{},"173":{},"174":{},"175":{},"224":{},"225":{},"226":{},"228":{},"229":{},"230":{},"232":{},"233":{},"234":{}},"description":{"108":{}}}],["without",{"_index":557,"title":{"241":{}},"description":{}}],["write",{"_index":608,"title":{},"description":{"261":{}}}],["zdr-compat",{"_index":430,"title":{"139":{}},"description":{}}],["zip",{"_index":645,"title":{"284":{},"289":{}},"description":{}}]],"pipeline":[]}},"options":{}};
var container = document.getElementById('redoc');
Redoc.hydrate(__redoc_state, container);
</script>
</body>
</html>